获取实例属性

最近更新时间:2020-03-04 17:55:47

1. 接口描述

接口请求域名: ckafka.tencentcloudapi.com 。

获取实例属性

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:ckafka.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstanceAttributes。
Version String 公共参数,本接口取值:2019-08-19。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例id

3. 输出参数

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

4. 示例

示例1 获取实例属性

输入示例

https://ckafka.tencentcloudapi.com/?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"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

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