DisassociateInstancesKeyPairs

最后更新时间：2021-10-27 15:54:29

1. API Description

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

This API is used to unbind one or more key pairs from one or more instances.

It only supports STOPPED Linux instances.
After a key pair is disassociated from an instance, you can log in to the instance with password.
If you did not set a password for the instance, you will not be able to log in via SSH after the unbinding. In this case, you can call ResetInstancesPassword to set a login password.
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.

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 parameter. The value used for this API: DisassociateInstancesKeyPairs.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
InstanceIds.N	Yes	Array of String	Instance ID(s). The maximum number of instances in each request is 100. You can obtain the available instance IDs in two ways: Log in to the console to query the instance IDs. Call DescribeInstances and look for `InstanceId` in the response.
KeyIds.N	Yes	Array of String	List of key pair IDs. The maximum number of key pairs in each request is 100. The key pair ID is in the format of `skey-11112222`. You can obtain the available key pair IDs in two ways: Log in to the console to query the key pair IDs. Call DescribeKeyPairs and look for `KeyId` in the response.
ForceStop	No	Boolean	Whether to force shut down a running instances. It is recommended to manually shut down a running instance before disassociating a key pair from it. Valid values: TRUE: force shut down an instance after a normal shutdown fails. FALSE: do not force shut down an instance after a normal shutdown fails. 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 Disassociating a key pair from an instance

Input Example

GET https://cvm.tencentcloudapi.com/?Action=DisassociateInstancesKeyPairs
&InstanceIds.0=ins-w34e5rl9
&KeyIds.0=skey-e3r6y7ji
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
  }
}

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
InternalServerError	Internal error.
InvalidInstance.NotSupported	This instance is not supported.
InvalidInstanceId.Malformed	Invalid instance `ID`. The specified instance `ID` has an invalid format. For example, `ins-1122` has an invalid `ID` length.
InvalidInstanceId.NotFound	No instance found.
InvalidKeyPairId.Malformed	Invalid key pair ID. The specified key pair ID has an invalid format. For example, `skey-1122` has an invalid `ID` length.
InvalidKeyPairId.NotFound	Invalid key pair ID. The specified key pair ID does not exist.
InvalidParameterValue	Incorrect parameter value.
InvalidParameterValue.LimitExceeded	The number of parameter values exceeds the limit.
MissingParameter	Missing parameter.
MutexOperation.TaskRunning	An identical job is running.
OperationDenied.InstanceOperationInProgress	The instance has an operation in progress. Please try again later.
UnsupportedOperation.InstanceOsWindows	The instance `ins-xxxxxx` with the `Xserver windows2012cndatacenterx86_64` operating system does not support this operation.
UnsupportedOperation.InstanceStateRunning	Running instances do not support this operation.
UnsupportedOperation.InstanceStateShutdown	Isolated instances do not support this operation.
UnsupportedOperation.InstanceStateStopping	The instance is being shut down, and this operation is not supported.
UnsupportedOperation.InstanceStateTerminating	The instance is being terminated, and the operation is not supported.
UnsupportedOperation.StoppedModeStopCharging	The instance does not support the no charges when shut down feature.

Recent Pages