查询任务执行状态列表
功能介绍
查询同一个request id下的任务。
URI
GET /v1/{project_id}/cloud-phone/jobs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目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_id和request_ids同时指定的时候,以request_ids为准。 |
offset |
否 |
Integer |
偏移量为一个大于等于0整数,表示查询该偏移量后面的所有的资源数,默认值为0。 |
limit |
否 |
Integer |
每页返回的资源个数。取值范围:1~100(默认值为100),一般设置为10、20、50。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
请求的唯一标识ID。 |
jobs |
Array of Job objects |
任务信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
phone_id |
String |
云手机的唯一标识,云手机相关任务包含此字段。 |
server_id |
String |
云手机服务器的唯一标识ID,云手机服务器相关任务包含此字段。 |
node_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 |
任务状态。
|
error_code |
String |
任务错误码。 |
error_msg |
String |
任务错误码说明。 |
execute_msg |
String |
任务执行返回内容,最长1024个字节。 |
请求示例
查询请求id对应的job状态
https://{CPH Endpoint}/v1/{project_id}/cloud-phone/jobs?request_id=6837531fd3f54550927b930180a706bf
响应示例
状态码: 200
OK
{ "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" : "" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。