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

Modifying a Cluster

Function

Modify the CDM cluster configuration.

Calling Method

For details, see Calling APIs.

URI

POST /v1.1/{project_id}/cluster/modify/{cluster_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

cluster_id

Yes

String

CDM cluster ID. For details about how to obtain the CDM cluster ID, see Querying the Cluster List.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Type (format) of the message body. This parameter is mandatory if the message body exists. If the message body does not exist, leave this parameter blank. If the request body contains Chinese characters, use charset=utf8 to specify the Chinese character set, for example, application/json;charset=utf8.

X-Auth-Token

Yes

String

User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.

X-Language

Yes

String

Request language.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

autoOff

No

Boolean

The phone automatically shuts down.

scheduleBootOff

No

Boolean

Scheduled shutdown.

scheduleBootTime

No

String

Scheduled startup.

scheduleOffTime

No

String

Scheduled shutdown time.

autoRemind

No

Boolean

Message notification.

phoneNum

No

String

Mobile number. A maximum of 20 mobile numbers can be entered and separated by commas (,).

email

No

String

Email address. A maximum of 20 email addresses can be entered and separated by commas (,).

Response Parameters

Status code: 202

The request is successful.

None

Example Requests

Modify the cluster configuration.

POST /v1.1/1551c7f6c808414d8e9f3c514a170f2e/cluster/modify/bae65496-643e-47ca-84af-948672de7eeb

{
  "autoOff" : false,
  "scheduleBootOff" : true,
  "scheduleBootTime" : "00:00:00",
  "scheduleOffTime" : "10:00:00",
  "autoRemind" : true,
  "phoneNum" : "xxx",
  "email" : "xxx@xxx.com"
}

Example Responses

None

Status Codes

Status Code

Description

202

The request is successful.

400

Request error.

401

Authentication failed.

403

No operation permission.

404

No resources found.

500

The internal API of the service is abnormal.

503

Service unavailable.

Error Codes

See Error Codes.