# 获取整个实例的信息 - DescribeUKafkaInstance

## 简介

获取整个实例的信息。实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取





## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `DescribeUKafkaInstance`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.sigcalcloud.com/uaccount/api_manage) 获取                                             | **Yes** |
| **Signature**  | string  | 根据公钥及 API 指令生成的用户签名，参见 [签名算法](/docs/api/summary/signature.md)  | **Yes** |

### 请求参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Region** | string | 地域。 参见 [地域和可用区列表](/docs/api/summary/regionlist) |**Yes**|
| **Zone** | string | 可用区。参见 [可用区列表](/docs/api/summary/regionlist) |**Yes**|
| **ProjectId** | string | 项目ID。不填写为默认项目，子帐号必须填写。 请参考[GetProjectList接口](/docs/api/summary/get_project_list) |No|
| **ClusterInstanceId** | string | 实例ID，可以通过ListUKafkaInstance 接口的ClusterSet. ClusterInstanceId 获取 |**Yes**|

### 响应字段

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RetCode** | int | 返回状态码，为 0 则为成功返回，非 0 为失败 |**Yes**|
| **Action** | string | 操作指令名称 |**Yes**|
| **Message** | string | 返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息 |No|
| **ClusterSet** | array[[*ClusterInfo*](#ClusterInfo)] | 实例信息列表 |**Yes**|

#### 数据模型


#### ClusterInfo

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Zone** | string | 所属可用区 |No|
| **AutoRenew** | string | 是否开启自动续费 |No|
| **BusinessId** | string | 业务组 ID |No|
| **ChargeType** | string | 付费类型 |No|
| **ClusterInstanceId** | string | 实例id |No|
| **ClusterInstanceName** | string | 实例名称 |No|
| **CreateTime** | int | 实例创建时间 |No|
| **ExpireTime** | int | 实例过期时间 |No|
| **Framework** | string | 实例框架 |No|
| **FrameworkVersion** | string | 实例框架版本 |No|
| **NetworkId** | string | 网络 id（已废弃） |No|
| **Remark** | string | 实例备注 |No|
| **RunningTime** | int | 实例运行时间 |No|
| **State** | string | 实例当前状态,实例状态："Running"\| "Abnormal"\| "Creating"\| "Deleting"\| "CreateFailed"\| "DeleteFailed"\| "Unavailable"\| "Deleted"\| "Updating"\| "Deploying"\| "Migrating"\| "ExpandFailed" |No|
| **SubnetId** | string | 所属子网 id |No|
| **Tag** | string | 实例标记 |No|
| **UHostCount** | int | 实例节点个数 |No|
| **UHostSet** | array[[*Broker*](#Broker)] | 节点信息列表 |No|
| **VPCId** | string | 所属 VPC id |No|
| **ValidBrokerNum** | int | 可用节点个数 |No|
| **IsOpenSecgroup** | string | 是否开启安全组 |No|

#### Broker

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Endpoints** | [*Endpoints*](#Endpoints) | broker 访问端点 |**Yes**|
| **BrokerId** | string | broker id |No|
| **BrokerInfo** | array[[*BrokerOfTopicInfo*](#BrokerOfTopicInfo)] | broker 关联topic 信息 |No|
| **CreateTime** | string | broker 创建信息 |No|
| **DomainName** | string | broker 域名 |No|
| **ExpireTime** | int | broker 过期时间 |No|
| **IPSet** | array[[*IP*](#IP)] | broker IP 信息 |No|
| **InstanceGroupType** | string | broker 机型信息 |No|
| **KafkaPort** | int | kafka 服务端口 |No|
| **Remark** | string | broker 备注信息 |No|
| **ResourceId** | string | broker 注册资源信息 |No|
| **SecurityGroupId** | string | 安全组 id |No|
| **State** | string | broker 当前状态 |No|
| **UHostConfig** | [*UHostConfig*](#UHostConfig) | broker 节点配置 |No|
| **UHostId** | string | 节点 id |No|
| **UHostName** | string | 节点名称 |No|
| **UHostRole** | string | 节点类型 |No|
| **ZooKeeper** | string | 节点是否部署 zookeeper |No|
| **ZooKeeperPort** | int | zookeeper 服务端口 |No|

#### Endpoints

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **PlainText** | [*Url*](#Url) | PLAINTEXT 协议访问信息 |**Yes**|
| **SaslPlainText** | [*Url*](#Url) | SASL_PLAINTEXT 协议访问信息 |No|

#### BrokerOfTopicInfo

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **PartitionOnBroker** | string | topic 在 broker 上分布的 partition 数量 |No|
| **Partitions** | string | topic 在 broker上 partition 列表 |No|
| **Replication** | int | Topic 副本数 |No|
| **TopicName** | string | topic 名称 |No|
| **TotalPartitions** | int | partition 数量 |No|

#### IP

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **IP** | string | IP地址 |No|
| **Type** | string | IP类型 |No|

#### UHostConfig

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **DiskType** | string | 节点数据盘类型 |No|
| **BootDiskSize** | int | 节点系统盘大小（单位G)【删除】 |No|
| **CPU** | int | 节点 CPU 核心数 |No|
| **DataDiskSize** | int | 节点数据盘大小（单位G) |No|
| **Memory** | int | 节点内存(单位MB) |No|
| **OS** | string | 节点内部系统名称【删除】 |No|

#### Url

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Protocal** | string | 访问协议 |No|
| **Addr** | string | 访问地址 |No|

## 示例

### 请求示例
    
```
https://api.sigcalcloud.com/?Action=DescribeUKafkaInstance
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=FbOBQofF
&ClusterInstanceId=qZgFPcaD
```

### 响应示例
    
```json
{
  "Action": "DescribeUKafkaInstanceResponse",
  "ClusterSet": [
    {
      "AutoRenew": "oaeMbAlQ",
      "BusinessId": "bUaOnzSz",
      "ChargeType": "dpdVIjPS",
      "ClusterInstanceId": "mGgpRJje",
      "ClusterInstanceName": "lWkLPxzN",
      "CreateTime": 3,
      "ExpireTime": 8,
      "Framework": "bkBGvTgo",
      "FrameworkVersion": "jDpbxEbm",
      "IsOpenSecgroup": "tkSvpRaW",
      "NetworkId": "xiEZIdEo",
      "Remark": "bsNMyxWb",
      "RunningTime": 2,
      "State": "npdpSnAa",
      "SubnetId": "UFSRbxGW",
      "Tag": "BOGxzixi",
      "UHostCount": 3,
      "UHostSet": [
        {
          "BrokerId": "tTuYVypA",
          "BrokerInfo": [
            {
              "PartitionOnBroker": "bMVJcVOh",
              "Partitions": "GQACzFhA",
              "Replication": 9,
              "TopicName": "tybylfNO",
              "TotalPartitions": 7
            }
          ],
          "CreateTime": "ltbxoQZG",
          "DomainName": "NRRkGRhQ",
          "Endpoints": {},
          "ExpireTime": 1,
          "IPSet": [
            {
              "IP": "LUOVVTsE",
              "Type": "bIuEYKkq"
            }
          ],
          "InstanceGroupType": "bQiIMxiS",
          "KafkaPort": 9,
          "Remark": "gLYFLUvq",
          "ResourceId": "AcVtFzGE",
          "SecurityGroupId": "RvciZZLd",
          "State": "TAxoEgpT",
          "UHostConfig": {},
          "UHostId": "SSfPoXSC",
          "UHostName": "XlZCsnaK",
          "UHostRole": "oNAHPtVL",
          "ZooKeeper": "Yes",
          "ZooKeeperPort": 3
        }
      ],
      "VPCId": "tMsfTwsC",
      "ValidBrokerNum": 7,
      "Zone": "wFznMujt"
    }
  ],
  "RetCode": 0
}
```