Querying All Queues in an Elastic Resource Pool

Function

This API is used to query all queues in an elastic resource pool.

URI

URI format
GET /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}/queues

Parameter descriptions

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
elastic_resource_pool_name	Yes	String	Name of the elastic resource pool.
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 parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Page size. The default value is 100.
offset	No	Integer	Offset. The default value is 0.
queue_name	No	String	You can filter data by queue name.

Request Parameters

None

Response Parameters

**Table 3** Response parameters
Parameter	Mandatory	Type	Description
is_success	No	Boolean	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 objects	Resource weight of all queues in the elastic resource pool. For details about the parameters, see Table 4.
count	No	Long	Number of queues bound to the elastic resource pool.

**Table 4** queues
Parameter	Mandatory	Type	Description
queue_name	No	String	Queue name.
enterprise_project_id	No	String	Enterprise project ID.
queue_type	No	String	Queue type. Options: sql: Queues used to run SQL jobs general: Queues used to run Flink and Spark Jar jobs
queue_scaling_policies	No	Array of objects	Scaling policy. For details about the parameters, see priority_infos.
owner	No	String	Queue owner.
create_time	No	Long	Time when a queue is created.
engine	No	String	Queue engine type.

**Table 5** queue_scaling_policies
Parameter	Mandatory	Type	Description
priority	No	Integer	The policy priority ranges from 1 to 100. The value 100 indicates the highest priority.
impact_start_time	No	String	Time when a policy takes effect.
impact_stop_time	No	String	Time when a policy expires.
min_cu	No	Integer	Minimum number of CUs.
max_cu	No	Integer	Maximum number of CUs.
inherit_elastic_resource_pool_max_cu	No	Boolean	Definition Whether queues within the elastic resource pool inherit the maximum CUs of the pool The setting takes effect only within the period specified by the current scaling policy. You need to manually configure CU limits for other periods. Range true: The maximum CUs of queues equal the maximum CUs of the resource pool within the period specified by the current scaling policy. false: Queues within the elastic resource pool do not inherit the maximum CUs of the pool.

Example Request

None

Example Response

{
  "is_success": true,
  "message": "",
  "count": 1,
  "queues": [
    {
      "queue_name": "lhm_sql",
      "enterprise_project_id": "0",
      "queue_type": "sql",
      "queue_scaling_policies": [
        {
          "priority": 50,
          "impact_start_time": "00:00",
          "impact_stop_time": "24:00",
          "min_cu": 16,
          "max_cu": 16
        },
        {
          "priority": 100,
          "impact_start_time": "00:00",
          "impact_stop_time": "12:00",
          "min_cu": 32,
          "max_cu": 64
        },
        {
          "priority": 50,
          "impact_start_time": "12:00",
          "impact_stop_time": "24:00",
          "min_cu": 16,
          "max_cu": 32
        }
      ]
    }
  ]
}

Status Codes

Status Code	Description
200	OK

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.

Parent topic: APIs Related to Elastic Resource Pools

Previous topic: Modifying Elastic Resource Pool Information

Next topic: Associating a Queue with an Elastic Resource Pool