tencent cloud

Cloud Infinite

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Product Overview
Product Strengths
Use Cases
Feature Overview
Regions and Domains
Specifications and Limits
Billing
Billing Overview
Billing Mode
Billable Items
Free Tier
Payment Overdue
Viewing Bill Details
FAQs
Getting Started
Registering and Logging In
Bind Bucket
Uploading and Processing File
Downloading and Deleting Images
Unbinding Buckets
Using CI via COS
Features
Image Processing
Media Processing
Content Moderation
AI Content Recognition
File Processing
Smart Voice
File processing
User Guide
Overview
Bucket Management
Smart Toolbox
Job and Workflow
Data Monitoring
Usage statistics
Use Cases
Copyright Protection Solutions
Image Processing Practices
Working with API Authorization Policies
Workflow Practices
API Documentation
API Overview
Structure
Common Request Headers
Common Response Headers
Activate Vast Service
Image Processing
AI-Based Content Recognition
Smart Audio
Media Processing
Content Moderation
Document Processing
File Processing
Job and Workflow
Cloud Virus Detection
Error Codes
Request Signature
SDK Documentation
SDK Overview
Android SDK
iOS SDK
COS Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Go SDK
COS iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
Mini Program SDK
Personal Information Protection Policy for SDK
Security and Compliance
Permission ‍Management
FAQs
Basic Settings
Document Processing
Media Processing
Content Recognition
Smart Audio
Agreements
Service Level Agreement
Contact Us
Glossary
문서Cloud InfiniteAPI DocumentationDocument ProcessingService and Queue ConfigurationCheck Document Processing Activation Status

Check Document Processing Activation Status

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-12-25 16:10:38

Description

You can use this API to query the list of Buckets for which the document preview feature is enabled.

Authorization Description

When a sub-account is used, you need to include the ci:DescribeDocProcessBucket permission in the action of the authorization policy. For all operations supported by Cloud Infinite, see CI action.

Service Activation

To use this feature, you need to bind Bucket in advance and activate the Cloud Infinite service.
Note:
After Cloud Infinite is bound, if you manually unbind Cloud Infinite from the Bucket, you will not be able to continue using this feature.

Use Limits

When using this interface, please first confirm the relevant restrictions. For details, see Usage Limits.


Request

Request sample

GET /docbucket?pageNumber=1&pageSize=2 HTTP/1.1
Host: ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Note:
Authorization: Auth String. For details, see the Request Signature documentation.

Request header

This API only uses common request headers. For details, see Common Request Headers.

Request body

The request body of this request is empty.

Request Parameter

Name
Description
Type
Required
regions
Region information, in a , delimited string, for example: ap-shanghai,ap-beijing.
string
No
bucketNames
Bucket names, separated by ,, supports multiple Buckets, exact search.
string
No
bucketName
Bucket name prefix, prefix search.
string
No
pageNumber
Page number (defaults to the first page)
string
No
pageSize
Items per page (default: 10)
string
No



Response

Response Headers

This API only returns common response headers. For details, see Common Response Headers.

Response Body

The response body returns application/xml data. The content containing complete node data is displayed as follows:
<Response>
        <TotalCount>2</TotalCount>
        <RequestId>RequestId</RequestId>
        <PageNumber>1</PageNumber>
        <PageSize>2</PageSize>
        <DocBucketList>
                <Name>BucketName-APPID</Name>
                <CreateTime>Time</CreateTime>
                <Region>Region</Region>
                <AliasBucketId/>
                <BucketId>BucketName-APPID</BucketId>
        </DocBucketList>
</Response>
The specific data content is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Response
None.
Container for saving results
Container
Content of the Container node Response:
Node Name (Keyword)
Parent Node
Description
Type
RequestId
Response
unique request ID
String
TotalCount
Response
Total number of document preview Buckets
Int
PageNumber
Response
current page number, same as the pageNumber in the request
Int
PageSize
Response
number of items per page, same as the pageSize in the request
Int
DocBucketList
Response
Document Preview Bucket list
Container
Content of the Container node DocBucketList:
Node Name (Keyword)
Parent Node
Description
Type
BucketId
Response.DocBucketList
Bucket ID
String
Name
Response.DocBucketList
Bucket name, same as BucketId
String
Region
Response.DocBucketList
Region
String
CreateTime
Response.DocBucketList
Creation time
String
AliasBucketId
Response.DocBucketList
Bucket alias
String

Error Codes

This request has no unique error messages. For common error messages, see Error Codes.

Practical Case

Request

GET /docbucket?regions=ap-chongqing HTTP/1.1
Connection: keep-alive
Accept-Encoding: gzip, deflate
Accept: */*
User-Agent: cos-python-sdk-v5.3.2
Host: ci.ap-chongqing.myqcloud.com
Content-Type: application/xml
Authorization: Authorization

Response

HTTP/1.1 200 OK
Date: Mon, 27 Jul 2020 07:00:43 GMT
Content-Type: application/xml
Content-Length: 843
Connection: keep-alive
Server: tencent-ci
x-ci-request-id: NWYxZTdiOWJfYzc2OTQzNjRfM2Qz****

<?xml version="1.0" encoding="utf-8"?>
<Response>
        <TotalCount>2</TotalCount>
        <RequestId>NWYxZTdiOWJfYzc2OTQzNjRfM2Qz****</RequestId>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <DocBucketList>
                <Name>examplebucket-1250000000</Name>
                <CreateTime>2020-07-27T10:54:42+0800</CreateTime>
                <Region>ap-chongqing</Region>
                <AliasBucketId/>
                <BucketId>examplebucket-1250000000</BucketId>
        </DocBucketList>
        <DocBucketList>
                <Name>examplebucket-1250000000</Name>
                <CreateTime>2020-07-24T22:42:26+0800</CreateTime>
                <Region>ap-chongqing</Region>
                <AliasBucketId/>
                <BucketId>examplebucket-1250000000</BucketId>
        </DocBucketList>
</Response>
이전 주제: Activate Document Processing Service다음 주제: Disable the document processing service

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백