# 查询SSH密钥对列表 - ListKeypairs #### 功能介绍 查询SSH密钥对列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dew/dew_02_0002.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dew/dew_02_0308.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | kps:SSHKeyPair:list | List | SSHKeyPair \* | - | kps:domainKeypairs:list | - | #### URI GET /v3/{project_id}/keypairs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID。可参考[获取项目ID](https://support.huaweicloud.com/api-dew/dew_02_0009.html)获取。 **约束限制：** 不涉及 **取值范围：** 以IAM服务接口返回值为准，字符长度32-32 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | String | **参数解释：** 查询返回密钥对列表当前页面的数量 **约束限制：** 不涉及 **取值范围：** 1-1000 **默认取值：** 1000 | | marker | 否 | String | **参数解释：** 以单页最后一条密钥对名称作为分页标记。为空时为查询第一页 **约束限制：** marker需要和limit配合使用，不能独立使用。当最后一页返回数量小于limit时，表示查询结束 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值） **约束限制：** 不涉及 **取值范围：** IAM服务查询用户Token接口为准 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | keypairs | Array of [Keypairs] objects | **参数解释：** SSH密钥对信息列表 | | page_info | [PageInfo] object | **参数解释：** 分页信息 **取值范围：** 不涉及 | 表5Keypairs | 参数 | 参数类型 | 描述 | |:---|:---|:---| | keypair | [Keypair] object | **参数解释：** SSH密钥对信息 | 表6Keypair | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释：** 密钥对名称由英文字母、数字、下划线、中划线组成，长度不能超过255个字节 **取值范围：** 不涉及 | | type | String | **参数解释：** 密钥对类型 **取值范围：** - ssh - x509 | | scope | String | **参数解释：** 密钥对所属域，租户级或用户级 **取值范围：** - domain - user | | public_key | String | **参数解释：** SSH密钥对对应的公钥信息 **取值范围：** 不涉及 | | fingerprint | String | **参数解释：** SSH密钥对应指纹信息 **取值范围：** 不涉及 | | is_key_protection | Boolean | **参数解释：** 是否托管密钥 **取值范围：** true或false | | frozen_state | String | **参数解释：** 密钥冻结状态 **取值范围：** - 0：正常状态 - 1：普通冻结 - 2：公安冻结 - 3：普通冻结及公安冻结 - 4：违规冻结 - 5：普通冻结及违规冻结 - 6：公安冻结及违规冻结 - 7：普通冻结、公安冻结及违规冻结 - 8：未实名认证冻结 - 9：普通冻结及未实名认证冻结 - 10：公安冻结及未实名认证冻结 | 表7PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | **参数解释：** 分页查询时，下一页的查询标志 **取值范围：** 不涉及 | | previous_marker | String | **参数解释：** 分页查询时，上一页的查询标志 **取值范围：** 不涉及 | | current_count | Integer | **参数解释：** 返回当前页条目数量 **取值范围：** 不涉及 | #### 请求示例 无 #### 响应示例 **状态码：200** 请求已成功 ``` { "keypairs" : [ { "keypair" : { "name" : "1hprr3TI", "type" : "ssh", "scope" : "user", "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABjV8GvwpSs.....", "fingerprint" : "65:ca:87:0a:16:86:59:ea:57:ea:18:37:58:e2:04:b0", "is_key_protection" : false, "frozen_state" : "0" } } ], "page_info" : { "next_marker" : "KeyPair-dxxx", "previous_marker" : "KeyPair-xxxx", "current_count" : 49 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dew/ErrorCode.html)。