隔离实例

最近更新时间:2024-05-09 01:18:35

我的收藏

1. 接口描述

接口请求域名: lighthouse.tencentcloudapi.com 。

本接口(IsolateInstances)用于退还一个或多个轻量应用服务器实例。

  • 只有状态为 RUNNING 或 STOPPED 的实例才可以进行此操作。
  • 接口调用成功后,实例会进入SHUTDOWN 状态。
  • 支持批量操作。每次请求批量资源(包括实例与数据盘)的上限为 20。
  • 本接口为异步接口,请求发送成功后会返回一个 RequestId,此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:IsolateInstances。
Version String 公共参数,本接口取值:2020-03-24。
Region String 公共参数,详见产品支持的 地域列表
InstanceIds.N Array of String 实例ID列表。一个或多个待操作的实例ID。可通过DescribeInstances接口返回值中的InstanceId获取。每次请求退还实例和数据盘数量总计上限为20。
示例值:["lhins-7ofik5q9"]
IsolateDataDisk Boolean 是否退还挂载的数据盘。取值范围:
TRUE:表示退还实例同时退还其挂载的数据盘。
FALSE:表示退还实例同时不再退还其挂载的数据盘。
默认取值:TRUE。
示例值:true

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 退还实例

退还实例

输入示例

POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: IsolateInstances
<公共请求参数>

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.DescribeResourcesReturnableError 查询资源返回了不符合要求内容。
FailedOperation.IsolateResourcesFailed 退还资源失败。
InternalError.DescribeResourcesReturnableError 查询资源返回了不符合要求内容。
InvalidParameterValue.Duplicated 参数值非法,不允许包含重复的值。
InvalidParameterValue.InstanceIdMalformed 参数值非法,实例 ID 格式非法。
InvalidParameterValue.LimitExceeded 参数值非法,参数值的数量超过最大限制。
LimitExceeded.IsolateResourcesLimitExceeded 退还资源数量超出限制。
OperationDenied.InstanceCreating 禁止对实例进行操作,实例在创建中,不允许进行该操作。
OperationDenied.InstanceOperationInProgress 禁止对实例进行操作,实例最近一次的操作尚在进行中。
ResourceNotFound.InstanceIdNotFound 实例 ID 不存在。
ResourceNotFound.InstanceNotFound 实例不存在。
UnsupportedOperation.InvalidInstanceState 不支持的操作,实例状态不合法。
UnsupportedOperation.LatestOperationUnfinished 不支持的操作,实例最近一次的操作尚未完成。
UnsupportedOperation.ResourceNotReturnable 资源不支持退换。