Updated on 2024-07-05 GMT+08:00

Creating a Consumer Group or Batch Deleting Consumer Groups

Function

This API is used to create a consumer group or batch deleting consumer groups.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/instances/{instance_id}/groups

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

action

No

String

This parameter is used to delete consumer groups in batches. If it is not set, a consumer group will be created. delete: Delete consumer groups in batches.

Request Parameters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

groups

No

Array of strings

List of consumer groups to be deleted.

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

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

ID of the job for deleting consumer groups.

name

String

ID of the consumer group that is successfully created.

Example Requests

  • For RocketMQ 4.8.0 instances: Creating a consumer group with broadcast consumption disabled, associated with broker-0, and max. 16 retries.

    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups
    
    {
      "name" : "consumer-group-test",
      "group_desc" : "group_description",
      "brokers" : [ "broker-0" ],
      "broadcast" : false,
      "retry_max_time" : 16
    }
  • For RocketMQ 5.x instances: Creating a consumer group with broadcast and orderly consumption disabled, and max. 16 retries

    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups
    
    {
      "name" : "consumer-group-test",
      "group_desc" : "group_description",
      "consume_orderly" : false,
      "broadcast" : false,
      "retry_max_time" : 16
    }
  • Deleting consumer group consumer-group-test.

    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups?action=delete
    
    {
      "groups" : [ "consumer-group-test" ]
    }

Example Responses

Status code: 200

A consumer group is created or multiple consumer groups are deleted in batches.

{
  "name" : "consumer-group-test"
}

SDK Sample Code

The SDK sample code is as follows.

  • For RocketMQ 4.8.0 instances: Creating a consumer group with broadcast consumption disabled, associated with broker-0, and max. 16 retries.

     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
    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 CreateConsumerGroupOrBatchDeleteConsumerGroupSolution {
    
        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();
            CreateConsumerGroupOrBatchDeleteConsumerGroupRequest request = new CreateConsumerGroupOrBatchDeleteConsumerGroupRequest();
            request.withInstanceId("{instance_id}");
            CreateConsumerGroupOrBatchDeleteConsumerGroupReq body = new CreateConsumerGroupOrBatchDeleteConsumerGroupReq();
            List<String> listbodyBrokers = new ArrayList<>();
            listbodyBrokers.add("broker-0");
            body.withGroupDesc("group_description");
            body.withName("consumer-group-test");
            body.withRetryMaxTime(16);
            body.withBrokers(listbodyBrokers);
            body.withBroadcast(false);
            request.withBody(body);
            try {
                CreateConsumerGroupOrBatchDeleteConsumerGroupResponse response = client.createConsumerGroupOrBatchDeleteConsumerGroup(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());
            }
        }
    }
    
  • For RocketMQ 5.x instances: Creating a consumer group with broadcast and orderly consumption disabled, and max. 16 retries

     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 CreateConsumerGroupOrBatchDeleteConsumerGroupSolution {
    
        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();
            CreateConsumerGroupOrBatchDeleteConsumerGroupRequest request = new CreateConsumerGroupOrBatchDeleteConsumerGroupRequest();
            request.withInstanceId("{instance_id}");
            CreateConsumerGroupOrBatchDeleteConsumerGroupReq body = new CreateConsumerGroupOrBatchDeleteConsumerGroupReq();
            body.withConsumeOrderly(false);
            body.withGroupDesc("group_description");
            body.withName("consumer-group-test");
            body.withRetryMaxTime(16);
            body.withBroadcast(false);
            request.withBody(body);
            try {
                CreateConsumerGroupOrBatchDeleteConsumerGroupResponse response = client.createConsumerGroupOrBatchDeleteConsumerGroup(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());
            }
        }
    }
    
  • Deleting consumer group consumer-group-test.

     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.*;
    
    import java.util.List;
    import java.util.ArrayList;
    
    public class CreateConsumerGroupOrBatchDeleteConsumerGroupSolution {
    
        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();
            CreateConsumerGroupOrBatchDeleteConsumerGroupRequest request = new CreateConsumerGroupOrBatchDeleteConsumerGroupRequest();
            request.withInstanceId("{instance_id}");
            CreateConsumerGroupOrBatchDeleteConsumerGroupReq body = new CreateConsumerGroupOrBatchDeleteConsumerGroupReq();
            List<String> listbodyGroups = new ArrayList<>();
            listbodyGroups.add("consumer-group-test");
            body.withGroups(listbodyGroups);
            request.withBody(body);
            try {
                CreateConsumerGroupOrBatchDeleteConsumerGroupResponse response = client.createConsumerGroupOrBatchDeleteConsumerGroup(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());
            }
        }
    }
    
  • For RocketMQ 4.8.0 instances: Creating a consumer group with broadcast consumption disabled, associated with broker-0, and max. 16 retries.

     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
    # 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 = CreateConsumerGroupOrBatchDeleteConsumerGroupRequest()
            request.instance_id = "{instance_id}"
            listBrokersbody = [
                "broker-0"
            ]
            request.body = CreateConsumerGroupOrBatchDeleteConsumerGroupReq(
                group_desc="group_description",
                name="consumer-group-test",
                retry_max_time=16,
                brokers=listBrokersbody,
                broadcast=False
            )
            response = client.create_consumer_group_or_batch_delete_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)
    
  • For RocketMQ 5.x instances: Creating a consumer group with broadcast and orderly consumption disabled, and max. 16 retries

     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 = CreateConsumerGroupOrBatchDeleteConsumerGroupRequest()
            request.instance_id = "{instance_id}"
            request.body = CreateConsumerGroupOrBatchDeleteConsumerGroupReq(
                consume_orderly=False,
                group_desc="group_description",
                name="consumer-group-test",
                retry_max_time=16,
                broadcast=False
            )
            response = client.create_consumer_group_or_batch_delete_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)
    
  • Deleting consumer group consumer-group-test.

     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
    # 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 = CreateConsumerGroupOrBatchDeleteConsumerGroupRequest()
            request.instance_id = "{instance_id}"
            listGroupsbody = [
                "consumer-group-test"
            ]
            request.body = CreateConsumerGroupOrBatchDeleteConsumerGroupReq(
                groups=listGroupsbody
            )
            response = client.create_consumer_group_or_batch_delete_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)
    
  • For RocketMQ 4.8.0 instances: Creating a consumer group with broadcast consumption disabled, associated with broker-0, and max. 16 retries.

     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 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.CreateConsumerGroupOrBatchDeleteConsumerGroupRequest{}
    	request.InstanceId = "{instance_id}"
    	var listBrokersbody = []string{
            "broker-0",
        }
    	groupDescCreateConsumerGroupOrBatchDeleteConsumerGroupReq:= "group_description"
    	nameCreateConsumerGroupOrBatchDeleteConsumerGroupReq:= "consumer-group-test"
    	retryMaxTimeCreateConsumerGroupOrBatchDeleteConsumerGroupReq:= int32(16)
    	broadcastCreateConsumerGroupOrBatchDeleteConsumerGroupReq:= false
    	request.Body = &model.CreateConsumerGroupOrBatchDeleteConsumerGroupReq{
    		GroupDesc: &groupDescCreateConsumerGroupOrBatchDeleteConsumerGroupReq,
    		Name: &nameCreateConsumerGroupOrBatchDeleteConsumerGroupReq,
    		RetryMaxTime: &retryMaxTimeCreateConsumerGroupOrBatchDeleteConsumerGroupReq,
    		Brokers: &listBrokersbody,
    		Broadcast: &broadcastCreateConsumerGroupOrBatchDeleteConsumerGroupReq,
    	}
    	response, err := client.CreateConsumerGroupOrBatchDeleteConsumerGroup(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    
  • For RocketMQ 5.x instances: Creating a consumer group with broadcast and orderly consumption disabled, and max. 16 retries

     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
    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.CreateConsumerGroupOrBatchDeleteConsumerGroupRequest{}
    	request.InstanceId = "{instance_id}"
    	consumeOrderlyCreateConsumerGroupOrBatchDeleteConsumerGroupReq:= false
    	groupDescCreateConsumerGroupOrBatchDeleteConsumerGroupReq:= "group_description"
    	nameCreateConsumerGroupOrBatchDeleteConsumerGroupReq:= "consumer-group-test"
    	retryMaxTimeCreateConsumerGroupOrBatchDeleteConsumerGroupReq:= int32(16)
    	broadcastCreateConsumerGroupOrBatchDeleteConsumerGroupReq:= false
    	request.Body = &model.CreateConsumerGroupOrBatchDeleteConsumerGroupReq{
    		ConsumeOrderly: &consumeOrderlyCreateConsumerGroupOrBatchDeleteConsumerGroupReq,
    		GroupDesc: &groupDescCreateConsumerGroupOrBatchDeleteConsumerGroupReq,
    		Name: &nameCreateConsumerGroupOrBatchDeleteConsumerGroupReq,
    		RetryMaxTime: &retryMaxTimeCreateConsumerGroupOrBatchDeleteConsumerGroupReq,
    		Broadcast: &broadcastCreateConsumerGroupOrBatchDeleteConsumerGroupReq,
    	}
    	response, err := client.CreateConsumerGroupOrBatchDeleteConsumerGroup(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    
  • Deleting consumer group consumer-group-test.

     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
    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.CreateConsumerGroupOrBatchDeleteConsumerGroupRequest{}
    	request.InstanceId = "{instance_id}"
    	var listGroupsbody = []string{
            "consumer-group-test",
        }
    	request.Body = &model.CreateConsumerGroupOrBatchDeleteConsumerGroupReq{
    		Groups: &listGroupsbody,
    	}
    	response, err := client.CreateConsumerGroupOrBatchDeleteConsumerGroup(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

A consumer group is created or multiple consumer groups are deleted in batches.

Error Codes

See Error Codes.