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