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

DescribeInstances

最近更新时间：2023.10.12 10:47:22

首次发布时间：2023.03.30 19:59:24

我的收藏

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

使用说明

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

请求参数

参数

参数类型

是否必选

示例值

说明

PageSize

Integer

是

10

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

PageNumber

Integer

是

1

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

InstanceId

String

否

kafka-cnaix6r3hlqv****

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

InstanceName

String

否

myinstance

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

InstanceStatus

String

否

Running

实例当前的状态。

ZoneId

String

否

cn-beijing-a

实例所在的可用区 ID。

说明

消息队列 Kafka版实例支持跨 AZ 部署，查看指定可用区下提供哪些计算规格时，可以指定多个可用区。多个可用区 ID 之间以逗号（,）间隔。
您可以调用 DescribeAvailabilityZones 查询当前提供服务的可用区列表。

Tags

Map<String, Array of String>

否

{ "tag-wzx" : ["11"] }

实例的标签。

Project

String

否

testProject

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

响应参数

参数

参数类型

示例值

说明

Total

Integer

1

实例总数。

InstancesInfo

Array of BasicInstanceInfoObject

/

实例的名称、版本等基本信息。详细信息请参考数据结构中 BasicInstanceInfoObject 部分。

示例

请求示例

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

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

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202302271712000AE823263252E862794A",
        "Action": "DescribeInstances",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstancesInfo": [
            {
                "AccountId": "2000006376",
                "ChargeDetail": {
                    "ChargeStartTime": "2022-07-18T07:48:58Z",
                    "ChargeStatus": "Normal",
                    "ChargeType": "PostPaid",
                    "OverdueTime": ""
                },
                "ComputeSpec": "kafka.20xrate.hw",
                "CreateTime": "2022-07-18T07:48:58Z",
                "DiskEncrypted": false,
                "EipId": "eip-13g3hg4mzvy0w3n6nu44b****",
                "InstanceDescription": "测试实例",
                "InstanceId": "kafka-cnngc7an0qpv****",
                "InstanceName": "new-instance",
                "InstanceStatus": "Running",
                "PrivateDomainOnPublic": false,
                "ProjectName": "",
                "RegionId": "cn-beijing",
                "StorageSpace": 600,
                "StorageType": "ESSD_FlexPL",
                "SubnetId": "subnet-rrsenz6y5iwwv0x58eg****",
                "UsablePartitionNumber": 564,
                "UsedGroupNumber": 6,
                "UsedPartitionNumber": 36,
                "UsedStorageSpace": 3,
                "UsedTopicNumber": 6,
                "Version": "2.2.2",
                "VpcId": "vpc-13fz1ktl52dc03n6nu55w****",
                "ZoneId": "cn-beijing-a"
            }
        ],
        "Total": 1
    }
}