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

DescribeInstances

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

首次发布时间：2021.08.30 16:33:47

我的收藏

调用接口 DescribeInstances 查看当前账号在指定地域下的所有 RabbitMQ 实例信息。

注意事项

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

请求参数

参数

参数类型

是否必选

示例值

说明

Region

String

必选

cn-beijing

地域 ID。

PageNumber

Integer

必选

1

实例列表的页码。

PageSize

Integer

必选

10

实例列表中每一页的条目数量。

OrderBy

String

必选

列表排序方式。支持根据以下方式排序：

  • Name：实例名称。
  • CreatedTime：创建时间。
  • Status：实例状态。

SortAsc

Bool

必选

true

是否使用升序排列方式。

  • true：升序排列。
  • false：降序排列。

响应参数

参数

参数类型

说明

Total

Integer

实例总数。

Instances

Array of Instance

实例信息。详细信息请参考 Instance。

示例

请求示例

POST https://rabbitmq.volcengineapi.com/?Action=DescribeInstances&Version=2018-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=********

{
  "Region": "cn-beijing",
  "PageNumber": 1,
  "PageSize": 10,
  "OrderBy": "Name",
  "SortAsc": true
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2022080315280601021114604610E3****",
        "Action": "DescribeInstances",
        "Version": "2018-01-01",
        "Service": "RabbitMQ",
        "Region": "cn-beijing"
    },
    "Result": {
        "Instances": [
            {
                "ArchType": "Cluster",
                "ChargeStatus": "Normal",
                "ChargeType": "PostPaid",
                "ComputeResource": "rabbitmq.n3.x2.medium",
                "CreatedTime": 1653994058,
                "InstanceId": "rbtmq-928c0619****",
                "InstanceName": "azA",
                "InstanceStatus": "Running",
                "OverdueTime": 0,
                "PeriodUnit": "Monthly",
                "ProjectName": "default",
                "Region": {
                    "Description": "华北2（北京）",
                    "Name": "cn-beijing"
                },
                "StorageCapacity": 300,
                "StorageType": "CloudSSD",
                "SubnetId": "subnet-13fvfm1q5rpq83n6nu5ep****",
                "UsedStorage": 6,
                "Version": {
                    "MajorVersion": 3,
                    "MinorVersion": 8,
                    "PatchVersion": 18
                },
                "VpcId": "vpc-rs5811nceqyov0x58x4****",
                "Zone": {
                    "Description": "华北2（北京）-可用区A",
                    "Name": "cn-beijing-a"
                }
            }
        ],
        "Total": 1
    }
}