1. 接口描述
接口请求域名: ssm.tencentcloudapi.com 。
创建用于托管SSH密钥对的凭据
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateSSHKeyPairSecret。 |
Version | 是 | String | 公共参数,本接口取值:2019-09-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SecretName | 是 | String | 凭据名称,同一region内不可重复,最长128字节,使用字母、数字或者 - _ 的组合,第一个字符必须为字母或者数字。 示例值:test2-sshkey-secret |
ProjectId | 是 | Integer | 密钥对创建后所属的项目ID。 示例值:0 |
Description | 否 | String | 描述信息,用于详细描述用途等,最大支持2048字节。 示例值:描述信息 |
KmsKeyId | 否 | String | 指定对凭据进行加密的KMS CMK。 如果为空则表示使用Secrets Manager为您默认创建的CMK进行加密。 您也可以指定在同region 下自行创建的KMS CMK进行加密。 示例值:6abd1fdb-86d4-11ef-b72d-52540089bc41 |
Tags.N | 否 | Array of Tag | 标签列表。 示例值:[{"TagKey":"env","TagValue":"dev"}] |
SSHKeyName | 否 | String | 用户自定义输入的SSH密钥对的名称,可由数字,字母和下划线组成,只能以数字和字母开头,长度不超过25个字符。 示例值:test2_key |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SecretName | String | 创建的凭据名称。 示例值:test2-sshkey-secret |
SSHKeyID | String | 创建的SSH密钥ID。 示例值:skey-e0vbh2ts |
SSHKeyName | String | 创建的SSH密钥名称。 示例值:test2_key |
TagCode | Integer | 标签操作的返回码. 0: 成功;1: 内部错误;2: 业务处理错误 示例值:0 |
TagMsg | String | 标签操作的返回信息。 示例值:ok |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建SSH密钥对凭据
创建SSH密钥对凭据
输入示例
POST / HTTP/1.1
Host: ssm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSSHKeyPairSecret
<公共请求参数>
{
"SecretName": "test2-sshkey-secret",
"ProjectId": 0,
"Description": "描述信息",
"KmsKeyId": "6abd1fdb-86d4-11ef-b72d-52540089bc41",
"Tags": [
{
"TagKey": "env",
"TagValue": "dev"
}
],
"SSHKeyName": "test2_key"
}
输出示例
{
"Response": {
"RequestId": "591e2b21-20e9-4621-8e4a-2697b89e985a",
"SSHKeyID": "skey-e0vbh2ts",
"SSHKeyName": "test2_key",
"SecretName": "test2-sshkey-secret",
"TagCode": 0,
"TagMsg": "ok"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.AccessKmsError | KMS操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.TagKeysDuplicated | 标签键重复。 |
InvalidParameterValue.TagsNotExisted | 标签键或标签值不存在。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse.SecretExists | 凭据名已存在。 |
ResourceUnavailable.NotPurchased | 服务未购买。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.AccessKmsError | 访问KMS失败。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |