# 查询消费者列表 - ShowConsumerConnections #### 功能介绍 查询消费组内消费者列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hrm/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hrm/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dms:group:get | Read | rocketmq | - g:ResourceTag/\ - g:EnterpriseProjectId | dms:instance:get | - | | dms:group:get | Read | consumerGroup \* | - | dms:instance:get | - | #### URI GET /v2/rocketmq/{project_id}/instances/{instance_id}/groups/{group}/clients 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-hrm/hrm-api-0011.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID。获取方法如下：调用"查询所有实例列表"接口，从响应体中获取实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | group | 是 | String | **参数解释**： 消费组名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释**： 查询数量。 **约束限制**： 不涉及。 **取值范围**： 1\~50。 **默认取值**： 10。 | | offset | 否 | Integer | **参数解释**： 偏移量，表示从此偏移量开始查询。 **约束限制**： 不涉及。 **取值范围**： 大于等于0。 **默认取值**： 0。 | | is_detail | 否 | Boolean | **参数解释**： 是否查询消费者详细列表，参数为"true"则表示查询详细列表，否则表示查询简易列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | group_name | String | **参数解释**： 消费组名称。 **取值范围**： 不涉及。 | | online | Boolean | **参数解释**： 消费组是否在线。 **取值范围**： - true：在线。 - false：不在线。 | | subscription_consistency | Boolean | **参数解释**： 订阅关系是否一致。 **取值范围**： - true：一致。 - false：不一致。 | | total | Integer | **参数解释**： 消费者总数。 **取值范围**： 不涉及。 | | next_offset | Integer | **参数解释**： 下个分页的offset。 **取值范围**： 不涉及。 | | previous_offset | Integer | **参数解释**： 上个分页的offset。 **取值范围**： 不涉及。 | | clients | Array of [ClientData] objects | **参数解释**： 消费者订阅详情列表。 **取值范围**： 不涉及。 | 表4ClientData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | language | String | **参数解释**： 客户端语言。 **取值范围**： 不涉及。 | | version | String | **参数解释**： 客户端版本。 **取值范围**： 不涉及。 | | client_id | String | **参数解释**： 客户端ID。 **取值范围**： 不涉及。 | | client_addr | String | **参数解释**： 客户端地址。 **取值范围**： 不涉及。 | | consume_type | String | **参数解释**： 消费类型。 **取值范围**： - CONSUME_POP：POP消费模式。 - CONSUME_PASSIVELY：推消费模式。 - CONSUME_ACTIVELY：拉消费模式。 | | subscriptions | Array of [Subscription] objects | **参数解释**： 订阅关系列表。 **取值范围**： 不涉及。 | 表5Subscription | 参数 | 参数类型 | 描述 | |:---|:---|:---| | topic | String | **参数解释**： 订阅的Topic名称。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 订阅类型。 **取值范围**： - TAG：基于TAG进行订阅。 - SQL92：基于消息属性进行复杂条件过滤的订阅。 | | expression | String | 订阅tag字符。 | #### 请求示例 查询指定消费组的消费者列表，查询数量为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", "consume_type" : "CONSUME_PASSIVELY", "subscriptions" : [ { "topic" : "topicA", "type" : "TAG", "expression" : "tagA" } ] } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := rocketmq.RocketMQClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := rocketmq.NewRocketMQClient(hcClient) 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](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/sdk?api=ShowConsumerConnections)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询消费者列表成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hrm/ErrorCode.html)。