DescribeInstances - 查询实例列表--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

DescribeInstances - 查询实例列表

最近更新时间：2024.11.18 10:27:30首次发布时间：2023.07.12 16:22:33

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

使用说明

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

注意事项

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeInstances	要执行的操作，取值：DescribeInstances。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
TagFilters	Array of Object	否	/	实例的标签。
PageNumber	Integer	是	1	查询结果分页展示时，此参数用于表示页码。支持的最小值为 1。
PageSize	Integer	是	10	查询结果分页展示时，此参数用于表示每页的数据量。取值范围为1~100。
ChargeType	String	否	PostPaid	根据付费类型查询。支持设置为： PostPaid：按量付费 PrePaid：包年包月
InstanceId	String	否	rocketmq-cnaib413a08c****	实例 ID。指定实例 ID 时，表示查看指定实例的信息，此时 InstanceName 等其他筛选项不生效。精确查询。
InstanceName	String	否	myinstance	根据实例名称筛选。支持模糊查询。
InstanceStatus	String	否	Running	实例当前的状态。
Version	String	否	4.8	根据 RocketMQ 版本筛选实例。当前支持 4.8 版本，即兼容 RocketMQ 4.x 版本系列。
ZoneId	String	否	cn-shanghai-a	实例所在的可用区 ID。消息队列 RocketMQ版实例支持跨 AZ 部署，查看指定可用区下提供哪些计算规格时，可以指定多个可用区。多个可用区ID之间以逗号（,）间隔。您可以调用 DescribeAvailabilityZones 查询当前提供服务的可用区列表。
Spec	String	否	rocketmq.n1.x2.small	实例的计算规格。
SortOrder	String	否	Desc	实例查询使用的排序方式。默认为 Desc，即降序。 Asc：升序 Desc：降序
SortBy	String	否	Status	指定排序字段，将查询结果进行排序。可设置为： InstanceName：默认按照 InstanceName 进行排序 InstanceStatus：实例状态 CreateTime：实例创建时间 UsedTopicNumber：实例的 Topic 数量 UsedGroupNumber：实例的 Group 数量
ProjectName	String	否	testProject	根据实例所属的 IAM 项目进行筛选。不指定此参数时，返回该操作账号具备查看权限的实例列表。
VpcId	String	否	vpc-mjisp3h****	根据实例绑定的 VPC ID 筛选。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Total	Integer	1	实例总数。
InstancesInfo	Array of Object	/	实例的名称、版本等基本信息。

请求示例

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

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023050817364118132DDDCE5933454CEB",
        "Action": "DescribeInstances",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {
        "InstancesInfo": [
            {
                "AccountId": "2000006376",
                "ApplyPrivateDNSToPublic": false,
                "AvailableQueueNumber": 3944,
                "ChargeDetail": {
                    "ChargeExpireTime": "1970-01-01T00:00:00Z",
                    "ChargeStatus": "Normal",
                    "ChargeType": "PostPaid",
                    "OverdueReclaimTime": "1970-01-01T00:00:00Z",
                    "OverdueTime": "1970-01-01T00:00:00Z",
                    "PeriodUnit": "Monthly"
                },
                "ComputeSpec": "rocketmq.n1.x2.micro",
                "CreateTime": "2023-05-08T09:11:15Z",
                "Defer": false,
                "DiskEncrypted": false,
                "EipId": "eip-22j06qkez64u87r2qr105****",
                "EnableByteProxyRateLimit": false,
                "EnableSSL": true,
                "FileReservedTime": 0,
                "HTTPProxy": false,
                "InstanceDescription": "",
                "InstanceId": "rocketmq-cnai1f0c29ca****",
                "InstanceName": "rocketmq-cnai1f0c29ca****",
                "InstanceStatus": "Running",
                "ProjectName": "",
                "RegionId": "cn-shanghai",
                "SSLMode": "enforcing",
                "StorageSpace": 300,
                "StorageType": "flexPL",
                "SubnetId": "subnet-22j3oc7a7rvuo7r2qr29u****",
                "Tags": {
                    "tag": "1"
                },
                "UsedGroupNumber": 0,
                "UsedStorageSpace": 0,
                "UsedTopicNumber": 0,
                "Version": "4.8",
                "VpcId": "vpc-3qe3nxqooqccg7prmkznr****",
                "ZoneId": "cn-shanghai-a"
            }
        ],
        "Total": 1
    }
}

错误码

公共错误码请参见公共错误码文档。