tencent cloud

All product documents
Cloud Infinite
DocumentationCloud InfiniteSDK DocumentationPython SDKFile ProcessingAsync Processing Queue APIs
Async Processing Queue APIs
Download PDF
Last updated: 2024-03-01 14:57:12
Async Processing Queue APIs
Last updated: 2024-03-01 14:57:12
Download PDF

Overview

This document provides an overview of APIs and SDK code samples for file preview queues.
API
Operation
Description
Querying file preview queues
Queries specified file preview queues.
Updating file preview queue
Updates specified file preview queue.

Querying File Preview Queue

Feature description

This API (ci_get_doc_queue) is used to query file preview queues.

Method prototype

def ci_get_doc_queue(self, Bucket, State='All', QueueIds='', PageNumber='', PageSize='', **kwargs):

Sample request

def ci_get_doc_queue():
    # Query a file preview queue
    response = client.ci_get_doc_queue(
        Bucket=bucket_name,
        PageNumber=1,
        PageSize=1,
    )
    print(response)
    return response

Parameter description

Parameter
Description
Type
Bucket
Bucket of the queue.
String
QueueIds
Queue ID. If you enter multiple IDs, separate them by comma.
String
State
1. Active: Jobs in the queue will be scheduled and executed by the file preview service. <br>2. Paused: The queue is paused, and jobs in it will no longer be scheduled and executed. All jobs in the queue will remain in the Paused status, while jobs being executed will continue without being affected.
String
PageNumber
Page number.
int
PageSize
Number of entries per page.
int

Response description

{
    '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'
    }]
}

Parameter
Description
Type
RequestId
Unique ID of the request
String
TotalCount
Total number of queues
Int
PageNumber
Current page number, which is the same as pageNumber in the request.
Int
PageSize
Number of entries per page, which is the same as pageSize in the request.
Int
QueueList
Queue array
Container
NonExistPIDs
List of IDs of non-existent queues
String array
QueueId
Queue ID
String
Name
Queue name
String
State
Current status: Active or Paused.
String
NotifyConfig
Callback configuration
Container
MaxSize
Maximum length of the queue
Int
MaxConcurrent
Maximum number of concurrent jobs in the current queue
Int
UpdateTime
Update time
String
CreateTime
Creation time
String
Url
Callback address
String
State
Switch status: On or Off.
String
Type
Callback type: Url.
String
Event
The event that triggers the callback
String

Updating File Preview Queue

Feature description

This API (ci_update_doc_queue) is used to update a file preview queue.

Method prototype

def ci_update_doc_queue(self, Bucket, QueueId, Request={}, **kwargs):


Sample request

def ci_put_doc_queue():
    # Update a file preview 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

Parameter description

Parameter
Description
Type
Bucket
Bucket name
String
Name
Queue name
String
QueueID
Queue ID
String
Request
Request body of the updated queue configuration
String

Response description

{
    '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'
    }]
}

Parameter
Description
Type
RequestId
Unique ID of the request
dict
Queue
Queue information. For more information, see QueueList in the response in Querying File Transcoding Queue.
dict
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon