1. 接口描述
接口请求域名: ecm.tencentcloudapi.com 。
用于创建一个 OpenSSH RSA 密钥对,可以用于登录 Linux 实例。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateKeyPair。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-19。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
KeyName | 是 | String | 密钥对名称,可由数字,字母和下划线组成,长度不超过25个字符。 示例值:xxx |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
KeyPair | KeyPair | 密钥对信息。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建密钥对
创建密钥对
输入示例
POST / HTTP/1.1
Host: ecm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateKeyPair
<公共请求参数>
{
"KeyName": "tencent"
}
输出示例
{
"Response": {
"KeyPair": {
"KeyId": "skey-mv9yzyjj",
"Description": "",
"CreatedTime": "2020-09-22T00:00:00+00:00",
"KeyName": "Tencent",
"AssociatedInstanceIds": [],
"PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIICXgIBAAKBgQDP0Yw2T4itUKOJQIK69c1Asy1UO88cxEbujR5Jbr0e/Ey1v4ZK\nAUzDnsBnFlf4h***********************************niikSnZuZPNSw8T+kg\n/oxijESOLAJBnt3S/g+D530Enjitvfc9mEB7mh0VmwWvPg==\n-----END RSA PRIVATE KEY-----\n",
"ProjectId": 0,
"PublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDP0Yw2T4itUKOJQIK69c1*******************************************+J/XUA7KHH1Y6wcn1RTRTMdDHbGhW1q/UpfeylNTbf+wEIWhEfaL5FKQm4hqCw== skey_112168"
},
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidKeyPairName | 密钥名称异常。 |
InvalidParameterValue.LimitExceeded | 参数值超出限制。 |
MissingParameter | 缺少参数错误。 |