ListInstances - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

You can call this operation to query a list of instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Tags	string	No	A list of resource tags in JSON format.	[{"key":"test","value":"test"}]

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The ID of the request.	294F5B26-FADF-41D0-BE68-14ABE4EB****
Code	string	The response code.	200
Message	string	The returned message.	operation success.
Success	string	Indicates whether the request was successful.	true
Instances	array<object>	The list of instances.
	array<object>	The instance object.
InstanceId	string	The instance ID.	mqtt-cn-xxxxxxx
InstanceName	string	The instance name.	mqtt-cn-xxxxxxx
InstanceStatus	integer	The instance status. 0: Preparing 5: In Service 7: Upgrading 15: Frozen 10: Released 1: Not Activated 2: Overdue 3: Expired	5
InstanceType	integer	The instance type: 0: Basic Edition 1: Platinum Edition 2: Pay-as-you-go 3: Subscription Lightweight 4: Professional Edition 5: Serverless Edition	4
Specific	string	The instance type of the Professional Edition instance.	mqtt.p2.1xlarge
RegionId	string	The region ID.	cn-shenzhen
CreateTime	integer	The time when the instance was created.	1739345768000
ExpireTime	integer	The expiration time of the instance.	1741795200000
KernelVersion	string	The Milvus version.	V3.3.0
MqttTags	array<object>	The list of tags.
	object	The tag object.
TagKey	string	The tag key.	test
TagValue	string	The tag value.	test
OrderId	string	The order ID.	245949616640095

Examples

Success response

JSON format

{
  "RequestId": "294F5B26-FADF-41D0-BE68-14ABE4EB****",
  "Code": "200",
  "Message": "operation success.",
  "Success": "true",
  "Instances": [
    {
      "InstanceId": "mqtt-cn-xxxxxxx",
      "InstanceName": "mqtt-cn-xxxxxxx",
      "InstanceStatus": 5,
      "InstanceType": 4,
      "Specific": "mqtt.p2.1xlarge",
      "RegionId": "cn-shenzhen",
      "CreateTime": 1739345768000,
      "ExpireTime": 1741795200000,
      "KernelVersion": "V3.3.0",
      "MqttTags": [
        {
          "TagKey": "test",
          "TagValue": "test"
        }
      ],
      "OrderId": "245949616640095"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	MqttOwnerCheckError	Failed to validate the instance permission
400	ServiceUnable	The current user has not activated the ONS service. Please activate the service first.	The current user has not activated the ONS service. Please activate the ONS service first. Thank you.
403	PermissionCheckFailed	Failed to verify API permissions.	ram permission check failed

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.