ListGroupId - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

Queries all groups on an ApsaraMQ for MQTT instance.

Operation description

Each successful call to the ListGroupId operation increases the messaging transactions per second (TPS) by one. This affects the billing of your instance. For more information, see Billing rules.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the ApsaraMQ for MQTT instance whose groups you want to query.	mqtt-cn-0pp1ldu****

Note For information about other parameters, see Common parameters and Endpoints .

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID. This parameter is a common parameter.	95996EEB-D894-44FA-A87C-940F5CD9****
Data	array<object>	The details of a queried group.
	object
UpdateTime	long	The time when the group was last updated.	1564577317000
InstanceId	string	The ID of the ApsaraMQ for MQTT instance to which the group belongs.	post-cn-45910tj****
IndependentNaming	boolean	Indicates whether a separate namespace is configured for the ApsaraMQ for MQTT instance. Valid values: true: A separate namespace is configured for the ApsaraMQ for MQTT instance. Resource names must be unique within an ApsaraMQ for MQTT instance but can be the same across ApsaraMQ for MQTT instances. false: No separate namespace is configured for the ApsaraMQ for MQTT instance. Resource names must be globally unique within an ApsaraMQ for MQTT instance and across ApsaraMQ for MQTT instances.	true
GroupId	string	The queried group that belongs to the ApsaraMQ for MQTT instance.	GID_test1
CreateTime	long	The time when the group was created.	1564577317000

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
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.
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.
500	InternalError	An error occurred while processing your request. Try again later.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history