更新时间:2024-04-30 GMT+08:00

批量修改消费组

功能介绍

批量修改消费组。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见获取项目ID

instance_id

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

groups

Array of CreateOrUpdateConsumerGroup objects

消费组列表。

表3 CreateOrUpdateConsumerGroup

参数

是否必选

参数类型

描述

name

String

消费组名称,只能由英文字母、数字、百分号、竖线、中划线、下划线组成,长度3~64个字符。

brokers

Array of strings

关联的代理列表(仅RocketMQ实例4.8.0版本需要填写此参数)。

broadcast

Boolean

是否广播。

retry_max_time

Integer

最大重试次数,取值范围为1~16。

enabled

Boolean

是否可以消费。

consume_orderly

Boolean

是否按序消费(仅RocketMQ实例5.x版本需要填写此参数)。

group_desc

String

消费组描述,长度0~200个字符。

最小长度:0

最大长度:200

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

请求示例

批量修改消费组的参数,将consumer-group-test消费组的最大重试次数修改为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
  } ]
}

响应示例

状态码: 200

批量修改消费组成功。

{
  "job_id" : "8abfa7b27da211df017da340427b0979"
}

SDK代码示例

SDK代码示例如下。

批量修改消费组的参数,将consumer-group-test消费组的最大重试次数修改为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());
        }
    }
}

批量修改消费组的参数,将consumer-group-test消费组的最大重试次数修改为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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("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)

批量修改消费组的参数,将consumer-group-test消费组的最大重试次数修改为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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

批量修改消费组成功。

错误码

请参见错误码