使用ImportKeyPair导入密钥对公钥-云服务器 ECS-阿里云-云服务器 ECS(ECS)-阿里云帮助中心

接口说明

调用该接口时，您需要注意：

您在每个地域的密钥对数最高为 500 对。
导入的密钥对必须支持下列任一种加密方式：
- rsa
- dsa
- ssh-rsa
- ssh-dss
- ecdsa

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecs:ImportKeyPair

create

*KeyPair

acs:ecs:{#regionId}:{#accountId}:keypair/*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
KeyPairName	string	是	密钥对名称。必须保持名称唯一性。长度为 2~128 个字符，必须以大小写字母或中文开头，不能以 http://和 https:// 开头。支持 Unicode 中 letter 分类下的字符（其中包括英文、中文和数字等）。可以包含半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。	testKeyPairName
PublicKeyBody	string	是	密钥对的公钥内容。	ABC1234567
ResourceGroupId	string	否	SSH 密钥对所在的企业资源组 ID。	rg-bp67acfmxazb4p****
Tag	array<object>	否	标签列表。
	object	否	标签列表。
Key	string	否	密钥对的标签键。N 的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。	TestKey
Value	string	否	密钥对的标签值。N 的取值范围：1~20。一旦传入该值，允许为空字符串。最多支持 128 个字符，不能包含 http://或者 https://。	TestValue

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
KeyPairName	string	密钥对名称。	testKeyPairName
KeyPairFingerPrint	string	密钥对的指纹。根据 RFC 4716 定义的公钥指纹格式，采用 MD5 信息摘要算法。	89:f0:ba:62:ac:b8:aa:e1:61:5e:fd:81:69:86:6d:6b:f0:c0:5a:**

示例

正常返回示例

JSON格式

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

异常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidKeyPairName.Malformed	Specified Key Pair name is not valid.	密钥对名称不合法。
400	InvalidPublicKeyBody.Malformed	The PublicKeyBody format is not supported.	公钥格式不支持。
400	MissingParameter	The input parameter "PublicKeyBody" that is mandatory for processing this request is not supplied.
400	KeyPair.AlreadyExist	The key pair already exist.	密钥对已存在，请不要重复添加。
500	InternalError	The request processing has failed due to some unknown error.
403	QuotaExceed.KeyPair	The key pair quota exceeds.
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.	资源组并不在记录中。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。