You need to enable JavaScript to run this app.
导航

ListInstances

最近更新时间2023.07.12 16:47:03

首次发布时间2021.08.30 16:57:44

调用接口 ListInstances 查看当前账号在当前地域下的所有 RocketMQ 实例信息。

请求参数

参数

参数类型

是否必选

示例值

说明

Offset

Integer

必选

0

偏移量。

Limit

Integer

必选

10

本次请求返回的条目数。取值范围为 1~50。

SortField

String

必选

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

  • Name:实例名称。
  • Protocal:协议。
  • MessageType:消息类型。
  • Status:状态。
  • TopicNum:Topic 数量。
  • GroupNum:Group 数量。
  • CreatedTime:创建时间。
  • VpcID:VPC ID。

SortOrder

String

必选

Asc

排序方式。支持设置为:

  • Asc:升序排列。
  • Desc:降序排列。

响应参数

参数

参数类型

说明

Total

Integer

实例总数。

Instances

Array of InstanceInfo

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

示例

请求示例

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

{
  "Offset": 0,
  "Limit": 10,
  "SortField": "Name",
  "SortOrder": "Asc"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202208031534210102091590260CEA****",
        "Action": "ListInstances",
        "Version": "2021-04-01",
        "Service": "RocketMQ",
        "Region": "cn-beijing"
    },
    "Result": {
        "Instances": [
            {
                "AkSkCount": 3,
                "AutoReNew": false,
                "ChargeStatus": "Normal",
                "ChargeSubType": "Monthly",
                "ChargeType": "PostPaid",
                "ComputeResource": {
                    "NormType": "rocketmq.n1.x2.medium"
                },
                "CreateTime": 1650892326,
                "DeployDefer": false,
                "DeployRMQProxy": false,
                "Description": "",
                "DiskUsage": {
                    "Total": 600,
                    "Used": 507
                },
                "GroupCount": 1,
                "InstanceId": "MQ_INST_5039qmjil4e7_o****",
                "InstanceName": "现网",
                "ProjectName": "test_project",
                "RocketMQVersion": "4.8",
                "Status": "Running",
                "StorageResource": {
                    "NormType": "高速存储",
                    "Value": 600
                },
                "SubnetID": "subnet-rs302h1mqrr4v0x57kq****",
                "TopicCount": 1,
                "Type": "Exclusive",
                "VpcId": "vpc-rs5811nceqyov0x58x4****",
                "VpcName": "MQtestVPC",
                "Zone": {
                    "Description": "华北2(北京)-可用区A",
                    "Name": "cn-beijing-a"
                }
            }
        ],
        "Total": 1
    }
}