获取实例属性

最近更新时间: 2026-09-17 00:01:30

1. 接口描述

接口请求域名： ckafka.api3.fincloud.tencent.cn。

获取实例属性

默认接口请求频率限制：100次/秒。

接口更新时间：2025-09-02 15:59:41。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeInstanceAttributes
Version 是 否 String 公共参数，本接口取值：2019-08-19
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId 是 否 String 实例id
示例值： ckafka-test

3. 输出参数

参数名称 类型 描述
Result InstanceAttributesRes 实例属性返回结果对象
示例值：查看
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码 描述
InvalidParameter 参数错误。
InvalidParameterValue.RepetitionValue 已存在相同参数。
InvalidParameterValue.WrongAction Action参数取值错误。
InvalidParameterValue.InstanceNotExist 实例不存在。
UnauthorizedOperation 未授权操作。
UnsupportedOperation.OssReject Oss拒绝该操作
InvalidParameterValue.SubnetNotBelongToZone 子网不属于zone
InvalidParameterValue.VpcIdInvalid 无效的 Vpc Id
InvalidParameterValue.SubnetIdInvalid 无效的子网id
InvalidParameterValue.ZoneNotSupport zone不支持
UnsupportedOperation.BatchDelInstanceLimit 批量删除实例限制
InternalError 内部错误。
ResourceUnavailable 资源不可用。

5. 示例

示例1 获取实例属性

输入示例

https://ckafka.api3.{{conf.domain_main}}/?Action=DescribeInstanceAttributes
&InstanceId=xxx
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "Tags": [],
            "InstanceId": "instance-will-s",
            "InstanceName": "treTest",
            "VipList": [
                {
                    "Vip": "172.16.16.135",
                    "Vport": "9092"
                }
            ],
            "Vip": "172.16.16.135",
            "Vport": "9092",
            "Status": 1,
            "Bandwidth": 48000,
            "DiskSize": 120000,
            "ZoneId": 100003,
            "VpcId": "vpc-1qkosjcb",
            "SubnetId": "subnet-lt4shnme",
            "Healthy": 1,
            "HealthyMessage": "连接数:0#磁盘使用百分比:0%#消费峰值带宽0MB/s",
            "CreateTime": "1970-01-19 06:46:02",
            "MsgRetentionTime": "1970-01-01 08:00:05",
            "Config": {
                "AutoCreateTopicsEnable": true,
                "NumPartitions": 3,
                "DefaultReplicationFactor": 2
            },
            "RemainderPartitions": 45,
            "RemainderTopics": 17,
            "CreatedPartitions": 0,
            "CreatedTopics": 0
        },
        "RequestId": "33a2224e-156d-4f23-9ffe-3c66d545c59c"
    }
}