Batch Modifying Consumer Groups
Function
This API is used to modify consumer groups in batches.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/instances/{instance_id}/groups
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. |
instance_id |
Yes |
String |
Instance ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
groups |
No |
Array of CreateOrUpdateConsumerGroup objects |
Consumer group list. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Consumer group name. Enter 3 to 64 characters. Use only letters, digits, percent (%), vertical bars (|), hyphens (-), and underscores (_). |
brokers |
No |
Array of strings |
Associated brokers. This parameter is mandatory only for RocketMQ 4.8.0 instances. |
broadcast |
No |
Boolean |
Whether to broadcast. |
retry_max_time |
No |
Integer |
Maximum number of retries (1 to 16 characters). |
enabled |
No |
Boolean |
Whether consumption is allowed. |
consume_orderly |
No |
Boolean |
Indicates whether to enable orderly consumption. This parameter is mandatory only for RocketMQ 5.x instances. |
group_desc |
No |
String |
Consumer group description (0 to 200 characters). |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Job ID. |
Example Requests
Batch modifying parameters of consumer groups, with max. retries of consumer-group-test changed to 16.
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups { "groups" : [ { "name" : "consumer-group-test", "enabled" : true, "broadcast" : false, "consume_orderly" : false, "retry_max_time" : 16 } ] }
Example Responses
Status code: 200
Consumer groups modified successfully.
{ "job_id" : "8abfa7b27da211df017da340427b0979" }
SDK Sample Code
The SDK sample code is as follows.
Batch modifying parameters of consumer groups, with max. retries of consumer-group-test changed to 16.
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 |
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.rocketmq.v2.region.RocketMQRegion; import com.huaweicloud.sdk.rocketmq.v2.*; import com.huaweicloud.sdk.rocketmq.v2.model.*; import java.util.List; import java.util.ArrayList; public class BatchUpdateConsumerGroupSolution { 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); RocketMQClient client = RocketMQClient.newBuilder() .withCredential(auth) .withRegion(RocketMQRegion.valueOf("<YOUR REGION>")) .build(); BatchUpdateConsumerGroupRequest request = new BatchUpdateConsumerGroupRequest(); request.withInstanceId("{instance_id}"); BatchUpdateConsumerGroupReq body = new BatchUpdateConsumerGroupReq(); List<CreateOrUpdateConsumerGroup> listbodyGroups = new ArrayList<>(); listbodyGroups.add( new CreateOrUpdateConsumerGroup() .withName("consumer-group-test") .withBroadcast(false) .withRetryMaxTime(16) .withEnabled(true) .withConsumeOrderly(false) ); body.withGroups(listbodyGroups); request.withBody(body); try { BatchUpdateConsumerGroupResponse response = client.batchUpdateConsumerGroup(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()); } } } |
Batch modifying parameters of consumer groups, with max. retries of consumer-group-test changed to 16.
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkrocketmq.v2.region.rocketmq_region import RocketMQRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkrocketmq.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 = RocketMQClient.new_builder() \ .with_credentials(credentials) \ .with_region(RocketMQRegion.value_of("<YOUR REGION>")) \ .build() try: request = BatchUpdateConsumerGroupRequest() request.instance_id = "{instance_id}" listGroupsbody = [ CreateOrUpdateConsumerGroup( name="consumer-group-test", broadcast=False, retry_max_time=16, enabled=True, consume_orderly=False ) ] request.body = BatchUpdateConsumerGroupReq( groups=listGroupsbody ) response = client.batch_update_consumer_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) |
Batch modifying parameters of consumer groups, with max. retries of consumer-group-test changed to 16.
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/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 := rocketmq.NewRocketMQClient( rocketmq.RocketMQClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.BatchUpdateConsumerGroupRequest{} request.InstanceId = "{instance_id}" nameGroups:= "consumer-group-test" broadcastGroups:= false retryMaxTimeGroups:= int32(16) enabledGroups:= true consumeOrderlyGroups:= false var listGroupsbody = []model.CreateOrUpdateConsumerGroup{ { Name: &nameGroups, Broadcast: &broadcastGroups, RetryMaxTime: &retryMaxTimeGroups, Enabled: &enabledGroups, ConsumeOrderly: &consumeOrderlyGroups, }, } request.Body = &model.BatchUpdateConsumerGroupReq{ Groups: &listGroupsbody, } response, err := client.BatchUpdateConsumerGroup(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 |
Consumer groups modified successfully. |
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