DescribeInstances - 查看实例列表 --消息队列 Kafka版-火山引擎

文档中心

导航

DescribeInstances - 查看实例列表

最近更新时间：2024.09.26 15:55:17首次发布时间：2023.03.30 19:59:24

调用 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	Array of Object	--	实例的名称、版本等基本信息。

请求示例

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.n3.x2.small",
                "CreateTime": "2022-07-18T07:48:58Z",
                "DiskEncrypted": false,
                "EipId": "eip-13g3hg4mzvy0w3n6nu44b****",
                "InstanceDescription": "每个小时的第0至第20分钟不要进行升级",
                "InstanceId": "kafka-cnngc7an0qpv****",
                "InstanceName": "效能服务-勿删",
                "InstanceStatus": "Running",
                "PrivateDomainOnPublic": false,
                "ProjectName": "",
                "RegionId": "cn-beijing",
                "StorageSpace": 600,
                "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
    }
}

错误码

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

状态码	错误码	错误信息	说明
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.	内部错误，请稍后重试。