文档首页> 云手机 CPH> API参考> 云手机API> 任务管理> 查询任务执行状态列表
更新时间:2022-03-31 GMT+08:00
分享

查询任务执行状态列表

功能介绍

  • 接口名称

    ListJobs

  • 功能描述

    查询同一个request id下的任务。

URI

GET /v1/{project_id}/cloud-phone/jobs?request_id={request_id}

参数说明请参见表1
表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

项目ID

获取方式请参见获取项目ID

request_id

String

任务下发请求时响应的request_id。

须知:

request_id和request_ids必须指定其中一个。request_id和request_ids同时指定的时候,以request_ids为准。

request_ids

String

任务下发请求时响应的多个request_id,用逗号分隔,最多不能超过20个。

说明:

request_id和request_ids同时指定的时候,以request_ids为准。

请求消息

  • 请求参数

  • 请求样例
    1
    GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/jobs?request_id=6837531fd3f54550927b930180a706bf
    

响应消息

  • 响应参数

    参数

    参数类型

    描述

    request_id

    String

    请求的唯一标识ID

    jobs

    Array of objects

    任务信息,详情请参见表2

    表2 job数据结构说明

    参数

    参数类型

    描述

    phone_id

    String

    云手机的唯一标识,云手机相关任务包含此字段。

    server_id

    String

    云手机服务器的唯一标识ID,云手机服务器相关任务包含此字段。

    node_id

    String

    (已废弃)云手机服务器的唯一标识ID,云手机服务器相关任务包含此字段。

    encode_server_id

    String

    编码服务器的唯一标识ID,编码服务器相关任务包含此字段。

    job_id

    String

    任务的唯一标识

    begin_time

    String

    任务处理开始时间

    时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。。

    end_time

    String

    任务处理结束时间

    时间格式为UTC,YYYY-MM-DDTHH:MM:SSZ。

    status

    Integer

    任务状态

    • 1 表示运行中
    • 2 表示成功
    • -1 表示失败

    error_code

    String

    任务错误码

    error_msg

    String

    任务错误码说明

    execute_msg

    String

    任务执行返回内容,最长1024个字节。

  • 响应样例
    {
        "request_id": "6a63a18b8bab40ffb71ebd9cb80d0085",
        "jobs": [
            {
                "phone_id": "1234567b8bab40ffb711234cb80d0234",
                "server_id": "1e223c8e-3ad0-4bf0-a837-bc90d4f91d01",
                "node_id": "1e223c8e-3ad0-4bf0-a837-bc90d4f91d01",
                "job_id": "1564567b8bab40f34711234cb80d0123",
                "begin_time": "2017-10-25T00:00:00Z",
                "end_time": "2017-10-25T00:00:30Z",
                "status": -1,
                "error_code": "CPS0005",
                "error_msg": "Phone not found."
            },
            { 
                "phone_id": "abc4567b8bab40ffb711234cb80d0abc", 
                "server_id": "1e223c8e-3ad0-4bf0-a837-bc90d4f91d01", 
                "node_id": "1e223c8e-3ad0-4bf0-a837-bc90d4f91d01", 
                "job_id": "1564567b8bab40f34711234cb80d0456", 
                "begin_time": "2017-10-25T00:00:00Z", 
                "end_time": "2017-10-25T00:00:32Z", 
                "status": 2, 
                "error_code": "", 
                "error_msg": "" 
            }
        ]
    }

返回值

请参考返回值

错误码

请参考错误码

分享:

    相关文档

    相关产品

close