使用 OnsMqttGroupIdList 查询目标地域(Region)里您所有的 Group ID(GID)。
OnsMqttGroupIdList 接口一般用于管理您所有的 GID 的场景。您可先获取 GID 列表,然后查询单个 GID 的相关数据。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | OnsMqttGroupIdList |
系统规定参数。取值:OnsMqttGroupIdList。 |
InstanceId | String | 否 | post-cn-0pp12gl**** |
需查询的 GID 的 MQTT 实例 ID。针对有独立命名空间的实例,该参数为必填。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | BC0DF068-D028-4C85-8C23-53E2C3A12599 |
为公共参数,每个请求的 ID 都是唯一的,可用于排查定位问题 |
Data | Array |
GID 信息数据结构 |
|
GroupId | String | GID_test |
GID |
CreateTime | Long | 1555293113000 |
创建时间,单位是毫秒时间戳 |
UpdateTime | Long | 1555293113000 |
最后更新时间,单位是毫秒时间戳 |
InstanceId | String | post-cn-0pp12gl**** |
当前 GID 所属的实例 ID |
IndependentNaming | Boolean | true |
当前 GID 所属实例是否有命名空间,取值说明如下:
|
示例
请求示例
http(s)://[Endpoint]/?Action=OnsMqttGroupIdList
&InstanceId=post-cn-0pp12gl****
&<公共请求参数>
正常返回示例
JSON
格式
{
"Data": {
"MqttGroupIdDo": [
{
"IndependentNaming": true,
"InstanceId": "post-cn-0pp12gl****",
"CreateTime": 1555293113000,
"UpdateTime": 1555293113000,
"GroupId": "GID_test"
}
]
},
"RequestId": "BC0DF068-D028-4C85-8C23-53E2C3A12599"
}
XML
格式
<OnsMqttGroupIdListResponse>
<Data>
<MqttGroupIdDo>
<IndependentNaming>true</IndependentNaming>
<InstanceId>post-cn-0pp12gl****</InstanceId>
<CreateTime>1555293113000</CreateTime>
<UpdateTime>1555293113000</UpdateTime>
<GroupId>GID_test</GroupId>
</MqttGroupIdDo>
</Data>
<RequestId>BC0DF068-D028-4C85-8C23-53E2C3A12599</RequestId>
</OnsMqttGroupIdListResponse>
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交