实例关机 PowerOffPod--云手机-火山引擎

文档中心

立即注册

导航

云手机

实例关机 PowerOffPod

最近更新时间：2025.11.03 17:18:49首次发布时间：2024.01.04 19:55:42

对指定实例执行开机操作。单次接口调用支持单实例关机，或至多 200 个实例的批量关机。

注意事项

本接口的单用户 QPS 限制为 200 次/秒。超过限制，API 调用会被限流。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=PowerOffPod&Version=2023-10-30

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`PowerOffPod`	接口名称。当前 API 的名称为 `PowerOffPod`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1591495366954******`	实例归属的业务 ID。可登录云手机控制台，在已创建的业务卡片中获取。
PodId	String	否	`7294107154305******`	实例 ID，若仅需对单个实例执行关机操作，请使用本参数。说明批量操作实例关机，请使用 `PodIdList` 参数。
PodIdList	Array of String	否	`["7294157141458****", "7294107154305****"]`	实例 ID 列表，若需对多个实例批量执行关机操作，请使用本参数。支持批量操作的实例数上限为 200。说明对单个实例执行关机操作，请使用`PodId` 参数。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
AccountId	String	`21000******`	火山引擎账号 ID。
ProductId	String	`1591495366954******`	实例所归属的业务 ID。
Details	Array of PodActionResult	`-`	实例关机操作结果详情。

PodActionResult

参数	类型	示例值	描述
PodId	String	`7294157141458******`	实例 ID。
ErrMsg	String	`record not found`	关机操作失败时的错误信息提示。
ErrCode	Integer	`0`	错误码。
Success	Boolean	`true`	操作执行是否成功： true：成功； false：失败。

请求示例

POST https://open.volcengineapi.com?Action=PowerOffPod&Version=2023-10-30
{
    "ProductId": "1591495366954******",
    "PodIdList": [
        "7294157141458******",
        "7294107154305******"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "PowerOffPod",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "AccountId": "21000******",
        "ProductId": "1591495366954******",
        "Details": [
            {
                "PodId": "7294157141458******",
                "Success": true,
                "ErrCode": 0,
                "ErrMsg": ""
            },
            {
                "PodId": "7294107154305******",
                "Success": false,
                "ErrCode": 0,
                "ErrMsg": "pod 7294107154305****** has been shut down, no need to shut down again"
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。