批量绑定SSH密钥对
功能介绍
给指定的虚拟机批量绑定新的SSH密钥对。
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/keypairs/batch-associate
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
batch_keypairs |
是 |
Array of AssociateKeypairRequestBody objects |
最多可同时选择10个弹性云服务器绑定密钥对。 约束：只支持选择相同的密钥对，弹性云服务器处于“运行中”状态，并未绑定密钥对。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
keypair_name |
是 |
String |
SSH密钥对的名称 |
server |
是 |
EcsServerInfo object |
需要绑定密钥对的虚拟机信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
id |
是 |
String |
需要绑定(替换或重置)SSH密钥对的虚拟机id |
auth |
否 |
Auth object |
可选字段，鉴权认证类型。替换时需要该参数，重置时不需要该参数。 |
disable_password |
否 |
Boolean |
|
port |
否 |
Long |
SSH监听端口。 |
响应参数
状态码： 202
参数 |
参数类型 |
描述 |
|---|---|---|
tasks |
Array of TaskResponseBody objects |
批量绑定密钥对任务。 |
参数 |
参数类型 |
描述 |
|---|---|---|
task_id |
String |
任务下发成功返回的ID。 |
server_id |
String |
绑定的虚拟机id。 |
status |
String |
任务下发的状态。SUCCESS或FAILED。 |
error_code |
String |
任务下发失败返回的错误码。 |
error_msg |
String |
任务下发失败返回的错误信息。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
{
"batch_keypairs" : [ {
"keypair_name" : "1",
"server" : {
"id" : "fxxx16e3-74b8-4025-9852-1f451932c20c",
"disable_password" : false,
"auth" : {
"type" : "password",
"key" : "password"
}
}
}, {
"keypair_name" : "1",
"server" : {
"id" : "4xxxxfc4-b4bf-49c2-b983-a1811c9760c1",
"disable_password" : false,
"auth" : {
"type" : "password",
"key" : "password"
}
}
} ]
}
响应示例
状态码： 202
请求已成功。
{
"tasks" : [ {
"server_id" : "xxx",
"task_id" : "xxx",
"status" : "SUCCESS"
}, {
"server_id" : "xxx",
"status" : "Failed",
"error_code" : "xxxx",
"error_msg" : "xxxx"
} ]
}
状态码： 400
Error response
{
"error_code" : "KPS.XXX",
"error_msg" : "XXX"
}
状态码
状态码 |
描述 |
|---|---|
202 |
请求已成功。 |
400 |
Error response |
错误码
请参见错误码。
