Create Key Pair
Last Updated：2020-09-21
- The interface is used to create a key pair. The default quota of a single user in one region is 500 (sum of created and imported key pairs) The created key pair can be implanted into the instance to realize remote login to the virtual machine.
Request structure
POST /v{version}/keypair?create HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"name": "keypair01",
"description": "some description"
} 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 |
Return header
There are no special headers except the common header.
Return parameter
| Parameter name | Type | Description |
|---|---|---|
| keypair | KeypairModel | Object of created key pair |
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. |
Request example
POST /v2/keypair?create 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"
} 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":
{
"keypairId": "k-y7VWq",
"name": "keypair01",
"description": "someDescription",
"createTime": "2018-01-27T13:23:13Z",
"regionId": "bj",
"publicKey": "publicKey-publicKey"
"privateKey":"privateKey-privateKye"
}
}