Bind Key Pair
Last Updated：2020-09-21
- The interface is used to bind the selected key pair (limited to a single) to the selected virtual machine (support multiple virtual machines).
- Currently, one key pair can be bound to one virtual machine only. If a key pair is already bound to the operated virtual machine, the operate replaces the original key pair of the virtual machine. This operation is only applicable to the virtual machine of linux system, and the selected virtual machine must be in the running or shutdown status.
Request structure
PUT /v{version}/keypair/{keypairId}?attach HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"instanceIds" : [instanceId]
} Request header
There are no special headers except the common header.
Request parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| keypairId | String | Yes | URL parameter | id of key pair to be bound |
| instanceIds | List<String> | Yes | RequestBody parameter | Short id list of virtual machine to be bound |
Return header
There are no special headers except the common header.
Return parameter
None
Error code
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| Keypair.UnsupportOsType | Unsupported os type, only linux supported. | 403 | Unsupported operating systems, only supporting linux operating system |
| Keypair.InstanceStatusForbidden | Instance not in running or stopped status. | 409 | You can only operate the virtual machine in the running or shutdown status. |
| Keypair.AttachAttachedKeypair | Can not attach to an attached keypair. | 400 | You can't bind a bound key pair |
| Keypair.InstanceNotExist | LogStore does not exist | 404 | The virtual machine doesn't exist. |
| Keypair.KeypairNotExist | Keypair not exist. | 404 | The key pair doesn't exist. |
Request example
PUT /v2/keypair/k-YufwpQAe?attach HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"instanceIds": ["i-ZeVPsPzv"]
} Return example
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS