查询密钥对列表

接口说明

本接口用于查看密钥对信息。


推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

GET https://ecloud.10086.cn/api/openapi-ecs/customer/v3/keypair

请求参数

Query

参数名称
类型
必填
描述
keyName
string
否

密钥对名称,模糊查询。

page
integer(int32)
否

列表分页页数,起始页为1。

size
integer(int32)
否

列表分页的每页大小,默认值为10。

请求示例

GET https://ecloud.10086.cn/api/openapi-ecs/customer/v3/keypair

返回参数

返回码:200
OK
参数名称
类型
描述
body
分页查询统一返回结构体«KeypairResp»

请求成功时返回的数据

content
<KeypairResp> array

分页查询返回的具体结构体

createTime
string(date-time)

创建时间

fingerPrint
string

指纹

id
string

密钥对ID

name
string

密钥对名称

region
string

可用区

total
integer

满足查询条件的总个数

errorCode
string

统一错误码

errorMessage
string

页面国际化错误提示

errorParams
<string> array

统一错误码的自定义参数

requestId
string

每个请求的序列号

state
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)

返回状态码

返回示例

返回码:200
OK
{
	"requestId":"reqId-14b880e8844e490439e7a-4121284d-1",
	"state":"OK",
	"body":{
		"total":1,
		"content":[
			{
				"id":"id",
				"name":"name",
				"type":"ssh",
				"fingerPrint":"fingerPrint",
				"keyaddress":null,
				"status":"1",
				"material":null,
				"proposer":"CIDC-U-***",
				"customerId":"CIDC-A-***",
				"poolId":null,
				"createdBy":"CIDC-A-***",
				"createdTime":"2025-05-18 16:18:37",
				"modifiedBy":"CIDC-U-***",
				"modifiedTime":"2025-05-18 16:18:37",
				"isDelete":0,
				"region":"SZJD",
				"vaz":null,
				"privateKey":null,
				"publicKey":null
			}
		]
	}
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。