Modifying a Host Cluster
Function
This API is used to modify host cluster information by ID. This API will not be maintained after September 30, 2024.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/host-groups/{group_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
group_id |
Yes |
String |
Definition: Host cluster ID. Constraints: N/A. Value range: 32 characters, including letters and digits. Default value: N/A. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Definition: Type (or format) of the message body. Constraints: N/A. Value range: N/A. Default value: N/A. |
X-Auth-Token |
Yes |
String |
Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API used forObtaining a User Token. Constraints: N/A. Value range: String. Max. 20,000 characters. Default value: N/A. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Definition: Host cluster name. Constraints: N/A. Value range: 3 to 128 characters, including letters, digits, hyphens (-), underscores (_), and periods (.). Default value: N/A. |
description |
No |
String |
Definition: Host cluster description. Constraints: N/A. Value range: String. 0 to 500 characters. Default value: N/A. |
slave_cluster_id |
No |
String |
Definition: Slave cluster ID. It is empty by default. When it is empty, the default agent pool is used. Constraints: N/A. Value range: 32 characters, including letters and digits. Default value: N/A. |
auto_connection_test_switch |
No |
Integer |
The automatic test function has been removed. This field is invalid. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
group_id |
String |
Definition: Host cluster ID. Value range: 32 characters, including letters and digits. |
Example Requests
Modify the basic information about the target host cluster, including the host cluster name and description.
https://{endpoint}/v2/host-groups/f3938bd63e354d2bb9d9cf7b5dc3bf95 { "name" : "test123", "description" : "This is a description.", "slave_cluster_id" : "", "auto_connection_test_switch" : 0 }
Example Responses
Status code: 200
OK: The request is successful.
{ "group_id" : "f3938bd63e354d2bb9d9cf7b5dc3bf95" }
SDK Sample Code
The SDK sample code is as follows.
Java
Modify the basic information about the target host cluster, including the host cluster name and description.
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 |
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.codeartsdeploy.v2.region.CodeArtsDeployRegion; import com.huaweicloud.sdk.codeartsdeploy.v2.*; import com.huaweicloud.sdk.codeartsdeploy.v2.model.*; public class UpdateDeploymentGroupSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsDeployClient client = CodeArtsDeployClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsDeployRegion.valueOf("<YOUR REGION>")) .build(); UpdateDeploymentGroupRequest request = new UpdateDeploymentGroupRequest(); request.withGroupId("{group_id}"); DeploymentGroupUpdateRequest body = new DeploymentGroupUpdateRequest(); body.withAutoConnectionTestSwitch(DeploymentGroupUpdateRequest.AutoConnectionTestSwitchEnum.NUMBER_0); body.withSlaveClusterId(""); body.withDescription("This is a description."); body.withName("test123"); request.withBody(body); try { UpdateDeploymentGroupResponse response = client.updateDeploymentGroup(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()); } } } |
Python
Modify the basic information about the target host cluster, including the host cluster name and description.
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsdeploy.v2.region.codeartsdeploy_region import CodeArtsDeployRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsdeploy.v2 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"] credentials = BasicCredentials(ak, sk) client = CodeArtsDeployClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsDeployRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateDeploymentGroupRequest() request.group_id = "{group_id}" request.body = DeploymentGroupUpdateRequest( auto_connection_test_switch=0, slave_cluster_id="", description="This is a description.", name="test123" ) response = client.update_deployment_group(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
Modify the basic information about the target host cluster, including the host cluster name and description.
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsdeploy "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codeartsdeploy.NewCodeArtsDeployClient( codeartsdeploy.CodeArtsDeployClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateDeploymentGroupRequest{} request.GroupId = "{group_id}" autoConnectionTestSwitchDeploymentGroupUpdateRequest:= model.GetDeploymentGroupUpdateRequestAutoConnectionTestSwitchEnum().E_0 slaveClusterIdDeploymentGroupUpdateRequest:= "" descriptionDeploymentGroupUpdateRequest:= "This is a description." request.Body = &model.DeploymentGroupUpdateRequest{ AutoConnectionTestSwitch: &autoConnectionTestSwitchDeploymentGroupUpdateRequest, SlaveClusterId: &slaveClusterIdDeploymentGroupUpdateRequest, Description: &descriptionDeploymentGroupUpdateRequest, Name: "test123", } response, err := client.UpdateDeploymentGroup(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
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 |
---|---|
200 |
OK: The request is successful. |
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