接口说明
查看密钥对详情信息。
URL
GET https://ecloud.10086.cn/api/openapi-instance/v4/key-pair/details
请求参数
Query
|
参数名称
|
类型
|
必填
|
描述
|
|
keyPairName
|
string
|
是
|
密钥对名称,可通过查询密钥列表获取。 |
|
tagNeeded
|
boolean
|
否
|
是否查询标签信息。取值范围:
默认值:false。 |
请求示例
GET https://ecloud.10086.cn/api/openapi-instance/v4/key-pair/details
返回参数
返回码:200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
InstanceKeyPairDetailResp
|
请求成功时返回的数据。 |
|
createdTime
|
string(date-time)
|
密钥对创建时间。 |
|
keyPairFingerPrint
|
string
|
密钥对的指纹。 |
|
keyPairId
|
string
|
密钥对ID。 |
|
keyPairName
|
string
|
密钥对名称。 |
|
modifiedTime
|
string(date-time)
|
密钥对修改时间。 |
|
publicKey
|
string
|
公钥。 |
|
status
|
string
|
密钥对状态。值为1:密钥正常。 |
|
tags
|
<SimpleTagResp> array
|
标签返回列表。 |
|
tagId
|
string
|
标签ID。 |
|
tagKey
|
string
|
标签key。 |
|
tagValue
|
string
|
标签value。 |
|
type
|
string
|
密钥类型。 |
|
zoneId
|
string
|
密钥对可用区。 |
|
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-d411adb27c1843779de61fcff607cfc5",
"state":"OK",
"body":{
"createdTime":"2025-09-09 19:26:58",
"keyPairFingerPrint":"0b:36:f0:d4:7d:9a:2a:22:66:d8:29:ff:59:47:ad:33",
"keyPairId":"13a753b586c749f29234d14275d79682",
"modifiedTime":"2025-09-09 19:26:58",
"keyPairName":"maverTestKeyPair",
"publicKey":null,
"zoneId":"cn-jiangsu-1a",
"status":"1",
"tags":[
{
"tagId":"4d30a221-3615-40e9-93f0-f64edf9a48b1",
"tagKey":"key001",
"tagValue":"value001"
}
],
"type":"ssh"
}
}