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

文档中心

立即注册

导航

边缘计算节点

获取密钥对列表

最近更新时间：2025.02.14 11:11:46首次发布时间：2022.02.25 18:58:31

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	ListSSHKey	公共参数。该参数表示接口名称。取值：ListSSHKey。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
page	Integer	否	1	密钥对列表的页码。默认值：1。
limit	Integer	否	10	分页查询时设置的每页行数。默认值：1000。

返回参数

参数	类型	示例值	描述
key_pairs	[]SSHKey	请参见返回示例	密钥对列表。

请求示例

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 请求失败。关于错误码的更多信息，参见错误码。