简介
本文档提供关于文档预览队列接口的 API 概览以及 SDK 示例代码。
API | 操作名 | 操作描述 |
查询文档预览队列 | 查询文档预览队列信息 | |
更新文档预览队列 | 更新文档预览队列信息 |
查询文档预览队列
功能说明
ci_get_doc_queue 接口用于查询文档预览队列。
方法原型
def ci_get_doc_queue(self, Bucket, State='All', QueueIds='', PageNumber='', PageSize='', **kwargs):
请求示例
def ci_get_doc_queue():# 查询文档预览队列信息response = client.ci_get_doc_queue(Bucket=bucket_name,PageNumber=1,PageSize=1,)print(response)return response
参数说明
参数名称 | 描述 | 类型 | 是否必选 |
Bucket | 队列所在存储桶 | String | 是 |
QueueIds | String | 否 | |
State | Active 表示队列内的作业会被文档预览服务调度执行 Paused 表示队列暂停，作业不再会被文档预览服务调度执行，队列内的所有作业状态维持在暂停状态，已经处于执行中的任务将继续执行，不受影响 | String | 否 |
PageNumber | 第几页 | int | 否 |
PageSize | 每页个数 | int | 否 |
返回结果说明
由于接口默认返回 xml 内容，解析结果都为 string 类型，以下描述为字段的真实类型。具体数据内容如下：
{'TotalCount': '1','RequestId': 'NjMyMWExY2RfMTIwNjxxxxxxxxxxxxxxxxxx','PageNumber': '1','PageSize': '1','QueueList': [{'QueueId': 'p4bdf22746bxxxxxxxxxxxxxxxxxxxxxx','Name': 'doc-queue','State': 'Active','NotifyConfig': {'Url': 'http://www.demo.callback.com','Event': 'TaskFinish','Type': 'Url','State': 'On','ResultFormat': 'JSON','MqMode': None,'MqName': None,'MqRegion': None},'MaxSize': '10000','MaxConcurrent': '10','CreateTime': '2022-08-11T14:42:01+0800','UpdateTime': '2022-09-14T11:18:08+0800','BucketId': 'test-125xxxxxxxxxx','Category': 'DocProcessing'}]}
参数名称 | 描述 | 类型 |
RequestId | 请求的唯一 ID | String |
TotalCount | 队列总数 | Int |
PageNumber | 当前页数，同请求中的 pageNumber | Int |
PageSize | 每页个数，同请求中的 pageSize | Int |
QueueList | 队列数组 | Container |
NonExistPIDs | 不存在的队列 ID 列表 | String 数组 |
QueueList 节点内容：
NotifyConfig 节点内容：
参数名称 | 描述 | 类型 |
Url | 回调地址 | String |
State | 开关状态，On 或者 Off | String |
Type | 回调类型，Url | String |
Event | 触发回调的事件 | String |
NonExistPIDs 节点内容：
参数名称 | 描述 | 类型 |
QueueID | 队列 ID | String |
更新文档预览队列
功能说明
ci_update_doc_queue 接口用于更新文档预览队列。
方法原型
def ci_update_doc_queue(self, Bucket, QueueId, Request={}, **kwargs):
请求示例
def ci_put_doc_queue():# 更新文档预览队列信息body = {'Name': 'doc-queue','QueueID': 'p4bdf22xxxxxxxxxxxxxxxxxxxxxxxxxf1','State': 'Active','NotifyConfig': {'Type': 'Url','Url': 'http://www.demo.callback.com','Event': 'TaskFinish','State': 'On','ResultFormat': 'JSON'}}response = client.ci_update_doc_queue(Bucket=bucket_name,QueueId='p4bdf22xxxxxxxxxxxxxxxxxxxxxxxxxf1',Request=body,ContentType='application/xml')print(response)return response
参数说明
Request 节点内容：
NotifyConfig 节点内容：
参数名称 | 描述 | 类型 | 是否必选 |
Url | 回调地址 | String | 否 |
State | 开关状态，On 或者 Off | String | 否 |
Type | 回调类型，Url | String | 否 |
Event | 触发回调的事件 | String | 否 |
返回结果说明
{'RequestId': 'NjMyMWEzMTFfZWMxxxxxxxxxxxxxxxxxxxx','Queue': [{'QueueId': 'p4bdf22746b0xxxxxxxxxxxxxxxxxx','Name': 'doc-queue','State': 'Active','NotifyConfig': {'Url': 'http://www.demo.callback.com','Event': 'TaskFinish','Type': 'Url','State': 'On','ResultFormat':'JSON','MqMode': None,'MqName': None,'MqRegion': None},'MaxSize': '10000','MaxConcurrent': '10','CreateTime': '2022-08-11T14:42:01+0800','UpdateTime': '2022-09-14T11:18:08+0800','BucketId': 'test-125xxxxxxxxxxx','Category': 'DocProcessing'}]}
参数名称 | 描述 | 类型 |
RequestId | 请求的唯一 ID | Dict |
Queue | Dict |
