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

Enabling or Disabling Resource Management

Function

This API is used to enable or disable resource management. The function is enabled by default for new clusters.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/clusters/{cluster_id}/workload

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

Yes

String

Definition

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

Constraints

The value must be a valid DWS cluster ID.

Range

It is a 36-digit UUID.

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

workload_status

No

WorkloadStatus object

Definition

Request for resource management status

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 WorkloadStatus

Parameter

Mandatory

Type

Description

workload_switch

Yes

String

Definition

Switch

Constraints

N/A

Range

on: enabled

off: disabled

Default Value

N/A

max_concurrency_num

No

Integer

Definition

Maximum concurrency

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

workload_res_code

Integer

Definition

Response code

Range

N/A

workload_res_str

String

Definition

Response information.

Range

N/A

Example Requests

Enable resource management and set the maximum number of concurrent tasks to 5.

POST https://{Endpoint} /v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/workload

Example Responses

Status code: 200

Resource management configured.

{
  "workload_res_code" : 0,
  "workload_res_str" : ""
}

Status Codes

Status Code

Description

200

Resource management configured.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.