Binding SSH Key Pairs in Batches

Function

This interface is used to bind new SSH key pairs to specified VMs in batches.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

• If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
• If you are using identity policy-based authorization, the following identity policy-based permissions are required.

  Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
  kps:SSHKeyPair:bind	Write	SSHKeyPair *	-	kps:domainKeypairs:bind	ecs:cloudServers:createServers ecs:cloudServers:deleteServers ecs:cloudServers:showServer ecs:cloudServers:attach ecs:cloudServers:listServerBlockDevices ecs:cloudServers:showServerBlockDevice ecs:cloudServers:detachVolume ecs:cloudServers:listServerInterfaces ecs:cloudServers:listServersDetails ecs:cloudServerFlavors:get ecs:cloudServerQuotas:get evs:types:get evs:volumes:use ims:images:get vpc:subnets:list

URI

POST /v3/{project_id}/keypairs/batch-associate

Request Parameters

Response Parameters

Status code: 202

Status code: 400

Example Requests

{
  "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"
      }
    }
  } ]
}

Example Responses

Status code: 202

Request succeeded.

{
  "tasks" : [ {
    "server_id" : "xxx",
    "task_id" : "xxx",
    "status" : "SUCCESS"
  }, {
    "server_id" : "xxx",
    "status" : "Failed",
    "error_code" : "xxxx",
    "error_msg" : "xxxx"
  } ]
}

Status code: 400

Error response

{
  "error_code" : "KPS.XXX",
  "error_msg" : "XXX"
}

Status Codes

Error Codes

See Error Codes.