tencent cloud

Feedback

Querying Document Preview Feature Status

Last updated: 2024-02-29 16:52:32

    Overview

    This document provides an overview of APIs and SDK code samples for querying the document preview feature status.
    API
    Description
    Queries whether the document preview feature is enabled for a bucket.

    Querying Document Preview Feature Status

    Feature description

    This API (DescribeDocProcessBuckets) is used to query whether the document preview feature is enabled for a bucket.

    Method prototype

    func (s *CIService) DescribeDocProcessBuckets(ctx context.Context, opt *DescribeDocProcessBucketsOptions) (*DescribeDocProcessBucketsResult, *Response, error)

    Sample request

    BucketsOpt := &cos.DescribeDocProcessBucketsOptions{
    Regions: "ap-shanghai",
    }
    res, _, err := c.CI.DescribeDocProcessBuckets(context.Background(), BucketsOpt)

    Parameter description

    type DescribeDocProcessBucketsOptions struct {
    Regions string
    BucketNames string
    BucketName string
    PageNumber int
    PageSize int
    }
    Parameter
    Description
    Type
    Regions
    Region abbreviation, such as ap-shanghai and ap-beijing. To specify multiple regions, separate them with commas (,). For more information, see Regions and Domains.
    string
    BucketNames
    Bucket name. To specify multiple bucket names, separate them with commas (,). Exact search is supported.
    string
    BucketName
    Bucket name prefix for prefix search
    string
    PageNumber
    Page number
    int
    pageSize
    Number of entries per page
    int

    Response description

    type DescribeDocProcessBucketsResult struct {
    RequestId string
    TotalCount int
    PageNumber int
    PageSize int
    DocBucketList []DocProcessBucket
    }
    type DocProcessBucket struct {
    BucketId string
    Name string
    Region string
    CreateTime string
    AliasBucketId string
    }
    Parameter
    Description
    Type
    RequestId
    Unique request ID
    string
    TotalCount
    Total number of buckets with document preview enabled
    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
    DocBucketList
    List of buckets with document preview enabled
    Container
    BucketId
    Bucket ID
    string
    Name
    Bucket name, which is the same as BucketId
    string
    Region
    Region
    string
    CreateTime
    Creation time
    string
    AliasBucketId
    Bucket alias
    string
    Contact Us

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

    Technical Support

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

    7x24 Phone Support