绑定密钥对

接口说明


为实例绑定密钥对(支持批量)。如您选择已经绑定过其他密钥对的实例,新绑定的密钥对将会覆盖以前绑定的密钥对。

注意事项:

  1. 只有linux操作系统的实例可绑定密钥对。

  2. 密钥的公钥写入到实例的ssh配置当中,用户就可以通过该密钥的私钥来登录实例。

  3. 如果实例原来绑定过密钥,那么原来的密钥将失效。

  4. 支持批量操作20台实例绑定密钥对。

  5. 弹性裸金属实例状态必须为已关机。


推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

POST https://ecloud.10086.cn/api/openapi-instance/v4/key-pair/bind-instances

请求参数

Body

参数名称
类型
必填
描述
batchBindKeyPairReq
BatchBindKeyPairReq
是

batchBindKeyPairReq

keyPairName
string
是

密钥对名称,可通过查询密钥列表获取。

instanceIds
<string> array
是

实例ID列表,可通过查询实例状态列表接口获取。

请求示例

POST https://ecloud.10086.cn/api/openapi-instance/v4/key-pair/bind-instances
{
	"instanceIds":[
		"c37945d7-0859-4c88-906b-0c49f79b64e0",
		"a3e664c3-f3cd-43ee-9f76-32476f218af2"
	],
	"keyPairName":"new-vm"
}

返回参数

返回码:200
OK
参数名称
类型
描述
body
BatchAction«InstanceActionResult»

请求成功时返回的数据。

instanceBatchResult
<InstanceActionResult> array

实例批量操作结果集。

instanceId
string

实例ID。

result
boolean

操作是否下发成功。

message
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":"req-150f330d-2b38-4da8-9113-99992ded4601",
	"state":"OK",
	"body":{
		"instanceBatchResult":[
			{
				"instanceId":"c37945d7-0859-4c88-906b-0c49f79b64e0",
				"result":true,
				"message":""
			},
			{
				"instanceId":"a3e664c3-f3cd-43ee-9f76-32476f218af2",
				"result":true,
				"message":""
			}
		]
	}
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。