tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DisassociateInstancesKeyPairs

Last updated: 2023-12-04 16:31:54

    1. API Description

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

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

    • Only instances on LINUX_UNIX in [RUNNING, STOPPED] status are supported. Instances in RUNNING status will be forcibly shut down before unbinding.
    • After a key pair is unassociated from an instance, you can log in to the instance with password.
    • If no password was set, you cannot log in to the instance with SSH after unbinding. You can call the ResetInstancesPassword API to set a login password.
    • Batch operations are supported. The maximum number of instances in each request is 100.
    • 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 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: 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 Unbinding key pair

    Input Example

    https://lighthouse.tencentcloudapi.com/?Action=DisassociateInstancesKeyPairs
&InstanceIds.0=lhins-ruy9d2tw
&KeyIds.0=lhkp-f7rjie1q
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "c81db282-c4e7-400e-aba4-6069a1537e77"
    }
}

    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

    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.InstanceOperationFailed Failed to manipulate the instance.
    InternalError.DescribeInstanceStatus Failed to query the instance status. Please try again later.
    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.NoPermission No permission
    UnsupportedOperation.InvalidInstanceState Unsupported operation: the instance status is invalid.
    UnsupportedOperation.KeyPairNotBoundToInstance Unsupported operation: key pairs that are not bound to instances cannot be unbound from instances.
    UnsupportedOperation.LatestOperationUnfinished Unsupported operation: the last operation of the instance has not been completed.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy