Domain name for API request: ssm.intl.tencentcloudapi.com.
This API is used to obtain the plaintext value of the SSH key secret.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: GetSSHKeyPairValue. |
| Version | Yes | String | Common Params. The value used for this API: 2019-09-23. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| SecretName | No | String | Secret name. This field is only valid for SSH key secrets. |
| SSHKeyId | No | String | ID of the key pair, which is the unique identifier of the key pair in the CVM. |
| Parameter Name | Type | Description |
|---|---|---|
| SSHKeyID | String | ID of the SSH key. |
| PublicKey | String | Plaintext value of the Base64-encoded public key. |
| PrivateKey | String | Plaintext value of the Base64-encoded private key. |
| ProjectID | Integer | ID of the project to which the SSH key belongs. |
| SSHKeyDescription | String | Description of the SSH key. The description can be modified in the CVM console. |
| SSHKeyName | String | Name of the SSH key. The name can be modified in the CVM console. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to obtain the plaintext value of the SSH key secret.
POST / HTTP/1.1
Host: ssm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetSSHKeyPairValue
<Common request parameters>
{
"SecretName": "xx"
}{
"Response": {
"SSHKeyID": "xx",
"ProjectID": 0,
"PrivateKey": "xx",
"PublicKey": "xx",
"RequestId": "xx",
"SSHKeyName": "xx",
"SSHKeyDescription": "xx"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.AccessKmsError | KMS operation failed. |
| InternalError | An internal error occurred. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | The parameter value is invalid. |
| InvalidParameterValue.TagKeysDuplicated | The tag keys are duplicated. |
| InvalidParameterValue.TagsNotExisted | The tag key or tag value does not exist. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| RequestLimitExceeded | The number of requests exceeds the frequency limit. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | The resource is unavailable. |
| UnauthorizedOperation | The operation is unauthorized. |
| UnauthorizedOperation.AccessKmsError | Failed to access KMS. |
| UnknownParameter | Unknown parameter. |
| UnsupportedOperation | Unsupported operation. |
フィードバック