1. 接口描述
接口请求域名: lighthouse.tencentcloudapi.com 。
本接口(StopInstances)用于关闭一个或多个实例。
- 只有状态为 RUNNING 的实例才可以进行此操作。
- 接口调用成功时,实例会进入 STOPPING 状态;关闭实例成功时,实例会进入 STOPPED 状态。
- 支持批量操作。每次请求批量实例的上限为 100。
- 本接口为异步接口,请求发送成功后会返回一个 RequestId,此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:StopInstances。 |
Version | 是 | String | 公共参数,本接口取值:2020-03-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceIds.N | 是 | Array of String | 实例 ID 列表。每次请求批量实例的上限为 100。可通过DescribeInstances接口返回值中的InstanceId获取。 示例值:["lhins-ruy9d2tw","lhins-rusdke45"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 关闭实例
本示例用于关闭两个实例。
输入示例
https://lighthouse.tencentcloudapi.com/?Action=StopInstances
&InstanceIds.0=lhins-ruy9d2tw
&InstanceIds.1=lhins-rusdke45
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "5fd6992a-f8b1-4cd2-9574-cb4251bc524f"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.DescribeInstanceStatus | 查询实例状态错误。 |
FailedOperation.InstanceOperationFailed | 对实例的操作失败。 |
InternalError.DescribeInstanceStatus | 查询实例状态失败,请稍后重试。 |
InvalidParameterValue.Duplicated | 参数值非法,不允许包含重复的值。 |
InvalidParameterValue.InstanceIdMalformed | 参数值非法,实例 ID 格式非法。 |
InvalidParameterValue.LimitExceeded | 参数值非法,参数值的数量超过最大限制。 |
InvalidParameterValue.OutOfRange | 参数值非法,不在合法范围内。 |
OperationDenied.InstanceCreating | 禁止对实例进行操作,实例在创建中,不允许进行该操作。 |
OperationDenied.InstanceOperationInProgress | 禁止对实例进行操作,实例最近一次的操作尚在进行中。 |
ResourceNotFound.InstanceIdNotFound | 实例 ID 不存在。 |
ResourceNotFound.InstanceNotFound | 实例不存在。 |
UnauthorizedOperation.NoPermission | 无权限。 |
UnsupportedOperation.InvalidInstanceState | 不支持的操作,实例状态不合法。 |
UnsupportedOperation.LatestOperationUnfinished | 不支持的操作,实例最近一次的操作尚未完成。 |