使用 OnsGroupList 展示您的 Group ID 资源的列表,并不用于具体的信息查询。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | OnsGroupList |
系统规定参数。取值:OnsGroupList。 |
InstanceId | String | 是 | MQ_INST_111111111111_DOxxxxxx |
需获取资源列表的 Group ID 所对应的实例 ID。 |
Tag.N.Key | String | 是 | CartService |
资源的标签键。
|
Tag.N.Value | String | 是 | ServiceA |
资源的标签值。
|
GroupId | String | 否 | GID_test_group_id |
查询指定 Group ID 时设置,否则查询所有 Group ID。 |
GroupType | String | 否 | tcp |
查询的 Group ID 适用的协议。TCP 协议和 HTTP 协议的 Group ID 不可以共用,需要分别创建。取值说明如下:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Array |
查询到的订阅关系集合。 |
|
SubscribeInfoDo | |||
CreateTime | Long | 1568896605000 |
Group ID 的创建时间。 |
GroupId | String | GID_test_group_id |
消费集群组 ID。 |
GroupType | String | tcp |
查询的 Group ID 适用的协议。TCP 协议和 HTTP 协议的 Group ID 不可以共用,需要分别创建。取值说明如下:
|
IndependentNaming | Boolean | true |
实例是否有命名空间。取值说明如下:
|
InstanceId | String | MQ_INST_111111111111_DOxxxxxx |
实例 ID。 |
Owner | String | 138015630679**** |
该发布信息的拥有者。 |
Remark | String | test |
备注。 |
Tags | Array |
Group ID 所绑定的标签。 |
|
Tag | |||
Key | String | CartService |
标签键。 |
Value | String | ServiceA |
标签值。 |
UpdateTime | Long | 1570700979000 |
该 Group ID 的更新时间。 |
RequestId | String | 16996623-AC4A-43AF-9248-FD9D2D75C8E8 |
为公共参数,每个请求的 ID 都是唯一的。 |
示例
请求示例
http(s)://[Endpoint]/?Action=OnsGroupList
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&Tag.1.Key=CartService
&Tag.1.Value=ServiceA
&<公共请求参数>
正常返回示例
XML
格式
<OnsGroupListResponse>
<RequestId>16996623-AC4A-43AF-9248-FD9D2D75C8E8</RequestId>
<Data>
<SubscribeInfoDo>
<Owner>138015630679****</Owner>
<GroupType>tcp</GroupType>
<InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>
<CreateTime>1568896605000</CreateTime>
<UpdateTime>1570700979000</UpdateTime>
<IndependentNaming>true</IndependentNaming>
<GroupId>GID_test_group_id</GroupId>
<Remark>test</Remark>
<Tags>
<Tag>
<Value>ServiceA</Value>
<Key>CartService</Key>
</Tag>
</Tags>
</SubscribeInfoDo>
</Data>
</OnsGroupListResponse>
JSON
格式
{
"RequestId": "16996623-AC4A-43AF-9248-FD9D2D75C8E8",
"Data": {
"SubscribeInfoDo": [
{
"Owner": "138015630679****",
"GroupType": "tcp",
"InstanceId": "MQ_INST_111111111111_DOxxxxxx",
"CreateTime": 1568896605000,
"UpdateTime": 1570700979000,
"IndependentNaming": true,
"GroupId": "GID_test_group_id",
"Remark": "test",
"Tags": {
"Tag": [
{
"Value": "ServiceA",
"Key": "CartService"
}
]
}
}
]
}
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交