You can call this operation to query all Group IDs of the specified instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListGroupId

The operation that you want to perform. Value: ListGroupId

InstanceId String Yes mqtt-cn-0pp1ldu automatic snapshot policies *

The ID of the instance to which the Group ID you want to query belongs.

Response parameters

Parameter Type Example Description
Data Array

The details of the Group ID to be queried.

CreateTime Long 1564577317000

The time when the Group ID was created.

GroupId String GID_test1

The Group IDs of the queried instances.

IndependentNaming Boolean true

Indicates whether the instance has a separate namespace. Valid values:

  • True: The instance has a separate namespace. The names of resources under this instance must be unique. The resources can be duplicated across instances.
  • False the instance has no separate namespace. The names of resources in the instance must be unique and cannot be duplicated across instances.
InstanceId String post-cn-45910tj automatic snapshot policies *

The ID of the instance to which the Group ID belongs.

UpdateTime Long 1564577317000

The time when the Group ID was last updated.

RequestId String 95996 EEB-D894-44FA-A87C-940F5CD97E6A

The ID of the request, which is a common parameter. Each request has a unique ID to facilitate troubleshooting and fault locating.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ListGroupId
&InstanceId=mqtt-cn-0pp1ldu static website hosting *
&<Common request parameters>

Sample success responses

XML format

<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 format

{
  "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"
    }
  ]
}

Error codes

HTTP status code Error code Error message Description 
400 ParameterFieldCheckFailed Failed to validate the parameters. The parameters may be missing or invalid. Parameter verification failed because it may be missing or invalid.
500 InternalError An error occurred while processing your request. Try again later. The MQTT backend service is abnormal. Please try again.
400 InstancePermissionCheckFailed An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings. The error message returned because the instance permission verification fails. Check the ownership and authorization policy of the MQTT instance.
400 InstanceNotFound Failed to find the instance. The instanceId may be invalid. Troubleshoot if you cannot find the instance
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. Failed to obtain the resource permission. Check the permission and authorization policy of the instance, Topic, and GroupId.

For a list of error codes, visit the API Error Center.