查询任务详情 GetTaskInfo--云手机-火山引擎

文档中心

立即注册

导航

云手机

查询任务详情 GetTaskInfo

最近更新时间：2025.11.03 17:18:49首次发布时间：2024.05.08 16:20:06

查询指定任务的执行结果详细信息。

注意事项

本接口仅支持查询 7 天内发起的任务详情，超过 7 天的任务详情会自动清除。
本接口的单用户 QPS 限制为 200 次/秒。超过限制，API 调用会被限流。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetTaskInfo`	接口名称。当前 API 的名称为 `GetTaskInfo`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。
ProductId	String	是	`15914953669544xxxxxx`	业务 ID，查询指定任务的执行结果详细信息。
TaskId	String	是	`7294157141458xxxxxx`	任务 ID，在任务创建后返回。

返回参数

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

参数	类型	示例值	描述
TaskId	String	`7294157141458xxxxxx`	返回的任务 ID。
TaskAction	String	`CreatePod`	任务类型。
TaskResult	Integer	`100`	任务执行进度。 100：执行完成； <0：执行失败。
TaskMessage	String	`demo`	任务信息，为任务执行过程中，或执行完成后产生的信息，如：应用上传后，解析到的应用信息、应用版本信息等。各任务根据需要定义。
Jobs	Array of Job	`-`	子任务列表，参看 `Job` 数据类型。

Job

参数	类型	示例值	描述
JobId	String	`job-7294170061873****-7294157141458****`	子任务 ID，每个子任务 ID 对应一个实例。
PodId	String	`7294157141458******`	实例 ID。
Status	Integer	`100`	子任务执行状态。通用状态取值如下： `-2`：部分失败 `-1`：全部失败 `10`：执行中 `100`：成功各任务类型专属状态码参看任务执行回调或子任务执行回调状态码说明。
JobAction	String	`CreatePod`	子任务类型。

请求示例

GET https://open.volcengineapi.com?Action=GetTaskInfo&Version=2023-10-30&ProductId=15914953669544xxxxxx&TaskId=7294157141458xxxxxx

返回示例

{
    "ResponseMetadata": {
        "Action": "GetTaskInfo",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "TaskId": "7294157141458xxxxxx",
        "TaskAction": "CreatePod",
        "TaskResult": 100,
        "TaskMessage": "",
        "Jobs": [
            {
                "JobId": "job-7294170061873xxxxxx-7294157141458xxxxxx",
                "PodId": "7294157141458xxxxxx",
                "Status": 100,
                "JobAction": "CreatePod"
            }
        ]
    }
}

错误码

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