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

使用说明

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

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeInstances

要执行的操作，取值：DescribeInstances。

Version string 必选示例值：2023-01-01

API的版本，取值：2023-01-01。

TagFilters object[] 可选示例值：[{"Key":"owner", "Values":["zhangsan"]}]

标签键值。

Key string 必选示例值：owner

标签的键。

Values string[] 可选示例值：zhangsan

标签的值。

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（默认）：实例名称

InstanceStatus：实例状态

CreateTime：实例创建时间

UsedTopicNumber：实例的 Topic 数量

UsedGroupNumber：实例的 Group 数量

ProjectName string 可选示例值：testProject

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

VpcId string 可选示例值：vpc-mjisp3h****

根据实例绑定的 VPC ID 筛选。

返回参数

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

Total integer 示例值：1

实例总数。

InstancesInfo object[] 示例值：/

实例的名称、版本等基本信息。

InstanceId string 示例值：rocketmq-cnai1f0c29ca****

实例 ID。

InstanceName string 示例值：newnstance

实例名称。

InstanceDescription string 示例值：这是一个测试实例

实例的简单描述。

InstanceStatus string 示例值：Running

实例状态。

RegionId string 示例值：cn-shanghai

实例所在的地域 ID。

ZoneId string 示例值：cn-guangzhou-a

实例所在的可用区 ID。对于跨 AZ 的高可用实例，此处会返回多个可用区 ID。

Version string 示例值：4.8

支持的 RocketMQ 版本。当前支持 4.8 版本，即兼容 RocketMQ 4.x 版本系列。

UsedTopicNumber integer 示例值：20

当前实例已创建的 Topic 个数。

ComputeSpec string 示例值：rocketmq.n1.x2.small

实例的计算规格。

CreateTime string 示例值：2022-07-18T07:48:58Z

实例的创建时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。

UsedStorageSpace integer 示例值：100

实例已用储空间。单位为 GiB。

StorageSpace integer 示例值：200

实例总存储空间。单位为 GiB。

VpcId string 示例值：vpc-13fo9gkz6j6683n6nu5ec****

私有网络（VPC） ID。

SubnetId string 示例值：subnet-min6uy01kuf45smt1a2i****

VPC 的子网 ID。

EnableSSL boolean 示例值：false

实例是否已开启 SSL 认证。

开启实例的公网访问后，默认开启 SSL 认证。如果 SSLMode 设置为 permissive，则可以按需选择是否经由 SSL 认证。

FileReservedTime integer 示例值：72

消息在消息队列 RocketMQ版服务端的保留时长，超过保留时长的消息将被过期清理。单位为小时。

ProjectName string 示例值：newproject

实例所属的 IAM 项目。如果实例不属于任何 IAM 项目，则不返回此参数。

AccountId string 示例值：200000****

创建实例的火山引擎主账号ID。

EipId string 示例值：eip-mjhulvqza6805smt1bnc****

EIP 的 ID。

如果实例未开启公网访问方式，则不返回此参数。

SSLMode string 示例值：permissive

实例的公网连接策略，仅在开启公网访问时需要设置。支持设置为：

enforcing：通过公网访问实例时，必须经由 SSL 认证。SSL 认证可实现数据的加密传输，相较于普通公网访问方式具备更高的安全性，但性能会有所下降。

permissive：通过公网访问实例时，可以选择是否经由 SSL 认证。

AvailableQueueNumber integer 示例值：3944

剩余可创建的分区数量。

UsedQueueNumber integer 示例值：1

实例已经使用的队列数。

UsedGroupNumber integer 示例值：20

当前实例已经创建的消费组（Group）个数。

ChargeDetail object 示例值：/

实例的计费方式等计费信息。

ChargeType string 示例值：PostPaid

实例的计费类型。支持的类型包括：

PostPaid ：按量付费

PrePaid：包年包月

AutoRenew boolean 示例值：true

包年包月实例到期后是否自动续费。

true：自动续费。

false：不自动续费。到期后需要手动续费，否则实例将被关停。

ChargeStatus string 示例值：Normal

实例的计费状态。包括：

Normal：正常

Overdue：按量计费欠费

Expired：包年包月到期

ChargeStartTime string 示例值：2022-07-18T07:48:58Z

实例的开始计费时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。

ChargeExpireTime string 示例值：2022-07-18T07:48:58Z

包年包月实例的到期时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。

按量付费实例此字段默认显示为 1970-01-01T00:00:00Z。

OverdueTime string 示例值：2022-07-18T07:48:58Z

实例的欠费关停时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。

OverdueReclaimTime string 示例值：2022-07-18T07:48:58Z

实例欠费关停后的预计释放时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。

PeriodUnit string 示例值：Monthly

包年包月类型实例的生命周期单位，即指定以月或以年为单位购买。其中：

Monthly（默认）：包月

Yearly：包年

ApplyPrivateDNSToPublic boolean 示例值：true

是否已开启私网域名支持公网解析功能。

true：已开启

false：已关闭

InstanceTags object[] 示例值：/

实例绑定的标签。

Key string 示例值：owner

标签的键。

Value string 示例值：zhangsan

标签的值。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	OK	OK	成功。
400	InvalidPara	The specified parameter is not valid.	参数值无效。
400	MissingParameter	The request body is missing a required parameter %s.	缺少%s参数。
400	UnsupportedParameter	The specified parameter %s is unsupported.	不支持%s参数。
400	InvalidParameter	The specified parameter %s is not valid.	参数值%s无效，请检查后重试。
400	OperationDenied.InvalidRequest	The request that you specified is not valid.	请求异常，请检查后重试。
400	QuotaExceeded	Quota Limited.	资源超配额 quota。
400	NotModifiedParameter	The resource was not changed.	未变更任何配置。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
403	OperationDenied.ResourceOccupied	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
500	ServerInternalError	The request failed due to some unknown error, exception or failure.	服务内部错误。
500	ResourceIsBusy	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后再试。
503	ServiceUnavailable	The request failed due to a temporary failure of the server.	当前服务暂时不可用。