创建密钥对
最近更新时间: 2024-09-03 18:49:49
1. 接口描述
接口请求域名： cvm.api3.cloud.sunhongs.com。
本接口 (CreateKeyPair) 用于创建一个 OpenSSH RSA 密钥对，可以用于登录 Linux 实例。
- 开发者只需指定密钥对名称，即可由系统自动创建密钥对，并返回所生成的密钥对的
ID及其公钥、私钥的内容。 - 密钥对名称不能和已经存在的密钥对的名称重复。
- 私钥的内容可以保存到文件中作为
SSH的一种认证方式。 - 腾讯云不会保存用户的私钥，请妥善保管。
默认接口请求频率限制：10次/秒。
接口更新时间：2023-07-19 10:40:59。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateKeyPair |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| KeyName | 是 | 否 | String | 此参数对外不可见。 密钥对名称，可由数字，字母和下划线组成，长度不超过25个字符。 |
| ProjectId | 是 | 否 | Int64 | 此参数对外不可见。 只能为0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| KeyPair | CreateKeyPair | 此参数对外不可见。 密钥对信息。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidProjectId.NotFound | |
| InternalServerError | |
| InvalidKeyPairNameEmpty | |
| InvalidParameterValue | |
| MissingParameter | |
| InvalidKeyPairName.Duplicate | |
| InvalidKeyPair.LimitExceeded | |
| InvalidKeyPairNameTooLong | |
| InvalidKeyPairNameIncludeIllegalChar |