DescribeInstanceDetail - 查看实例详情--消息队列 Kafka版-火山引擎

文档中心

立即注册

导航

DescribeInstanceDetail - 查看实例详情

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

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeInstanceDetail	要执行的操作，取值：DescribeInstanceDetail。
Version	String	是	2022-05-01	API的版本，取值：2022-05-01。
InstanceId	String	是	kafka-cnngqkfgdudt****	待查询详情的 Kafka 实例 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
BasicInstanceInfo	Object	--	实例的名称、版本等基本信息。
ConnectionInfo	Array of Object	--	实例的连接信息。
ChargeDetail	Object	--	实例的付费方式。
Parameters	String	{"AutoDeleteGroup":"false","LogAutoDeletion":"true","LogAutoDeletionPercent":"90","LogRetentionHours":"72","MessageMaxByte":"10","MessageTimestampType":"CreateTime","OffsetRetentionMinutes":"4320"}	实例的配置参数。包括： 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": "20230227175320C12F37564824A75D14D3",
        "Action": "DescribeInstanceDetail",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": {
        "BasicInstanceInfo": {
            "AccountId": "2000006376",
            "ChargeDetail": {
                "ChargeStartTime": "2022-07-18T07:48:58Z",
                "ChargeStatus": "Normal",
                "ChargeType": "PostPaid",
                "OverdueTime": ""
            },
            "ComputeSpec": "kafka.n3.x2.tiny",
            "CreateTime": "2022-07-18T07:48:58Z",
            "DiskEncrypted": true,
            "InstanceDescription": "",
            "InstanceId": "kafka-cnng3s31v076****",
            "InstanceName": "test-211",
            "InstanceStatus": "Running",
            "PrivateDomainOnPublic": false,
            "ProjectName": "default",
            "RegionId": "cn-beijing",
            "StorageSpace": 300,
            "SubnetId": "subnet-mjhjxfs4ycqo5smt1bro****",
            "UsablePartitionNumber": 238,
            "UsedGroupNumber": 1,
            "UsedPartitionNumber": 12,
            "UsedStorageSpace": 0,
            "UsedTopicNumber": 1,
            "Version": "2.2.2",
            "VpcId": "vpc-rs5811nceqyov0x58x4****",
            "ZoneId": "cn-beijing-a"
        },
        "ChargeDetail": {
            "ChargeStartTime": "2022-07-18T07:48:58Z",
            "ChargeStatus": "Normal",
            "ChargeType": "PostPaid",
            "OverdueTime": ""
        },
        "ConnectionInfo": [
            {
                "EndpointType": "SASL_PLAINTEXT",
                "InternalEndpoint": "kafka-cnng3s31v076****.kafka.ivolces.com:9093",
                "NetworkType": "PrivateNetwork",
                "PublicEndpoint": ""
            },
            {
                "EndpointType": "PLAINTEXT",
                "InternalEndpoint": "kafka-cnng3s31v07****.kafka.ivolces.com:9092",
                "NetworkType": "PrivateNetwork",
                "PublicEndpoint": ""
            }
        ],
        "Parameters": "{\"LogRetentionHours\":\"72\",\"MessageMaxByte\":\"10\",\"MessageTimestampType\":\"CreateTime\",\"OffsetRetentionMinutes\":\"4320\"}"
    }
}

错误码

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

状态码	错误码	错误信息	说明
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后重试。