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

使用说明

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

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeInstances

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

Version string 必选示例值：2022-05-01

API的版本，取值：2022-05-01。

PageSize integer 必选示例值：10

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

PageNumber integer 必选示例值：1

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

InstanceId string 可选示例值：kafka-5b293870****

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

InstanceName string 可选示例值：myinstance

实例名称。支持模糊查询。

InstanceStatus string 可选示例值：Running

实例当前的状态。

ZoneId string 可选示例值：cn-beijing-a

实例所在的可用区 ID。

Tags object 可选示例值： { "tag-wzx" : ["11"] }

实例的标签。

Project string 可选示例值：default

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

返回参数

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

Total integer 示例值：1

实例总数。

InstancesInfo object[] 示例值：--

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

InstanceId string 示例值：kafka-cnngqkfgdudt****

Kafka 实例 ID。

InstanceName string 示例值：kafkainstance

Kafka 实例名称。

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

实例的简单描述。

InstanceStatus string `示例值：Running

`

实例状态。

Error：错误

Deleting：删除中

Creating：部署中

Upgrading：升级中

Updating：变更中

Running：运行中

Scaling：更配中

Rebuilding：重建中

Destroying：销毁中

Restarting：重启中

Migrating：迁移中

Restoring：恢复中

Importing：导入中

NetCreating：申请公网中

NetReleasing：释放公网中

Rollingback：回滚中

CreateFailed：创建失败

UpgradeFailed：升级失败

ScaleFailed：更配失败

RestartFailed：重启失败

RegionId string 示例值：cn-beijing

实例所在的地域 ID。

ZoneId string 示例值：cn-beijing-a

实例所在的可用区 ID。

Version string 示例值：2.2.2

Kafka版本。当前支持的版本包括：

2.2.2：Kafka 2.2.2 版本。

2.8.2：Kafka 2.8.2 版本。

UsedTopicNumber integer 示例值：20

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

UsedGroupNumber integer 示例值：20

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

UsedPartitionNumber integer 示例值：120

当前实例已经使用的分区个数。

UsablePartitionNumber integer 示例值：20

当前实例剩余可用分区数。

ComputeSpec string 示例值：kafka.60xrate.hw

Kafka 实例的计算规格。

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

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

UsedStorageSpace integer 示例值：100

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

StorageSpace integer 示例值：200

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

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

VPC 的子网 ID。

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

EIP 的 ID。

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

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

私有网络（VPC） ID。

ProjectName string 示例值：newproject

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

AccountId string 示例值：200000****

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

ChargeDetail object 示例值：--

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

ChargeType string 示例值：PostPaid

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

PostPaid ：按量付费

PrePaid：包年包月

AutoRenew boolean 示例值：true

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

true：自动续费。

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

PeriodUnit string 示例值：Month

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

Month：（默认）包月

Year：包年

ChargeStatus string 示例值：Normal

实例的计费状态。包括：

Normal：正常

Overdue：按量计费欠费

Expired：包年包月到期

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

`

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

仅包年包月实例返回此参数。

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'。

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

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

PrivateDomainOnPublic boolean 示例值：false

是否已开启公网解析功能。

true：已开启

false：已关闭

StorageType string 示例值：ESSD_FlexPL

Kafka 实例数据存储的云盘类型。即 ESSD_FlexPL 或 ESSD_PL0。关于不同存储类型的详细性能说明，请参考云盘规格。

UsableGroupNumber integer 示例值：100

当前实例剩余可用消费组数。

Tags object 示例值：{ "mode": "http", "tag-wzx": "11" }

已绑定的标签。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter is not valid.	参数值无效。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后重试。

消息队列 Kafka版