异步处理队列接口

简介

本文档提供关于文档预览队列接口的 API 概览以及 SDK 示例代码。

查询文档预览队列

功能说明

DescribeDocProcessQueues 接口用于查询文档预览队列。

方法原型

func (s *CIService) DescribeDocProcessQueues(ctx context.Context, opt *DescribeDocProcessQueuesOptions) (*DescribeDocProcessQueuesResult, *Response, error)

请求示例

DescribeQueueOpt := &cos.DescribeDocProcessQueuesOptions{
    QueueIds: "p111a8dd208104ce3b11c78398f658ca8,p4318f85d2aa14c43b1dba6f9b78be9b3,aacb2bb066e9c4478834d4196e76c49d3",
    PageNumber: 1,
    PageSize:   2,
}
res, _, err := c.CI.DescribeDocProcessQueues(context.Background(), DescribeQueueOpt)

参数说明

type DescribeDocProcessQueuesOptions struct {
    QueueIds   string `url:"queueIds,omitempty"`
    State      string `url:"state,omitempty"`
    PageNumber int    `url:"pageNumber,omitempty"`
    PageSize   int    `url:"pageSize,omitempty"`
}

返回结果说明

type DescribeDocProcessQueuesResult struct {
    XMLName      xml.Name          
    RequestId    string            
    TotalCount   int
    PageNumber   int
    PageSize     int
    QueueList    []DocProcessQueue 
    NonExistPIDs []string
}
type DocProcessQueue struct { 
    QueueId       string
    Name          string
    State         string
    MaxSize       int
    MaxConcurrent int
    UpdateTime    string
    CreateTime    string
    NotifyConfig  *DocProcessQueueNotifyConfig
}
type DocProcessQueueNotifyConfig struct { 
    Url   string
    State string
    Type  string
    Event string
}

更新文档预览队列

功能说明

UpdateDocProcessQueue 接口用于更新文档预览队列。

方法原型

func (s *CIService) UpdateDocProcessQueue(ctx context.Context, opt *UpdateDocProcessQueueOptions) (*UpdateDocProcessQueueResult, *Response, error)

请求示例

updateQueueOpt := &cos.UpdateDocProcessQueueOptions{
    Name:    "queue-doc-process-1",
    QueueID: "p111a8dd208104ce3b11c78398f658ca8",
    State:   "Active",
    NotifyConfig: &cos.DocProcessQueueNotifyConfig{
        State: "Off",
    },
}
res, _, err := c.CI.UpdateDocProcessQueue(context.Background(), updateQueueOpt)

参数说明

type UpdateDocProcessQueueOptions struct {
    XMLName      xml.Name
    Name         string
    QueueID      string
    State        string
    NotifyConfig *DocProcessQueueNotifyConfig
}

返回结果说明

type UpdateDocProcessQueueResult struct {
    XMLName   xml.Name
    RequestId string
    Queue     *DocProcessQueue
}