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

Deleting Queue Properties

Function

This API is used to delete queue properties. You can delete multiple property values at a time.

URI

  • URI format

    DELETE /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 deleted.

Request Parameters

Table 2 Request body parameter

Parameter

Mandatory

Type

Description

keys

Yes

Array of strings

Key of the queue property to be deleted.

Options:

  • computeEngine.maxInstance
  • computeEngine.maxPrefetchInstance
  • job.maxConcurrent

The multipleSc.support property cannot be deleted.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

is_success

Boolean

Whether the update is successful.

message

String

Description of the API.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Delete the queue property computeEngine.maxInstance.

{
 "keys": [
  "computeEngine.maxInstance"
 ]
}

Example Response

None

Status Codes

Table 5 describes the status codes.

Table 5 Status codes

Status Code

Description

200

The API is successfully called.

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.