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}
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
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. |
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 (,). |
|
No |
String |
Email address. A maximum of 20 email addresses can be entered and separated by commas (,). |
Response Parameters
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
SDK Sample Code
The SDK sample code is as follows.
Modify the cluster configuration.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cdm.v1.region.CdmRegion; import com.huaweicloud.sdk.cdm.v1.*; import com.huaweicloud.sdk.cdm.v1.model.*; public class ModifyClusterSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CdmClient client = CdmClient.newBuilder() .withCredential(auth) .withRegion(CdmRegion.valueOf("<YOUR REGION>")) .build(); ModifyClusterRequest request = new ModifyClusterRequest(); request.withClusterId("{cluster_id}"); CdmModifyClusterReq body = new CdmModifyClusterReq(); body.withEmail("xxx@xxx.com"); body.withPhoneNum("xxx"); body.withAutoRemind(true); body.withScheduleOffTime("10:00:00"); body.withScheduleBootTime("00:00:00"); body.withScheduleBootOff(true); body.withAutoOff(false); request.withBody(body); try { ModifyClusterResponse response = client.modifyCluster(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Modify the cluster configuration.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcdm.v1.region.cdm_region import CdmRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcdm.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CdmClient.new_builder() \ .with_credentials(credentials) \ .with_region(CdmRegion.value_of("<YOUR REGION>")) \ .build() try: request = ModifyClusterRequest() request.cluster_id = "{cluster_id}" request.body = CdmModifyClusterReq( email="xxx@xxx.com", phone_num="xxx", auto_remind=True, schedule_off_time="10:00:00", schedule_boot_time="00:00:00", schedule_boot_off=True, auto_off=False ) response = client.modify_cluster(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Modify the cluster configuration.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cdm "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdm/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdm/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdm/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := cdm.NewCdmClient( cdm.CdmClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ModifyClusterRequest{} request.ClusterId = "{cluster_id}" emailCdmModifyClusterReq:= "xxx@xxx.com" phoneNumCdmModifyClusterReq:= "xxx" autoRemindCdmModifyClusterReq:= true scheduleOffTimeCdmModifyClusterReq:= "10:00:00" scheduleBootTimeCdmModifyClusterReq:= "00:00:00" scheduleBootOffCdmModifyClusterReq:= true autoOffCdmModifyClusterReq:= false request.Body = &model.CdmModifyClusterReq{ Email: &emailCdmModifyClusterReq, PhoneNum: &phoneNumCdmModifyClusterReq, AutoRemind: &autoRemindCdmModifyClusterReq, ScheduleOffTime: &scheduleOffTimeCdmModifyClusterReq, ScheduleBootTime: &scheduleBootTimeCdmModifyClusterReq, ScheduleBootOff: &scheduleBootOffCdmModifyClusterReq, AutoOff: &autoOffCdmModifyClusterReq, } response, err := client.ModifyCluster(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot