获取队列列表

最近更新时间:2019-04-25 19:15:50

接口描述

本接口 (ListQueue) 该接口用于列出用户账户下的队列列表,可分页获取数据。

  • 外网接口请求域名:https://cmq-queue-{$region}.api.qcloud.com
  • 内网接口请求域名:http://cmq-queue-{$region}.api.tencentyun.com

上述域名中的{$region}需用具体地域替换:gz(广州)、sh(上海)、bj(北京)、shjr(上海金融)、szjr(深圳金融)、hk(香港)、cd(成都)、ca(北美)、usw(美西)、sg(新加坡)。公共参数中的 region 值要与域名的 region 值保持一致,如果出现不一致的情况,以域名的 region 值为准,将请求发往域名 region 所指定的地域。

注意:

任何时候(包括内测期间),如果使用外网域名产生公网下行流量,都会收取流量费用。 因此强烈建议服务在腾讯云上的用户使用内网域名,内网不会产生流量费用。

输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 文档。

参数名称 是否必选 类型 描述
searchWord String 用于过滤队列列表,后台用模糊匹配的方式来返回符合条件的队列列表。如果不填该参数,默认返回帐号下的所有队列
offset Int 分页时本页获取队列列表的起始位置。如果填写了该值,必须也要填写 limit 。该值缺省时,后台取默认值0
limit Int 分页时本页获取队列的个数,如果不传递该参数,则该参数默认为20,最大值为50

输出参数

参数名称 类型 描述
code Int 请参考 错误码
message String 错误提示信息。
requestId String 服务器生成的请求 ID。出现服务器内部错误时,用户可提交此 ID 给后台定位问题
totalCount Int 用户帐号下本次请求返回的队列总数,而非分页后本页获取的队列数量
queueList Array 队列列表信息,每个元素表示一个队列的信息

queueList 定义如下:

参数名称 类型 描述
queueId String 队列的唯一标识 ID
queueName String 队列名字,在单个地域同个帐号下唯一。 队列名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线-

示例

输入:

 https://domain/v2/index.php?Action=ListQueue
 &searchWord=test
 &<公共请求参数>

输出:

{
    "code": 0,
    "message": "",
    "requestId": "14534664555",
    "totalCount": 10,
    "queueList": [{
            "queueId": "queue-asdfo",
            "queueName": "test-queue1"
        },
        {
            "queueId": "queue-asdsafo",
            "queueName": "queue-test1"
        }
    ]
}