数据结构

AccountInfo

账户信息

被如下接口引用：DescribeAccounts。

名称	类型	描述
DBInstanceId	String	实例ID，形如postgres-lnp6j617 示例值：postgres-lnp6j617
UserName	String	账号 示例值：test_user
Remark	String	账号备注 示例值：remark
Status	Integer	账号状态。 1-创建中，2-正常，3-修改中，4-密码重置中，5-锁定中，-1-删除中 示例值：2
CreateTime	Timestamp	账号创建时间 示例值：2024-06-06 21:00:12
UpdateTime	Timestamp	账号最后一次更新时间 示例值：2024-06-06 22:00:12
UserType	String	账号类型 示例值：normal

AnalysisItems

慢查询分析接口返回的分析详情，按照参数抽象之后进行分类

被如下接口引用：DescribeSlowQueryAnalysis。

名称	类型	描述
DatabaseName	String	慢SQL查询的数据库名 示例值：postgres
UserName	String	慢SQL执行的用户名 示例值：postgres
NormalQuery	String	抽象参数之后的慢SQL 示例值：select $1
ClientAddr	String	慢SQL执行的客户端地址 示例值：::1
CallNum	Integer	在选定时间范围内慢SQL语句执行的次数 示例值：1
CallPercent	Float	在选定时间范围内，慢SQL语句执行的次数占所有慢SQL的比例（小数返回） 示例值：0.1
CostTime	Float	在选定时间范围内，慢SQL执行的总时间 示例值：1.1
CostPercent	Float	在选定时间范围内，慢SQL语句执行的总时间占所有慢SQL的比例（小数返回） 示例值：0.2
MinCostTime	Float	在选定时间范围内，慢SQL语句执行的耗时最短的时间（单位：ms） 示例值：0.01
MaxCostTime	Float	在选定时间范围内，慢SQL语句执行的耗时最长的时间（单位：ms） 示例值：1
AvgCostTime	Float	在选定时间范围内，慢SQL语句执行的耗时平均时间（单位：ms） 示例值：0.2
FirstTime	String	在选定时间范围内，慢SQL第一条开始执行的时间戳 示例值：2020-01-01 01:01:01
LastTime	String	在选定时间范围内，慢SQL最后一条开始执行的时间戳 示例值：2020-01-01 01:01:01

BackupDownloadRestriction

备份下载限制信息

被如下接口引用：DescribeBackupDownloadURL。

名称	类型	必选	描述
RestrictionType	String	否	备份文件下载限制类型，NONE 无限制，内外网都可以下载；INTRANET 只允许内网下载；CUSTOMIZE 自定义限制下载的vpc或ip。 示例值：NONE
VpcRestrictionEffect	String	否	vpc限制效力，ALLOW 允许；DENY 拒绝。 示例值：ALLOW
VpcIdSet	Array of String	否	允许或拒绝下载备份文件的vpcId列表。 示例值：[ "vpc-15ld6dhr" ]
IpRestrictionEffect	String	否	ip限制效力，ALLOW 允许；DENY 拒绝。 示例值：ALLOW
IpSet	Array of String	否	允许或拒绝下载备份文件的ip列表。 示例值：[ "10.10.10.220" ]

BackupPlan

备份计划

被如下接口引用：DescribeBackupPlans。

名称	类型	描述
BackupPeriod	String	备份周期 示例值：["monday","thursday","friday"]
BaseBackupRetentionPeriod	Integer	数据备份保留时长 示例值：3
MinBackupStartTime	String	开始备份的最早时间 示例值：01:00:00
MaxBackupStartTime	String	开始备份的最晚时间 示例值：02:00:00
PlanId	String	备份计划ID 示例值：f6adc02a-432e-536f-a5f3-3dbf40ecd683
PlanName	String	备份计划自定义名称。 示例值：default
LogBackupRetentionPeriod	Integer	日志备份保留时长。 示例值：3
CreatedTime	String	创建时间。 示例值：2024-10-09 15:16:51
UpdatedTime	String	最近一次的修改时间。 示例值：2024-11-09 15:16:51
PlanType	String	备份计划类型。系统默认创建的为default，自定义的为custom。 示例值：default
BackupPeriodType	String	备份周期类型。当前支持week、month。 示例值：week

BackupSummary

实例备份统计项

被如下接口引用：DescribeBackupSummaries。

名称	类型	描述
DBInstanceId	String	实例ID。 示例值：postgres-xxxxxxxx
LogBackupCount	Integer	实例日志备份数量。 示例值：0
LogBackupSize	Integer	实例日志备份大小。 示例值：0
ManualBaseBackupCount	Integer	手动创建的实例数据备份数量。 示例值：0
ManualBaseBackupSize	Integer	手动创建的实例数据备份大小。 示例值：0
AutoBaseBackupCount	Integer	自动创建的实例数据备份数量。 示例值：0
AutoBaseBackupSize	Integer	自动创建的实例数据备份大小。 示例值：0
TotalBackupCount	Integer	总备份数量 示例值：0
TotalBackupSize	Integer	总备份大小 示例值：0

BaseBackup

数据库数据备份信息

被如下接口引用：DescribeBaseBackups。

名称	类型	描述
DBInstanceId	String	实例ID。 示例值：postgres-xxxxxxxx
Id	String	备份文件唯一标识。 示例值：f6adc02a-432e-536f-a5f3-3dbf40ecd683
Name	String	备份文件名称。 示例值：0
BackupMethod	String	备份方式：物理备份、逻辑备份。 示例值：0
BackupMode	String	备份模式：自动备份、手动备份。 示例值：0
State	String	备份任务状态。 示例值：0
Size	Integer	备份集大小，单位bytes。 示例值：0
StartTime	String	备份的开始时间。 示例值：0
FinishTime	String	备份的结束时间。 示例值：0
ExpireTime	String	备份的过期时间。 示例值：0

ClassInfo

数据库实例规格

被如下接口引用：DescribeClasses。

名称	类型	描述
SpecCode	String	规格ID 示例值：pg.it.2xlarge16
CPU	Integer	CPU核数 示例值：8
Memory	Integer	内存大小，单位：MB 示例值：16384
MaxStorage	Integer	该规格所支持最大存储容量，单位：GB 示例值：4000
MinStorage	Integer	该规格所支持最小存储容量，单位：GB 示例值：10
QPS	Integer	该规格的预估QPS 示例值：20000

DBBackup

数据库备份信息

被如下接口引用：DescribeDBBackups。

名称	类型	描述
Id	Integer	备份文件唯一标识 示例值：450
StartTime	String	文件生成的开始时间 示例值：2018-06-21 01:55:04.199169
EndTime	String	文件生成的结束时间 示例值：2018-06-21 01:55:58.477232
Size	Integer	文件大小(K) 示例值：3654991
Strategy	Integer	策略（0-实例备份；1-多库备份） 示例值：1
Way	Integer	类型（0-定时） 示例值：1
Type	Integer	备份方式（1-完整） 示例值：1
Status	Integer	状态（1-创建中；2-成功；3-失败） 示例值：2
DbList	Array of String	DB列表 示例值：[ "db2" ]
InternalAddr	String	内网下载地址 示例值：http://172.16.16.30:8366/download/20180621015515.tar.gz?giz7Z4LlMjascFkshSSB4+B1gaI0F3HAQIZcFPDbIse2MDEI7vd/CuyMUMMyDXAd4ld69sCMdEKwkpFWIVcfE+PZ0+MYTbsBHzW84KtSGw8=
ExternalAddr	String	外网下载地址 示例值：https://gz-dl-postgres.cloud.tencent.com/download/20180621015515.tar.gz?giz7Z4LlMjascFkshSSB4+B1gaI0F3HAQIZcFPDbIse2MDEI7vd/CuyMUMMyDXAd4ld69sCMdEKwkpFWIVcfE+PZ0+MYTbsBHzW84KtSGw8=
SetId	String	备份集ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：f6yecd1a-087c-5c66-cdas-95c835d7ec24

DBInstance

描述实例的详细信息

被如下接口引用：DescribeDBInstanceAttribute, DescribeDBInstances, DescribeReadOnlyGroups。

名称	类型	描述
Region	String	实例所属地域，如: ap-guangzhou，对应RegionSet的Region字段。 示例值：ap-guangzhou
Zone	String	实例所属可用区， 如：ap-guangzhou-3，对应ZoneSet的Zone字段。 示例值：ap-guangzhou-3
VpcId	String	私有网络ID，形如vpc-e6w23k31。有效的VpcId可通过登录控制台查询；也可以调用接口 DescribeVpcs ，从接口返回中的unVpcId字段获取。 示例值：vpc-e6w23k31
SubnetId	String	私有网络子网ID，形如subnet-51lcif9y。有效的私有网络子网ID可通过登录控制台查询；也可以调用接口 DescribeSubnets ，从接口返回中的unSubnetId字段获取。 示例值：subnet-51lcif9y
DBInstanceId	String	实例ID。 示例值：postgres-7lzldndx
DBInstanceName	String	实例名称。 示例值：数据库名称
DBInstanceStatus	String	实例状态，分别为：applying（申请中）、init(待初始化)、initing(初始化中)、running(运行中)、limited run（受限运行）、isolating（隔离中）、isolated（已隔离）、disisolating（解隔离中）、recycling（回收中）、recycled（已回收）、job running（任务执行中）、offline（下线）、migrating（迁移中）、expanding（扩容中）、waitSwitch（等待切换）、switching（切换中）、readonly（只读）、restarting（重启中）、network changing（网络变更中）、upgrading（内核版本升级中）、audit-switching（审计状态变更中）、primary-switching（主备切换中） 示例值：applying
DBInstanceMemory	Integer	实例分配的内存大小，单位：GB 示例值：2
DBInstanceStorage	Integer	实例分配的存储空间大小，单位：GB 示例值：10
DBInstanceCpu	Integer	实例分配的CPU数量，单位：个 示例值：2
DBInstanceClass	String	售卖规格ID 示例值：cdb.pg.ts1.2g
DBMajorVersion	String	PostgreSQL大版本号，版本信息可从DescribeDBVersions获取，目前支持10，11，12，13，14，15这几个大版本。 注意：此字段可能返回 null，表示取不到有效值。 示例值：12
DBVersion	String	PostgreSQL社区大版本+小版本号，如12.4，版本信息可从DescribeDBVersions获取。 示例值：12.4
DBKernelVersion	String	PostgreSQL内核版本号，如v12.7_r1.8，版本信息可从DescribeDBVersions获取。 注意：此字段可能返回 null，表示取不到有效值。 示例值：v12.4_r1.0
DBInstanceType	String	实例类型，类型有： primary：主实例 readonly：只读实例 guard：灾备实例 temp：临时实例 示例值：primary
DBInstanceVersion	String	实例版本，目前只支持standard（双机高可用版, 一主一从）。 示例值：standard
DBCharset	String	实例字符集，目前只支持： UTF8 LATIN1 示例值：utf-8
CreateTime	Timestamp	实例创建时间。 示例值：2014-08-03 12:00:00
UpdateTime	Timestamp	实例执行最后一次更新的时间。 示例值：2014-08-03 12:00:00
ExpireTime	Timestamp	实例到期时间。 示例值：2014-08-03 12:00:00
IsolatedTime	Timestamp	实例隔离时间。 示例值：2014-08-03 12:00:00
PayType	String	计费模式： prepaid：包年包月,预付费 postpaid：按量计费，后付费 示例值：prepaid
AutoRenew	Integer	是否自动续费： 0：手动续费 1：自动续费 默认值：0 示例值：1
DBInstanceNetInfo	Array of DBInstanceNetInfo	实例网络连接信息。 示例值：[ { "Address": "", "Ip": "10.10.10.220", "Port": 5432, "Status": "opened", "NetType": "private", "VpcId": "vpc-xxxxxxxx", "SubnetId": "subnet-xxxxxxxx" }, { "Address": "", "Ip": "", "Port": 0, "Status": "", "NetType": "public", "VpcId": "", "SubnetId": "" } ]
Type	String	机器类型。 示例值：TS85
AppId	Integer	用户的AppId。 示例值：123455
Uid	Integer	实例的Uid。 示例值：12344
ProjectId	Integer	项目ID。 示例值：1
TagList	Array of Tag	实例绑定的标签信息。 注意：此字段可能返回 null，表示取不到有效值。 示例值：[ { "TagKey": "tag1", "TagValue": "v1" } ]
MasterDBInstanceId	String	主实例信息，仅在实例为只读实例时返回。 注意：此字段可能返回 null，表示取不到有效值。 示例值：postgres-7lzldndx
ReadOnlyInstanceNum	Integer	只读实例数量。 注意：此字段可能返回 null，表示取不到有效值。 示例值：6
StatusInReadonlyGroup	String	只读实例在只读组中的状态。 注意：此字段可能返回 null，表示取不到有效值。 示例值：ok
OfflineTime	String	下线时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2014-08-03 12:00
DBNodeSet	Array of DBNode	实例的节点信息。 注意：此字段可能返回 null，表示取不到有效值。 示例值：[ { "Role": "Primary", "Zone": "ap-guangzhou-2" } ]
IsSupportTDE	Integer	实例是否支持TDE数据加密： 0：不支持 1：支持 默认值：0 TDE数据加密可参考数据透明加密概述 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
DBEngine	String	数据库引擎，支持： postgresql：云数据库PostgreSQL mssql_compatible：MSSQL兼容-云数据库PostgreSQL 默认值：postgresql 注意：此字段可能返回 null，表示取不到有效值。 示例值：postgresql
DBEngineConfig	String	数据库引擎的配置信息，配置格式如下： {"$key1":"$value1", "$key2":"$value2"} 各引擎支持如下： mssql_compatible引擎： migrationMode：数据库模式，可选参数，可取值：single-db（单数据库模式），multi-db（多数据库模式）。默认为single-db。 defaultLocale：排序区域规则，可选参数，在初始化后不可修改，默认为en_US，可选值如下： "af_ZA", "sq_AL", "ar_DZ", "ar_BH", "ar_EG", "ar_IQ", "ar_JO", "ar_KW", "ar_LB", "ar_LY", "ar_MA", "ar_OM", "ar_QA", "ar_SA", "ar_SY", "ar_TN", "ar_AE", "ar_YE", "hy_AM", "az_Cyrl_AZ", "az_Latn_AZ", "eu_ES", "be_BY", "bg_BG", "ca_ES", "zh_HK", "zh_MO", "zh_CN", "zh_SG", "zh_TW", "hr_HR", "cs_CZ", "da_DK", "nl_BE", "nl_NL", "en_AU", "en_BZ", "en_CA", "en_IE", "en_JM", "en_NZ", "en_PH", "en_ZA", "en_TT", "en_GB", "en_US", "en_ZW", "et_EE", "fo_FO", "fa_IR", "fi_FI", "fr_BE", "fr_CA", "fr_FR", "fr_LU", "fr_MC", "fr_CH", "mk_MK", "ka_GE", "de_AT", "de_DE", "de_LI", "de_LU", "de_CH", "el_GR", "gu_IN", "he_IL", "hi_IN", "hu_HU", "is_IS", "id_ID", "it_IT", "it_CH", "ja_JP", "kn_IN", "kok_IN", "ko_KR", "ky_KG", "lv_LV", "lt_LT", "ms_BN", "ms_MY", "mr_IN", "mn_MN", "nb_NO", "nn_NO", "pl_PL", "pt_BR", "pt_PT", "pa_IN", "ro_RO", "ru_RU", "sa_IN", "sr_Cyrl_RS", "sr_Latn_RS", "sk_SK", "sl_SI", "es_AR", "es_BO", "es_CL", "es_CO", "es_CR", "es_DO", "es_EC", "es_SV", "es_GT", "es_HN", "es_MX", "es_NI", "es_PA", "es_PY","es_PE", "es_PR", "es_ES", "es_TRADITIONAL", "es_UY", "es_VE", "sw_KE", "sv_FI", "sv_SE", "tt_RU", "te_IN", "th_TH", "tr_TR", "uk_UA", "ur_IN", "ur_PK", "uz_Cyrl_UZ", "uz_Latn_UZ", "vi_VN"。 serverCollationName：排序规则名称，可选参数，在初始化后不可修改，默认为sql_latin1_general_cp1_ci_as，可选值如下："bbf_unicode_general_ci_as", "bbf_unicode_cp1_ci_as", "bbf_unicode_CP1250_ci_as", "bbf_unicode_CP1251_ci_as", "bbf_unicode_cp1253_ci_as", "bbf_unicode_cp1254_ci_as", "bbf_unicode_cp1255_ci_as", "bbf_unicode_cp1256_ci_as", "bbf_unicode_cp1257_ci_as", "bbf_unicode_cp1258_ci_as", "bbf_unicode_cp874_ci_as", "sql_latin1_general_cp1250_ci_as", "sql_latin1_general_cp1251_ci_as", "sql_latin1_general_cp1_ci_as", "sql_latin1_general_cp1253_ci_as", "sql_latin1_general_cp1254_ci_as", "sql_latin1_general_cp1255_ci_as","sql_latin1_general_cp1256_ci_as", "sql_latin1_general_cp1257_ci_as", "sql_latin1_general_cp1258_ci_as", "chinese_prc_ci_as", "cyrillic_general_ci_as", "finnish_swedish_ci_as", "french_ci_as", "japanese_ci_as", "korean_wansung_ci_as", "latin1_general_ci_as", "modern_spanish_ci_as", "polish_ci_as", "thai_ci_as", "traditional_spanish_ci_as", "turkish_ci_as", "ukrainian_ci_as", "vietnamese_ci_as"。 注意：此字段可能返回 null，表示取不到有效值。 示例值：{ "migrationMode": "single-db", "defaultLocale": "zh_CN", "serverCollationName": "sql_latin1_general_cp1250_ci_as" }
NetworkAccessList	Array of NetworkAccess	实例网络信息列表（此字段已废弃） 注意：此字段可能返回 null，表示取不到有效值。 示例值：[]
SupportIpv6	Integer	实例是否支持Ipv6： 0：否 1：是 默认值：0 示例值：1

DBInstanceNetInfo

描述实例的网络连接信息。

被如下接口引用：DescribeDBInstanceAttribute, DescribeDBInstances, DescribeReadOnlyGroups。

名称	类型	描述
Address	String	DNS域名 示例值：cd-postgres-xxxxxxxx.sql.tencentcdb.com
Ip	String	IP地址 示例值：111.111.11.11
Port	Integer	连接Port地址 示例值：5432
NetType	String	网络类型，1、inner（基础网络内网地址）；2、private（私有网络内网地址）；3、public（基础网络或私有网络的外网地址）； 示例值：private
Status	String	网络连接状态，1、initing（未开通）；2、opened（已开通）；3、closed（已关闭）；4、opening（开通中）；5、closing（关闭中）； 示例值：opened
VpcId	String	私有网络ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc-xxxxxxxx
SubnetId	String	子网ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：subnet-xxxxxxxx
ProtocolType	String	连接数据库的协议类型，当前支持：postgresql、mssql（MSSQL兼容语法） 注意：此字段可能返回 null，表示取不到有效值。 示例值：postgresql

DBNode

描述实例节点信息，包括节点类型、节点所在可用区、节点所在专属集群。

被如下接口引用：CloneDBInstance, CreateInstances, DescribeDBInstanceAttribute, DescribeDBInstances, ModifyDBInstanceDeployment。

名称	类型	必选	描述
Role	String	是	节点类型，值可以为： Primary，代表主节点； Standby，代表备节点。 示例值：Primary, Standby
Zone	String	是	节点所在可用区，例如 ap-guangzhou-1。 示例值：ap-guangzhou-1
DedicatedClusterId	String	否	专属集群ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cluster-d8htgb6k

Database

描述数据库详细信息，包括所有者、字符编码等

被如下接口引用：DescribeDatabases。

名称	类型	描述
DatabaseName	String	数据库名 注意：此字段可能返回 null，表示取不到有效值。 示例值：postgres
DatabaseOwner	String	数据库所有者 注意：此字段可能返回 null，表示取不到有效值。 示例值：postgres
Encoding	String	数据库字符编码 注意：此字段可能返回 null，表示取不到有效值。 示例值：UTF8
Collate	String	数据库排序规则 注意：此字段可能返回 null，表示取不到有效值。 示例值：C
Ctype	String	数据库字符分类 注意：此字段可能返回 null，表示取不到有效值。 示例值：C
AllowConn	Boolean	数据库是否允许连接 注意：此字段可能返回 null，表示取不到有效值。 示例值：false
ConnLimit	Integer	数据库最大连接数，-1表示无限制 注意：此字段可能返回 null，表示取不到有效值。 示例值：-1
Privileges	String	数据库权限列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：postgres=CTc/postgres

DatabaseObject

描述数据库中某个对象所属的类型、是在哪个数据库、模式、表中的对象。

被如下接口引用：DescribeAccountPrivileges。

名称	类型	必选	描述
ObjectType	String	是	支持使用的数据库对象类型有：account,database,schema,sequence,procedure,type,function,table,view,matview,column。 注意：此字段可能返回 null，表示取不到有效值。 示例值：database
ObjectName	String	是	所描述的数据库对象名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_database
DatabaseName	String	否	所要描述的数据库对象，所属的数据库名称。当描述对象类型不为database时，此参数必选。 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_database
SchemaName	String	否	所要描述的数据库对象，所属的模式名称。当描述对象不为database、schema时，此参数必选。 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_schema
TableName	String	否	所要描述的数据库对象，所属的表名称。当描述的对象类型为column时，此参数必填。 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_table

DatabasePrivilege

指定账号对数据库对象拥有的权限列表

被如下接口引用：DescribeAccountPrivileges, ModifyAccountPrivileges。

名称	类型	必选	描述
Object	DatabaseObject	否	数据库对象，当ObjectType为database时，DataseName/SchemaName/TableName可为空；当ObjectType为schema时，SchemaName/TableName可为空；当ObjectType为column时，TableName不可为空，其余情况均可为空。 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"ObjectType":"table","ObjectName":"test_table","DatabaseName":"test_database","SchemaName":"test_schema"}
PrivilegeSet	Array of String	否	指定账号对数据库对象拥有的权限列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["SELECT"]

DedicatedCluster

专属集群相关信息，用于查询用户的专属集群列表

被如下接口引用：DescribeDedicatedClusters。

名称	类型	必选	描述
DedicatedClusterId	String	否	专属集群ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：dedicatedCluster-gz
Name	String	否	专属集群名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：TestDedicatedClusterName
Zone	String	否	专属集群所在可用区 注意：此字段可能返回 null，表示取不到有效值。 示例值：ap-guangzhou
StandbyDedicatedClusterSet	Array of String	否	灾备集群 注意：此字段可能返回 null，表示取不到有效值。 示例值：dedicatedCluster-sh
InstanceCount	Integer	否	实例数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
CpuTotal	Integer	否	Cpu总量 注意：此字段可能返回 null，表示取不到有效值。 示例值：10
CpuAvailable	Integer	否	Cpu可用数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：10
MemTotal	Integer	否	内存总量 注意：此字段可能返回 null，表示取不到有效值。 示例值：10
MemAvailable	Integer	否	内存可用量 注意：此字段可能返回 null，表示取不到有效值。 示例值：10
DiskTotal	Integer	否	磁盘总量 注意：此字段可能返回 null，表示取不到有效值。 示例值：10
DiskAvailable	Integer	否	磁盘可用量 注意：此字段可能返回 null，表示取不到有效值。 示例值：10

Detail

慢SQL 统计分析接口返回详情

被如下接口引用：DescribeSlowQueryAnalysis。

名称	类型	描述
TotalTime	Float	输入时间范围内所有慢sql执行的总时间，单位毫秒（ms） 示例值：0.1
TotalCallNum	Integer	输入时间范围内所有慢sql总条数 示例值：0
AnalysisItems	Array of AnalysisItems	慢SQL统计分析列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：[ { "AvgCostTime": 101.01300048828125, "ClientAddr": "", "CostPercent": 11.703700311890035, "CostTime": 101.01300048828125, "DatabaseName": "postgres", "FirstTime": "2021-07-27 03:12:01", "LastTime": "2021-07-27 03:12:01", "MaxCostTime": 101.01300048828125, "MinCostTime": 101.01300048828125, "NormalQuery": "select $1 from information_schema.tables where table_schema = $2 and table_name = $3", "UserName": "postgres" } ]

DurationAnalysis

慢SQL耗时分段分析

被如下接口引用：DescribeSlowQueryList。

名称	类型	描述
TimeSegment	String	慢SQL耗时，时段 示例值：“0-1s”
Count	Integer	对应时段区间慢SQL 条数 示例值：10

EncryptionKey

KMS密钥信息

被如下接口引用：DescribeEncryptionKeys。

名称	类型	描述
KeyId	String	KMS实例加密的KeyId。 注意：此字段可能返回 null，表示取不到有效值。 示例值：975982f8-b2d5-11ef-a4a2-525400000000
KeyAlias	String	KMS实例加密Key的别名。 注意：此字段可能返回 null，表示取不到有效值。 示例值：PGSQL-KMS
DEKCipherTextBlob	String	实例加密密钥DEK的密文。 注意：此字段可能返回 null，表示取不到有效值。 示例值：A****9
IsEnabled	Integer	密钥是否启用，1-启用， 0-未启用。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
KeyRegion	String	KMS密钥所在地域。 注意：此字段可能返回 null，表示取不到有效值。 示例值：ap-guangzhou
CreateTime	String	DEK密钥创建时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2014-08-03 12:00:00

ErrLogDetail

错误日志详情

被如下接口引用：DescribeDBErrlogs。

名称	类型	描述
UserName	String	用户名 示例值：app_user
Database	String	数据库名字 示例值：user-data-db
ErrTime	String	错误发生时间 示例值：2024-12-04 21:13:46
ErrMsg	String	错误消息 示例值：2024-12-04 21:13:46.789 UTC [12345] FATAL: password authentication failed for user "myuser"

EventInfo

参数修改事件信息

被如下接口引用：DescribeParamsEvent。

名称	类型	描述
ParamName	String	参数名 注意：此字段可能返回 null，表示取不到有效值。 示例值：wal_level
OldValue	String	原参数值 注意：此字段可能返回 null，表示取不到有效值。 示例值：replica
NewValue	String	本次修改期望参数值 注意：此字段可能返回 null，表示取不到有效值。 示例值：logical
ModifyTime	String	后台参数修改开始时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-08-01 02:03:04
EffectiveTime	String	后台参数生效开始时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-08-01 02:03:34
State	String	修改状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：success
Operator	String	操作者（一般为用户sub UIN） 注意：此字段可能返回 null，表示取不到有效值。 示例值：123344
EventLog	String	时间日志。 注意：此字段可能返回 null，表示取不到有效值。 示例值：this event is success

EventItem

修改参数条目，以参数为维度

被如下接口引用：DescribeParamsEvent。

名称	类型	描述
ParamName	String	参数名 注意：此字段可能返回 null，表示取不到有效值。 示例值：wal_level
EventCount	Integer	修改事件数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
EventDetail	Array of EventInfo	修改时间详情 注意：此字段可能返回 null，表示取不到有效值。 示例值：[]

Filter

描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称等

• 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。
• 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。

被如下接口引用：DescribeBackupSummaries, DescribeBaseBackups, DescribeDBInstances, DescribeDatabases, DescribeDedicatedClusters, DescribeLogBackups, DescribeParameterTemplates, DescribeReadOnlyGroups, DescribeServerlessDBInstances。

名称	类型	必选	描述
Name	String	否	过滤键的名称。 示例值：db-instance-id
Values	Array of String	否	一个或者多个过滤值。 示例值：postgres-kwk4tq23

LogBackup

数据库日志备份信息

被如下接口引用：DescribeLogBackups。

名称	类型	描述
DBInstanceId	String	实例ID。 示例值：0
Id	String	备份文件唯一标识。 示例值：0
Name	String	备份文件名称。 示例值：0
BackupMethod	String	备份方式：物理备份、逻辑备份。 示例值：0
BackupMode	String	备份模式：自动备份、手动备份。 示例值：0
State	String	备份任务状态。 示例值：0
Size	Integer	备份集大小，单位bytes。 示例值：0
StartTime	String	备份的开始时间。 示例值：0
FinishTime	String	备份的结束时间。 示例值：0
ExpireTime	String	备份的过期时间。 示例值：0

ModifyPrivilege

用于修改数据库对象的权限，其中包含了数据库对象描述的数据结构、需要修改的权限列表以及修改的类型等。

被如下接口引用：ModifyAccountPrivileges。

名称	类型	必选	描述
DatabasePrivilege	DatabasePrivilege	否	要修改的数据库对象及权限列表 注意：此字段可能返回 null，表示取不到有效值。 示例值："Object":{"ObjectType":"table","ObjectName":"test_table","DatabaseName":"test_database","SchemaName":"test_schema"},"Privileges":["SELECT"]
ModifyType	String	否	修改的方式，当前仅支持grantObject、revokeObject、alterRole。grantObject代表授权、revokeObject代表收回权、alterRole代表修改账号类型。 注意：此字段可能返回 null，表示取不到有效值。 示例值：grantObject
IsCascade	Boolean	否	当ModifyType为revokeObject才需要此参数，参数为true时，撤销权限会级联撤销。默认为false。 注意：此字段可能返回 null，表示取不到有效值。 示例值：false

NetworkAccess

网络相关信息。（该数据结构已废弃，网络相关信息使用DBInstanceNetInfo）

被如下接口引用：DescribeDBInstanceAttribute, DescribeDBInstances, DescribeReadOnlyGroups。

名称	类型	描述
ResourceId	String	网络资源id，实例id或RO组id 注意：此字段可能返回 null，表示取不到有效值。 示例值：postgres-xxxxxxxx
ResourceType	Integer	资源类型，1-实例 2-RO组 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
VpcId	String	私有网络ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc-xxxxxxxx
Vip	String	IPV4地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：11.11.1.11
Vip6	String	IPV6地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：2000:0000:0000:0000:0001:2345:6789:abcd
Vport	Integer	访问端口 注意：此字段可能返回 null，表示取不到有效值。 示例值：5432
SubnetId	String	子网ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：subnet-xxxxxxxx
VpcStatus	Integer	网络状态，1-申请中，2-使用中，3-删除中，4-已删除 注意：此字段可能返回 null，表示取不到有效值。 示例值：1

NormalQueryItem

单条SlowQuery信息

被如下接口引用：DescribeDBSlowlogs。

名称	类型	描述
UserName	String	用户名 示例值：db_user
Calls	Integer	调用次数 示例值：150
CallsGrids	Array of Integer	粒度点 示例值：[10,20,30,40,50]
CostTime	Float	花费总时间 示例值：120.5
Rows	Integer	影响的行数 示例值：75
MinCostTime	Float	花费最小时间 示例值：0.5
MaxCostTime	Float	花费最大时间 示例值：5.0
FirstTime	String	最早一条慢SQL时间 示例值：2024-10-01T10:00:00Z
LastTime	String	最晚一条慢SQL时间 示例值：2024-10-01T10:05:00Z
SharedReadBlks	Integer	读共享内存块数 示例值：300
SharedWriteBlks	Integer	写共享内存块数 示例值：50
ReadCostTime	Integer	读io总耗时 示例值：100
WriteCostTime	Integer	写io总耗时 示例值：20
DatabaseName	String	数据库名字 示例值：my_database
NormalQuery	String	脱敏后的慢SQL 示例值：SELECT * FROM users WHERE age > 30

ParamEntry

批量修改参数

被如下接口引用：ModifyDBInstanceParameters, ModifyParameterTemplate。

名称	类型	必选	描述
Name	String	是	参数名 示例值：wal_level
ExpectedValue	String	是	修改参数值。入参均以字符串形式传递，例如：小数”0.1“、整数”1000“、枚举”replica“ 示例值：replica

ParamInfo

参数详情

被如下接口引用：DescribeDBInstanceParameters, DescribeDefaultParameters, DescribeParameterTemplateAttributes。

名称	类型	描述
ID	Integer	参数ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
Name	String	参数名 注意：此字段可能返回 null，表示取不到有效值。 示例值：wal_level
ParamValueType	String	参数值类型：integer（整型）、real（浮点型）、bool（布尔型）、enum（枚举类型）、mutil_enum（枚举类型、支持多选）。 当参数类型为integer（整型）、real（浮点型）时，参数的取值范围根据返回值的Max、Min确定； 当参数类型为bool（布尔型）时，参数设置值取值范围是true | false； 当参数类型为enum（枚举类型）、mutil_enum（多枚举类型）时，参数的取值范围由返回值中的EnumValue确定。 注意：此字段可能返回 null，表示取不到有效值。 示例值：integer
Unit	String	参数值 单位。参数没有单位时，该字段返回空 注意：此字段可能返回 null，表示取不到有效值。 示例值：ms
DefaultValue	String	参数默认值。以字符串形式返回 注意：此字段可能返回 null，表示取不到有效值。 示例值：replica
CurrentValue	String	参数当前运行值。以字符串形式返回 注意：此字段可能返回 null，表示取不到有效值。 示例值：replica
Max	Float	数值类型（integer、real）参数，取值下界 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
EnumValue	Array of String	枚举类型参数，取值范围 注意：此字段可能返回 null，表示取不到有效值。 示例值：[replica,logical]
Min	Float	数值类型（integer、real）参数，取值上界 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000
ParamDescriptionCH	String	参数中文描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：此参数决定记录到日志的信息，不允许设置为minimal
ParamDescriptionEN	String	参数英文描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：Set the level of information written to the WAL.
NeedReboot	Boolean	参数修改，是否重启生效。（true为需要，false为不需要） 注意：此字段可能返回 null，表示取不到有效值。 示例值：false
ClassificationCN	String	参数中文分类 注意：此字段可能返回 null，表示取不到有效值。 示例值：WAL
ClassificationEN	String	参数英文分类 注意：此字段可能返回 null，表示取不到有效值。 示例值：Write-Ahead Log
SpecRelated	Boolean	是否和规格相关。（true为相关，false为不想关） 注意：此字段可能返回 null，表示取不到有效值。 示例值：false
Advanced	Boolean	是否为重点参数。（true为重点参数，修改是需要重点关注，可能会影响实例性能） 注意：此字段可能返回 null，表示取不到有效值。 示例值：false
LastModifyTime	String	参数最后一次修改时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-08-01 02:03:04
StandbyRelated	Integer	参数主备制约，0：无主备制约关系，1:备机参数值需比主机大，2:主机参数值需比备机大 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
VersionRelationSet	Array of ParamVersionRelation	参数版本关联信息，内容为相应内核版本下的参数详细信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：null
SpecRelationSet	Array of ParamSpecRelation	参数规格关联信息，内容为相应规格下的参数详细信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：null

ParamSpecRelation

各规格下的参数信息

被如下接口引用：DescribeDBInstanceParameters, DescribeDefaultParameters, DescribeParameterTemplateAttributes。

名称	类型	描述
Name	String	参数名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：wal_level
Memory	String	参数信息所属规格 注意：此字段可能返回 null，表示取不到有效值。 示例值：2G
Value	String	参数在该规格下的默认值 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
Unit	String	参数值单位。参数没有单位时，该字段返回空 注意：此字段可能返回 null，表示取不到有效值。 示例值：s
Max	Float	数值类型（integer、real）参数，取值上界 注意：此字段可能返回 null，表示取不到有效值。 示例值：20000
Min	Float	数值类型（integer、real）参数，取值下界 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
EnumValue	Array of String	枚举类型参数，取值范围 注意：此字段可能返回 null，表示取不到有效值。 示例值：[on;off]

ParamVersionRelation

各版本下的参数信息

被如下接口引用：DescribeDBInstanceParameters, DescribeDefaultParameters, DescribeParameterTemplateAttributes。

名称	类型	描述
Name	String	参数名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：wal_level
DBKernelVersion	String	参数信息所属内核版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：v14.1_r1.2
Value	String	参数在该版本该规格下的默认值 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
Unit	String	参数值单位。参数没有单位时，该字段返回空 注意：此字段可能返回 null，表示取不到有效值。 示例值：s
Max	Float	数值类型（integer、real）参数，取值上界 注意：此字段可能返回 null，表示取不到有效值。 示例值：20000
Min	Float	数值类型（integer、real）参数，取值下界 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
EnumValue	Array of String	枚举类型参数，取值范围 注意：此字段可能返回 null，表示取不到有效值。 示例值：[on;off]

ParameterTemplate

参数模板的基本信息

被如下接口引用：DescribeParameterTemplates。

名称	类型	描述
TemplateId	String	参数模板ID 示例值：6e89c045-935f-5d5f-8512-08d7f6cf2210
TemplateName	String	参数模板名称 示例值：my_custom_template
DBMajorVersion	String	参数模板适用的数据库版本 示例值：13
DBEngine	String	参数模板适用的数据库引擎 示例值：postgresql
TemplateDescription	String	参数模板描述 示例值：This template is used for testing

PgDeal

订单详情

被如下接口引用：DescribeOrders。

名称	类型	描述
DealName	String	订单名 示例值：20180615110033
OwnerUin	String	所属用户 示例值：909619400
Count	Integer	订单涉及多少个实例 示例值：1
PayMode	Integer	付费模式。1-预付费；0-后付费 示例值：1
FlowId	Integer	异步任务流程ID 示例值：3356
DBInstanceIdSet	Array of String	实例ID数组 示例值：postgres-2uepfuz1

PolicyRule

安全组规则信息

被如下接口引用：DescribeDBInstanceSecurityGroups。

名称	类型	描述
Action	String	策略，ACCEPT 或者 DROP 示例值：ACCEPT
CidrIp	String	来源或目的 IP 或 IP 段，例如172.16.0.0/12 示例值：0.0.0.0/0
PortRange	String	端口 示例值：ALL
IpProtocol	String	网络协议，支持 UDP、TCP 等 示例值：icmp
Description	String	规则描述 示例值：放通Ping服务

RawSlowQuery

慢SQL查询接口返回 慢SQL列表详情

被如下接口引用：DescribeSlowQueryList。

名称	类型	描述
RawQuery	String	慢SQL 语句 示例值：select 1
DatabaseName	String	慢SQL 查询的数据库 示例值：postgres
Duration	Float	慢SQL执行 耗时 示例值：1.1
ClientAddr	String	执行慢SQL的客户端 示例值：::1
UserName	String	执行慢SQL的用户名 示例值：postgres
SessionStartTime	String	慢SQL执行的开始时间 示例值：2020-02-01 01:02:03

ReadOnlyGroup

只读组信息

被如下接口引用：DescribeReadOnlyGroups。

名称	类型	描述
ReadOnlyGroupId	String	只读组标识 注意：此字段可能返回 null，表示取不到有效值。 示例值：pgrogrp-q66su76e
ReadOnlyGroupName	String	只读组名字 注意：此字段可能返回 null，表示取不到有效值。 示例值：Autotestgroup
ProjectId	Integer	项目id 注意：此字段可能返回 null，表示取不到有效值。 示例值：1465
MasterDBInstanceId	String	主实例id 注意：此字段可能返回 null，表示取不到有效值。 示例值：postgres-dsu8985n
MinDelayEliminateReserve	Integer	最小保留实例数 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
MaxReplayLatency	Integer	延迟空间大小阈值 示例值：0
ReplayLatencyEliminate	Integer	延迟大小开关 示例值：0
MaxReplayLag	Float	延迟时间大小阈值 示例值：0
ReplayLagEliminate	Integer	延迟时间开关 示例值：0
VpcId	String	虚拟网络id 示例值：vpc-e3t30r8t
SubnetId	String	子网id 注意：此字段可能返回 null，表示取不到有效值。 示例值：subnet-jd9cvu0o
Region	String	地域id 示例值：ap-guangzhou
Zone	String	地区id 示例值：ap-guangzhou-3
Status	String	状态 示例值：ok
ReadOnlyDBInstanceList	Array of DBInstance	实例详细信息 示例值：[ { "AppId": 2512000007, "AutoRenew": 0, "CreateTime": "2024-12-05 12:04:14", "DBCharset": "UTF8", "DBEngine": "postgresql", "DBEngineConfig": "", "DBInstanceClass": "pg.it.small2", "DBInstanceClassName": "1 core 2 GiB", "DBInstanceCpu": 1, "DBInstanceId": "pgro-kdkdkx68", "DBInstanceMemory": 2, "DBInstanceName": "Unnamed", "DBInstanceNetInfo": [ { "Address": "", "Ip": "172...*", "NetType": "private", "Port": 5432, "ProtocolType": "postgresql", "Status": "opened", "SubnetId": "subnet-jd9cvu0o", "VpcId": "vpc-e3t30r8t" } ], "DBInstanceStatus": "running", "DBInstanceStorage": 40, "DBInstanceType": "readonly", "DBInstanceVersion": "standard", "DBKernelVersion": "v17.0_r1.0", "DBMajorVersion": "17", "DBNodeSet": null, "DBVersion": "17.0", "ExpireTime": "0000-00-00 00:00:00", "IsSupportTDE": 0, "IsolatedTime": "0000-00-00 00:00:00", "MasterDBInstanceId": "postgres-dsu8985n", "NetworkAccessList": null, "OfflineTime": "0001-01-04 00:00:00", "PayType": "postpaid", "ProjectId": 0, "ReadOnlyInstanceNum": 0, "Region": "ap-guangzhou", "StatusInReadonlyGroup": "running", "SubnetId": "subnet-jd9cvu0o", "SupportIpv6": 0, "SwitchEndTime": "", "SwitchStartTime": "", "TagList": [], "Type": "", "Uid": 1289, "UpdateTime": "2024-12-05 12:06:17", "VpcId": "vpc-e3t30r8t", "Zone": "ap-guangzhou-3" } ]
Rebalance	Integer	自动负载均衡开关 示例值：0
DBInstanceNetInfo	Array of DBInstanceNetInfo	网络信息 示例值：[ { "Address": "", "Ip": "172...*", "NetType": "private", "Port": 5432, "ProtocolType": "postgresql", "Status": "opened", "SubnetId": "subnet-jd9cvu0o", "VpcId": "vpc-e3t30r8t" } ]
NetworkAccessList	Array of NetworkAccess	只读组网络信息列表（此字段已废弃） 注意：此字段可能返回 null，表示取不到有效值。

RegionInfo

描述地域的编码和状态等信息

被如下接口引用：DescribeRegions。

名称	类型	描述
Region	String	该地域对应的英文名称 示例值：ap-guangzhou
RegionName	String	该地域对应的中文名称 示例值：广州
RegionId	Integer	该地域对应的数字编号 示例值：1
RegionState	String	可用状态，UNAVAILABLE表示不可用，AVAILABLE表示可用 示例值：AVAILABLE
SupportInternational	Integer	该地域是否支持国际站售卖，0：不支持，1：支持 注意：此字段可能返回 null，表示取不到有效值。 示例值：0

SecurityGroup

安全组信息

被如下接口引用：DescribeDBInstanceSecurityGroups。

名称	类型	描述
ProjectId	Integer	项目Id 示例值：0
CreateTime	String	创建时间 示例值：2022-10-20 21:38:20
Inbound	Array of PolicyRule	入站规则 示例值：[ { "Action": "ACCEPT", "CidrIp": "0.0.0.0/0", "Description": "放通Ping服务", "IpProtocol": "icmp", "PortRange": "ALL" }, { "Action": "ACCEPT", "CidrIp": "::/0", "Description": "放通Ping服务", "IpProtocol": "icmpv6", "PortRange": "ALL" } ]
Outbound	Array of PolicyRule	出站规则 示例值：[ { "Action": "ACCEPT", "CidrIp": "0.0.0.0/0", "Description": "", "IpProtocol": "ALL", "PortRange": "ALL" }, { "Action": "ACCEPT", "CidrIp": "", "Description": "", "IpProtocol": "ALL", "PortRange": "ALL" } ]
SecurityGroupId	String	安全组ID 示例值：sg-mpkb1net
SecurityGroupName	String	安全组名称 示例值：securitygroup
SecurityGroupDescription	String	安全组备注 示例值：安全组

ServerlessDBAccount

serverless账号描述

被如下接口引用：DescribeServerlessDBInstances。

名称	类型	描述
DBUser	String	用户名 注意：此字段可能返回 null，表示取不到有效值。 示例值：web_app
DBPassword	String	密码 注意：此字段可能返回 null，表示取不到有效值。 示例值：A****5
DBConnLimit	Integer	连接数限制 注意：此字段可能返回 null，表示取不到有效值。 示例值：5

ServerlessDBInstance

serverless实例描述

被如下接口引用：DescribeServerlessDBInstances。

名称	类型	必选	描述
DBInstanceId	String	否	实例id，唯一标识符 注意：此字段可能返回 null，表示取不到有效值。 示例值：postgres-1i1xmfwr
DBInstanceName	String	否	实例名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：pg10
DBInstanceStatus	String	否	实例状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：running
Region	String	否	地域 注意：此字段可能返回 null，表示取不到有效值。 示例值：ap-guangzhou
Zone	String	否	可用区 注意：此字段可能返回 null，表示取不到有效值。 示例值：ap-guangzhou-3
ProjectId	Integer	否	项目id 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
VpcId	String	否	私有网络Id 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
SubnetId	String	否	子网id 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
DBCharset	String	否	字符集 注意：此字段可能返回 null，表示取不到有效值。 示例值：UTF8
DBVersion	String	否	数据库版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：10.4
CreateTime	String	否	创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-10-11 17:04:24
DBInstanceNetInfo	Array of ServerlessDBInstanceNetInfo	否	实例网络信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
DBAccountSet	Array of ServerlessDBAccount	否	实例账户信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
DBDatabaseList	Array of String	否	实例下的db信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
TagList	Array of Tag	否	实例绑定的标签数组 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
DBKernelVersion	String	否	数据库内核版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：v10.4_r1.0
DBMajorVersion	String	否	数据库主要版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：10

ServerlessDBInstanceNetInfo

serverless实例网络信息描述

被如下接口引用：DescribeServerlessDBInstances。

名称	类型	描述
Address	String	地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：gz-xxx.tencent.com
Ip	String	ip地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：172...*
Port	Integer	端口号 注意：此字段可能返回 null，表示取不到有效值。 示例值：5432
Status	String	状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：opened
NetType	String	网络类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：private

SlowlogDetail

慢查询详情

被如下接口引用：DescribeDBSlowlogs。

名称	类型	描述
TotalTime	Float	花费总时间 示例值：120.5
TotalCalls	Integer	调用总次数 示例值：150
NormalQueries	Array of NormalQueryItem	脱敏后的慢SQL列表 示例值：{ "DatabaseName": "my_database", "UserName": "db_user", "NormalQuery": "SELECT * FROM users WHERE age > 30", "Calls": 150, "CallsGrids": [ 10, 20, 30, 40, 50 ], "CostTime": 120.5, "Rows": 75, "MinCostTime": 0.5, "MaxCostTime": 5.0, "FirstTime": "2024-10-01T10:00:00Z", "LastTime": "2024-10-01T10:05:00Z", "SharedReadBlks": 300, "SharedWriteBlks": 50, "ReadCostTime": 100, "WriteCostTime": 20 }

SpecInfo

描述某个地域下某个可用区的可售卖规格详细信息。

被如下接口引用：DescribeProductConfig。

名称	类型	描述
Region	String	地域英文编码，对应RegionSet的Region字段 示例值：ap-guangzhou
Zone	String	区域英文编码，对应ZoneSet的Zone字段 示例值：ap-guangzhou-3
SpecItemInfoList	Array of SpecItemInfo	规格详细信息列表 示例值：空
SupportKMSRegions	Array of String	支持KMS的地域 注意：此字段可能返回 null，表示取不到有效值。 示例值：["ap-guangzhou"]

SpecItemInfo

描述一种规格的信息

被如下接口引用：DescribeProductConfig。

名称	类型	描述
SpecCode	String	规格ID 示例值：1
Version	String	PostgreSQL的版本编号 示例值：1
VersionName	String	内核编号对应的完整版本名称 示例值：1
Cpu	Integer	CPU核数 示例值：1
Memory	Integer	内存大小，单位：MB 示例值：1
MaxStorage	Integer	该规格所支持最大存储容量，单位：GB 示例值：1
MinStorage	Integer	该规格所支持最小存储容量，单位：GB 示例值：1
Qps	Integer	该规格的预估QPS 示例值：1
Pid	Integer	【该字段废弃】 示例值：1
Type	String	机器类型 示例值：1
MajorVersion	String	PostgreSQL的主要版本编号 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
KernelVersion	String	PostgreSQL的内核版本编号 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
IsSupportTDE	Integer	是否支持TDE数据加密功能，0-不支持，1-支持 注意：此字段可能返回 null，表示取不到有效值。 示例值：1

Tag

实例绑定的标签信息，包含标签键TagKey和标签值TagValue

被如下接口引用：CloneDBInstance, CreateDBInstances, CreateInstances, CreateReadOnlyDBInstance, CreateServerlessDBInstance, DescribeDBInstanceAttribute, DescribeDBInstances, DescribeServerlessDBInstances。

名称	类型	必选	描述
TagKey	String	是	标签键 示例值：env
TagValue	String	是	标签值 示例值：prod

TaskDetail

任务的详情信息

被如下接口引用：DescribeTasks。

名称	类型	必选	描述
CurrentStep	String	否	当前执行的子任务步骤名称。 注意：此字段可能返回 null，表示取不到有效值。 示例值：Pre-check
AllSteps	String	否	当前任务所拥有的子步骤描述。 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"stepID":1,"stepName":"Pre-check"},{"stepID":2,"stepName":"Initialize New Instance"},{"stepID":3,"stepName":"Download Base Backup","stepProcess":100},{"stepID":4,"stepName":"Add Instance Management Process"},{"stepID":5,"stepName":"Task Complete"}]
Input	String	否	任务的输入参数。 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"DBInstanceId":"postgres-5gevh7gr","IsAssignVip":false,"SubnetId":"subnet-cd0t5777","Vip":"","VpcId":"vpc-n0ofy999"}
Output	String	否	任务的输出参数。 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"DBInstanceId":"postgres-5gevh7gr","DBInstanceNetInfo":{"Address":"","Ip":"10.0.0.1","Port":5432,"Status":"opened","NetType":"private","VpcId":"vpc-n0ofy999","SubnetId":"subnet-cd0t5m77","ProtocolType":"postgresql"}}
SwitchTag	Integer	否	指定实例配置完成变更后的切换时间，默认值：0 0: 此任务不需要切换 1：立即切换 2：指定时间切换 3：维护时间窗口内切换。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
SwitchTime	String	否	指定的切换时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：03:00:00-04:00:00
Message	String	否	任务的提示信息。 注意：此字段可能返回 null，表示取不到有效值。 示例值：This task requires a reboot

TaskSet

任务列表信息

被如下接口引用：DescribeTasks。

名称	类型	必选	描述
TaskId	Integer	否	任务ID。 示例值：10
TaskType	String	否	任务的类型。 示例值：CloneInstance
DBInstanceId	String	否	任务实例的实例ID。 示例值：postgres-6jt3ml1r
StartTime	String	否	任务的开始时间。 示例值：2024-08-22 10:06:38
EndTime	String	否	任务的结束时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-08-22 10:06:38
Status	String	否	任务的运行状态，包括Running,Success,WaitSwitch,Fail,Pause。 示例值：Success
Progress	Integer	否	任务的执行进度，取值范围0-100。 示例值：75
TaskDetail	TaskDetail	否	任务的详情信息 注意：此字段可能返回 null，表示取不到有效值。

Version

数据库版本号信息

被如下接口引用：DescribeDBVersions。

名称	类型	描述
DBEngine	String	数据库引擎，支持： 1、postgresql（云数据库PostgreSQL）； 2、mssql_compatible（MSSQL兼容-云数据库PostgreSQL）； 示例值：postgresql
DBVersion	String	数据库版本，例如：12.4 示例值：12.4
DBMajorVersion	String	数据库主要版本，例如：12 示例值：12
DBKernelVersion	String	数据库内核版本，例如：v12.4_r1.3 示例值：v12.4_r1.3
SupportedFeatureNames	Array of String	数据库内核支持的特性列表。例如， TDE：支持数据加密。 示例值：["TDE"]
Status	String	数据库版本状态，包括： AVAILABLE：可用； UPGRADE_ONLY：不可创建，此版本仅可升级至高版本； DEPRECATED：已弃用。 示例值：AVAILABLE
AvailableUpgradeTarget	Array of String	该数据库版本（DBKernelVersion）可以升级到的版本号列表。其中包含可升级的小版本号和可升级的大版本号（完整内核版本格式示例：v15.1_v1.6）。 示例值：["v12.4_r1.4"]

Xlog

数据库Xlog信息

被如下接口引用：DescribeDBXlogs。

名称	类型	描述
Id	Integer	备份文件唯一标识 示例值：450
StartTime	Timestamp	文件生成的开始时间 示例值：2024-06-22 01:56:46
EndTime	Timestamp	文件生成的结束时间 示例值：2024-06-22 01:56:53
InternalAddr	String	内网下载地址 示例值：http://172.*.*.*:8366/download/20180622015646_20180622015653.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTALKlriBmLUrmJMxzi1C3EagZ/IhOQeSGyXm+Qr3D3I2GL1G4RV69vLVylUaeIJ+zH+CEG5Ast0GoDmpzjJ5Jaw==
ExternalAddr	String	外网下载地址 示例值：https://gz-dl-postgres.cloud.tencent.com/download/20180622015646_20180622015653.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTALKlriBmLUrmJMxzi1C3EagZ/IhOQeSGyXm+Qr3D3I2GL1G4RV69vLVylUaeIJ+zH+CEG5Ast0GoDmpzjJ5Jaw==
Size	Integer	备份文件大小 示例值：247967

ZoneInfo

描述可用区的编码和状态信息

被如下接口引用：DescribeZones。

名称	类型	描述
Zone	String	该可用区的英文名称 示例值：ap-guangzhou-1
ZoneName	String	该可用区的中文名称 示例值：广州一区
ZoneId	Integer	该可用区对应的数字编号 示例值：100001
ZoneState	String	可用状态包含， UNAVAILABLE：不可用。 AVAILABLE：可用。 SELLOUT：售罄。 SUPPORTMODIFYONLY：支持变配。 示例值：AVAILABLE
ZoneSupportIpv6	Integer	该可用区是否支持Ipv6 示例值：1
StandbyZoneSet	Array of String	该可用区对应的备可用区集合 注意：此字段可能返回 null，表示取不到有效值。 示例值：ap-guangzhou-1,ap-guangzhou-2