Help Center> Data Lake Insight> API Reference> Queue-related APIs (Recommended)> Querying All Queues
View PDF

Querying All Queues

Function

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

Debugging

You can debug this API in API Explorer.

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

    Indicates the queue type. The options are as follows:

    • sql
    • general
    • all

    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.

    tags

    No

    String

    Query results are filtered by tag.

Request

None

Response

Table 3 Response parameters

Parameter

Mandatory

Type

Description

is_success

No

Boolean

Indicates whether the request is successfully executed. Value true indicates that the request is successfully executed.

message

No

String

System prompt. If execution succeeds, the parameter setting may be left blank.

queues

No

Array of Object

Queue information For details, see Table 4.
Table 4 queues parameters description

Parameter

Mandatory

Type

Description

queue_name

No

String

Name of a queue.

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 expressed in milliseconds.

queue_type

No

String

Queue type.

  • sql
  • general
  • all

If this parameter is not specified, the default value sql is used.

cu_count

No

Integer

Number of compute units (CUs) bound to a queue, that is, the number of CUs in the current queue.

charging_mode

No

Integer

Billing mode of a queue.

  • Value 1 indicates that queues are billed based on the used CUH.
  • Value 2 indicates that queues are billed based on yearly/monthly packages.

resource_id

No

String

Resource ID of a queue.

enterprise_project_id

No

String

Enterprise project ID. 0 indicates the default enterprise project. For details about how to set an enterprise project, see Accessing the Enterprise Center in the Enterprise Management User Guide.

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. For example, 10.0.0.0/8-24, 172.16.0.0/12-24, and 192.168.0.0/16-24.

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
  • AArch64

is_restarting

No

Boolean

Whether to restart the queue. The default value is false.

labels

No

Array of Objects

Tag information of the queue to be created, including the JSON string indicating whether the queue is Dual-AZ. Currently, only the value 2 is supported, indicating that two queues are created.

feature

No

String

Queue feature. The options are as follows:

  • basic: basic type
  • ai: AI-enhanced (Only the SQL x86_64 dedicated queue supports this option.)

The default value is basic.

NOTE:

For an enhanced AI queue, an AI image is loaded in the background. The image integrates AI algorithm packages based on the basic image. For details, see the Data Lake Insight User Guide.

queue_resource_type

No

String

Type of the resource to which a queue belongs.

  • vm: ECF cluster
  • container: container cluster (Kubernetes)

Example

  • Example request 
    None
  • Example response (successful request) 
    {
      "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"]
,
    }

Status Codes

Table 5 describes the status code.

Table 5 Status codes

Status Code

Description

200

The query is successful.

400

Request error.

500

Internal service error.

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 Code.