Function

This API is used to list all queues under the project.

URI

URI format
GET /v1.0/{project_id}/queues

Parameter descriptions

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

**Table 2** query parameter descriptions
Parameter	Mandatory	Type	Description
queue_type	No	String	Type of the queue. The options are as follows: sql: queues for SQL jobs general: queues for Flink and Spark Jar jobs all: queues of all types If this parameter is not specified, the default value sql is used.
with-priv	No	Boolean	Whether to return permission information.
page-size	No	Integer	Maximum number of lines displayed on each page. The default value is Integer.MAX_VALUE, indicating that all results are displayed on one page.
current-page	No	Integer	Current page number. The default value is 1.
order	No	String	Queue sorting method The default value is queue_name_asc (alphabetically ascending order on queue names). Other options are queue_name_desc (alphabetically descending order on queue names), cu_asc (ascending order on CUs), and cu_desc (descending order on CUs).
tags	No	String	Query results are filtered by tag.
limit	No	Integer	Number of records to be displayed of the page-based query.
offset	No	Integer	Specifies the offset of the page-based query.

Request Parameters

None

Response Parameters

**Table 3** Response parameters
Parameter	Mandatory	Type	Description
is_success	No	Boolean	Indicates whether the request is successfully executed. true indicates that the request is successfully executed.
message	No	String	System prompt. If the execution succeeds, this parameter may be left blank.
queues	No	Array of Object	Queue information For details, see Table 4.

**Table 4** queues parameter descriptions
Parameter	Mandatory	Type	Description
queue_id	No	Long	Queue ID
queue_name	No	String	Queue name.
description	No	String	Queue description.
owner	No	String	User who creates a queue.
create_time	No	Long	Time when the queue is created. The timestamp is in milliseconds.
queue_type	No	String	Queue type. Options: sql general all If left unset, the default value sql is used.
engine	No	String	Engine type.
used_cu	No	Float	CUs used by all queues.
cu_count	No	Integer	Number of compute units (CUs) bound to a queue, that is, the number of CUs in the current queue.
resource_id	No	String	Resource ID of a queue.
enterprise_project_id	No	String	Enterprise project ID. 0 indicates the default enterprise project. NOTE: Users who have enabled Enterprise Management can set this parameter to bind a specified project.
cidr_in_vpc	No	String	The VPC CIDR block of the queue.
cidr_in_mgntsubnet	No	String	CIDR block of the management subnet
cidr_in_subnet	No	String	Subnet CIDR block
resource_mode	No	Integer	Resource mode 0: Shared queue 1: Dedicated queue
platform	No	String	CPU architecture of queue compute resources. x86_64
is_restarting	No	Boolean	Whether to restart the queue. The default value is false.
labels	No	String	Tag information of the queue to be created, currently including the JSON string indicating whether the queue is cross-AZ. Currently, only the value 2 is supported, indicating that two queues are created.
cu_spec	No	Integer	Specifications of a queue.
cu_scale_out_limit	No	Integer	Upper limit of the CU value for elastic scaling of the current queue.
cu_scale_in_limit	No	Integer	Lower limit of the CU value for elastic scaling of the current queue.
elastic_resource_pool_name	Yes	String	Name of the elastic resource pool
support_spark_versions	No	Array[String]	Spark version supported by the queue
default_spark_version	No	String	Default Spark version of the queue
support_hetu_engine_versions	No	Array[String]	HetuEngine version supported by the queue
default_hetu_engine_version	No	String	Default HetuEngine version of the queue
support_flink_sql_versions	No	Array[String]	Flink SQL version supported by the queue
default_flink_sql_version	No	String	Default Flink SQL version of the queue
support_flink_jar_versions	No	Array[String]	Flink Jar version supported by the queue
default_flink_jar_version	No	String	Default Flink Jar version of the queue
support_opensource_flink_versions	No	Array[String]	Flink OpenSource SQL versions supported by the queues.

Example Request

None

Example Response

{
      "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
          }
       ]      
    }

Status Codes

Table 5 describes status codes.

**Table 5** Status codes
Status Code	Description
200	The query is successful.
400	Request error.
500	Internal server error.

Error Codes

If an error occurs when this API is called, the system does not return the result similar to the preceding example, but returns an error code and error message. For details, see Error Codes.

Querying All Queues