Help Center/ Data Warehouse Service/ API Reference/ API Description/ Resource Management/ Creating a Resource Management Plan
Updated on 2025-08-06 GMT+08:00
View PDF

Creating a Resource Management Plan

Function

This API is used to create a resource management plan.

Calling Method

For details, see Calling APIs.

URI

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

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

plan_name

Yes

String

Definition

Plan name

Constraints

N/A

Range

N/A

Default Value

N/A

logical_cluster_name

No

String

Definition

Logical cluster name.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 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

Create the resource management plan test2.

POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans

{
  "plan_name" : "planA",
  "logical_cluster_name" : "v3_logical"
}

Example Responses

Status code: 200

Operation succeeded.

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

Status Codes

Status Code

Description

200

Operation succeeded.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.
Parent Topic: Resource Management