Cluster
实例相关信息
被如下接口引用:DescribeClusters。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AppID | Integer | 否 | 用户APPID 注意:此字段可能返回 null,表示取不到有效值。 |
| ClusterID | String | 否 | 实例id 注意:此字段可能返回 null,表示取不到有效值。 示例值:ctsdbi-kcd2mjqp |
| AccountID | String | 否 | 账号id 注意:此字段可能返回 null,表示取不到有效值。 |
| Name | String | 否 | 自定义实例名 注意:此字段可能返回 null,表示取不到有效值。 示例值:ctsdbi-kcd2mjqp |
| Region | String | 否 | 地域 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-beijing |
| Zones | String | 否 | 可用区 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-beijing-5 |
| Status | Integer | 否 | 实例状态:0:运行中,1:创建中 ,16:变配中,17:隔离中,18:待销毁,19:恢复中,20:关机 , 21:销毁中 ,22:已销毁 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| Period | Period | 否 | 实例有效期 注意:此字段可能返回 null,表示取不到有效值。 |
| CreatedAt | Timestamp ISO8601 | 否 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
| UpdatedAt | Timestamp ISO8601 | 否 | 最后修改时间 注意:此字段可能返回 null,表示取不到有效值。 |
| Tenant | Tenant | 否 | 产品内部特性 注意:此字段可能返回 null,表示取不到有效值。 |
| Tags | Array of Tag | 否 | 标签 注意:此字段可能返回 null,表示取不到有效值。 |
| Security | Array of String | 否 | 安全组信息 注意:此字段可能返回 null,表示取不到有效值。 |
ClusterDetail
实例详情信息
被如下接口引用:DescribeClusterDetail。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AppID | Integer | 否 | 用户APPID 注意:此字段可能返回 null,表示取不到有效值。 示例值:251223625 |
| ClusterID | String | 否 | 实例id 注意:此字段可能返回 null,表示取不到有效值。 示例值:ctsdbi-p39mhwnt |
| AccountID | String | 否 | 账号id 注意:此字段可能返回 null,表示取不到有效值。 示例值:Tnog5Q== |
| Name | String | 否 | 自定义实例名 注意:此字段可能返回 null,表示取不到有效值。 示例值:jacob-test |
| Region | String | 否 | 地域 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-beijing |
| Networks | Array of Network | 否 | 网络信息 注意:此字段可能返回 null,表示取不到有效值。 |
| Status | Integer | 否 | 实例状态 枚举值:
注意:此字段可能返回 null,表示取不到有效值。 示例值:18 |
| CreatedAt | Timestamp ISO8601 | 否 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-12-23T03:26:51Z |
| UpdatedAt | Timestamp ISO8601 | 否 | 最后修改时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-12-26T09:51:03Z |
| Tags | Array of Tag | 否 | 标签 注意:此字段可能返回 null,表示取不到有效值。 |
| Security | Array of String | 否 | 安全组信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:["sg-xxxxxx"] |
| Components | Array of Component | 否 | 组件信息 注意:此字段可能返回 null,表示取不到有效值。 |
| ExpiredAt | Timestamp ISO8601 | 否 | 过期时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-12-26T09:51:03Z |
| RenewFlag | Integer | 否 | 续费标识 枚举值:
注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| ShutdownAt | Timestamp ISO8601 | 否 | 关机时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2026-01-02T09:51:03Z |
| IsolatedAt | Timestamp ISO8601 | 否 | 隔离时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-12-26T09:51:03Z |
| Type | Integer | 否 | 实例类型 枚举值:
示例值:1 |
Component
实例组件信息
被如下接口引用:DescribeClusterDetail。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceID | String | 否 | 所属实例id 注意:此字段可能返回 null,表示取不到有效值。 示例值:ctsdbi-lx33hoz6 |
| Name | String | 否 | 名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:扩展节点1 |
| Type | String | 否 | 组件类型 枚举值:
注意:此字段可能返回 null,表示取不到有效值。 示例值:gateway |
| Cpu | Integer | 否 | cpu 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
| Memory | Integer | 否 | 内存 注意:此字段可能返回 null,表示取不到有效值。 示例值:8 |
| Disk | Integer | 否 | 磁盘 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| Shards | Integer | 否 | 节点数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:3 |
| Replicas | Integer | 否 | 副本数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| Networks | Array of Network | 否 | 网络 注意:此字段可能返回 null,表示取不到有效值。 |
| State | Integer | 否 | 组件状态 枚举值:
注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| ID | Integer | 否 | 组件内部ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:4294967724 |
Database
数据库相关信息
被如下接口引用:DescribeDatabases。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ClusterID | String | 否 | 实例ID 注意:此字段可能返回 null,表示取不到有效值。 |
| Name | String | 否 | 数据库名 注意:此字段可能返回 null,表示取不到有效值。 |
| CoolDownInDays | Integer | 否 | 降冷时间(天) 注意:此字段可能返回 null,表示取不到有效值。 |
| RetentionInDays | Integer | 否 | 数据保留时间(天) 注意:此字段可能返回 null,表示取不到有效值。 |
| Remark | String | 否 | 备注 注意:此字段可能返回 null,表示取不到有效值。 |
| Status | Integer | 否 | 状态:0: 资源初始化中, 1: 资源创建中, 2: 正常状态, 3: 资源删除中, 4: 资源已删除, 5: 资源禁用中, 6: 资源已禁用, 7: 资源异常,需要人工操作 注意:此字段可能返回 null,表示取不到有效值。 |
| CreatedAt | Timestamp ISO8601 | 否 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
| UpdatedAt | Timestamp ISO8601 | 否 | 最后修改时间 注意:此字段可能返回 null,表示取不到有效值。 |
Filter
查询过滤器
被如下接口引用:DescribeClusters。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 否 | 过滤参数 示例值:app_id |
| Op | String | 否 | 过滤表达式 示例值:IN,=,LIKE |
| Values | Array of String | 否 | 参与过滤的值 示例值:10000 |
Network
实例网络信息(influxdb)
被如下接口引用:DescribeClusterDetail。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VpcId | String | 是 | vpc id 注意:此字段可能返回 null,表示取不到有效值。 示例值:vpc-7y8i6k84 |
| SubnetId | String | 是 | vpc subnet id 注意:此字段可能返回 null,表示取不到有效值。 示例值:subnet-5vh2p6bj |
| VIP | String | 否 | vpc ip地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:10.0.0.1 |
| Port | Integer | 否 | vpc port地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:8086 |
Order
排序参数,用于排序查询结果
被如下接口引用:DescribeClusters。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 否 | 排序字段 示例值:created_at |
| Type | String | 否 | 排序方式 示例值:ASC/DESC |
Period
有效期
被如下接口引用:DescribeClusters。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| StartTime | Timestamp ISO8601 | 否 | 开始时间 注意:此字段可能返回 null,表示取不到有效值。 |
| EndTime | Timestamp ISO8601 | 否 | 结束时间 注意:此字段可能返回 null,表示取不到有效值。 |
Tag
标签
被如下接口引用:DescribeClusterDetail, DescribeClusters。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 否 | 键 注意:此字段可能返回 null,表示取不到有效值。 |
| Value | String | 否 | 值 注意:此字段可能返回 null,表示取不到有效值。 |
Tenant
产品内部特性
被如下接口引用:DescribeClusters。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| IsPasswordEncrypted | Boolean | 否 | 密码是否已加密 示例值:false |