tencent cloud



Last updated: 2023-05-22 15:38:51

1. API Description

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

This API is used to return one or more Lighthouse instances.

  • Only RUNNING and STOPPED instances can be returned.
  • The instance status goes to SHUTDOWN after the API is called successfully.
  • Batch operations are supported. Up to 20 resources (including instances and data disks) can be returned in each request.
  • 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: IsolateInstances.
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.
InstanceIds.N Yes Array of String IDs of target instances. You can get the IDs from the InstanceId parameter returned by the DescribeInstances API. Up to 20 instances can be specified at the same time.
IsolateDataDisk No Boolean Whether to return data disks mounted on the instance together with the instance. Valid values:
TRUE: Return the mounted data disks at the same time
FALSE: Do not return the mounted data disks at the same time
Default value: TRUE.

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 Returning Lighthouse instances

Input Example

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

    "InstanceIds": [

Output Example

    "Response": {
        "RequestId": "35eee594-4644-401a-815a-1c9075b5f39c"

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
AuthFailure Error with CAM signature/authentication.
FailedOperation.IsolateResourcesFailed Failed to return the resource.
InternalError.DescribeResourcesReturnableError Error querying the resource
InvalidParameterValue.Duplicated Invalid parameter value: duplicate values are not allowed.
InvalidParameterValue.InstanceIdMalformed Invalid parameter value: the instance ID format is invalid.
InvalidParameterValue.LimitExceeded Invalid parametric value: the number of parameter values exceeds the upper limit.
LimitExceeded.IsolateResourcesLimitExceeded Reached the upper limit of resources can be returned
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.
UnsupportedOperation.InvalidInstanceState Unsupported operation: the instance status is invalid.
UnsupportedOperation.LatestOperationUnfinished Unsupported operation: the last operation of the instance has not been completed.
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