Unbind Key Pair
Last Updated：2020-09-21
- The interface is used to unbind the selected virtual machines from the key pairs bound to them respectively.
- Currently, one key pair can be bound to one virtual machine only. This operation is to unbind the selected virtual machines from the key pairs unbound to them through the Baidu AI Cloud console operation. If the virtual machine has no key pair of this kind, it may not be processed.
- 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.
-
Note
- 1）If no key pair may be bound to the virtual machine selected by the user, this operation has no action on the virtual machine;
- 2）If the user may manually bind the key pair to the selected virtual machine, the operation has no impact on the key pair bound manually by the user;
- 3）If the user binds a key pair to the selected virtual machine through the Baidu AI Cloud console operation and the key pair status is normal, the operation deletes the key pair from the virtual machine.
Request structure
PUT /v{version}/keypair/{keypairId}?detach 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 | Key pair id to be unbound |
| instanceIds | List<String> | Yes | RequestBody parameter | Short id list of virtual machine to be unbound |
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-h4NDJPhY?detach HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"instanceId" : ["i-ePEyBGdM"]
} 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