调用ListGroupId查看某实例下的所有GroupID_云消息队列 MQTT 版(MQTT )-阿里云帮助中心

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

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	ListGroupId	系统规定参数。取值：ListGroupId。
InstanceId	String	是	mqtt-cn-0pp1ldu****	需查询的Group ID列表的实例的ID。

说明更多参数说明请参见公共参数和调用方式。

返回数据


名称	类型	示例值	描述
Data	Array		所查询的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-940F5CD97E6A	公共参数，每个请求的ID都是唯一的。

示例

请求示例

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

正常返回示例

XML格式

<ListGroupIdResponse>
  <RequestId>95996EEB-D894-44FA-A87C-940F5CD97E6A</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-940F5CD97E6A",
  "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的所属权限和授权策略。

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