接口说明
本接口用于查看密钥对详情。
URL
GET https://ecloud.10086.cn/api/openapi-ecs/customer/v3/keypair/{keypairName}
请求参数
Path
|
参数名称
|
类型
|
必填
|
描述
|
|
keypairName
|
string
|
否
|
密钥对名称。 |
Query
|
参数名称
|
类型
|
必填
|
描述
|
|
region
|
string
|
否
|
可用区，苏州和北京资源池不区分可用区，此参数无效。 |
|
tagNeeded
|
boolean
|
否
|
是否查询标签信息，默认为否。 |
请求示例
GET https://ecloud.10086.cn/api/openapi-ecs/customer/v3/keypair/{keypairName}返回参数
返回码：200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
密钥对详情返回体
|
请求成功时返回的数据 |
|
createdTime
|
string(date-time)
|
密钥对创建时间 |
|
fingerPrint
|
string
|
密钥对指纹 |
|
id
|
string
|
密钥对ID |
|
modifiedTime
|
string(date-time)
|
密钥对修改时间 |
|
name
|
string
|
密钥对名称 |
|
privateKey
|
string
|
密钥对私钥 |
|
publicKey
|
string
|
公钥 |
|
region
|
string
|
密钥对可用区 |
|
status
|
string
|
密钥对状态 |
|
tags
|
<标签返回体> array
|
标签返回列表 |
|
tagId
|
string
|
标签ID |
|
tagKey
|
string
|
标签键 |
|
tagValue
|
string
|
标签值 |
|
type
|
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-c7d4ab3453d66863a5862-****",
"state":"OK",
"body":{
"id":"id",
"name":"name",
"type":"ssh",
"fingerPrint":"fingerPrint",
"status":"1",
"createdTime":"2024-06-12 11:02:23",
"modifiedTime":"2024-06-12 11:02:23",
"region":"SZJD"
}
}