导入密钥对
最近更新时间: 2024-09-03 18:49:49
1. 接口描述
接口请求域名： cvm.api3.cloud.sunhongs.com。
本接口 (ImportKeyPair) 用于导入密钥对。
- 本接口的功能是将密钥对导入到用户账户，并不会自动绑定到实例。如需绑定可以使用AssociateInstancesKeyPairs接口。
- 需指定密钥对名称以及该密钥对的公钥文本。
- 如果用户只有私钥，可以通过
SSL工具将私钥转换成公钥后再导入。
默认接口请求频率限制：10次/秒。
接口更新时间：2023-07-19 10:40:59。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：ImportKeyPair |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| KeyName | 是 | 否 | String | 密钥对名称，可由数字，字母和下划线组成，长度不超过25个字符。 |
| ProjectId | 是 | 否 | Int64 | 密钥对创建后所属的项目ID。<br><br>可以通过以下方式获取项目ID：<br><li>通过项目列表查询项目ID。<br><li>通过调用接口 DescribeProjects，取返回信息中的 projectId 获取项目ID。 |
| PublicKey | 是 | 否 | String | 密钥对的公钥内容，OpenSSH RSA 格式。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| KeyId | String | 此参数对外不可见。 密钥对ID。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalServerError | |
| InvalidKeyPairNameTooLong | |
| InvalidKeyPairNameEmpty | |
| InvalidKeyPairName.Duplicate | |
| InvalidKeyPair.LimitExceeded | |
| MissingParameter | |
| InvalidKeyPairNameIncludeIllegalChar | |
| InvalidParameterValue | |
| InvalidPublicKey.Duplicate | |
| InvalidPublicKey.Malformed |