数据万象
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 数据万象 > SDK 文档 > Python SDK > 文档处理 > 异步处理队列接口

异步处理队列接口

最近更新时间：2023-07-12 20:50:01

我的收藏

本页目录：

简介

本文档提供关于文档预览队列接口的 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
队列 ID（开通预览服务后自动生成，可通过 万象控制台 在存储桶中查询），以“,”符号分割字符串
String
否
State
1. Active 表示队列内的作业会被文档预览服务调度执行 2. Paused 表示队列暂停，作业不再会被文档预览服务调度执行，队列内的所有作业状态维持在暂停状态，已经处于执行中的任务将继续执行，不受影响
String
否
PageNumber
第几页
int
否
PageSize
每页个数
int
否

返回结果说明

{
    '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 数组
QueueId
队列 ID，开通预览服务后自动生成，请使用 查询队列 获取或通过 万象控制台 在存储桶中查询
String
Name
队列名字
String
State
当前状态，Active 或者 Paused
String
NotifyConfig
回调配置
Container
MaxSize
队列最大长度
Int
MaxConcurrent
当前队列最大并行执行的任务数
Int
UpdateTime
更新时间
String
CreateTime
创建时间
String
Url
回调地址
String
State
开关状态，On 或者 Off
String
Type
回调类型，Url
String
Event
触发回调的事件
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

参数说明

参数名称
描述
类型
是否必选
Bucket
存储桶名称
String
是
QueueID
队列 ID，开通预览服务后自动生成，请使用 查询队列 获取或通过 万象控制台 在存储桶中查询
String
是
Request
更新队列配置请求体
dict
是

返回结果说明

{
    '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
队列信息，详情请参见 查询文档转码队列响应信息中的 QueueList
dict

中国站