tencent cloud



Last updated: 2022-09-26 17:00:17

1. API Description

Domain name for API request: lighthouse.tencentcloudapi.com.

This API is used to create a key pair.

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 Params. The value used for this API: CreateKeyPair.
Version Yes String Common Params. The value used for this API: 2020-03-24.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
KeyName Yes String Key pair name, which can contain up to 25 digits, letters, and underscores.

3. Output Parameters

Parameter Name Type Description
KeyPair KeyPair Key pair information.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating key pair

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "KeyPair": {
            "KeyId": "lhkp-hfenegt1",
            "KeyName": "test_create_1",
            "PublicKey": "xxxxxx",
            "AssociatedInstanceIds": [],
            "CreatedTime": null,
            "PrivateKey": "xxxxxx"
        "RequestId": "02dc35eb-06f0-477f-9b06-c980bc56c18d"

5. Developer Resources


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.CreateKeyPairFailed Failed to create the key pair.
InvalidParameterValue.DuplicateParameterValue The parameter KeyName already exists and is duplicate.
InvalidParameterValue.InvalidKeyPairNameEmpty Invalid parametric value.
InvalidParameterValue.InvalidKeyPairNameIncludeIllegalChar The key pair name is invalid.
InvalidParameterValue.InvalidKeyPairNameTooLong The parameter length is invalid.
LimitExceeded.KeyPairLimitExceeded The key pair quota is exceeded.
UnauthorizedOperation.NoPermission No permission
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support