调用OnsGroupSubDetail查看Group订阅了哪些Topic。
使用说明
该接口用于查询Group ID和Topic之间的订阅关系。如果Group ID对应的消费者实例不在线则查不到数据。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
授权信息
默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息,请参见权限策略和示例。
API |
Action |
Resource(有命名空间) |
Resource(无命名空间) |
---|---|---|---|
OnsGroupSubDetail |
mq:QueryInstanceBaseInfo mq:QueryGroupSubDetail |
acs:mq:*:*:{instanceId}%{groupId} |
acs:mq:*:*:{groupId} |
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | OnsGroupSubDetail |
系统规定参数。取值:OnsGroupSubDetail。 |
InstanceId | String | 是 | MQ_INST_111111111111_DOxxxxxx |
需查询的Group ID所属的实例ID。 |
GroupId | String | 是 | GID_test_group_id |
需查询的Group ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 3364E875-013B-442A-BC3C-C1A84DC6**** |
公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。 |
Data | Object |
返回Data对象。 |
|
SubscriptionDataList | Array of SubscriptionDataList |
如果Group ID所对应的消费者不在线则查不到数据。 |
|
SubscriptionDataList | |||
SubString | String | * |
订阅表达式。 |
Topic | String | test-mq_topic |
订阅的Topic。 |
GroupId | String | GID_test_group_id |
需查询的Group ID。 |
MessageModel | String | CLUSTERING |
消费模式。取值说明如下:
消费模式的更多信息,请参见集群消费和广播消费。 |
Online | Boolean | true |
消费者是否在线。 |
示例
请求示例
http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsGroupSubDetail
&GroupId=GID_test_group_id
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<OnsGroupSubDetailResponse>
<Data>
<MessageModel>CLUSTERING</MessageModel>
<Online>true</Online>
<SubscriptionDataList>
<SubscriptionDataList>
<SubString>*</SubString>
<Topic>test-mq_topic</Topic>
</SubscriptionDataList>
</SubscriptionDataList>
<GroupId>GID_test_group_id</GroupId>
</Data>
<RequestId>3364E875-013B-442A-BC3C-C1A84DC6****</RequestId>
</OnsGroupSubDetailResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Data" : {
"MessageModel" : "CLUSTERING",
"Online" : true,
"SubscriptionDataList" : {
"SubscriptionDataList" : [ {
"SubString" : "*",
"Topic" : "test-mq_topic"
} ]
},
"GroupId" : "GID_test_group_id"
},
"RequestId" : "3364E875-013B-442A-BC3C-C1A84DC6****"
}
错误码
访问错误中心查看更多错误码。
控制台操作
除了调用OnsGroupSubDetail接口,您还可以通过消息队列RocketMQ版控制台查看Topic和Group的订阅关系。具体操作,请参见查看订阅关系。