Updated on 2025-08-06 GMT+08:00

Updating Queue Properties

Function

This API is used to update queue properties.

URI

  • URI format

    PUT /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 whose properties are to be modified.

    The name can contain up to 128 characters. Use commas (,) to separate multiple queue names.

Request Parameters

Table 2 Request body parameter

Parameter

Mandatory

Type

Description

properties

No

object

Properties to be updated. For details, see properties.

Table 3 properties

Parameter

Mandatory

Type

Description

computeEngine.maxInstance

No

Integer

Maximum number of Spark drivers can be started on this queue.

job.maxConcurrent

No

Integer

Maximum number of jobs can be concurrently executed by a Spark driver.

computeEngine.maxPrefetchInstance

No

Integer

Maximum number of Spark drivers can be prestarted on this queue.

network.cidrInVpc

No

String

Queue CIDR block.

job.saveJobResultToJobBucket

No

String

Whether to use the job bucket to save SQL query results.

computeEngine.spark.nativeEnabled

No

String

Whether to enable Spark Native.

Currently, Spark Native attributes can be set only in the following regions:
  • AP-Bangkok
  • AP-Singapore

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

is_success

Boolean

Whether the update is successful.

message

String

Description of the API.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Update queue properties.

{
  "properties" : {
    "computeEngine.maxInstance" : 2,
    "job.maxConcurrent" : 32,
    "computeEngine.maxPrefetchInstance" : 1
  }
}

Example Response

None

Status Codes

Table 6 describes the status codes.

Table 6 Status codes

Status Code

Description

200

Returned result. If is_success is true, the update is successful.

400

Request failed.

500

Internal server error.

Error Codes

If an error occurs when this API is called, an error code and message are returned. For details, see Error Codes.