Querying Queue Properties

Function

This API is used to query queue properties.

URI

URI format
GET /v3/{project_id}/queues/{queue_name}/properties

Parameter descriptions

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which is used for resource isolation. For how to obtain a project ID, see Obtaining a Project ID.
queue_name	Yes	String	Name of the queue for which the scheduled CU range is to be modified. The name can contain up to 128 characters. Use commas (,) to separate multiple queue names.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Query result offset. The default value is 0.
limit	No	Integer	Number of records displayed on each page. The default value is 1000.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
is_success	Boolean	Whether the request is successfully executed. true indicates that the request is successfully executed.
message	String	Message content.
properties	Array of properties objects	For details, see Table 4.

**Table 4** properties
Parameter	Type	Description
key	String	Key corresponding to the returned property value. computeEngine.maxInstances: Maximum number of Spark drivers can be started on this queue. computeEngine.maxPrefetchInstance: Maximum number of Spark drivers can be prestarted on this queue. job.maxConcurrent: Maximum number of jobs can be concurrently executed by a Spark driver. multipleSc.support: Whether multiple Spark drivers can be set. job.saveJobResultToJobBucket: Whether to use the user job bucket to save SQL query results. true indicates that the function is enabled. computeEngine.spark.nativeEnabled: Whether to use DLI Spark Native. Enumerated values: computeEngine.maxInstances computeEngine.maxPrefetchInstance job.maxConcurrent multipleSc.support job.saveJobResultToJobBucket computeEngine.spark.nativeEnabled
value	String	Value corresponding to the returned property value.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

None

Example Response

{
 "message": "ok",
 "is_success": true,
 "properties": [
    "computeEngine.maxInstance" : 2,
    "job.maxConcurrent" : 32,
    "computeEngine.maxPrefetchInstance" : 1
]
}