调用 DescribeInstanceDetail 接口获取指定实例的详细信息。
2018-01-01。| 参数 | 参数类型 | 是否必选 | 示例值 | 说明 |
|---|---|---|---|---|
| InstanceID | String | 必选 | kafka-**** | 实例 ID。 |
| 参数 | 参数类型 | 示例值 | 说明 |
|---|---|---|---|
Status | String | Running | 实例当前的状态。包括：
|
| UsedTopicNumber | Integer | 20 | 当前实例已创建的 Topic 个数。 |
| UsedGroupNumber | Integer | 20 | 当前实例已经创建的消费组个数。 |
| UsedPartitionNumber | Integer | 120 | 当前实例已经创建的分区个数。 |
| LimitPartitionNumber | Integer | 1500 | 当前最多能创建的分区个数。 |
| StorageCapacity | Integer | 1500 | 实例购买的总磁盘大小，单位为 GiB。 |
| AccountId | Integer | 0 | 实例所属的火山引擎账号 ID。 |
| InstanceName | String | kafka-test | 实例名称。 |
| Version | String | 2.2.2 | 实例的 Kafka 版本号。 |
| CreateTime | String | 2021-12-14 18:26:56 | 实例创建时间。格式为 YYYY-MM-DDTHH:mm:ss+08:00。 |
| AvaliableZones | List | - | 实例所属的可用区。详细信息请参考 Zone。 |
| KafkaParams | List | - | Kafka 的配置参数列表。详细信息请参考 KafkaParam。 |
| Description | String | test | 实例描述信息。 |
| KafkaSpecification | String | kafka.n3.x2.small | 实例的计算规格。 |
| InstanceId | String | kafka-**** | 唯一标识实例的实例 ID。 |
| UsedCapacity | Integer | 118 | 实例当前已使用的容量，单位为 GiB。 |
| ProjectName | String | test | 用户所属的 IAM 项目名称。若无项目，则为空。 |
| VpcInfo | VPCInfo | - | 实例的网络访问信息。详细说明请参考 VPCInfo。 |
| KafkaEndpoints | List | - | Kafka接入点列表。详细说明请参考 EndpointInfo。 |
| KafkaChargeInfo | BasicChargeInfo | - | 实例的计费信息。详细说明请参考 BasicChargeInfo。 |
| OptimalPartitionNumber | Integer | 200 | 最佳的分区数量，使用该分区数量时， Topic 性能达到最佳。 |
POST https://kafka.volcengineapi.com/?Action=DescribeInstanceDetail&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=******** { "InstanceId": "kafka-****" }
{ "ResponseMetadata": { "RequestId": "********", "Action": "DescribeInstanceDetail", "Version": "2018-01-01", "Service": "Kafka", "Region": "cn-beijing" }, "Result": { "AccountId": 2000006376, "AvaliableZones": [ { "ZoneId": "cn-beijing-a", "ZoneIdInChinese": "华北2（北京）-可用区A" } ], "CreateTime": "2022-01-18T14:28:36+08:00", "Description": "", "InstanceId": "****", "InstanceName": "test", "KafkaChargeInfo": { "ChargeStatus": "Normal", "ChargeSubType": "Monthly", "ChargeType": "PostPaid", "CreatedTime": 1642487317, "OrderId": "********", "OverdueTime": 0 }, "KafkaEndpoints": [ { "AccessAddress": "****.kafka.ivolces.com:9092", "EndpointProtocol": "PLAINTEXT", "EndpointType": "Private" }, { "AccessAddress": "****.kafka.ivolces.com:9093", "EndpointProtocol": "SASL_PLAINTEXT", "EndpointType": "Private" } ], "KafkaParams": [ { "DefaultValue": "10", "Description": "最大消息长度", "Name": "MessageMaxByte", "ParamType": "TypeInt", "Restart": false, "RunningValue": "10", "Unit": "MB", "ValueRange": "1-12" }, { "DefaultValue": "72", "Description": "消息保存时间", "Name": "LogRetentionHours", "ParamType": "TypeInt", "Restart": false, "RunningValue": "72", "Unit": "小时", "ValueRange": "0-2160" }, { "DefaultValue": "4320", "Description": "日志索引保存时间", "Name": "OffsetRetentionMinutes", "ParamType": "TypeInt", "Restart": false, "RunningValue": "4320", "Unit": "分钟", "ValueRange": "1-10080" }, { "DefaultValue": "12", "Description": "topic默认的分区数", "Name": "NumPartitions", "ParamType": "TypeInt", "Restart": false, "RunningValue": "12", "Unit": "", "ValueRange": "1-300" }, { "DefaultValue": "3", "Description": "topic默认的副本数", "Name": "ReplicationFactor", "ParamType": "TypeInt", "Restart": false, "RunningValue": "3", "Unit": "", "ValueRange": "2-3" } ], "KafkaSpecification": "kafka.n3.x2.small", "LimitPartitionNumber": 300, "OptimalPartitionNumber": 12, "ProjectName": "", "Status": "Running", "StorageCapacity": 1500, "UsedCapacity": 0, "UsedGroupNumber": 0, "UsedPartitionNumber": 13, "UsedTopicNumber": 2, "Version": "2.2.2", "VpcInfo": { "ID": "vpc-****", "Name": "mq-test", "SubnetId": "****" } } }