CreateKeyPair

创建一对SSH密钥对。我们会为您保管密钥的公钥部分,并返回未加密的 PEM 编码的 PKCS#8 格式私钥。您需要自行妥善保管私钥部分。

描述

除了调用CreateKeyPair创建密钥对之外,您还可以使用第三方工具创建密钥对,然后上传(ImportKeyPair)到某一阿里云地域,其使用方法和我们为您创建的密钥对是一致的。

您在每个地域的密钥对数最高为 500 对。更多详情,请参阅 SSH 密钥对。

调试

前往【API Explorer】在线调试,API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力,能显著降低使用云 API 的难度,强烈推荐使用。

请求参数

名称 类型 是否必选 示例值 描述
KeyPairName String FinanceJoshuaV23

密钥对名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头,不能以 http:// 和 https:// 开头。可以包含数字、半角冒号(:)、下划线(_)或者连字符(-)。必须保持名称唯一性,支持所有的字符集编码格式。

RegionId String cn-hangzhou

密钥对所在的地域ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

Action String CreateKeyPair

系统规定参数。取值:CreateKeyPair

ResourceGroupId String rg-resourcegroupid1

标签所在的企业资源组 ID。

Tag.N.Key String FinanceDept

密钥对的标签键。n的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持64个字符,不能以aliyun、acs:、http:// 或者 https:// 开头。

Tag.N.Value String FinanceDept.Joshua

密钥对的标签值。n的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持128个字符,不能以aliyun、acs:、http:// 或者 https:// 开头。

返回参数

名称 类型 示例值 描述
KeyPairFingerPrint String 89:f0:ba:62:ac:b8:aa:e1:61:5e:fd:81:69:86:6d:6b:f0:c0:5a:d7

密钥对的指纹。根据RFC4716定义的公钥指纹格式,采用MD5信息摘要算法。更多详情,请参阅 RFC4716。

KeyPairName String FinanceJoshuaV23

密钥对名称。

PrivateKeyBody String xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

密钥对的私钥。PEM PKCS#8格式的私钥部分。更多详情,请参阅OpenSSL PKCS#8。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求 ID。无论调用接口成功与否,我们都会返回请求 ID。

示例

请求示例


https://ecs.aliyuncs.com/?Action=CreateKeyPair
&RegionId=cn-qingdao
&KeyPairName=test
&<公共请求参数>

正常返回示例

XML 格式

<CreateKeyPairResponse>
  <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
  <KeyPairName>test</KeyPairName>
  <KeyPairFingerPrint>89:f0:ba:62:ac:b8:aa:e1:61:5e:fd:81:69:86:6d:6b:f0:c0:5a:d7</KeyPairFingerPrint>
  <PrivateKeyBody>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</PrivateKeyBody>
</CreateKeyPairResponse>

JSON 格式

{
	"RequestId":"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
	"PrivateKeyBody":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	"KeyPairFingerPrint":"89:f0:ba:62:ac:b8:aa:e1:61:5e:fd:81:69:86:6d:6b:f0:c0:5a:d7",
	"KeyPairName":"test"
}

错误码

HttpCode 错误码 错误信息 描述
403 QuotaExceed.KeyPair The key pair quota exceeds. 密钥对数量已达上限,
400 KeyPair.AlreadyExist The key pair already exist. 密钥对已存在,请不要重复添加。

查看本产品错误码

发布者:佚, 佚名,转转请注明出处:https://www.cms2.cn/aliyun/1897.html

发表评论

邮箱地址不会被公开。 必填项已用*标注