更新时间:2022-12-07 GMT+08:00

查询所有队列

功能介绍

该API用于列出该project下所有的队列。

URI

  • URI格式:

    GET/v1.0/{project_id}/queues

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

    表2 query参数

    参数名称

    是否必选

    参数类型

    说明

    queue_type

    String

    队列的类型,有如下三种类型:

    • sql:查询SQL队列类型的队列。
    • general:查询通用队列类型的队列。
    • all:查询所有类型的队列。

    如果不指定,默认为sql。

    with-priv

    Boolean

    是否返回权限信息。

    page-size

    Integer

    每页显示的最大结果行数,默认值Integer.MAX_VALUE(也即不分页)。

    current-page

    Integer

    当前页码,默认为第一页。

    order

    String

    指定队列排序方式。

    默认为queue_name_asc(队列名称升序),支持queue_name_asc(队列名称升序)、queue_name_desc(队列名称降序)、cu_asc(CU数升序)、cu_desc(CU数降序)四种排序。

    tags

    String

    查询根据标签进行过滤。

请求消息

无请求参数。

响应消息

表3 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

请求执行是否成功。“true”表示请求执行成功。

message

String

系统提示信息,执行成功时,信息可能为空。

queues

Array of Object

队列信息。具体请参考表4

表4 queues参数

参数名称

是否必选

参数类型

说明

queue_name

String

队列名称。

description

String

队列描述信息。

owner

String

创建队列的用户。

create_time

Long

创建队列的时间。单位为“毫秒”的时间戳。

queue_type

String

队列的类型,。

  • sql
  • general
  • all

如果不指定,默认为“sql”

cu_count

Integer

与该队列绑定的计算单元数,即当前队列的CU数。

resource_id

String

队列的资源ID。

enterprise_project_id

String

企业项目ID。0”表示default,即默认的企业项目。

说明:

开通了企业管理服务的用户可设置该参数绑定指定的项目。

cidr_in_vpc

String

队列的虚拟私有云(VPC)的网段。

cidr_in_mgntsubnet

String

管理子网的网段。

cidr_in_subnet

String

子网网段。

resource_mode

Integer

资源模式。

  • 0:共享队列
  • 1:专属队列

platform

String

队列计算资源的cpu架构。

  • x86_64

is_restarting

Boolean

是否重启队列。默认值为“false”。

labels

String

创建队列的标签信息,目前包括队列是否跨AZ的标签信息的Json字符串。目前只支持值为“2”,即创建两个队列。

cu_spec

Integer

队列的规格大小。对于包周期队列,表示包周期部分的CU值;对于按需队列,表示用户购买队列时的初始值。

cu_scale_out_limit

Integer

当前队列弹性扩缩容的CU值上限。

cu_scale_in_limit

Integer

当前队列弹性扩缩容的CU值下限。

请求示例

响应示例

{
      "is_success": "true",
      "message": "",
      "queues": [
          {
              "queue_name": "test",
              "owner": "testuser",
              "description": "",
              "create_time": 1562221422671,
              "queue_type": "spark",
              "cu_count": 16,
              "resource_id": "26afb850-d3c9-42c1-81c0-583d1163e80f",
              "cidr_in_vpc": "10.0.0.0/8",
              "cidr_in_subnet": "10.0.0.0/24",
              "cidr_in_mgntsubnet": "10.23.128.0/24",
              "resource_mode": 1,
              "platform": "x86_64",
              "is_restarting": "false",
              "labels": "multi_az=2",
              "resource_type": "vm",
              "cu_spec": 16
          }
       ]      
    }

状态码

状态码如表5所示。

表5 状态码

状态码

描述

200

查询成功。

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码