Querying All Queues

Function

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

URI

• URI format

  GET/v1.0/{project_id}/queues

• Parameter description

  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 description

  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.
  with-charge-info	No	Boolean	Whether to return billing 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

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,
              "charging_mode": 2,
              "resource_id": "26afb850-d3c9-42c1-81c0-583d1163e80f",
              "enterprise_project_id": "0",
              "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.

Error Codes

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