调用 ListGroupId 查看某实例下的所有 Group ID。

说明 每成功调用一次 ListGroupId 接口,都会计算为一次消息 TPS,从而影响您的计费。详情请参见计费说明

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListGroupId

系统规定参数。取值:ListGroupId

InstanceId String mqtt-cn-0pp1ldu****

需查询的 Group ID 列表的实例的 ID。

说明 更多参数说明请参见公共参数服务接入点

返回数据

名称 类型 示例值 描述
Data Array of MqttGroupIdDo

所查询的 Group ID 的详细信息。

CreateTime Long 1564577317000

该 Group ID 的创建时间。

GroupId String GID_test1

查询到的属于该实例的 Group ID。

IndependentNaming Boolean true

该实例是否有独立命名空间。取值如下:

  • true:有独立命名空间,该实例下的资源需保证命名唯一,跨实例可重名。
  • false:无独立命名空间,该实例下的资源需保证全局命名唯一,跨实例不可重名。
InstanceId String post-cn-45910tj****

查询的 Group ID 所属实例的 ID。

UpdateTime Long 1564577317000

该 Group ID 的最近一次更新时间。

RequestId String 95996EEB-D894-44FA-A87C-940F5CD9****

公共参数,每个请求的 ID 都是唯一的。

示例

请求示例

http(s)://onsmqtt.cn-hangzhou.aliyuncs.com/?Action=ListGroupId
&InstanceId=mqtt-cn-0pp1ldu****
&<公共请求参数>

正常返回示例

XML 格式

<ListGroupIdResponse>
  <RequestId>95996EEB-D894-44FA-A87C-940F5CD9****</RequestId>
  <Data>
        <InstanceId>post-cn-45910tj****</InstanceId>
        <CreateTime>1564577317000</CreateTime>
        <UpdateTime>1564577317000</UpdateTime>
        <IndependentNaming>true</IndependentNaming>
        <GroupId>GID_test2</GroupId>
  </Data>
  <Data>
        <InstanceId>post-cn-45910tj****</InstanceId>
        <CreateTime>1563200655000</CreateTime>
        <UpdateTime>1563200655000</UpdateTime>
        <IndependentNaming>true</IndependentNaming>
        <GroupId>GID_test1</GroupId>
  </Data>
</ListGroupIdResponse>

JSON 格式

{
  "RequestId": "95996EEB-D894-44FA-A87C-940F5CD9****",
  "Data": [
    {
      "InstanceId": "post-cn-45910tj****",
      "CreateTime": 1564577317000,
      "UpdateTime": 1564577317000,
      "IndependentNaming": true,
      "GroupId": "GID_test2"
    },
    {
      "InstanceId": "post-cn-45910tj****",
      "CreateTime": 1563200655000,
      "UpdateTime": 1563200655000,
      "IndependentNaming": true,
      "GroupId": "GID_test1"
    }
  ]
}

错误码

HttpCode 错误码 错误信息 描述
400 ParameterFieldCheckFailed Failed to validate the parameters. The parameters may be missing or invalid. 参数校验失败,可能缺失或者传入值非法。
500 InternalError An error occurred while processing your request. Try again later. MQTT 后端服务异常,请重试。
400 InstancePermissionCheckFailed An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings. 实例权限校验失败,请确认 MQTT 实例的所属关系以及授权策略。
400 InstanceNotFound Failed to find the instance. The instanceId may be invalid. 无法找到实例。
400 PermissionCheckFailed An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings. 资源权限校验失败,请检查实例、Topic 和 Group ID 的所属权限和授权策略。

访问错误中心查看更多错误码。