You can call this operation to query all your group IDs in the target region.

OnsMqttGroupIdList is typically used to manage all your group IDs. You can obtain the group ID list and then query the data about a single group ID.

Debugging

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

Request parameters

Parameter Type Required Example Description
Action String Yes OnsMqttGroupIdList

The operation that you want to perform. Set the value to OnsMqttGroupIdList.

InstanceId String No post-cn-0pp12gl****

The ID of the MQTT instance to which the group ID you want to query belongs. This parameter is required for instances with separate namespaces.

Response parameters

Parameter Type Example Description
Data

The structure of the group ID information.

MqttGroupIdDo

The structure of the detailed group ID information.

CreateTime Long 1555293113000

The time when the group ID was created, in the timestamp format. Unit: millisecond.

GroupId String GID_test

GID

Id Long 51013

The data entry ID.

IndependentNaming Boolean true

Indicates whether the MQTT instance to which the current group ID belongs has a separate namespace. Valid values:

  • true: The MQTT instance has a separate namespace. A resource name must be unique within the same instance but can be duplicated across instances.
  • false: The MQTT instance does not have a separate namespace. Resource names must be globally unique both within an instance and across instances.
InstanceId String post-cn-0pp12gl****

The ID of the MQTT instance to which the current group ID belongs.

UpdateTime Long 1555293113000

The last time when the group ID was updated, in the timestamp format. Unit: millisecond.

RequestId String BC0DF068-D028-4C85-8C23-53E2C3A12599

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

Examples

Sample request


http(s)://[Endpoint]/? Action=OnsMqttGroupIdList
&InstanceId=post-cn-0pp12gl****
&<Common request parameters>

Sample success response

XML format

<OnsMqttGroupIdListResponse>
  <Data>
        <MqttGroupIdDo>
              <IndependentNaming>true</IndependentNaming>
              <InstanceId>post-cn-0pp12gl****</InstanceId>
              <CreateTime>1555293113000</CreateTime>
              <UpdateTime>1555293113000</UpdateTime>
              <Id>51013</Id>
              <GroupId>GID_test</GroupId>
        </MqttGroupIdDo>
  </Data>
  <RequestId>BC0DF068-D028-4C85-8C23-53E2C3A12599</RequestId>
</OnsMqttGroupIdListResponse>

JSON format

{
	"Data":{
		"MqttGroupIdDo":[
			{
				"IndependentNaming":true,
				"CreateTime":1555293113000,
				"InstanceId":"post-cn-0pp12gl****",
				"UpdateTime":1555293113000,
				"Id":51013,
				"GroupId":"GID_test"
			}
		]
	},
	"RequestId":"BC0DF068-D028-4C85-8C23-53E2C3A12599"
}

Error codes

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