DBInstanceDetail
DB实例详情
被如下接口引用：DescribeDBInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | DB实例Id 示例值：tdsql-test |
| InstanceName | String | DB实例名称 示例值：tdsql-test |
| Status | Integer | DB实例状态,-1:已隔离, 0:创建中, 1:流程中, 2:运行中, 3:未初始化 示例值：2 |
| StatusDesc | String | DB实例状态描述,-1:已隔离, 0:创建中, 1:流程中, 2:运行中, 3:未初始化 示例值：2 |
| DbVersion | String | DB实例版本 示例值：5.7.17 |
| Vip | String | Vip信息 示例值：10.0.0.1 |
| Vport | Integer | Vip使用的端口号 示例值：3306 |
| UniqueVpcId | String | 字符串型的私有网络ID 示例值：vpc-test |
| UniqueSubnetId | String | 字符串型的私有网络子网ID 示例值：subnet-test |
| Shard | Integer | 是否为分布式版本,0:否,1:是 示例值：1 |
| NodeNum | Integer | DB实例节点数 示例值：3 |
| Cpu | Integer | CPU规格(单位:核数) 示例值：2 |
| Memory | Integer | 内存规格(单位:GB) 示例值：10 |
| Disk | Integer | 磁盘规格(单位:GB) 示例值：10 |
| ShardNum | Integer | 分布式类型的实例的分片数 示例值：2 |
| Region | String | 地域 示例值：ap-guangzhou |
| Zone | String | 可用区 示例值：ap-guangzhou-1 |
| DbHosts | String | Db所在主机列表, 格式: m1,s1|m2,s2 示例值：svr-test1|svr-test2 |
| HostRole | Integer | 主机角色, 1:主, 2:从, 3:主+从 示例值：1 |
| DbEngine | String | DB引擎，MySQL,Percona,MariaDB 示例值：MySQL |
| CreateTime | String | 创建时间 示例值：2022-05-10 12:00:00 |
DescribeInstanceDetail
独享集群详情
被如下接口引用：DescribeInstanceList。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 独享集群实例Id 示例值：dbdc-test |
| InstanceName | String | 独享集群实例名称 示例值：dbdc-test |
| Region | String | 地域 示例值：ap-guangzhou |
| ProductId | Integer | 产品ID, 0:CDB, 1:TDSQL 示例值：0 |
| Type | Integer | 集群类型, 0:公有云, 1:金融围笼, 2:CDC集群 示例值：0 |
| HostType | Integer | 主机类型, 0:物理机, 1:CVM机型, 2:CDC机型 示例值：0 |
| AutoRenewFlag | Integer | 自动续费标志, 0:未设置, 1:自动续费, 2:到期不续费 示例值：0 |
| Status | Integer | 集群状态 示例值：1 |
| StatusDesc | String | 集群状态描述 示例值：运行中 |
| CreateTime | String | 创建时间 示例值：2021-04-28 00:00:00 |
| PeriodEndTime | String | 到期时间 示例值：2021-05-28 00:00:00 |
| HostNum | Integer | 主机数 示例值：1 |
| DbNum | Integer | DB实例数 示例值：1 |
| AssignStrategy | Integer | 分配策略, 0:紧凑, 1:均匀 示例值：0 |
| CpuSpec | Integer | 总主机CPU(单位:核数) 示例值：100 |
| CpuAssigned | Integer | 总已分配CPU(单位:核数) 示例值：100 |
| CpuAssignable | Integer | 总可分配CPU(单位:核数) 示例值：100 |
| MemorySpec | Integer | 总主机内存(单位:GB) 示例值：100 |
| MemoryAssigned | Integer | 总已分配内存(单位:GB) 示例值：100 |
| MemoryAssignable | Integer | 总可分配内存(单位:GB) 示例值：100 |
| DiskSpec | Integer | 总机器磁盘(单位:GB) 示例值：1000 |
| DiskAssigned | Integer | 总已分配磁盘(单位:GB) 示例值：1000 |
| DiskAssignable | Integer | 总可分配磁盘(单位:GB) 示例值：1000 |
| Zone | String | 可用区 示例值：ap-guangzhou-3 |
| FenceId | String | 金融围笼ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cage-x-x |
| ClusterId | String | 所属集群ID(默认集群为空) 注意：此字段可能返回 null，表示取不到有效值。 示例值：cluster-xxx |
DeviceInfo
设备信息
被如下接口引用：DescribeInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| DeviceId | Integer | 设备ID |
| DeviceNo | String | 设备No |
| DevClass | String | 设备类型 |
| MaxMemory | Float | 设备总内存，单位GB |
| MaxDisk | Float | 设备总磁盘，单位GB |
| RestMemory | Float | 设备剩余内存，单位GB |
| RestDisk | Float | 设备剩余磁盘，单位GB |
| RawDeviceNum | Integer | 设备机器个数 |
| InstanceNum | Integer | 数据库实例个数 |
HostDetail
主机详情
被如下接口引用：DescribeHostList。
| 名称 | 类型 | 描述 |
|---|---|---|
| HostId | String | 主机Id 示例值：svr-test |
| HostName | String | 主机名称 示例值：svr-test |
| Zone | String | 可用区 示例值：ap-guangzhou-1 |
| Status | Integer | 主机状态 示例值：1 |
| AssignStatus | Integer | 分配DB实例状态,0:可分配,1:不可分配 示例值：0 |
| HostType | Integer | 主机类型, 0:物理机, 1:cvm本地盘, 2:cvm云盘 示例值：0 |
| DbNum | Integer | DB实例数 示例值：1 |
| CpuSpec | Integer | 主机CPU(单位:核数) 示例值：100 |
| CpuAssigned | Integer | 已分配CPU(单位:核数) 示例值：100 |
| CpuAssignable | Integer | 可分配CPU(单位:核数) 示例值：100 |
| MemorySpec | Integer | 主机内存(单位:GB) 示例值：100 |
| MemoryAssigned | Integer | 已分配内存(单位:GB) 示例值：100 |
| MemoryAssignable | Integer | 可分配内存(单位:GB) 示例值：100 |
| DiskSpec | Integer | 主机磁盘(单位:GB) 示例值：100 |
| DiskAssigned | Integer | 已分配磁盘(单位:GB) 示例值：100 |
| DiskAssignable | Integer | 可分配磁盘(GB) 示例值：100 |
| CpuRatio | Float | CPU分配比 示例值：1 |
| MemoryRatio | Float | 内存分配比 示例值：1 |
| DiskRatio | Float | 磁盘分配比 示例值：1 |
| MachineName | String | 机型名称 示例值：HYI12A |
| MachineType | String | 机型类别 示例值：SH12 |
| PidTag | String | 计费标签 示例值：excluster_xxx |
| Pid | Integer | 计费ID 示例值：10811 |
| InstanceId | String | 独享集群实例Id 示例值：dbdc-test |
InstanceDetail
集群容量信息。
被如下接口引用：DescribeInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | Integer | 集群状态，0：运行中，1：不在运行 |
| ReadWriteTotalLeaveMemory | Float | 读写集群剩余内存容量，单位GB |
| ReadWriteTotalLeaveDisk | Float | 读写集群剩余磁盘容量，单位GB |
| ReadWriteTotalMemory | Float | 读写集群总内存容量，单位GB |
| ReadWriteTotalDisk | Float | 读写集群总磁盘容量，单位GB |
| ReadOnlyTotalLeaveMemory | Float | 只读集群剩余内存容量，单位GB |
| ReadOnlyTotalLeaveDisk | Float | 只读集群剩余磁盘容量，单位GB |
| ReadOnlyTotalMemory | Float | 只读集群总内存容量，单位GB |
| ReadOnlyTotalDisk | Float | 只读集群总磁盘容量，单位GB |
| InstanceDeviceInfos | Array of InstanceDeviceInfo | 集群设备详情 |
InstanceDeviceInfo
集群设备组信息。
被如下接口引用：DescribeInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 集群ID 注意：此字段可能返回 null，表示取不到有效值。 |
| ReadWriteDevice | Array of DeviceInfo | 读写设备组 注意：此字段可能返回 null，表示取不到有效值。 |
| ReadOnlyDevice | Array of DeviceInfo | 只读设备组 注意：此字段可能返回 null，表示取不到有效值。 |
| FreeDevice | Array of DeviceInfo | 空闲设备组 注意：此字段可能返回 null，表示取不到有效值。 |
InstanceExpand
集群扩展信息。
被如下接口引用：DescribeInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 集群ID |
| InstanceName | String | 集群名称 |
| AppId | Integer | 用户ID |
| Region | String | 地域 |
| Zone | String | 可用区 |
| InstanceType | Integer | 集群类型： 0：一主一备，1：一主两备 |
| InstanceStatus | Integer | 集群状态: 0 集群创建中, 1 集群有效, 2 集群扩容中, 3 集群删除中, 4 集群缩容中 -1 集群已隔离 -2 集群已删除 |
| CreateTime | String | 创建时间 |
| AutoRenewFlag | Integer | 实例自动续费标识： 0正常续费 1自动续费 2到期不续费 |
| Machine | String | 机型 |
| PeriodEndTime | String | 过期时间 |
| InstanceDetail | InstanceDetail | 集群信息 |
| Pid | Integer | 计费侧的产品ID |