Modifying a Host Group
Function
Modify a host group.
Calling Method
For details, see Calling APIs.
URI
PUT /v3/{project_id}/lts/host-group
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID. It can be obtained by calling an API or from the console. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token obtained from IAM. For details about how to obtain it, see Obtaining a User Token. Constraints N/A Range N/A Default Value N/A |
Content-Type |
Yes |
String |
Definition Message body format. Set this parameter to application/json;charset=utf8. Constraints N/A Range N/A Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
host_group_id |
Yes |
String |
Definition Host group ID. Constraints N/A Range N/A Default Value N/A |
host_group_name |
No |
String |
Definition Host group name. Constraints N/A Range
Default Value N/A |
host_id_list |
No |
Array of strings |
Definition Host ID list. The host type must be the same as the host group type. Constraints N/A |
host_group_tag |
No |
Array of HostGroupTag objects |
Definition Host group tags. Constraints You can add up to 20 tags. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
No |
String |
Definition Tag key. Constraints
Range A tag key can contain letters, digits, spaces, and special characters (_.:=+-@), but cannot start or end with a space or start with sys. A tag key can contain up to 128 characters. Default Value N/A |
value |
No |
String |
Definition Tag value. Constraints A tag is a key-value pair. Each key is paired with its corresponding value. Range
Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
host_group_id |
String |
Definition Host group ID. Range N/A |
host_group_name |
String |
Definition Host group name. Range N/A |
host_group_type |
String |
Definition Host group type. Range
|
host_id_list |
Array of strings |
Definition Host ID list. |
host_group_tag |
Array of HostGroupTag objects |
Definition Host group tags. |
create_time |
Long |
Definition Time when the host group was created. Range N/A |
update_time |
Long |
Definition Time when the host group was updated. Range N/A |
agent_access_type |
String |
Definition Host access type. Range
|
Parameter |
Type |
Description |
---|---|---|
key |
String |
Definition Tag key. Constraints
Range A tag key can contain letters, digits, spaces, and special characters (_.:=+-@), but cannot start or end with a space or start with sys. A tag key can contain up to 128 characters. Default Value N/A |
value |
String |
Definition Tag value. Constraints A tag is a key-value pair. Each key is paired with its corresponding value. Range
Default Value N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. For details, see Error Codes. Range N/A |
error_msg |
String |
Definition Error message. Range N/A |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. For details, see Error Codes. Range N/A |
error_msg |
String |
Definition Error message. Range N/A |
Example Requests
Update a host group. Parameter host_group_id is mandatory.
PUT https://{endpoint}/v3/{project_id}/lts/host-group { "host_group_id" : "xxxxxx", "host_group_name" : "qweqwe", "host_id_list" : [ "host_id_1", "host_id_2" ], "host_group_tag" : [ { "key" : "xxx", "value" : "xxx" } ] }
Example Responses
Status code: 200
The host group is modified.
{ "host_group_id" : "598c77aa-c69b-42f0-8cb8-983178b38", "host_group_name" : "devspore_app_dzhou1", "host_group_type" : "linux", "agent_access_type" : "IP", "host_id_list" : [ "dc1dab7e-b045-4e77-bda4-914d3f7", "xxxxx" ], "host_group_tag" : [ { "key" : "xxx", "value" : "xxx" }, { "key" : "xxx", "value" : "xxx" } ], "create_time" : 16351494332, "update_time" : 16351494332 }
Status code: 400
Invalid request. Modify the request based on the description in error_msg before a retry.
{ "error_code" : "LTS.1807", "error_msg" : "Invalid host group id" }
Status code: 500
The server has received the request but encountered an internal error.
{ "error_code" : "LTS.0010", "error_msg" : "Internal Server Error" }
SDK Sample Code
The SDK sample code is as follows.
Update a host group. Parameter host_group_id is mandatory.
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 58 59 60 61 62 63 64 |
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.lts.v2.region.LtsRegion; import com.huaweicloud.sdk.lts.v2.*; import com.huaweicloud.sdk.lts.v2.model.*; import java.util.List; import java.util.ArrayList; public class UpdateHostGroupSolution { 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); LtsClient client = LtsClient.newBuilder() .withCredential(auth) .withRegion(LtsRegion.valueOf("<YOUR REGION>")) .build(); UpdateHostGroupRequest request = new UpdateHostGroupRequest(); UpdateHostGroupRequestBody body = new UpdateHostGroupRequestBody(); List<HostGroupTag> listbodyHostGroupTag = new ArrayList<>(); listbodyHostGroupTag.add( new HostGroupTag() .withKey("xxx") .withValue("xxx") ); List<String> listbodyHostIdList = new ArrayList<>(); listbodyHostIdList.add("host_id_1"); listbodyHostIdList.add("host_id_2"); body.withHostGroupTag(listbodyHostGroupTag); body.withHostIdList(listbodyHostIdList); body.withHostGroupName("qweqwe"); body.withHostGroupId("xxxxxx"); request.withBody(body); try { UpdateHostGroupResponse response = client.updateHostGroup(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()); } } } |
Update a host group. Parameter host_group_id is mandatory.
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdklts.v2.region.lts_region import LtsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdklts.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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = LtsClient.new_builder() \ .with_credentials(credentials) \ .with_region(LtsRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateHostGroupRequest() listHostGroupTagbody = [ HostGroupTag( key="xxx", value="xxx" ) ] listHostIdListbody = [ "host_id_1", "host_id_2" ] request.body = UpdateHostGroupRequestBody( host_group_tag=listHostGroupTagbody, host_id_list=listHostIdListbody, host_group_name="qweqwe", host_group_id="xxxxxx" ) response = client.update_host_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) |
Update a host group. Parameter host_group_id is mandatory.
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := lts.NewLtsClient( lts.LtsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateHostGroupRequest{} keyHostGroupTag:= "xxx" valueHostGroupTag:= "xxx" var listHostGroupTagbody = []model.HostGroupTag{ { Key: &keyHostGroupTag, Value: &valueHostGroupTag, }, } var listHostIdListbody = []string{ "host_id_1", "host_id_2", } hostGroupNameUpdateHostGroupRequestBody:= "qweqwe" request.Body = &model.UpdateHostGroupRequestBody{ HostGroupTag: &listHostGroupTagbody, HostIdList: &listHostIdListbody, HostGroupName: &hostGroupNameUpdateHostGroupRequestBody, HostGroupId: "xxxxxx", } response, err := client.UpdateHostGroup(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 |
---|---|
200 |
The host group is modified. |
400 |
Invalid request. Modify the request based on the description in error_msg before a retry. |
500 |
The server has received the request but encountered an internal error. |
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