接口说明
查询密钥对列表，支持标签键值对查询，支持同步返回密钥标签。
URL
POST https://ecloud.10086.cn/api/openapi-instance/v4/key-pair/list
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
instanceKeyPairListReqV2
|
InstanceKeyPairListReqV2
|
是
|
instanceKeyPairListReqV2 |
|
keyPairName
|
string
|
否
|
密钥对名称。 |
|
orderSequence
|
enum(ASC,DESC)
|
否
|
创建时间升序或降序,ASC或DESC。 |
|
tagNeeded
|
boolean
|
否
|
是否查询标签信息。取值范围：
默认值：false。 |
|
tags
|
<Tag> array
|
否
|
标签，可通过查询用户标签列表接口获取。 |
|
key
|
string
|
是
|
标签键，仅支持中英文、数字、中划线、下划线，长度1-127位之间，不能以 |
|
value
|
string
|
是
|
标签值，仅支持数字、中英文、中划线、下划线，长度在1~255位之间，不能以 |
|
page
|
integer(int32)
|
否
|
列表分页页数，最小值为1，默认值：1。 |
|
pageSize
|
integer(int32)
|
否
|
列表分页每页大小，最小值为1，最大值为100，默认值：10。 |
请求示例
POST https://ecloud.10086.cn/api/openapi-instance/v4/key-pair/list{
"keyPairName":"maverTestKeyPair"
}返回参数
返回码：200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
PageListResp«InstanceKeyPairResp»
|
请求成功时返回的数据。 |
|
content
|
<InstanceKeyPairResp> array
|
分页查询返回的具体结构体。 |
|
createdBy
|
string
|
密钥创建人。 |
|
createdTime
|
string(date-time)
|
密钥对创建时间。 |
|
customerId
|
string
|
客户ID。 |
|
keyPairFingerPrint
|
string
|
密钥对的指纹。 |
|
keyPairId
|
string
|
密钥对ID。 |
|
keyPairName
|
string
|
密钥对名称。 |
|
modifiedBy
|
string
|
密钥修改人ID。 |
|
modifiedTime
|
string(date-time)
|
密钥对修改时间。 |
|
proposer
|
string
|
用户ID。 |
|
status
|
string
|
密钥对状态。 |
|
tags
|
<SimpleTagResp> array
|
标签返回列表。 |
|
tagId
|
string
|
标签ID。 |
|
tagKey
|
string
|
标签key。 |
|
tagValue
|
string
|
标签value。 |
|
type
|
string
|
密钥类型。 |
|
zoneId
|
string
|
密钥对可用区。 |
|
total
|
integer
|
满足查询条件的总个数。 |
|
errorCode
|
string
|
统一错误码。 |
|
errorMessage
|
string
|
页面国际化错误提示。 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数。 |
|
requestId
|
string
|
每个请求的序列号。 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码。返回正常：OK，返回错误：ERROR，返回异常：EXCEPTION，需要告警实现的：ALARM，禁止访问：FORBIDDEN。 |
返回示例
返回码：200
OK
{
"requestId":"reqId-9d10a4c531a0bbf12136e-a6227433-5",
"state":"OK",
"body":{
"total":1,
"content":[
{
"createdBy":"CIDC-A-8f01a904c3b54189b0069681809bf6a5",
"createdTime":"2025-09-09 19:26:58",
"customerId":"CIDC-A-8f01a904c3b54189b0069681809bf6a5",
"keyPairFingerPrint":"0b:36:f0:d4:7d:9a:2a:22:66:d8:29:ff:59:47:ad:33",
"keyPairId":"13a753b586c749f29234d14275d79682",
"modifiedBy":"CIDC-U-8a0eacbf92df46fa9dfb672b7d273e49",
"modifiedTime":"2025-09-09 19:26:58",
"keyPairName":"maverTestKeyPair",
"proposer":"CIDC-U-8a0eacbf92df46fa9dfb672b7d273e49",
"zoneId":"cn-jiangsu-1a",
"status":"1",
"tags":[
{
"tagId":"4d30a221-3615-40e9-93f0-f64edf9a48b1",
"tagKey":"key001",
"tagValue":"value001"
}
],
"type":"ssh"
}
]
}
}