Domain name for API request: lighthouse.tencentcloudapi.com.
This API is used to return one or more Lighthouse instances.
RUNNING
and STOPPED
instances can be returned. SHUTDOWN
after the API is called successfully. 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.
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 . |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to return an instance.
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: IsolateInstances
<Common request parameters>
{
"InstanceIds": [
"lhins-lfdnmikp"
]
}
{
"Response": {
"RequestId": "35eee594-4644-401a-815a-1c9075b5f39c"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Operation failed. |
FailedOperation.DescribeResourcesReturnableError | The query returns contents that do not meet the requirement. |
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. |
Was this page helpful?