功能描述
本接口用于查询文件处理队列。
授权说明
授权策略中 action 设置为 ci:DescribeFileProcessQueues
。查看所有 action。
服务开通
使用该功能需提前开通数据万象,并绑定存储桶。详情请参见 绑定存储桶。
使用限制
使用该接口时,请先确认相关限制条件。详情请参见 使用限制。
请求
请求示例
GET /file_queue HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml
说明Authorization: Auth String(详情请参见 请求签名 文档)。通过子账号使用时,需要授予相关的权限,详情请参见 授权粒度详情 文档。
请求头
此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。
请求体
该请求的请求体为空。
请求参数
参数名称(关键字) | 描述 | 类型 | 是否必选 |
queueIds | 队列 ID,以“,”符号分割字符串 | String | 否 |
state | Active 表示队列内的作业会被调度执行Paused 表示队列暂停,作业不再会被调度执行,队列内的所有作业状态维持在暂停状态,已经执行中的任务不受影响 | String | 否 |
pageNumber | 第几页,默认值1 | String | 否 |
pageSize | 每页个数,默认值10 | String | 否 |
响应
响应头
此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。
响应体
该响应体返回为 application/xml 数据,当指定 pageNumber 和 pageSize 时包含完整节点数据的内容展示如下:
NjJmNDczY2RfOTBmYTUwNjRfNTA4ZV85 1 1 10 p4a17eeea29334bf499b7e20e2fbfd99d My-Queue-file Active http://callback.demo.com TaskFinish,WorkflowFinish Url On JSON 10000 10 2022-08-09T16:23:11+0800 2022-08-09T16:23:11+0800 FileProcess
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
Container 节点 Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
RequestId | Response | 请求的唯一 ID | String |
TotalCount | Response | 队列总数 | Int |
PageNumber | Response | 当前页数,同请求中的 pageNumber | Int |
PageSize | Response | 每页个数,同请求中的 pageSize | Int |
QueueList | Response | 队列数组 | Container 数组 |
NonExistPIDs | Response | 不存在的队列 ID 列表 | String 数组 |
Container 节点 QueueList 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
QueueId | Response.QueueList | 队列 ID | String |
Name | Response.QueueList | 队列名字 | String |
State | Response.QueueList | 当前状态,Active 或者 Paused | String |
NotifyConfig | Response.QueueList | 回调配置 | Container |
MaxSize | Response.QueueList | 队列最大长度 | Int |
MaxConcurrent | Response.QueueList | 当前队列最大并行执行的任务数 | Int |
Category | Response.QueueList | 队列类型 | String |
UpdateTime | Response.QueueList | 更新时间 | String |
CreateTime | Response.QueueList | 创建时间 | String |
Container 节点 NotifyConfig 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Url | Response.QueueList.NotifyConfig | 回调地址 | String |
State | Response.QueueList.NotifyConfig | 开关状态 | String |
Type | Response.QueueList.NotifyConfig | 回调类型 | String |
Event | Response.QueueList.NotifyConfig | 回调事件 | String |
ResultFormat | Response.QueueList.NotifyConfig | 回调类型 | String |
MqMode | Response.QueueList.NotifyConfig | TDMQ 使用模式 | String |
MqRegion | Response.QueueList.NotifyConfig | TDMQ 所属园区 | String |
MqName | Response.QueueList.NotifyConfig | TDMQ 主题名称 | String |
错误码
该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。
实际案例
请求
GET /file_queue?queueIds=p4a17eeea29334bf499b7e20e2fbfd99d,A,B HTTP/1.1Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11be********Host: test-1234567890.ci.ap-chongqing.myqcloud.comContent-Length: 0Content-Type: application/xml
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 100Connection: keep-aliveDate: Thu, 09 Aug 2022 16:23:12 GMTServer: tencent-cix-ci-request-id: NjJmNDczY2RfOTBmYTUwNjRfNTA4ZV85
NjJmNDczY2RfOTBmYTUwNjRfNTA4ZV85 p4a17eeea29334bf499b7e20e2fbfd99d My-Queue-file Active http://callback.demo.com TaskFinish,WorkflowFinish Url On JSON 10000 10 2022-08-09T16:23:11+0800 2022-08-09T16:23:11+0800 FileProcess A B
对象存储官网1折活动,限时活动,即将结束,速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠
转转请注明出处:https://www.yunxiaoer.com/145256.html