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

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

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
mq:ListMqttGroupId	get	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	需查询的 Group ID 列表的实例的 ID。	mqtt-cn-0pp1ldu****

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

返回参数

名称	类型	描述	示例值
	object
RequestId	string	公共参数，每个请求的 ID 都是唯一的。	95996EEB-D894-44FA-A87C-940F5CD9****
Data	array<object>	所查询的 Group ID 的详细信息。
MqttGroupIdDo	object
UpdateTime	long	该 Group ID 的最近一次更新时间。	1564577317000
InstanceId	string	查询的 Group ID 所属实例的 ID。	post-cn-45910tj****
IndependentNaming	boolean	该实例是否有独立命名空间。取值如下： true：有独立命名空间，该实例下的资源需保证命名唯一，跨实例可重名。 false：无独立命名空间，该实例下的资源需保证全局命名唯一，跨实例不可重名。	true
GroupId	string	查询到的属于该实例的 Group ID。	GID_test1
CreateTime	long	该 Group ID 的创建时间。	1564577317000

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	ParameterFieldCheckFailed	Failed to validate the parameters. The parameters may be missing or invalid.	参数校验失败，可能缺失或者传入值非法。
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的所属权限和授权策略。
500	InternalError	An error occurred while processing your request. Try again later.	MQTT后端服务异常，请重试。

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

变更历史

变更时间	变更内容概要	操作
2025-03-31	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情