ListInstances - 查询实例列表_云消息队列 MQTT 版(MQTT)-阿里云帮助中心

查询实例列表。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mq:ListMqttInstance

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
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>	实例列表。
	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	实例权限校验失败

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

变更历史

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