Release Notes and Announcements

Image Release Notes

Announcements

Product Introduction

Overview

Basic Concepts

Strengths

Scenarios

Use Limits

Region and Network Connectivity

Product Comparison

User Guide

Billing

Billing Overview

Instance Package

Pricing Details

Purchase Methods

Configuration Adjustment (for Upgrade Only)

Overdue Payments

Refund

Getting Started

One-Click Application Creation Using Lighthouse

Quick Instance Creation

User Guide

Instances

Cloud Disks

Images

Firewall

Private Network Interconnection

Data Backup and Restoration Using Snapshots

Cloud Access Management

OPS and Monitoring

File Transfer

Use Cases

Website Building

Development Environment Building

Cloud Storage System Building

E-commerce Platform Building

Personal Live Streaming Room Building

FTP Service Building

SSL Certificate Installation

Troubleshooting

Windows Instance: RDP Connection to the Remote Computer Fails

Windows Instance: Offline Password Resetting Fails or Invalid

Linux/Windows Instance: Online Password Resetting Fails or Invalid

API Documentation

History

Introduction

API Category

Making API Requests

Image APIs

Firewall APIs

Key APIs

Instance APIs

Snapshot APIs

CCN APIs

Other APIs

Cloud Disk APIs

Scene APIs

Package APIs

Quota APIs

Region APIs

Data Types

Error Codes

FAQs

Agreements

Data Processing And Security Agreement

AssociateInstancesKeyPairs

PDF

Mode fokus

Ukuran font

Terakhir diperbarui: 2025-10-30 21:47:18

1. API Description

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

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: AssociateInstancesKeyPairs.
Version	Yes	String	Common Params. The value used for this API: 2020-03-24.
Region	No	String	Common Params. This parameter is not required for this API.
KeyIds.N	Yes	Array of String	Key pair ID list. Each request can contain up to 100 key pairs.
InstanceIds.N	Yes	Array of String	Instance ID list. Each request can contain up to 100 instances at a time. You can get an instance ID from the `InstanceId` returned by the DescribeInstances API.

3. Output Parameters

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

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.intl.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.

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.

Error Code	Description
FailedOperation.DescribeInstanceStatus	An error occurred when querying the instance status.
FailedOperation.InstanceOperationFailed	Failed to manipulate the instance.
InternalError.DescribeInstanceStatus	Failed to query the instance status. Please try again later.
InternalError.InvalidCommandNotFound	The command is not found.
InvalidParameterValue.Duplicated	Invalid parameter value: duplicate values are not allowed.
InvalidParameterValue.InstanceIdMalformed	Invalid parameter value: the instance ID format is invalid.
InvalidParameterValue.KeyPairIdMalformed	Invalid parametric value: the key pair ID format is invalid.
InvalidParameterValue.LimitExceeded	Invalid parametric value: the number of parameter values exceeds the upper limit.
InvalidParameterValue.OutOfRange	Invalid parametric value: it is not within the valid range.
OperationDenied.InstanceCreating	It is not allowed to manipulate this instance, as it is being created.
OperationDenied.InstanceOperationInProgress	It is not allowed to manipulate this instance, as the last operation is still in progress.
ResourceNotFound.InstanceIdNotFound	The instance ID does not exist.
ResourceNotFound.InstanceNotFound	The instance does not exist.
ResourceNotFound.KeyIdNotFound	The key pair ID does not exist.
UnauthorizedOperation.MFAExpired	MFA has expired.
UnauthorizedOperation.MFANotFound	MFA does not exist.
UnauthorizedOperation.NoPermission	No permission.
UnsupportedOperation.InvalidInstanceState	Unsupported operation: the instance status is invalid.
UnsupportedOperation.KeyPairBindDuplicate	Unsupported operation: one key pair cannot be bound to the same instance repeatedly.
UnsupportedOperation.LatestOperationUnfinished	Unsupported operation: the last operation of the instance has not been completed.
UnsupportedOperation.WindowsNotAllowToAssociateKeyPair	Windows instances do not support binding key pairs.
UnsupportedOperation.WindowsNotSupportKeyPair	SSH key pair is not available for Windows instances

Bantuan dan Dukungan

Apakah halaman ini membantu?

Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.

masukan

tencent cloud

Tencent Cloud Lighthouse