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

DescribeInstanceDetail

最近更新时间：2022.10.18 16:24:24

首次发布时间：2021.08.30 16:20:22

我的收藏

调用 DescribeInstanceDetail 接口获取指定实例的详细信息。

使用说明

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

请求参数

参数参数类型是否必选示例值说明
InstanceIDString必选kafka-****实例 ID。

响应参数

参数参数类型示例值说明

Status

String

Running

实例当前的状态。包括：

  • Creating：部署中
  • Upgrading：升级中
  • Updating：变更中
  • Running：运行中
  • Scaling：更配中
  • Migrating：迁移中
  • RollinGiBack：回滚中
  • CreateFailed：创建失败
  • UpgradeFailed：升级失败
  • ScaleFailed：更配失败
  • Closed：已关停
  • CreatingUnpaid：未缴费
UsedTopicNumberInteger20当前实例已创建的 Topic 个数。
UsedGroupNumberInteger20当前实例已经创建的消费组个数。
UsedPartitionNumberInteger120当前实例已经创建的分区个数。
LimitPartitionNumberInteger1500当前最多能创建的分区个数。
StorageCapacityInteger1500实例购买的总磁盘大小，单位为 GiB。
AccountIdInteger0实例所属的火山引擎账号 ID。
InstanceNameStringkafka-test实例名称。
VersionString2.2.2实例的 Kafka 版本号。
CreateTimeString2021-12-14 18:26:56实例创建时间。格式为 YYYY-MM-DDTHH:mm:ss+08:00。
AvaliableZonesList-实例所属的可用区。详细信息请参考 Zone。
KafkaParamsList-Kafka 的配置参数列表。详细信息请参考 KafkaParam。
DescriptionStringtest实例描述信息。
KafkaSpecificationStringkafka.n3.x2.small实例的计算规格。
InstanceIdStringkafka-****唯一标识实例的实例 ID。
UsedCapacityInteger118实例当前已使用的容量，单位为 GiB。
ProjectNameStringtest用户所属的 IAM 项目名称。若无项目，则为空。
VpcInfoVPCInfo-实例的网络访问信息。详细说明请参考 VPCInfo。
KafkaEndpointsList-Kafka接入点列表。详细说明请参考 EndpointInfo。
KafkaChargeInfoBasicChargeInfo-实例的计费信息。详细说明请参考 BasicChargeInfo。
OptimalPartitionNumberInteger200最佳的分区数量，使用该分区数量时， 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": "****"
        }
    }
}