接口请求域名： ssm.intl.tencentcloudapi.com 。
获取SSH密钥对凭据明文信息。
默认接口请求频率限制：100次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetSSHKeyPairValue。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-23。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SecretName | 否 | String | 凭据名称，此凭据只能为SSH密钥对凭据类型。 |
| SSHKeyId | 否 | String | 密钥对ID，是云服务器中密钥对的唯一标识。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SSHKeyID | String | SSH密钥对ID。 |
| PublicKey | String | 公钥明文，使用base64编码。 |
| PrivateKey | String | 私钥明文，使用base64编码 |
| ProjectID | Integer | 此密钥对所属的项目ID。 |
| SSHKeyDescription | String | SSH密钥对的描述信息。 用户可以在CVM侧控制台对密钥对的描述信息进行修改。 |
| SSHKeyName | String | SSH密钥对的名称。 用户可以在CVM侧控制台对密钥对的名称进行修改。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
获取SSH密钥对凭据明文
POST / HTTP/1.1
Host: ssm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetSSHKeyPairValue
<公共请求参数>
{
"SecretName": "test2-sshkey-secret"
}
{
"Response": {
"PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKC***********NEuTGXFT8sLJ\n-----END RSA PRIVATE KEY-----",
"ProjectID": 0,
"PublicKey": "ssh-rsa AAAA********H5TD4ab skey-e0vbh2ts",
"RequestId": "9f436a38-ced1-45f0-9b51-946958b90244",
"SSHKeyDescription": "created by ssm",
"SSHKeyID": "skey-e0vbh2ts",
"SSHKeyName": "test2_key"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.AccessKmsError | KMS操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.TagKeysDuplicated | 标签键重复。 |
| InvalidParameterValue.TagsNotExisted | 标签键或标签值不存在。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.AccessKmsError | 访问KMS失败。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
文档反馈