【旧版】任务信息查询 GetTaskInfo--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】任务信息查询 GetTaskInfo

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

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

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	string	是	公共参数，OpenAPI 接口名称	GetTaskInfo
Version	Query	string	是	公共参数，OpenAPI 接口版本	2022-08-01
product_id	Query	string	是	业务 ID	例：client-demo
task_id	Query	string	是	任务 ID	任务 ID，在任务创建时返回

返回结果

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

Result 字段包含的参数说明，参考 TaskInfo 定义。

示例

请求示例

GET https://open.volcengineapi.com?Action=GetTaskInfo
&Version=2022-08-01
&product_id=15914953669544xxxxxx
&task_id=7294157141458xxxxxx
&<通过header传入的公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "Action": "GetTaskInfo",
        "Region": "cn-north-1",
        "RequestId": "202310261503276FCDD0A16663056379BA",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "task_id": "7294157141458xxxxxx",
        "task_action": "CreatePod",
        "task_result": 100,
        "task_message": "",
        "jobs": [
            {
                "job_id": "job-7294157141458xxxxxx-7294157141458xxxxxx",
                "pod_id": "7294157141458xxxxxx",
                "job_action": "CreatePod",
                "status": 100
            }
        ]
    }
}