功能描述
DescribeAIJobs 用于拉取符合条件的任务。
请求
请求示例
GET /jobs?size=&states=&queueId=&startCreationTime=&endCreationTime= HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>
请求参数
参数的具体内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
queueId | 无 | 拉取该队列 ID 下的任务 | String | 是 |
tag | 无 | 任务的 Tag | String | 是 |
orderByTime | 无 | Desc 或者 Asc。默认为 Desc | String | 否 |
nextToken | 无 | 请求的上下文,用于翻页。上次返回的值 | String | 否 |
size | 无 | 拉取的最大任务数。默认为10。最大为100 | Integer | 否 |
states | 无 | 拉取该状态的任务,以 , 分割,支持多状态:All、Submitted、Running、Success、Failed、Pause、Cancel。默认为 All | String | 否 |
startCreationTime | 无 | 拉取创建时间大于该时间的任务。格式为: %Y-%m-%dT%H:%m:%S%z ,示例:2001-01-01T00:00:00+0800 | String | 否 |
endCreationTime | 无 | 拉取创建时间小于该时间的任务。格式为: %Y-%m-%dT%H:%m:%S%z ,示例:2001-01-01T23:59:59+0800 | String | 否 |
tag 支持以下几种类型:
任务类型 | tag |
翻译 | Translation |
请求头
请求体
该请求无请求体。
响应
响应头
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response><JobsDetail>...</JobsDetail><NextToken></NextToken></Response>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
Container 节点 Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
JobsDetail | Response | 任务的详细信息 | Container数组 |
NextToken | Response | 翻页的上下文 Token | String |
对于不同的任务类型,JobsDetail 的内容不同,请参照以下链接:
错误码
实际案例
请求
GET /jobs?queueId=p893bcda225bf4945a378da6662e81a89&tag=Translation HTTP/1.1Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0**********&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057Host: test-123456789.ci.ap-beijing.myqcloud.com
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 666Connection: keep-aliveDate: Mon, 28 Jun 2022 15:23:12 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=<Response><JobsDetail><Code>Success</Code><Message></Message><JobId>a8d121820f5e411ec926ef19d53ba9c6f</JobId><State>Running</State><CreationTime>2022-07-07T12:12:12+0800</CreationTime><StartTime>2022-07-07T12:12:13+0800</StartTime><EndTime>-</EndTime><QueueId>p893bcda225bf4945a378da6662e81a89</QueueId><Tag>Translation<Tag><Input><Object>test.txt</Object><Lang>zh</Lang><Type>txt</Type></Input><Operation><Translation><Lang>en</Lang><Type>txt</Type></Translation><Output><Region>ap-beijing</Region><Bucket>test-123456789</Bucket><Object>test-result.txt</Object></Output><UserData>This is my data.</UserData></Operation></JobsDetail><JobsDetail><Code>Success</Code><Message></Message><JobId>a8d121820f5e411ec926ef19d53ba9c6f</JobId><State>Running</State><CreationTime>2022-07-07T12:12:12+0800</CreationTime><StartTime>2022-07-07T12:12:13+0800</StartTime><EndTime>-</EndTime><QueueId>p893bcda225bf4945a378da6662e81a89</QueueId><Tag>Translation<Tag><Input><Object>test.txt</Object><Lang>zh</Lang><Type>txt</Type></Input><Operation><Translation><Lang>en</Lang><Type>txt</Type></Translation><Output><Region>ap-beijing</Region><Bucket>test-123456789</Bucket><Object>test-result.txt</Object></Output><UserData>This is my data.</UserData></Operation></JobsDetail><NextToken>225508</NextToken></Response>