tencent cloud



Last updated: 2023-08-18 14:28:06

1. API Description

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

This API is used to unbind a key pair from an instance.

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: DisassociateInstancesKeyPairs.
Version Yes String Common Params. The value used for this API: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
InstanceIds.N Yes Array of String You can get available instance IDs in the following ways:
Log in to the console to query instance IDs.
Get the instance IDs from the InstanceId field in the information returned by the DescribeInstances API.
KeyIds.N Yes Array of String List of key pair IDs. Each request can contain up to 100 key pairs. The key pair ID takes the form of skey-11112222.

You can get available key IDs in the following ways:
Log in to the console to query key IDs.
Get the key pair IDs from the KeyId field in the information returned by the DescribeKeyPairs API.
ForceStop No Boolean Whether to force shut down the running instance. We recommend you manually shut down the running instance before unbinding the key. Valid values:
TRUE: yes.
FALSE: no.

Default value: FALSE.

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 Unbinding key pair

Input Example

Host: ecm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DisassociateInstancesKeyPairs
<Common request parameters>

    "InstanceIds": [
    "KeyIds": [

Output Example

    "Response": {
        "RequestId": "d40cdb72-7bc0-4b48-b3aa-25e8401f6999"

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
InvalidParameterValue The parameter value is incorrect.
InvalidParameterValue.InstanceIdNotSupported The instance does not support the current operation.
InvalidParameterValue.InvalidKeyPairId Invalid key ID.
InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
MissingParameter The parameter is missing.
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