接口功能介绍
该接口提供用户关闭一台轻量型云主机功能。
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
异步接口：该接口为异步接口，请求过后会拿到任务ID（jobID），后续可以调用查询一个异步任务的结果来查询操作是否成功
接口约束
1. 使用限制，本接口只支持在部分资源池进行公测
2. 确保当前请求资源池下，该云主机存在（即instanceID真实存在且与regionID相对应）
3. 云主机需要处于开机状态（running），您可以调用查询轻量型云主机详情查询结果中的instanceStatus字段来确认当前云主机状态
URI
POST /v4/ecs/lite/stop
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
aaf589124d5d11eaa04d0242ac110002 | |
| instanceID | 是 | String | 轻量型云主机ID，您可以查看轻量型云主机了解轻量型云主机的相关信息 获取： 查 查询轻量型云主机列表 创 创建轻量型云主机 |
adc614e0-e838-d73f-0618-a6d51d09070a |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| jobID | String | 关机任务ID | os-ffe1fe3c-36be-469d-a5ea-593662bb40b4 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "aaf589124d5d11eaa04d0242ac110002",
"instanceID": "adc614e0-e838-d73f-0618-a6d51d09070a"
}
响应示例
{
"returnObj": {
"jobID": "os-ffe1fe3c-36be-469d-a5ea-593662bb40b4"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
