接口说明
查询密钥对列表V2,返回可选带有标签。
URL
GET https://ecloud.10086.cn/api/openapi-ecs/customer/v3/keypair/list
请求参数
Query
|
参数名称
|
类型
|
必填
|
描述
|
|
keyName
|
string
|
否
|
密钥对名称。 |
|
orderSequence
|
enum(ASC,DESC)
|
否
|
创建时间升序或降序。 |
|
tagNeeded
|
boolean
|
否
|
是否查询标签信息，默认为否。 |
|
tagIds
|
<string> array(multi)
|
否
|
标签ID集合。 |
|
page
|
integer(int32)
|
否
|
列表分页页数，起始页为1。 |
|
size
|
integer(int32)
|
否
|
列表分页的每页大小，默认值为10。 |
|
region
|
string
|
否
|
可用区。 |
请求示例
GET https://ecloud.10086.cn/api/openapi-ecs/customer/v3/keypair/list返回参数
返回码：200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
分页查询统一返回结构体«KeypairRespV2»
|
请求成功时返回的数据 |
|
content
|
<KeypairRespV2> array
|
分页查询返回的具体结构体 |
|
createdBy
|
string
|
密钥对创建人 |
|
createdTime
|
string(date-time)
|
密钥对修改时间 |
|
customerId
|
string
|
客户ID |
|
fingerPrint
|
string
|
指纹 |
|
id
|
string
|
密钥对ID |
|
modifiedBy
|
string
|
密钥对修改人ID |
|
modifiedTime
|
string(date-time)
|
密钥对修改时间 |
|
name
|
string
|
密钥对名称 |
|
proposer
|
string
|
用户ID |
|
region
|
string
|
可用区 |
|
status
|
string
|
密钥对状态 |
|
tags
|
<标签返回体> array
|
标签返回列表 |
|
tagId
|
string
|
标签ID |
|
tagKey
|
string
|
标签键 |
|
tagValue
|
string
|
标签值 |
|
type
|
string
|
密钥对类型 |
|
vaz
|
string
|
虚拟az |
|
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-ee8a4640fa72e5b903d71-a67b389b-1",
"state":"OK",
"body":{
"total":2,
"content":[
{
"id":"a8adadaw06b842adab244c04f3b217fc",
"name":"keypairTest",
"type":"ssh",
"fingerPrint":"c1:d8:cf:84:38:b3:14:c0:ad:5d:92:w8:1f:fd:10:1f",
"region":"SZJD",
"status":"1",
"proposer":"CIDC-U-***",
"customerId":"CIDC-A-***",
"createdBy":"CIDC-A-***",
"createdTime":"2025-05-20 09:32:12",
"modifiedBy":"CIDC-U-***",
"modifiedTime":"2025-05-20 09:32:12",
"tags":[
{
"tagId":"2eb9fe5a-cffb-496f-b65c-8ad34fdcea10",
"tagKey":"key",
"tagValue":"value"
}
]
},
{
"id":"1ddcf4509e9f4930mcidjaiw2cf39fb0",
"name":"keypairTest2",
"type":"ssh",
"fingerPrint":"0a:fe:a3:0b:b6:45:a8:0e:13:27:d9:f9:18:23:22:e8",
"region":"SZJD",
"status":"1",
"proposer":"CIDC-U-***",
"customerId":"CIDC-A-***",
"createdBy":"CIDC-A-***",
"createdTime":"2025-05-18 16:18:37",
"modifiedBy":"CIDC-U-***",
"modifiedTime":"2025-05-18 16:18:37"
}
]
}
}