Account
数据库账户信息
被如下接口引用：DescribeAccounts。
| 名称 | 类型 | 描述 |
|---|---|---|
| AccountName | String | 数据库账号名 示例值：root |
| ClusterId | String | 集群ID 示例值：tdcpg-xxx |
| AccountDescription | String | 数据库账号描述 示例值：xxx |
| CreateTime | String | 数据库账号创建时间。按照RFC3339标准表示，并且使用东八区时区时间，格式为：YYYY-MM-DDThh:mm:ss+08:00。 示例值：2021-11-18T18:10:25+08:00 |
| UpdateTime | String | 数据库账号信息更新时间。按照RFC3339标准表示，并且使用东八区时区时间，格式为：YYYY-MM-DDThh:mm:ss+08:00。 示例值：2021-11-18T18:10:25+08:00 |
AvailableRecoveryTimeRange
可以回档时间范围
被如下接口引用：DescribeClusterRecoveryTimeRange。
| 名称 | 类型 | 描述 |
|---|---|---|
| AvailableBeginTime | String | 可回档起始时间。按照RFC3339标准表示，并且使用东八区时区时间，格式为：YYYY-MM-DDThh:mm:ss+08:00。 示例值：2021-11-18T18:10:25+08:00 |
| AvailableEndTime | String | 可回档结束时间。按照RFC3339标准表示，并且使用东八区时区时间，格式为：YYYY-MM-DDThh:mm:ss+08:00。 示例值：2021-11-18T18:10:25+08:00 |
Backup
集群备份集信息
被如下接口引用：DescribeClusterBackups。
| 名称 | 类型 | 描述 |
|---|---|---|
| BackupId | Integer | 备份集ID，集群内唯一 示例值：1 |
| BackupType | String | 备份集类型，目前只支持 SNAPSHOT：快照 示例值：SNAPSHOT |
| BackupMethod | String | 备份集产生的方案，目前只支持 AUTO：自动 示例值：AUTO |
| BackupDataTime | String | 备份集对应的数据时间。按照RFC3339标准表示，并且使用东八区时区时间，格式为：YYYY-MM-DDThh:mm:ss+08:00。 示例值：2021-11-18T18:10:25+08:00 |
| BackupDataSize | Integer | 备份集数据大小，单位GiB 示例值：10 |
| BackupTaskStartTime | String | 备份集对应的任务开始时间。按照RFC3339标准表示，并且使用东八区时区时间，格式为：YYYY-MM-DDThh:mm:ss+08:00。 示例值：2021-11-18T18:10:25+08:00 |
| BackupTaskEndTime | String | 备份集对应的任务结束时间。按照RFC3339标准表示，并且使用东八区时区时间，格式为：YYYY-MM-DDThh:mm:ss+08:00。 示例值：2021-11-18T18:10:25Z+08:00 |
| BackupTaskStatus | String | 备份集对应的任务状态 SUCCESS：成功 示例值：SUCCESS |
Cluster
集群信息
被如下接口引用：DescribeClusters。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClusterId | String | 集群ID，集群的唯一标识 示例值：tdcpg-xxx |
| ClusterName | String | 集群名字，不修改时默认和集群ID相同 示例值：MyClusterName |
| Region | String | 地域 示例值：ap-guangzhou |
| Zone | String | 可用区 示例值：ap-guangzhou-3 |
| DBVersion | String | TDSQL-C PostgreSQL 合入的社区版本号 示例值：10.17 |
| ProjectId | Integer | 项目ID 示例值：0 |
| Status | String | 集群状态。目前包括 - creating ：创建中 - running : 运行中 - isolating : 隔离中 - isolated : 已隔离 - recovering : 恢复中 - deleting : 删除中 - deleted : 已删除 示例值：running |
| StatusDesc | String | 集群状态中文含义 示例值：运行中 |
| CreateTime | String | 集群创建时间。按照RFC3339标准表示，并且使用东八区时区时间，格式为：YYYY-MM-DDThh:mm:ss+08:00。 示例值：2021-11-18T18:10:25+08:00 |
| StorageUsed | Float | 存储当前使用量，单位GiB 示例值：0.13 |
| StorageLimit | Integer | 存储最大使用量，单位GiB 示例值：1024 |
| PayMode | String | 付费模式： - PREPAID : 预付费，即包年包月 - POSTPAID_BY_HOUR : 按小时结算后付费 示例值：PREPAID |
| PayPeriodEndTime | String | 预付费集群到期时间。按照RFC3339标准表示，并且使用东八区时区时间，格式为：YYYY-MM-DDThh:mm:ss+08:00。 示例值：2021-11-18T18:10:25+08:00 |
| AutoRenewFlag | Integer | 预付费集群自动续费标签 - 0 : 到期不自动续费 - 1 : 到期自动续费 示例值：1 |
| DBCharset | String | 数据库字符集 示例值：UTF8 |
| InstanceCount | Integer | 集群内实例的数量 示例值：1 |
| EndpointSet | Array of Endpoint | 集群内访问点信息 示例值：[] |
| DBMajorVersion | String | TDSQL-C PostgreSQL 合入的社区主要版本号 示例值：10 |
| DBKernelVersion | String | TDSQL-C PostgreSQL 内核版本号 示例值：v10.17_r1.4 |
| StoragePayMode | String | 存储付费模式 - PREPAID：预付费，即包年包月 - POSTPAID_BY_HOUR：按小时后付费 注意：此字段可能返回 null，表示取不到有效值。 示例值：PREPAID |
Endpoint
集群的连接点信息，包含访问数据库的相关网络信息
被如下接口引用：DescribeClusterEndpoints, DescribeClusters。
| 名称 | 类型 | 描述 |
|---|---|---|
| EndpointId | String | 连接点ID，集群内唯一 示例值：tdcpg-ep-xxx |
| ClusterId | String | 连接点所属的集群ID 示例值：tdcpg-xxx |
| EndpointName | String | 连接点名字，默认和连接点ID一致 示例值：tdcpg-ep-xxx |
| EndpointType | String | 连接点类型 - RW : 读写 - RO : 只读 示例值：RW |
| VpcId | String | 私有网络VPC实例ID 示例值：vpc-xxxx |
| SubnetId | String | 私有网络VPC下子网实例ID 示例值：subnet-xxx |
| PrivateIp | String | 私有网络VPC下用于访问数据库的IP 示例值：10.0.0.1 |
| PrivatePort | Integer | 私有网络VPC下用于访问数据库的端口 示例值：5432 |
| WanIp | String | 公共网络用户访问数据库的IP 示例值：111.0.0.1 |
| WanPort | Integer | 公共网络用户访问数据库的端口 示例值：5432 |
| WanDomain | String | 公共网络用户访问数据库的域名 示例值：gz-tdcpg-ep-xxx.sql.tencentcdb.com |
Filter
过滤条件
被如下接口引用：DescribeClusterInstances, DescribeClusters。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 过滤条件名 示例值：ClusterId |
| Values | Array of String | 是 | 过滤条件值数组 示例值：[tdsqlcpg-xxxx,tdsqlcpg-xxx] |
| ExactMatch | Boolean | 是 | true:精确匹配(默认值) false:(模糊匹配) 示例值：true |
Instance
集群下的实例信息
被如下接口引用：DescribeClusterInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID，集群下唯一 示例值：tdcpg-ins-xxx |
| InstanceName | String | 实例名字，默认和实例ID一致 示例值：MyInstanceName |
| ClusterId | String | 集群ID 示例值：tdcpg-xxx |
| EndpointId | String | 实例所在的访问点ID 示例值：tdcpg-ep-xxx |
| Region | String | 地域 示例值：ap-guangzhou |
| Zone | String | 可用区 示例值：ap-guangzhou-2 |
| DBVersion | String | 数据库版本 示例值：10.17 |
| Status | String | 实例状态 示例值：running |
| StatusDesc | String | 实例状态中文含义 示例值：运行中 |
| CreateTime | String | 实例创建时间。按照RFC3339标准表示，并且使用东八区时区时间，格式为：YYYY-MM-DDThh:mm:ss+08:00。 示例值：2021-11-18T18:10:25+08:00 |
| PayMode | String | 付费模式： - PREPAID : 预付费 - POSTPAID_BY_HOUR : 按小时结算后付费 同一集群下付费模式需要保持一致。 示例值：PREPAID |
| PayPeriodEndTime | String | 实例到期时间。同一集群下到期时间需要保持一致。按照RFC3339标准表示，并且使用东八区时区时间，格式为：YYYY-MM-DDThh:mm:ss+08:00。 示例值：2021-11-18T18:10:25+08:00 |
| CPU | Integer | CPU核数 示例值：1 |
| Memory | Integer | 内存大小，单位GiB 示例值：2 |
| InstanceType | String | 实例类型 - RW：读写实例 - RO：只读实例 示例值：RW |
| DBMajorVersion | String | TDSQL-C PostgreSQL 合入的社区主要版本号 示例值：10 |
| DBKernelVersion | String | TDSQL-C PostgreSQL 内核版本号 示例值：v10.17_r1.4 |
ResourceIdInfo
资源ID信息，包括ClusterID和InstanceID
被如下接口引用：DescribeResourcesByDealName。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClusterId | String | 集群ID 示例值：tdcpg-xxx |
| InstanceIdSet | Array of String | 实例ID列表 示例值：[tdcpg-ins-xxx,tdcpg-ins-xxx] |