DescribeInstancesSummary--消息队列 Kafka版-火山引擎

文档中心

立即注册

导航

DescribeInstancesSummary

最近更新时间：2023.01.06 16:42:35首次发布时间：2022.04.25 13:44:48

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

使用说明

查询实例列表提供分页式的查询接口, 只返回 Kafka 实例的概览信息。如需获取详细信息，请使用 DescribeInstanceDetail 接口。

此接口的 API Version 为 2018-01-01。
此接口的调用频率限制为 100 次/s，超出频率限制会报错 “AccountFlowLimitExceeded”。

请求参数

参数	参数类型	是否必选	示例值	说明
PageNumber	Integer	必选	1	需要查询的页码。取值范围为非 0 整数。
PageSize	Integer	必选	10	需要查询的单页大小。取值范围为 1~50。
Filters	List	可选	-	实例查询使用的过滤字段。当前支持过滤字段为： Name：实例名称过滤，模糊匹配。 InstanceId：实例 ID 过滤，模糊匹配。
SortFiledName	String	可选	Name	实例查询结果排序字段。默认使用 Status 进行排序。可设置为： Name：实例名称 InstanceID：实例 ID Status：实例状态 CreateTime：实例创建时间 UsedTopicNum：实例的 Topic 数量
SortOrder	String	可选	Asc	实例查询使用的排序方式。默认为升序。 Asc：升序 Desc：降序。

响应参数

参数	参数类型	说明
Total	Integer	实例数量。
Instances	List	实例信息列表。详细信息请参考 InstanceBasicInfo。

示例

请求示例

POST https://kafka.volcengineapi.com/?Action=DescribeInstancesSummary&Version=2018-01-01 HTTP/1.1
Accept: application/json
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=********

{
  "PageNumber": 1,
  "PageSize": 1,
  "Filters": [
    {
      "Name": "Name",
      "Values": [
        ""
      ]
    }
  ],
  "SortFiledName": "",
  "SortOrder": "Asc"
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "****************",
    "Action": "DescribeInstancesSummary",
    "Version": "2018-01-01",
    "Service": "kafka",
    "Region": "cn-beijing"
  },
  "Result": {
        "Instances": [
            {
                "AccountId": 2000006376,
                "AvaliableZones": [
                    {
                        "ZoneId": "cn-beijing-a",
                        "ZoneIdInChinese": "华北2（北京）-可用区A"
                    }
                ],
                "CreateTime": "2022-01-18T14:28:36+08:00",
                "Description": "",
                "InstanceId": "kafka-******",
                "InstanceName": "kafka",
                "KafkaChargeInfo": {
                    "ChargeStatus": "Normal",
                    "ChargeSubType": "Monthly",
                    "ChargeType": "PostPaid",
                    "CreatedTime": 1642487317,
                    "OrderId": "******",
                    "OverdueTime": 0
                },
                "KafkaSpecification": "kafka.n3.x2.small",
                "ProjectName": "",
                "Status": "Running",
                "UsedGroupNumber": 0,
                "UsedTopicNumber": 2,
                "VpcInfo": {
                    "ID": "vpc-******",
                    "Name": "mq-test",
                    "SubnetId": "******"
                }
            }
        ],
        "Total": 3
    }