取消代理任务 CancelTask--云手机-火山引擎

文档中心

立即注册

导航

云手机

取消代理任务 CancelTask

最近更新时间：2025.11.17 14:12:57首次发布时间：2025.11.17 14:12:57

取消指定的正在运行的代理任务。

使用说明

调用 Mobile Use OpenAPI 前，必须先访问跨服务访问请求为您的账号授权。

注意事项

本接口整体 QPS 限制为 50 次/秒、单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=CancelTask&Version=2023-08-01

请求参数

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

参数	类型	是否必选	示例值	描述
Content-Type	String	是	application/json	请求头信息。

Query

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

Body

参数	类型	是否必选	示例值	描述
RunId	String	是	run-123456	运行 ID。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://open.volcengineapi.com?Action=CancelTask&Version=2023-08-01
{
    "RunId": "run-123456"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CancelTask",
        "Version": "2023-08-01",
        "Service": "ipaas",
        "Region": "cn-north-1"
    },
    "Result": null
}

错误码

Mobile Use OpenAPI 错误码请参见错误码；更多错误码信息，可访问公共错误码。

云手机