接口说明
创建密钥对。系统会为您保管密钥的公钥部分,并返回未加密的PEM编码的PKCS#8格式私钥。您需要自行妥善保管私钥部分。创建时可以指定标签。
注意事项:
-
开发者只需指定密钥对名称,即可由系统自动创建密钥对,并返回所生成的密钥对的ID及其私钥的内容。
-
密钥对名称不能和已经存在的密钥对的名称重复。
-
私钥的内容可以保存到文件中作为SSH的一种认证方式。
-
移动云不会保存用户的私钥,请妥善保管。
-
华东-苏州地域和华北-北京3地域密钥对不区分可用区,zoneId非必填;其余地域zoneId必填。
URL
POST https://ecloud.10086.cn/api/openapi-instance/v4/key-pair/create
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
instanceCreateKeyPairReq
|
InstanceCreateKeyPairReq
|
是
|
instanceCreateKeyPairReq |
|
keyPairName
|
string
|
是
|
密钥名称,5-128位的英文、数字的组合。 |
|
zoneId
|
string
|
否
|
可用区,可通过查询属地地域可用区信息接口获取。 |
|
tags
|
<Tag> array
|
否
|
标签,可通过查询用户标签列表接口获取。 |
|
key
|
string
|
是
|
标签键,仅支持中英文、数字、中划线、下划线,长度1-127位之间,不能以ecloud开头。 |
|
value
|
string
|
是
|
标签值,仅支持数字、中英文、中划线、下划线,长度在1~255位之间,不能以 |
请求示例
POST https://ecloud.10086.cn/api/openapi-instance/v4/key-pair/create
{
"keyPairName":"testKeyPairV1",
"zoneId":"cn-jiangsu-1b",
"tags":[
{
"key":"testkey",
"value":"testvalue"
}
]
}
返回参数
返回码:200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
InstanceCreateKeypairResp
|
请求成功时返回的数据。 |
|
keyPairFingerPrint
|
string
|
密钥对的指纹。 |
|
keyPairId
|
string
|
密钥对ID。 |
|
keyPairName
|
string
|
密钥对名称。 |
|
privateKey
|
string
|
私钥部分。 |
|
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-3ed6c4bbe9c7153adf66d-54999784-6",
"state":"OK",
"body":{
"keyPairId":"1f06094285324c9cb48487b8cf4f8e55",
"keyPairName":"lljs12334",
"keyPairFingerPrint":"fd:22:0a:18:0a:71:0f:a9:32:53:7d:98:d9:b6:c5:2b",
"privateKey":"-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAvyKZpmj/x4PWpxfTdCcIzmuXlrWvlSrSfM1aj/iXGNbVeF2W\nifAyrqCyt6rRgTGs2N3tdHr5g6PwIqz1Mpmn1TRZNjh+zzk9htiMY1zUW3r6qFsU\nt2pxr5HayYxQrkOIYRkci/Eq77g8wKbfpYwitJF9awZFggxihN0FNEFe7+2vmo4Q\nf9ednjQXQtLjnvjQARzAdSNyqvQBIssas7gRB9vtzsFMnoio3Cs4JX4NLVyCz3Ni\nRYqrOnKekz5m30WSo7LWjajRyYs3yRD/L9//T+Oy+Mm85Vy4upMGjqiwnKFhd/qh\nCjA20X9tZPLFslGTg60MW2WXL7naHIgKGUgI/QIDAQABAoIBAQC7jcNCNSRQbkFT\nA6E+CBOvIorEm5IpCLU1O/kS73etKxqcGxHeVzIUg6H7coZUhR88S0F4HDf9gf/g\ntuGAfqDfKJgmCXf99gg26wWPdwb2oY2XaJDCjpPyGWicf7Cn36LSzOZjOArO4nXT\nAazR8NoZX+6295d7TpXaFFvH9CGpwlkLzK3faFki+92wSXahzYY+hXsJtHwyG/jO\nHBxSrD2c7/39SlsanDUrlyGaXMpJmpnL67wZNa2Rm41r5WhWbR61K7D91aVovpnF\n8btSq/KPWSUMNVQ4UVUC4ZN+ikNL3p253Dy9DCWj0B51X9ZYhrnknGT86mMr0+Iy\ni7KhiWlNAoGBAPYCt6cbPDmX7GSWvB7BnIzAreJnyIgfmvXiiPKDhA5qw2Pefc8p\n9Oi0InI3optSV4IO2gCQxt/hNxiHEnF316RucFeD93JsEzGFQmMdtULOeI1YpYCx\n/PoKHhd+U1QC0q2ZgkaEYEnitr/WDCNTiDSub/XXlkK7kznstn3AG5TnAoGBAMbl\nc7CMkbURYu2C83GiK2gJs9H7UO7LHofiixE2S6WeMTAnpp0okBrnLqM3/2ePRxYW\nVcesjKQ5bPPuZGWtuWTEN0gf+IMXT8C593B/7Yv+nHy3NWshqlDGbafNqxScolaj\nIwHck+eRGut4JUXgGRV6T/6IjrWkw5JmTtGWztJ7AoGBAMsy62cHw/L+Xa+oIbJ1\n0U0hSX8cojJtiJ1YhC1sHAOcg89V0yzuRvB++YTGF3WbydQPWFnnO51odQ25Y659\ngoy6++gNhLHqOuBIZdFglHud900oz2tBmOcevERDf6iAvGvPxB9i7/WXYcOKlXQI\nZxS8kJXLgL2WGcFamFG+AAo5AoGBAMQAQ4Sc0c3Uh1+1Zz/45ruMrCbmeXgItFqG\nVjMtBVj9Tk29FUTUP0YzwdLYkRk1qYDLm9a8ZJBFgufTah6FFyiE8FFkKBrPMymi\nWYQEnUwTKZUBWmPrdhJJqK/vToNuY8/qzcm83AgcB6I58MkuMKnoscIMQk4gQxYX\nOd7ytXfXAoGAQm+m9Hz0TbXuAjCtjPBhbbdrFRAlwSUbvbW8B1QFSzK+mS8meDx3\n56Dud/yiubvL0LWvjWosm4dyRmXnw+kp4ub7fTDwTS34fdqGwOEo5SHVWExNeoyL\n+Xhr3mK8P31e7GsNm7DmwDrzSmLmj05LjKedr6xLOVz6gE/9VbQRAGA=\n-----END RSA PRIVATE KEY-----\n"
}
}