tencent cloud



Last updated: 2023-12-04 16:32:03

    1. API Description

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

    This API is used to return one or more Lighthouse cloud disks.

    You can only perform this operation on UNATTACHED disks.
    After the successful call of the API, the cloud disk goes to the SHUTDOWN state.
    Up to 20 instances are supported at one time.
    This API is async. After the request is sent, a RequestId is returned. At this time, the operation is not completed yet. To check the result, you need to call DescribeDisks. If the latest operation status (LatestOperationState) of the disk 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: IsolateDisks.
    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.
    DiskIds.N Yes Array of String IDs of cloud disks. The value can be obtained from the InstanceId parameter returned by the DescribeDisks API. Up to 20 disks can be processed at a time.

    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 Returns cloud disks

    Returns cloud disks

    Input Example

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

    Output Example

        "Response": {
            "RequestId": "e43cdee7-5dc8-4d3c-9c46-56718971b193"

    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
    FailedOperation.DescribeResourcesReturnableError The query returns contents that do not meet the requirement.
    FailedOperation.IsolateResourcesFailed Failed to return the resource.
    InvalidParameterValue.InvalidDiskIdMalformed Invalid parameter value: the disk ID format is invalid.
    LimitExceeded.IsolateResourcesLimitExceeded Reached the upper limit of resources can be returned
    OperationDenied.DiskCreating The disk is being created.
    ResourceNotFound.DiskIdNotFound The disk ID does not exist.
    UnsupportedOperation.DiskLatestOperationUnfinished Unsupported operation: the last operation of the disk has not been completed.
    UnsupportedOperation.InvalidDiskState The disk's status does not support this operation.
    UnsupportedOperation.ResourceNotReturnable The resource cannot be returned.
    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