获取密钥对列表--边缘计算节点-火山引擎

文档中心

立即注册

边缘计算节点

请输入

密钥对

获取密钥对列表

本接口用于获取密钥对列表。

请求说明

请求方式：GET
请求地址：https://veenedge.volcengineapi.com/?Action=ListSSHKey&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListSSHKey`	接口名称。当前 API 的名称为 `ListSSHKey`。
Version	String	是	`2021-04-30`	接口版本。当前 API 的版本为 `2021-04-30`。
projects	String[]	否	`default`	所属项目列表。
with_tag_info	Boolean	否	`false`	是否返回标签信息。取值范围： true：返回标签信息。 false（默认值）：不返回标签信息。
TagFilters.N.Key	String[]	否	`env`	标签过滤器的键。
TagFilters.N.Values.N	String[]	否	`testing`	标签过滤器的标签值列表。
page	Integer	否	`1`	密钥对列表的页码。默认值：1。
limit	Integer	否	`10`	分页查询时设置的每页行数。默认值：1000。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结果。

参数	类型	示例值	描述
key_pairs	Object[]	`-`	密钥对列表。

请求示例

GET https://veenedge.volcengineapi.com/?Action=ListSSHKey&Version=2021-04-30
&<其他公共参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230525204841E30CA95925EEFCAD****",
        "Action": "ListSSHKey",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "key_pairs": [
            {
                "key_pair_identity": "sshkey-4ht47hq65z9****",
                "key_pair_name": "My_keypair",
                "fingerprint": "a66d0bfa15e905f9c65bb7a5008****",
                "create_time": 1664530597,
                "tags": {},
                "used": true
            }
        ]
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。

最近更新时间：2025.12.22 17:43:04

这个页面对您有帮助吗？

有用

无用