接口说明
本接口用于创建一个OpenSSH RSA密钥对,可以用于登录Linux实例。
说明:
- 开发者只需指定密钥对名称,即可由系统自动创建密钥对,并返回所生成的密钥对的ID及其公钥、私钥的内容。
- 密钥对名称不能和已经存在的密钥对的名称重复。
- 私钥的内容可以保存到文件中作为SSH的一种认证方式。
- 移动云不会保存用户的私钥,请妥善保管。
URL
POST https://ecloud.10086.cn/api/openapi-ecs/customer/v3/keypair
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
createKeypairReq
|
密钥创建请求体
|
是
|
密钥对创建请求体。 |
|
apiVersion
|
string
|
否
|
API版本,如传“v2.1”,则返回体中将包含密钥对私钥信息。 |
|
name
|
string
|
是
|
密钥对名称,5-128位的英文、数字的组合。 |
|
region
|
string
|
否
|
可用区。 |
请求示例
POST https://ecloud.10086.cn/api/openapi-ecs/customer/v3/keypair
{
"body":{
"name":"test456"
}
}
返回参数
返回码:200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
object
|
请求成功时返回的数据。 |
|
errorCode
|
string
|
统一错误码。 |
|
errorMessage
|
string
|
页面国际化错误提示。 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数。 |
|
requestId
|
string
|
每个请求的序列号。 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码,返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN。 |
返回示例
返回码:200
OK
{
"requestId":"reqId-****-e9489309-1",
"state":"OK",
"body":"test456"
}