查询消费者列表
功能介绍
查询消费组内消费者列表
调用方法
请参见如何调用API。
URI
GET /v2/rocketmq/{project_id}/instances/{instance_id}/groups/{group}/clients
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID。获取方法如下:登录Kafka控制台,在Kafka实例详情页面查找实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
group |
是 |
String |
参数解释: 消费组名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
参数解释: 查询数量。 约束限制: 不涉及。 取值范围: 1~50。 默认取值: 不涉及。 |
offset |
否 |
Integer |
参数解释: 偏移量,表示从此偏移量开始查询, offset大于等于0。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
is_detail |
否 |
Boolean |
参数解释: 是否查询消费者详细列表,参数为“true”则表示查询详细列表,否则表示查询简易列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
group_name |
String |
参数解释: 消费组名称。 取值范围: 不涉及。 |
online |
Boolean |
参数解释: 消费组是否在线。 取值范围:
|
subscription_consistency |
Boolean |
参数解释: 订阅关系是否一致。 取值范围:
|
total |
Integer |
参数解释: 消费者总数。 取值范围: 不涉及。 |
next_offset |
Integer |
参数解释: 下个分页的offset。 取值范围: 不涉及。 |
previous_offset |
Integer |
参数解释: 上个分页的offset。 取值范围: 不涉及。 |
clients |
Array of ClientData objects |
参数解释: 消费者订阅详情列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
language |
String |
参数解释: 客户端语言。 取值范围: 不涉及。 |
version |
String |
参数解释: 客户端版本。 取值范围: 不涉及。 |
client_id |
String |
参数解释: 客户端ID。 取值范围: 不涉及。 |
client_addr |
String |
参数解释: 客户端地址。 取值范围: 不涉及。 |
subscriptions |
Array of Subscription objects |
参数解释: 订阅关系列表。 |
请求示例
查询指定消费组的消费者列表,查询数量为10,从offset=0开始查询。
GET https://{endpoint}/v2/rocketmq/{project_id}/instances/{instance_id}/groups/{group}/clients?offset=0&limit=10&is_detail=true
响应示例
状态码:200
查询消费者订阅详情成功。
{ "group_name" : "test", "online" : true, "subscription_consistency" : true, "total" : 1, "next_offset" : -1, "previous_offset" : -1, "clients" : [ { "client_id" : "192.168.0.1@consumer1", "language" : "JAVA", "version" : "V4_8_0", "client_addr" : "192.168.0.1:65233", "subscriptions" : [ { "topic" : "topicA", "type" : "TAG", "expression" : "tagA" } ] } ] }
SDK代码示例
SDK代码示例如下。
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 |
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 ShowConsumerConnectionsSolution { 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(); ShowConsumerConnectionsRequest request = new ShowConsumerConnectionsRequest(); request.withInstanceId("{instance_id}"); request.withGroup("{group}"); try { ShowConsumerConnectionsResponse response = client.showConsumerConnections(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 |
# 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 = ShowConsumerConnectionsRequest() request.instance_id = "{instance_id}" request.group = "{group}" response = client.show_consumer_connections(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 |
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.ShowConsumerConnectionsRequest{} request.InstanceId = "{instance_id}" request.Group = "{group}" response, err := client.ShowConsumerConnections(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询消费者订阅详情成功。 |
错误码
请参见错误码。