Modifying a Consumer Group
Function
This API is used to modify parameters of a specified consumer group.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/instances/{instance_id}/groups/{group}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Parameter description: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A |
instance_id |
Yes |
String |
Parameter description: Instance ID. To obtain it, log in to the RocketMQ console and find the instance ID on the RocketMQ instance details page. Constraints: N/A Value range: N/A Default value: N/A |
group |
Yes |
String |
Parameter description: Consumer group name. Constraints: N/A Value range: N/A Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enabled |
Yes |
Boolean |
Parameter description: Whether a message can be consumed. Constraints: N/A Value range: Default value: N/A |
broadcast |
Yes |
Boolean |
Parameter description: Whether to broadcast. Constraints: N/A Value range: Default value: N/A |
brokers |
No |
Array of strings |
Parameter description: List of associated brokers. |
name |
No |
String |
Parameter description: Consumer group whose parameters are to be modified. (The consumer group name cannot be modified.) Constraints: N/A Value range: N/A Default value: N/A |
retry_max_time |
Yes |
Integer |
Parameter description: Maximum number of retries. Constraints: N/A Value range: 1–16 Default value: N/A |
Response Parameters
Status code: 204
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Parameter description: ID of the specification modification task. Value range: N/A |
Example Requests
Changing consumer-group-test's max. retries to 16
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/{group} { "name" : "consumer-group-test", "enabled" : true, "retry_max_time" : 16, "broadcast" : true }
Example Responses
Status code: 204
The specified consumer group is modified.
{ "job_id" : "93b94287-728d-4bb1-a158-cb66cb0854e7" }
SDK Sample Code
The SDK sample code is as follows.
Changing consumer-group-test's max. retries 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 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.*; public class UpdateConsumerGroupSolution { 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(); UpdateConsumerGroupRequest request = new UpdateConsumerGroupRequest(); request.withInstanceId("{instance_id}"); request.withGroup("{group}"); UpdateConsumerGroup body = new UpdateConsumerGroup(); body.withRetryMaxTime(16); body.withName("consumer-group-test"); body.withBroadcast(true); body.withEnabled(true); request.withBody(body); try { UpdateConsumerGroupResponse response = client.updateConsumerGroup(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()); } } } |
Changing consumer-group-test's max. retries 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 |
# 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 = UpdateConsumerGroupRequest() request.instance_id = "{instance_id}" request.group = "{group}" request.body = UpdateConsumerGroup( retry_max_time=16, name="consumer-group-test", broadcast=True, enabled=True ) response = client.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) |
Changing consumer-group-test's max. retries 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 |
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.UpdateConsumerGroupRequest{} request.InstanceId = "{instance_id}" request.Group = "{group}" nameUpdateConsumerGroup:= "consumer-group-test" request.Body = &model.UpdateConsumerGroup{ RetryMaxTime: int32(16), Name: &nameUpdateConsumerGroup, Broadcast: true, Enabled: true, } response, err := client.UpdateConsumerGroup(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 |
The specified consumer group is modified. |
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