Release Notes and Announcements

Image Release Notes

Announcements

Product Introduction

Overview

Basic Concepts

Strengths

Scenarios

Use Limits

Region and Network Connectivity

Product Comparison

User Guide

Billing

Billing Overview

Instance Package

Pricing Details

Purchase Methods

Configuration Adjustment (for Upgrade Only)

Overdue Payments

Refund

Getting Started

One-Click Application Creation Using Lighthouse

Quick Instance Creation

User Guide

Instances

Cloud Disks

Images

Firewall

Private Network Interconnection

Data Backup and Restoration Using Snapshots

Cloud Access Management

OPS and Monitoring

File Transfer

Use Cases

Website Building

Development Environment Building

Cloud Storage System Building

E-commerce Platform Building

Personal Live Streaming Room Building

FTP Service Building

SSL Certificate Installation

Troubleshooting

Windows Instance: RDP Connection to the Remote Computer Fails

Windows Instance: Offline Password Resetting Fails or Invalid

Linux/Windows Instance: Online Password Resetting Fails or Invalid

API Documentation

History

Introduction

API Category

Making API Requests

Image APIs

Firewall APIs

Key APIs

Instance APIs

Snapshot APIs

CCN APIs

Other APIs

Cloud Disk APIs

Scene APIs

Package APIs

Quota APIs

Region APIs

Data Types

Error Codes

FAQs

Agreements

Data Processing And Security Agreement

IsolateInstances

PDF

Mode fokus

Ukuran font

Terakhir diperbarui: 2025-10-30 21:47:22

1. API Description

Domain name for API request: lighthouse.intl.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 an instance

This example shows you how to return an instance.

Input Example

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

{
    "InstanceIds": [
        "lhins-lfdnmikp"
    ]
}

Output Example

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

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
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.

Bantuan dan Dukungan

Apakah halaman ini membantu?

Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.

masukan

tencent cloud

Tencent Cloud Lighthouse