基本信息

获取一个或多个 SSH 密钥。用户可根据密钥 ID，密钥名称，云服务器 ID ，加密方式作为过滤条件，获取密钥列表。 如果不指定任何过滤条件，默认返回你所拥有的所有密钥。 如果指定不支持的加密方式，则会返回错误信息。

Action

DescribeKeyPairs

Path

/iaas

Method

GET

请求参数

此接口除公共参数外，还包含以下参数。关于公共参数的更多信息，请参见前文内容。

参数名 类型 描述 是否必须

keypairs.n

String

密钥 ID

否

instance_id

String

云服务器 ID

否

owner

String

按照用户账户过滤, 只返回指定账户的资源

否

encrypt_method

String

加密算法: ssh-rsa，ssh-dss，ecdsa-sha2-nistp521 和 ssh-ed25519

否

search_word

String

搜索关键词，支持密钥 ID，密钥名称

否

tags.n

String

按照标签 ID 过滤, 只返回已绑定某标签的资源

否

verbose

Integer

是否返回冗长的信息，若为 1，则返回加载了该 SSH 密钥的云服务器的信息，默认为 0.

否

返回数据

此接口除公共返回参数外，还包含以下返回参数。关于公共返回参数的更多信息，请参见前文内容。

参数名 类型 描述

keypair_set

Array

JSON 格式的密钥数据列表，每项参数可见下面 Response Item

total_count

Integer

根据过滤条件得到的密钥总数

keypair_set 参数说明如下。

参数名 类型 描述

keypair_id

String

SSH密钥 ID

keypair_name

String

SSH密钥名称

description

String

SSH密钥描述

encrypt_method

String

SSH密钥加密算法，有效值为 ssh-rsa 和 ssh-dss

pub_key

String

SSH密钥公钥

instance_ids

Array

SSH密钥加载的云服务器 ID 列表
只有在请求参数 verbose=1 时才会返回此信息。

请求示例

https://api.<your_domain>/iaas/?action=Describekeypairs
&verbose=1
&COMMON_PARAMS

返回示例

{
  "action":"DescribeKeyPairsResponse",
  "total_count":1,
  "keypair_set":[
    {
      "description":null,
      "encrypt_method":"ssh-rsa",
      "keypair_name":"kp 1",
      "instance_ids":[
        "i-ogbndull"
      ],
      "create_time":"2013-08-30T05:13:50Z",
      "keypair_id":"kp-bn2n77ow",
      "pub_key":"AAAAB3..."
    }
  ],
  "ret_code":0
}