调用ListInstances API查询实例列表-云消息队列 MQTT 版-阿里云

查询实例列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Tags	string	否	json 格式的资源标签列表。	[{"key":"test","value":"test"}]

返回参数

名称	类型	描述	示例值
	object	返回对象。
RequestId	string	Id of the request	294F5B26-FADF-41D0-BE68-14ABE4EB****
Code	string	响应 code。	200
Message	string	信息。	operation success.
Success	string	请求是否成功。	true
Instances	array<object>	实例列表。
	array<object>	实例对象。
InstanceId	string	实例 Id	mqtt-cn-xxxxxxx
InstanceName	string	实例名称。	mqtt-cn-xxxxxxx
InstanceStatus	integer	实例状态。 0：准备中。 5：服务中。 7：升级中。 15：冻结中。 10：已释放。 1：未开通。 2：欠费。 3：欠费超期。	5
InstanceType	integer	实例类型： 0：基础版。 1：铂金版。 2：按量付费。 3：预付费轻量实例。 4：专业版。 5：Serverless 版。	4
Specific	string	专业版实例规格。	mqtt.p2.1xlarge
RegionId	string	地域 ID。	cn-shenzhen
CreateTime	integer	实例的创建时间。	1739345768000
ExpireTime	integer	实例到期时间。	1741795200000
KernelVersion	string	内核版本	V3.3.0
MqttTags	array<object>	标签列表。
	object	标签对象。
TagKey	string	标签键。	test
TagValue	string	标签值。	test
OrderId	string	订单 id。	245949616640095

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	MqttOwnerCheckError	Failed to validate the instance permission	实例权限校验失败
400	ServiceUnable	The current user has not activated the ONS service. Please activate the service first.	当前用户未开通ONS服务，请先开通ONS服务，谢谢。
403	PermissionCheckFailed	Failed to verify API permissions.	ram权限检查失败

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

变更历史

更多信息，参考变更详情。