接口说明
本接口用于为云主机绑定密钥对。
说明:
- 只有linux操作系统的云主机可绑定密钥对。
- 密钥的公钥写入到实例的ssh配置当中,用户就可以通过该密钥的私钥来登录实例。
- 如果实例原来绑定过密钥,那么原来的密钥将失效。
URL
PUT https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/bind/keypair
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
keypairUpdateReq
|
密钥对更新请求体
|
是
|
密钥对更新请求体。 |
|
keyName
|
string
|
是
|
密钥对名称,只能包含数字、字母,长度5~128位。 |
|
serverId
|
string
|
是
|
云主机ID,可通过主机列表详情接口获取。 |
请求示例
PUT https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/bind/keypair
{
"body":{
"keyName":"test345",
"serverId":"2e675a52-cb9b-4c95-1s7a-5abb452xs32f"
}
}
返回参数
返回码:200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
object
|
请求成功时返回的数据 |
|
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-32e147072ws9210566f10-0d6txsbb-7",
"state":"OK",
"body":null
}