全部产品
Search

搜索本产品

    云消息队列 RocketMQ 版：ListInstances - 查询实例列表

    文档中心

    云消息队列 RocketMQ 版：ListInstances - 查询实例列表

    更新时间：Sep 24, 2024

    查询指定地域下，所有的云消息队列 RocketMQ 版实例的列表信息。

    接口说明

    注意 阿里云提供的 OpenAPI 属于管控类 API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖 OpenAPI 实现，否则可能会导致链路产生风险。

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    rocketmq:ListInstanceslist
    • Instance
      acs:rocketmq:{#regionId}:{#accountId}:instance/*
      无
    		无

    请求语法

    GET /instances HTTP/1.1

    请求参数

    名称类型必填描述示例值
    filterstring否

    查询的过滤条件，若不输入则查询所有实例。

    		rmq-cn-7e22ody****
    pageNumberinteger否

    分页页码，查询第几页的返回结果。

    取值范围：1~100000000。

    若您设置的参数值小于 1，则系统默认按照参数值为 1 处理；若您设置的参数值大于 100000000，则系统默认按照参数值为 100000000 处理。

    		1
    pageSizeinteger否

    分页大小，每页最多显示的返回结果数量。

    取值范围：10~200。

    若您设置的参数值小于 10，则系统默认按照参数值为 10 处理；若您设置的参数值大于 200，则系统默认按照参数值为 200 处理。

    		10
    resourceGroupIdstring否

    实例所属的资源组 ID。

    		rg-acfmx7caj******
    tagsstring否

    资源标签列表，用于筛选实例。

    		[{"key": "rmq-test", "value": "test"}]
    seriesCodesarray否

    实例的主系列编码。

    参数取值如下：

    • standard：标准版
    • ultimate：铂金版
    • professional：专业版
    string否

    实例的主系列编码。

    		standard

    返回参数

    名称类型描述示例值
    object

    Result<MyPage>

    requestIdstring

    请求 ID，每个请求的 ID 都是唯一的，可用于排查和定位问题。

    		84445A20-2B50-5306-A3C0-AF99FC1833C6
    successboolean

    执行结果是否成功。

    		true
    dataobject

    返回结果。

    pageNumberlong

    当前页码。

    		1
    pageSizelong

    分页大小。

    		10
    totalCountlong

    返回结果的总数量。

    		100
    listarray<object>

    分页数据。

    listobject
    regionIdstring

    实例所属的地域 ID。

    		cn-hangzhou
    instanceIdstring

    实例 ID。

    		rmq-cn-7e22ody****
    instanceNamestring

    实例名称。

    		test instance
    statusstring

    实例状态。

    参数取值如下：

    • RELEASED（已释放）
    • RUNNING（运行中）
    • STOPPED（已停服）
    • CHANGING（变更中）
    • CREATING（创建中）
    		RUNNING
    startTimestring

    实例的创建时间。

    		2022-08-01 00:00:00
    expireTimestring

    实例的到期时间。

    		2022-09-01 00:00:00
    releaseTimestring

    实例的释放时间。

    		2022-09-07 00:00:00
    userIdstring

    实例所属的用户 ID。

    		6W0xz2uPfiwp****
    commodityCodestring

    消息队列 RocketMQ 5.x 系列实例的商品代号，类似于 ons_rmqsub_public_cn。

    		ons_rmqsub_public_cn
    serviceCodestring

    实例所属的服务编码。消息队列 RocketMQ 版的服务编码为 rmq。

    		rmq
    seriesCodestring

    实例的主系列编码。

    参数取值如下：

    • standard：标准版
    • ultimate：铂金版
    • professional：专业版
    		standard
    subSeriesCodestring

    实例的子系列编码。

    参数取值如下：

    • cluster_ha：集群高可用版
    • single_node：单节点版
    		cluster_ha
    paymentTypestring

    实例的付费类型。

    参数取值如下：

    • PayAsYouGo：按量付费（后付费）
    • Subscription：包年包月（预付费）
    		Subscription
    remarkstring

    实例的备注信息。

    		This is remark for instance.
    topicCountlong

    实例中所创建的主题数量。

    		20
    groupCountlong

    实例中所创建的消费者分组的数量。

    		10
    createTimestring

    实例的版本更新时间。

    		2022-08-01 00:00:00
    updateTimestring

    实例的最后修改时间。

    		2022-08-02 00:00:00
    resourceGroupIdstring

    实例所属的资源组 ID。

    		rg-acfmx7caj******
    tagsarray<object>

    资源标签列表。

    tagsobject

    资源标签。

    keystring

    资源标签 key 值。

    		key
    valuestring

    资源标签 value 值。

    		value
    productInfoobject

    产品信息。

    traceOnboolean

    是否开启消息轨迹功能。

    • true：开启消息轨迹功能
    • false：关闭消息轨迹功能

    该参数暂不生效，不管参数是否开启，实例都默认支持轨迹功能。

    		true
    codestring

    错误码。

    		MissingPageNumber
    messagestring

    错误信息。

    		Parameter pageNumber is mandatory for this action .
    httpStatusCodeinteger

    HTTP 状态码。

    		400
    dynamicCodestring

    动态错误码。

    		PageNumber
    dynamicMessagestring

    动态错误信息。

    		pageNumber

    示例

    正常返回示例

    JSON格式

    {
  "requestId": "84445A20-2B50-5306-A3C0-AF99FC1833C6",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 100,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "instanceName": "test instance",
        "status": "RUNNING",
        "startTime": "2022-08-01 00:00:00",
        "expireTime": "2022-09-01 00:00:00",
        "releaseTime": "2022-09-07 00:00:00",
        "userId": "6W0xz2uPfiwp****",
        "commodityCode": "ons_rmqsub_public_cn",
        "serviceCode": "rmq",
        "seriesCode": "standard",
        "subSeriesCode": "cluster_ha",
        "paymentType": "Subscription",
        "remark": "This is remark for instance.",
        "topicCount": 20,
        "groupCount": 10,
        "createTime": "2022-08-01 00:00:00",
        "updateTime": "2022-08-02 00:00:00",
        "resourceGroupId": "rg-acfmx7caj******",
        "tags": [
          {
            "key": "key",
            "value": "value"
          }
        ],
        "productInfo": {
          "traceOn": true
        }
      }
    ]
  },
  "code": "MissingPageNumber",
  "message": "Parameter pageNumber is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "PageNumber",
  "dynamicMessage": "pageNumber"
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-05-31API 内部配置变更，不影响调用查看变更详情
    2023-10-09OpenAPI 返回结构发生变更查看变更详情
    2023-08-02OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-05-08API 内部配置变更，不影响调用查看变更详情
    2023-03-14API 内部配置变更，不影响调用查看变更详情