GetSSHKeyPairValue

Last updated: 2021-10-08 15:34:41

1. API Description

Domain name for API request: ssm.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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 parameter. The value used for this API: GetSSHKeyPairValue.
Version Yes String Common parameter. The value used for this API: 2019-09-23.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
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.

3. Output Parameters

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.

4. Example

Example1 Obtaining the plaintext value of the SSH key secret

This example shows you how to obtain the plaintext value of the SSH key secret.

Input Example

POST / HTTP/1.1
Host: ssm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetSSHKeyPairValue
<Common request parameters>

{
    "SecretName": "xx"
}

Output Example

{
  "Response": {
    "SSHKeyID": "xx",
    "ProjectID": 0,
    "PrivateKey": "xx",
    "PublicKey": "xx",
    "RequestId": "xx",
    "SSHKeyName": "xx",
    "SSHKeyDescription": "xx"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.