查询任务列表
更新时间:2024-01-03
该接口用于查询集群中的任务列表。
请求结构
Java
1GET /v{version}/clusters/{clusterId}/jobs HTTP/1.1
2Host: kafka-api.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其他特殊头域。
请求参数
参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号 |
clusterId | String | 是 | URL参数 | 待查询的集群ID |
marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置,需要设置为任务ID |
maxKeys | int | 否 | Query参数 | 每页包含的最大数量,最大数量不超过1000,缺省值为1000 |
name | String | 否 | Query参数 | 待查询的任务类型名称,具体可选类型参见JobType |
返回头域
除公共头域外,无其他特殊头域。
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
marker | String | 标记查询的起始位置,与请求接口时传入的marker参数值保持一致 |
maxKeys | int | 每页包含的最大数量 |
isTruncated | boolean | true表示后面还有数据,false表示已经是最后一页 |
nextMarker | String | 下一页所需要传递的marker值,当isTruncated为false时,该值为null |
jobs | List<Job> | 任务列表信息,由 Job 组成的集合 |
错误码
错误码 | 错误描述 | HTTP状态码 | 描述 |
---|---|---|---|
ERROR_PARAMS | 请求参数错误 | 400 | 请求参数错误 |
CLUSTER_NOT_FOUND | 集群不存在 | 451 | 集群不存在 |
CLUSTER_HAD_DELETED | 集群已删除 | 451 | 集群已删除 |
CLUSTER_NOT_BELONGED | 未拥有该集群 | 451 | 未拥有该集群 |
CLUSTER_NOT_AVAILABLE | 集群不可用 | 451 | 集群不可用 |
INTERNAL_ERROR | 服务内部错误 | 500 | 服务内部错误 |
请求示例
Java
1GET http://kafka-api.bj.baidubce.com/v2/clusters/33a168bb70c0459787416077114ab233/jobs
2Authorization: bce-auth-v1/ALTAKaiKeDfBD880eMWBE5oIGE/2023-05-08T11:43:45Z/1800/host;x-bce-date/322f3f98ce57d296c0f5abc64e5554b640ea035c5cb462fcaeab54b9810a3c61
3Host: kafka-api.bj.baidubce.com
返回示例
Java
1HTTP/1.1 200 OK
2x-bce-request-id: 97e6d4ad-6fca-4609-ad4d-9a27c4d1a362
3Date: Mon, 08 May 2023 09:39:11 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "marker": null,
9 "isTruncated": false,
10 "nextMarker": null,
11 "maxKeys": 1000,
12 "jobs": [
13 {
14 "jobId":"xxxxxx",
15 "name":"INCREASE_BROKER_COUNT",
16 "status":"RUNNING",
17 "operations": [
18 {
19 "jobId":"xxxxxx",
20 "name":"INCREASE_BROKER_COUNT",
21 "status":"RUNNING",
22 "operationId":"xxxxxx",
23 "type":"INCREASE_BROKER_COUNT",
24 "state":"RUNNING",
25 "process":90,
26 "schedule":"EXECUTE",
27 "started":true,
28 "createTime":"2022-09-15T11:30:01Z",
29 "startTime":"2022-09-15T11:30:01Z",
30 "endTime":""
31 }
32 ]
33 }
34 ]
35}