高性能应用服务 HAI 关闭实例

1. 接口描述

接口请求域名： hai.tencentcloudapi.com 。

本接口 (StopInstance) 用于主动关闭实例。
‘已关机’、‘预付费’的实例不支持关机

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：StopInstance。
Version	是	String	公共参数，本接口取值：2023-08-12。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例ID。可通过DescribeInstances API获取实例ID。示例值：hai-2dfajzo4q
StopMode	否	String	hai实例关机的模式，目前仅支持关机不收费： STOP_CHARGE -- 关闭hai实例，释放计算资源，停止收取计算资源的费用。注意：默认值为STOP_CHARGE 示例值：STOP_CHARGE
DryRun	否	Boolean	默认为False，True代表只验证接口连通性示例值：False

3. 输出参数

参数名称	类型	描述
TaskId	Integer	task任务id 示例值：232558431
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 实例关机

实例关机不收费场景。

输入示例

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

{
    "InstanceId": "hai-dunyfddn",
    "StopMode": "STOP_CHARGE",
    "DryRun": false
}

输出示例

{
    "Response": {
        "TaskId": 123456,
        "RequestId": "057b40b9-c27f-4241-918b-debd34cfdafdasfdaf"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.OperateInstanceRepeatedly	并发操作实例失败
InternalError	内部错误。
InvalidParameterValue.Duplicated	列表入参中存在重复值
InvalidParameterValue.InstanceIdNotFound	指定的实例不存在
InvalidParameterValue.InvalidInstanceIdMalformed	实例ID格式非法
OperationDenied.InstanceOperationInProgress	指定实例有正在执行的操作，不能执行新的操作
UnsupportedOperation.InstanceStateArrears	不支持对处于`Arrears`状态的实例执行当前操作。
UnsupportedOperation.InstanceStateLaunchFailed	不支持对处于`LaunchFailed`状态的实例执行当前操作。
UnsupportedOperation.InstanceStatePending	不支持对处于`Pending`状态的实例执行当前操作。
UnsupportedOperation.InstanceStateStoppedNoCharge	不支持对处于`StoppedNoCharge`状态的实例执行当前操作。
UnsupportedOperation.InstanceStateTerminated	不支持对处于`Terminated`状态的实例执行当前操作。

关闭实例

本页目录：