接口请求域名： ssm.intl.tencentcloudapi.com 。
创建用于托管SSH密钥对的凭据
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateSSHKeyPairSecret。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-23。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SecretName | 是 | String | 凭据名称，同一region内不可重复，最长128字节，使用字母、数字或者 - _ 的组合，第一个字符必须为字母或者数字。 |
| ProjectId | 是 | Integer | 密钥对创建后所属的项目ID。 |
| Description | 否 | String | 描述信息，用于详细描述用途等，最大支持2048字节。 |
| KmsKeyId | 否 | String | 指定对凭据进行加密的KMS CMK。 如果为空则表示使用Secrets Manager为您默认创建的CMK进行加密。 您也可以指定在同region 下自行创建的KMS CMK进行加密。 |
| Tags.N | 否 | Array of Tag | 标签列表。 |
| SSHKeyName | 否 | String | 用户自定义输入的SSH密钥对的名称，可由数字，字母和下划线组成，只能以数字和字母开头，长度不超过25个字符。 |
| KmsHsmClusterId | 否 | String | KMS的独享集群的ID。当KmsKeyId为空,并且用户的KMS存在有效的HsmClusterId时有效。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SecretName | String | 创建的凭据名称。 |
| SSHKeyID | String | 创建的SSH密钥ID。 |
| SSHKeyName | String | 创建的SSH密钥名称。 |
| TagCode | Integer | 标签操作的返回码. 0: 成功；1: 内部错误；2: 业务处理错误 |
| TagMsg | String | 标签操作的返回信息。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
创建SSH密钥对凭据
POST / HTTP/1.1
Host: ssm.intl.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"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| 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 | 操作不支持。 |
文档反馈