Modifying Consumer Groups in Batches
Function
This API is used to modify consumer groups in batches.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
PUT /v2/{engine}/{project_id}/instances/{instance_id}/groups
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| engine | Yes | String | Definition Message engine. Constraints N/A Range kafka. Default Value N/A |
| project_id | Yes | String | Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
| instance_id | Yes | String | Definition Instance ID. To obtain it, call the API for querying all instances. Constraints N/A Range N/A Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| groups | No | Array of GroupCreateReq objects | Definition Consumer group list. Constraints A maximum of 50 consumer groups can be modified in batches. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| group_name | No | String | Definition Consumer group name. Constraints The consumer group name cannot be modified. Range N/A Default Value N/A |
| group_desc | No | String | Definition Consumer group description. Constraints A maximum of 200 characters Range N/A Default Value N/A |
Response Parameters
Status code: 204
None
Example Requests
PUT https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/groups
{
"groups" : [ {
"group_name" : "test_group_1",
"group_desc" : "group description for test_group_1"
}, {
"group_name" : "test_group_2",
"group_desc" : "group description for test_group_2"
} ]
} Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
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 65 | 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.kafka.v2.region.KafkaRegion; import com.huaweicloud.sdk.kafka.v2.*; import com.huaweicloud.sdk.kafka.v2.model.*; import java.util.List; import java.util.ArrayList; public class UpdateInstanceGroupSolution { 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); KafkaClient client = KafkaClient.newBuilder() .withCredential(auth) .withRegion(KafkaRegion.valueOf("<YOUR REGION>")) .build(); UpdateInstanceGroupRequest request = new UpdateInstanceGroupRequest(); request.withEngine("{engine}"); request.withInstanceId("{instance_id}"); BatchModiftGroupDescriptionReq body = new BatchModiftGroupDescriptionReq(); List<GroupCreateReq> listbodyGroups = new ArrayList<>(); listbodyGroups.add( new GroupCreateReq() .withGroupName("test_group_1") .withGroupDesc("group description for test_group_1") ); listbodyGroups.add( new GroupCreateReq() .withGroupName("test_group_2") .withGroupDesc("group description for test_group_2") ); body.withGroups(listbodyGroups); request.withBody(body); try { UpdateInstanceGroupResponse response = client.updateInstanceGroup(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()); } } } |
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 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkkafka.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 = KafkaClient.new_builder() \ .with_credentials(credentials) \ .with_region(KafkaRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateInstanceGroupRequest() request.engine = "{engine}" request.instance_id = "{instance_id}" listGroupsbody = [ GroupCreateReq( group_name="test_group_1", group_desc="group description for test_group_1" ), GroupCreateReq( group_name="test_group_2", group_desc="group description for test_group_2" ) ] request.body = BatchModiftGroupDescriptionReq( groups=listGroupsbody ) response = client.update_instance_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) |
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 65 66 67 68 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := kafka.KafkaClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := kafka.NewKafkaClient(hcClient) request := &model.UpdateInstanceGroupRequest{} request.Engine = "{engine}" request.InstanceId = "{instance_id}" groupNameGroups:= "test_group_1" groupDescGroups:= "group description for test_group_1" groupNameGroups1:= "test_group_2" groupDescGroups1:= "group description for test_group_2" var listGroupsbody = []model.GroupCreateReq{ { GroupName: &groupNameGroups, GroupDesc: &groupDescGroups, }, { GroupName: &groupNameGroups1, GroupDesc: &groupDescGroups1, }, } request.Body = &model.BatchModiftGroupDescriptionReq{ Groups: &listGroupsbody, } response, err := client.UpdateInstanceGroup(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 |
|---|---|
| 204 | Operation successful. |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank 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