【旧版】实例停机 PowerOffPod--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】实例停机 PowerOffPod

最近更新时间：2024.06.17 19:36:16首次发布时间：2023.06.14 12:45:14

对指定实例执行停机操作，释放 CPU 算力。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	string	是	公共参数，OpenAPI 接口名称	PowerOffPod
Version	Query	string	是	公共参数，OpenAPI 接口版本	2022-08-01

Body 参数

字段	类型	必填	说明
product_id	string	是	实例所归属的业务 ID
pod_id	string	否	实例 ID，指定该参数时，仅对单个实例执行停机操作与 pod_id_list 二选一
pod_id_list	[]string	否	实例 ID 列表，指定该参数时，对多个实例批量执行停机操作（支持批量操作的实例数上限为100）与 pod_id 二选一

字段

类型

必填

说明

product_id

string

是

实例所归属的业务 ID

pod_id

string

否

实例 ID，指定该参数时，仅对单个实例执行停机操作

与 pod_id_list 二选一

pod_id_list

[]string

否

实例 ID 列表，指定该参数时，对多个实例批量执行停机操作（支持批量操作的实例数上限为100）

与 pod_id 二选一

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

示例

请求示例

POST https://open.volcengineapi.com?Action=PowerOffPod
&Version=2022-08-01
&<通过header传入的公共请求参数>

{
    "product_id":"1591495366954xxxxxx",
    "pod_id":"7294107154305xxxxxx"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "PowerOffPod",
        "Region": "cn-north-1",
        "RequestId": "20231026153046199F499A78BA6AFB8CDA",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": "success"
}

错误码

错误码	说明	操作建议
8030010	所属业务欠费关停	检查指定的业务 ID 已通过审核
8060003	正在操作实例, 上次操作完成前禁止再次操作	等待操作完成后重试
8060004	禁止操作实例	检查实例状态后重试
8060005	操作的实例数量超过批量操作上限	参考说明文档，检查可批量执行的实例数量上限，建议减少并发请求