You need to enable JavaScript to run this app.
导航
消息队列 RabbitMQ版
  • 文档首页
    • /
  • 消息队列 RabbitMQ版

DescribeInstances

最近更新时间：2024.02.23 15:26:18

首次发布时间：2023.05.19 15:47:10

我的收藏

调用 DescribeInstances 接口获取当前账户下的实例列表。

注意事项

请求频率：该接口请求频率限制为 20 次/秒；单用户请求频率限制为 4 次/秒。

使用说明

DescribeInstances 是分页式的查询接口，返回符合筛选条件的 RabbitMQ 实例列表及概览信息。如需获取指定 RabbitMQ 实例的详细信息，可以指定实例 ID 进行查询，或直接使用 DescribeInstanceDetail 接口。

请求参数

参数

参数类型

是否必选

示例值

说明

PageSize

Integer

是

10

查询结果分页展示时，此参数用于表示每页的数据量。取值范围为1~100。

PageNumber

Integer

是

1

查询结果分页展示时，此参数用于表示页码。支持的最小值为1。

InstanceId

String

否

rbtmq-5b293870****

实例 ID。指定实例 ID 时，表示查看指定实例的信息，此时InstanceName 等其他筛选项不生效。支持模糊匹配。

InstanceName

String

否

myinstance

实例名称。模糊匹配。

InstanceStatus

String

否

Running

实例当前的状态。精确查询。

VpcId

String

否

myvpc

实例所在的 VPC 名称。模糊匹配。

ZoneId

String

否

cn-beijing-a

实例所在的可用区 ID。模糊匹配。

ChargeType

String

否

PostPaid

实例的付费类型。精确查询。支持设置为：

  • PostPaid：按量付费
  • PrePaid：包年包月

Spec

String

否

rabbitmq.n3.x2.medium

实例的计算规格。精确查询。
消息队列 RabbitMQ版实例提供的计算规格清单，请参考产品规格。

Tags

Map<String, Array of String>

否

{ "tag-wzx" : ["11"] }

根据实例的标签进行筛选。

ProjectName

String

否

default

根据实例所属的 IAM 项目进行筛选。不指定此参数时，返回该操作账号具备查看权限的实例列表。

响应参数

参数

参数类型

示例值

说明

Total

Integer

1

实例总数。

InstancesInfo

Array of BasicInstanceInfoObject

实例的名称、版本等基本信息。详细信息请参考BasicInstanceInfoObject。

示例

请求示例

POST https://rabbitmq.volcengineapi.com/?Action=DescribeInstances&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rabbitmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/rabbitmq/request, SignedHeaders=x-date, Signature=********

{
    "PageSize":10,
    "PageNumber":1
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230217143155B04E2C25D739C689****",
        "Action": "DescribeInstances",
        "Version": "2022-01-01",
        "Service": "RabbitMQ",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstancesInfo": [
            {
                "ArchType": "Cluster",
                "ChargeDetail": {
                    "ChargeEndTime": "1970-01-01 08:00:00 +0800 CST",
                    "ChargeStartTime": "2022-05-31 18:47:38 +0800 CST",
                    "ChargeStatus": "Normal",
                    "ChargeType": "PostPaid"
                },
                "ComputeSpec": "rabbitmq.n3.x2.medium",
                "CreateTime": "1653994058",
                "InstanceDescription": "",
                "InstanceId": "rbtmq-928c0619****",
                "InstanceName": "勿删",
                "InstanceStatus": "Running",
                "ProjectName": "default",
                "RegionDescription": "",
                "RegionId": "cn-beijing",
                "StorageSpace": 500,
                "SubnetId": "subnet-13fvfm1q5rpq83n6nu5ep****",
                "UsedStorageSpace": 11,
                "Version": "3.8.18",
                "VpcId": "vpc-rs5811nceqyov0x58x4****",
                "ZoneDescription": "华北2（北京）-可用区A",
                "ZoneId": "cn-beijing-a"
            },
            {
                "ArchType": "Cluster",
                "ChargeDetail": {
                    "ChargeEndTime": "1970-01-01 08:00:00 +0800 CST",
                    "ChargeStartTime": "2022-06-29 11:10:05 +0800 CST",
                    "ChargeStatus": "Normal",
                    "ChargeType": "PostPaid"
                },
                "ComputeSpec": "rabbitmq.n3.x2.medium",
                "CreateTime": "1656472205",
                "InstanceDescription": "",
                "InstanceId": "rbtmq-5b293870****",
                "InstanceName": "勿删-azB",
                "InstanceStatus": "Running",
                "ProjectName": "default",
                "RegionDescription": "",
                "RegionId": "cn-beijing",
                "StorageSpace": 1000,
                "SubnetId": "subnet-rs302h1mqrr4v0x57kq****",
                "TagMap": {
                    "勿删-wzy": "123123"
                },
                "UsedStorageSpace": 19,
                "Version": "3.8.18",
                "VpcId": "vpc-rs5811nceqyov0x58x4****",
                "ZoneDescription": "华北2（北京）-可用区B",
                "ZoneId": "cn-beijing-b"
            }
        ],
        "Total": 2
    }
}