tencent cloud

Feedback

Searching for Media Processing Queues

Last updated: 2021-12-31 17:20:38

    Feature Description

    This API (DescribeMediaQueues) is used to search for queues.

    Request

    Sample request

    GET /queue HTTP/1.1
    Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
    Date: <GMT Date>
    Authorization: <Auth String>
    Content-Length: <length>
    Content-Type: application/xml
    
    Note:

    Authorization: Auth String (For more information, please see Request Signature.)

    Request headers

    This API only uses Common Request Headers.

    Request body

    The request body of this request is empty.

    Request parameters

    Name Type Description Required
    queueIds string Queue ID. If you enter multiple IDs, separate them with commas (,). No
    state string 1. Active: jobs in the queue will be scheduled and transcoded by the media transcoding service.
    2. Paused: the channel is paused, and jobs in the queue will no longer be scheduled and transcoding. All jobs in the queue remain in the suspended state, and the tasks being transcoded will continue to be transcoded without being affected.
    No
    pageNumber string Page number No
    pageSize string Number of records per page No

    Response

    Response headers

    This API only returns Common Response Headers.

    Response body

    The response body returns application/xml data. The following contains all the nodes when pageNumber and pageSize are specified:

    <Response>
      <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
      <TotalCount>1</TotalCount>
      <PageNumber>1</PageNumber>
      <PageSize>10</PageSize>
      <QueueList>
          <QueueId>A</QueueId>
          <Name></Name>
          <State>Active</State>
          <MaxSize>10000</MaxSize>
          <MaxConcurrent>10</MaxConcurrent>
          <UpdateTime></UpdateTime>
          <CreateTime></CreateTime>
          <NotifyConfig>
              <Url></Url>
              <Type></Type>
              <State></State>
              <Event></Event>
          </NotifyConfig>
      </QueueList>
    </Response>
    

    The nodes are described as follows:

    Node Name (Keyword) Parent Node Description Type
    Response None Response container Container

    Response has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    RequestId Response Unique ID of the request String
    TotalCount Response Total number of queues Int
    PageNumber Response Current page number. Same as pageNumber in the request. Int
    PageSize Response Number of records per page. Same as pageSize in the request. Int
    QueueList Response Queue array Container

    QueueList has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    QueueId Response.QueueList Queue ID String
    Name Response.QueueList Queue name String
    State Response.QueueList Current status: Active or Paused String
    NotifyConfig Response.QueueList Callback configuration Container
    MaxSize Response.QueueList Maximum length of the queue Int
    MaxConcurrent Response.QueueList Maximum number of concurrent tasks in the current queue Int
    UpdateTime Response.QueueList Update time String
    CreateTime Response.QueueList Creation time String

    NotifyConfig has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Url Response.QueueList.NotifyConfig Callback address String
    State Response.QueueList.NotifyConfig Switch status: On or Off String
    Type Response.QueueList.NotifyConfig Callback type: URL String
    Event Response.QueueList.NotifyConfig Task completed: TaskFinish; workflow completed: WorkflowFinish String

    The response body returns application/xml data. The following contains all the nodes when queueIds is specified:

    <Response>
      <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
      <QueueList>
          <QueueId>A</QueueId>
          <Name></Name>
          <State>Active</State>
          <NotifyConfig>
              <Url></Url>
          </NotifyConfig>
      </QueueList>
      <NonExistPIDs>
          <QueueID>B</QueueID>
          <QueueID>C</QueueID>
      </NonExistPIDs>
    </Response>
    

    The nodes are described as follows:

    Node Name (Keyword) Parent Node Description Type
    Response None Response container Container

    Response has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    RequestId Response Unique ID of the request String
    QueueList Response Queue array. Same as QueueList described above. Container
    NonExistPIDs Response Non-existing queue ID list Container

    NonExistPIDs has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    QueueID Response.NonExistPIDs Queue ID String

    Error codes

    No special error message will be returned for this request. For the common error messages, please see Error Codes.

    Examples

    Request 1: getting the queue list

    GET /queue?queueIds=A,B,C HTTP/1.1
    Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
    Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
    Content-Length: 0
    Content-Type: application/xml
    

    Response 1

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 100
    Connection: keep-alive
    Date: Thu, 15 Jun 2017 12:37:29 GMT
    Server: tencent-ci
    x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
    <Response>
      <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
      <QueueList>
          <QueueID>A</QueueID>
          <Name></Name>
          <State>Active</State>
          <NotifyConfig>
              <Url></Url>
          </NotifyConfig>
      </QueueList>
      <NonExistPIDs>
          <QueueID>B</QueueID>
          <QueueID>C</QueueID>
      </NonExistPIDs>
    </Response>
    

    Request 2: getting the information of a specified queue

    GET /queue?page_size=10&page_number=1 HTTP/1.1
    Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
    Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
    Content-Length: 0
    Content-Type: application/xml
    

    Response 2

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 100
    Connection: keep-alive
    Date: Thu, 15 Jun 2017 12:37:29 GMT
    Server: tencent-ci
    x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
    <Response>
      <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
      <TotalCount>1</TotalCount>
      <PageNumber>1</PageNumber>
      <PageSize>10</PageSize>
      <QueueList>
          <QueueID>B</QueueID>
          <Name></Name>
          <State>Paused</State>
          <NotifyConfig>
              <Url></Url>
          </NotifyConfig>
      </QueueList>
    </Response>
    
    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