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

DescribeInstanceDetail

最近更新时间：2023.09.27 10:17:49

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

我的收藏

调用 DescribeInstanceDetail 接口查看指定实例的详情。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

是

kafka-cnngqkfgdudt****

待查询详情的 Kafka 实例 ID。

响应参数

参数

参数类型

示例值

说明

BasicInstanceInfo

BasicInstanceInfo

/

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

ConnectionInfo

Array of EndpointObject

/

实例的连接信息。详细信息请参考数据结构中 EndpointObject 部分。

ChargeDetail

ChargeDetailObject

/

付费方式。详细信息请参考数据结构中 ChargeDetailObject 部分。

Parameters

String

/

实例的配置参数。包括：

  • LogAutoDeletion：是否自动删除旧消息。
  • LogRetentionHours：消息保留时长。单位为小时。
  • MessageMaxByte：最大消息大小。单位为 MB。
  • MessageTimestampType：消息时间类型。
  • OffsetRetentionMinutes：消费位点保留时长。单位为分钟。

示例

请求示例

POST /?Action=DescribeInstanceDetail&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=********

{
  "InstanceId": "kafka-cnng3s31v076****"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2023071923571842DD84CF65A6B2BF84C9",
        "Action": "DescribeInstanceDetail",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": {
        "BasicInstanceInfo": {
            "AccountId": "200000****",
            "AutoUseGroup": true,
            "AutoUseTopic": false,
            "ChargeDetail": {
                "ChargeStartTime": "2023-07-19T13:11:15Z",
                "ChargeStatus": "Normal",
                "ChargeType": "PostPaid",
                "OverdueTime": ""
            },
            "ComputeSpec": "kafka.20xrate.hw",
            "CreateTime": "2023-07-19T13:11:14Z",
            "DiskEncrypted": true,
            "EipId": "eip-11vlvmhvc2znk40yrhcye****",
            "InstanceDescription": "",
            "InstanceId": "kafka-cnng3s31v076****",
            "InstanceName": "kafka-cnng3s31v076****",
            "InstanceStatus": "Running",
            "PrivateDomainOnPublic": false,
            "ProjectName": "default",
            "RegionId": "cn-guangzhou",
            "StorageSpace": 300,
            "StorageType": "ESSD_FlexPL",
            "SubnetId": "subnet-36t6c6egvp91c383g0wqf****",
            "UsableGroupNumber": 500,
            "UsablePartitionNumber": 250,
            "UsedGroupNumber": 0,
            "UsedPartitionNumber": 0,
            "UsedStorageSpace": 0,
            "UsedTopicNumber": 0,
            "Version": "2.2.2",
            "VpcId": "vpc-11w4ygf1zls7440yrhcq****",
            "ZoneId": "cn-beijing-a"
        },
        "ChargeDetail": {
            "ChargeStartTime": "2023-07-19T13:11:15Z",
            "ChargeStatus": "Normal",
            "ChargeType": "PostPaid",
            "OverdueTime": ""
        },
        "ConnectionInfo": [
            {
                "EndpointType": "PLAINTEXT",
                "InternalEndpoint": "kafka-cnng3s31v076****.kafka.ivolces.com:9092",
                "NetworkType": "PrivateNetwork",
                "PublicEndpoint": ""
            },
            {
                "EndpointType": "SASL_PLAINTEXT",
                "InternalEndpoint": "kafka-cnng3s31v076****.kafka.ivolces.com:9093",
                "NetworkType": "PrivateNetwork",
                "PublicEndpoint": "kafka-cnng3s31v076****.kafka.volces.com:9592,kafka-cnng3s31v076****.kafka.volces.com:9593,kafka-cnng3s31v076****.kafka.volces.com:9594"
            },
            {
                "EndpointType": "SASL_SSL",
                "InternalEndpoint": "kafka-cnng3s31v076****.kafka.ivolces.com:9095",
                "NetworkType": "PrivateNetwork",
                "PublicEndpoint": "kafka-cnng3s31v076****.kafka.volces.com:9492,kafka-cnng3s31v076****.kafka.volces.com:9493,kafka-cnng3s31v076****.kafka.volces.com:9494"
            }
        ],
        "Parameters": "{\"LogRetentionHours\":\"72\",\"MessageMaxByte\":\"10\",\"MessageTimestampType\":\"CreateTime\",\"OffsetRetentionMinutes\":\"4320\"}"
    }
}