创建密钥对
更新时间:2024-10-17
该接口用于创建密钥对,单个用户在一个地域默认配额500个(创建和导入的密钥对之和)。创建后的密钥对可植入BCC实例中以实现远程登录BCC实例。
请求结构
POST /v{version}/keypair HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"name": "keypair01",
"description": "some description"
}
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号 |
name | String | 是 | RequestBody | 待创建的密钥对名称,只支持大小写字母、数字、汉字以及-_ /.特殊字符,必须以字母开头,长度1-65。 |
description | String | 否 | RequestBody | 待创建的密钥对的描述 |
返回头域
除公共头域,无其它特殊头域。
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
keypair | KeypairModel | 创建的密钥对对象 |
错误码
错误码 | 错误描述 | HTTP状态码 | 中文解释 |
---|---|---|---|
Keypair.KeypairNameInvalid | Keypair name is invalid. | 400 | 密钥对名称格式不正确 |
Keypair.KeypairDescriptionInvalid | Keypair description is invalid. | 400 | 密钥对描述格式不正确 |
Keypair.KeypairQuotaExceedLimit | Keypair number exceeds the limit. | 413 | 密钥对数目超限 |
请求示例
POST /v2/keypair 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"
}
返回示例
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"
}
}