tencent cloud

1. API Description

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

This API is used to bind a user-specified key pair to an instance.

• Only instances on LINUX_UNIX in [RUNNING, STOPPED] status are supported. Instances in RUNNING status will be forcibly shut down before binding.
• If the public key of a key pair is written to the SSH configuration of the instance, you will be able to log in to the instance with the private key of the key pair.
• If the instance is already associated with a key, the old key will become invalid.
• If you currently use a password to log in, you will no longer be able to do so after you associate the instance with a key.
• Batch operations are supported. The maximum number of instances in each request is 100. If instances not available for the operation are selected, you will get an error code.
• This API is async. After the request is sent successfully, a RequestId will be returned. At this time, the operation is not completed immediately. The result of the instance operation can be queried by calling the DescribeInstances API. If the latest operation status (LatestOperationState) of the instance is SUCCESS, the operation is successful.

A maximum of 10 requests can be initiated per second for this API.

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.

3. Output Parameters

4. Example

Example1 Binding key pair to instance

This example shows you how to bind a key pair to an instance.

Input Example

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

{
    "InstanceIds": [
        "lhins-ruy9d2tw"
    ],
    "KeyIds": [
        "lhkp-f7rjie1q"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "f192c1a9-580e-4653-9d54-ba42cd4353a3"
    }
}

5. Developer Resources

SDK

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

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.