Unbind a key pair
Updated at：2025-10-20
This API unbinds the selected BCC instances from their associated key pairs.
- A BCC instance can only be linked to one key pair. This operation detaches the selected BCC instances from the key pairs they were associated with through the Baidu AI Cloud console. If a BCC instance is not linked to a key pair, no action is taken.
- This operation applies exclusively to BCC instances running on Linux systems, and the chosen BCC instances must either be in the running or stopped state.
-
Notes:
-
- The selected BCC instances by the user may not be bound to any key pairs, in which case this operation will have no effect on them;
-
- The user may have manually bound a key pair to the selected BCC instances, in which case this operation will have no impact on the manually bound key pairs;
-
- If the user has previously bound a key pair to the selected BCC instances through the Baidu AI Cloud’s console and the key pair is in a normal status, this operation will remove the key pair from the BCC instances
-
Request structure
Plain Text
1PUT /v{version}/keypair/{keypairId}?{action} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4{
5 "instanceIds" : [instanceId]
6}Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| keypairId | String | Yes | URL parameter | ID of the key pair to be unbound |
| action | String | Yes | Query | Operation performed on the key pair, current value: detach |
| instanceIds | List |
Yes | RequestBody | List of instance IDs to be unbound |
Response headers
No special headers are required beyond the standard ones.
Response parameters
None
Error codes
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| Keypair.UnsupportOsType | Unsupported os type, only linux supported. | 403 | Unsupported OS; only the Linux OS is supported |
| Keypair.InstanceStatusForbidden | Instance not in running or stopped status. | 409 | Only instances in the running or stopped status can be operated |
| Keypair.AttachAttachedKeypair | Can not attach to an attached keypair. | 400 | The key pair that is already bound cannot be bound |
| Keypair.InstanceNotExist | Instance not exist. | 404 | The instance does not exist. |
| Keypair.KeypairNotExist | Keypair not exist. | 404 | Key pair does not exist |
Request example
Plain Text
1PUT /v2/keypair/k-h4NDJPhY?detach HTTP/1.1
2Host: bcc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5
6{
7 "instanceIds" : ["i-ePEyBGdM"]
8}Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS