Import Key Pair
Last Updated：2020-09-21
- This interface is used to import and create key pairs by users themselves.
-
The key pair imported in the request parameter must support any of the following encryption methods:
- rsa
- dsa
- ssh-rsa
- ssh-dss
- ecdsa
Request structure
PUT /v{version}/keypair?import HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"name": "keypair01",
"description": "some description",
"publicKey": "your-pulicKey"
} 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 |
| name | String | Yes | RequestBody | Name of key pair to be created |
| description | String | No | RequestBody | Description of key pair to be created |
| publicKey | String | Yes | RequestBody | Public key content |
Return header
There are no special headers except the common header.
Return parameter
| Parameter name | Type | Description |
|---|---|---|
| keypair | KeypairModel | Key pair object |
Error code
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| Keypair.KeypairNameInvalid | Keypair name is invalid. | 400 | The name format of key pair is incorrect. |
| Keypair.KeypairDescriptionInvalid | Keypair description is invalid. | 400 | The description format of key pair is incorrect. |
| Keypair.KeypairQuotaExceedLimit | Keypair number exceeds the limit. | 413 | The number of key pairs exceeds the limit. |
| Keypair.KeypairPublicKeyExist | Keypair already exist. | 400 | The public key already exists. |
| Keypair.PublicKeyFormatInvalid | Public key format is invalid. | 400 | The public key format is incorrect. |
Request example
POST /v2/keypair?import HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"name": "keypair01",
"description": "some description",
"publicKey": "your-publicKey"
} 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
{
"keypair":{
"instanceCount":0,
"name":"keypair01",
"description":"from import",
"createdTime":"2019-01-30T11:52:41Z",
"publicKey":"publicKey",
"fingerPrint":"fingerPrint",
"regionId":"bj",
"keypairId":"keypairId"
}
}