Updated on 2025-09-19 GMT+08:00

Editing a Plan for Adding or Deleting a Logical Cluster

Function

This API is used to edit a scheduled plan for adding or deleting a logical cluster.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/clusters/{cluster_id}/logical-cluster-plans/{plan_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

cluster_id

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

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

plan_id

Yes

String

Definition

ID of the plan for adding or deleting a logical cluster.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

actions

Yes

Array of UpdateLogicalClusterPlanActions objects

Definition

List of details about editing the logical cluster addition or deletion plan.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 UpdateLogicalClusterPlanActions

Parameter

Mandatory

Type

Description

id

No

String

Definition

ID of the action for editing the logical cluster addition or deletion plan.

Constraints

N/A

Range

N/A

Default Value

N/A

type

No

String

Definition

Action type for editing the logical cluster addition or deletion plan.

Constraints

N/A

Range

create

delete

Default Value

N/A

strategy

No

String

Definition

Cron policy expression for editing the logical cluster addition or deletion plan.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

Example Requests

Edit a scheduled plan for adding or deleting a logical cluster.

POST https://{Endpoint}/v1/05f2cff45100d5112f4bc00b794ea08e/clusters/91da08ba-7d92-4242-98ef-d76954effa9f/logical-cluster-plans/da1fe612-ce83-4d80-be1f-24217c8e9e72

{
  "actions" : [ {
    "id" : "7beae20d-a0d8-495f-9c8c-cf69315088ee",
    "type" : "create",
    "strategy" : "0 00 5 ? * 5"
  }, {
    "id" : "4783cd04-ce68-4e8d-918c-67fd2ce7ef82",
    "type" : "delete",
    "strategy" : "0 05 3 ? * 1"
  } ]
}

Example Responses

Status code: 200

Logical cluster addition or deletion plan edited.

{
  "error_code" : "DWS.0000",
  "error_msg" : null
}

Status Codes

Status Code

Description

200

Logical cluster addition or deletion plan edited.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.