任务状态查询 GetJobDetails--云手机-火山引擎

文档中心

立即注册

导航

任务状态查询 GetJobDetails

最近更新时间：2024.05.09 17:19:40首次发布时间：2022.03.25 20:12:48

根据任务 ID（job_id），查询任务执行的结果。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	GetJobDetails
Version	Query	String	是	公共参数，OpenAPI 接口版本	2020-10-25
product_id	Query	String	是	业务 ID	可在「云手机控制台-业务管理-业务详情」中获取
job_id	Query	String	是	任务 ID	例：req-7075149906478xxxxxx

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
result	Object	任务状态信息，参考以下 JobInfo 结构说明

JobInfo 结构说明

字段	类型	说明
product_id	String	业务 ID
job_id	String	任务 ID
status	Integer	任务状态： 100：执行中 200：成功 500：全部失败 501：部分失败 502：取消
status_str	String	任务状态描述
create_time	Integer	任务创建时间，秒级时间戳
update_time	Integer	任务更新时间，秒级时间戳
process	Object	任务数量列表列表，参考以下 ProcessInfo 结构说明
task_info_list	Object[]	任务的子任务列表，参考以下 `list<TaskInfo>` 结构说明

ProcessInfo 结构说明

字段	类型	说明
total_task_num	Integer	任务总数
success_task_num	Integer	处理成功的任务数
fail_task_num	Integer	处理失败的任务数
pending_task_num	Integer	待处理的任务数

list<TaskInfo> 结构说明

字段	类型	说明
global_task_id	String	全局子任务ID，例：t-7068581870979xxxxxx
instance_id	String	实例 ID
host_id	String	云机 ID
task_type	String	任务类型，枚举值： GetInstanceProperty（获取实例属性） UpdateInstanceProperty（设置实例属性） ResetInstanceToFactory（实例重置） ResetInstances（重置实例镜像） UpgradeInstances（升级实例镜像） AdbCommand（批量执行命令） PushFile（推送文件） PullFile（下载文件） InstallApplication（安装应用） ControlApplication（控制应用） DistributeFile（文件分发） BindInstancesSecurityGroup（安全组批量绑定实例） UnbindInstancesSecurityGroup（批量解绑安全组） BindInstancesAdbKey（密钥对批量绑定实例） UnbindInstancesAdbKey（批量解绑密钥对）
task_status	Integer	子任务状态： 99：等待中 100：执行中 200：成功 500：失败
task_status_str	String	子任务状态描述
msg	String	失败错误信息或者成功执行的返回信息
create_time	Integer	子任务创建时间，秒级时间戳
update_time	Integer	子任务更新时间，秒级时间戳
expire_time	Integer	子任务过期时间，秒级时间戳

示例

请求示例

GET https://open.volcengineapi.com?Action=GetJobDetails
&Version=2020-10-25
&product_id=1471432326763xxxxxx
&job_id=req-7075149906478xxxxxx
&<通过header传入的公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "Action": "GetJobDetails",
        "Region": "cn-north-1",
        "RequestId": "202307261204054D6EEE27361C22A619D1",
        "Service": "iPaaS",
        "Version": "2020-10-25"
    },
    "Result": {
        "job_id": "req-7075149906478xxxxxx",
        "product_id": "1471432326763xxxxxx",
        "status": 200,
        "status_str": "Succeed",
        "process": {
            "total_task_num": 1,
            "success_task_num": 1,
            "fail_task_num": 0,
            "pending_task_num": 0
        },
        "create_time": 1656576452,
        "update_time": 1656576635,
        "task_info_list": [
            {
                "global_task_id": "t-7114939761705xxxxxx",
                "instance_id": "i-1735578662xxxxxx",
                "host_id": "h-1771998361xxxxxx",
                "task_type": "InstallApplication",
                "task_status": 200,
                "task_status_str": "Succeed",
                "msg": "Success",
                "create_time": 1656576452,
                "update_time": 1689750730,
                "expire_time": 1656578253
            }
        ]
    }
}