有奖:语音产品征文挑战赛火热进行中> HOT

AccountInfo

账户信息

被如下接口引用:DescribeAccounts。

名称 类型 描述
DBInstanceId String 实例ID,形如postgres-lnp6j617
UserName String 帐号
Remark String 帐号备注
Status Integer 帐号状态。 1-创建中,2-正常,3-修改中,4-密码重置中,-1-删除中
CreateTime Timestamp 帐号创建时间
UpdateTime Timestamp 帐号最后一次更新时间

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。
VpcRestrictionEffect String vpc限制效力,ALLOW 允许;DENY 拒绝。
VpcIdSet Array of String 允许或拒绝下载备份文件的vpcId列表。
IpRestrictionEffect String ip限制效力,ALLOW 允许;DENY 拒绝。
IpSet Array of String 允许或拒绝下载备份文件的ip列表。

BackupPlan

备份计划

被如下接口引用:DescribeBackupPlans。

名称 类型 描述
BackupPeriod String 备份周期
示例值:["monday","thursday","friday"]
BaseBackupRetentionPeriod Integer 数据备份保留时长
示例值:3
MinBackupStartTime String 开始备份的最早时间
示例值:01:00:00
MaxBackupStartTime String 开始备份的最晚时间
示例值:02:00:00

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
CPU Integer CPU核数
Memory Integer 内存大小,单位:MB
MaxStorage Integer 该规格所支持最大存储容量,单位:GB
MinStorage Integer 该规格所支持最小存储容量,单位:GB
QPS Integer 该规格的预估QPS

DBBackup

数据库备份信息

被如下接口引用:DescribeDBBackups。

名称 类型 描述
Id Integer 备份文件唯一标识
StartTime String 文件生成的开始时间
EndTime String 文件生成的结束时间
Size Integer 文件大小(K)
Strategy Integer 策略(0-实例备份;1-多库备份)
Way Integer 类型(0-定时)
Type Integer 备份方式(1-完整)
Status Integer 状态(1-创建中;2-成功;3-失败)
DbList Array of String DB列表
InternalAddr String 内网下载地址
ExternalAddr String 外网下载地址
SetId String 备份集ID
注意:此字段可能返回 null,表示取不到有效值。

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-xxxxxxxx。有效的VpcId可通过登录控制台查询;也可以调用接口 DescribeVpcEx ,从接口返回中的unVpcId字段获取。
示例值:vpc-xxxxxxxx
SubnetId String 私有网络子网ID,形如subnet-xxxxxxxx。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 DescribeSubnets ,从接口返回中的unSubnetId字段获取。
示例值:subnet-xxxxxxxx
DBInstanceId String 实例ID。
示例值:postgres-xxxxxxxx
DBInstanceName String 实例名称。
示例值:xxxx
DBInstanceStatus String 实例状态,分别为:applying(申请中)、init(待初始化)、initing(初始化中)、running(运行中)、limited run(受限运行)、isolating(隔离中)、isolated(已隔离)、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 实例网络连接信息。
    Type String 机器类型。
    示例值:TS85
    AppId Integer 用户的AppId。
    示例值:123455
    Uid Integer 实例的Uid。
    示例值:12344
    ProjectId Integer 项目ID。
    示例值:1
    TagList Array of Tag 实例绑定的标签信息。
    注意:此字段可能返回 null,表示取不到有效值。
    MasterDBInstanceId String 主实例信息,仅在实例为只读实例时返回。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:postgres-xxxxxxxx
    ReadOnlyInstanceNum Integer 只读实例数量。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:6
    StatusInReadonlyGroup String 只读实例在只读组中的状态。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ok
    OfflineTime String 下线时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2014-08-03 12:00
    DBNodeSet Array of DBNode 实例的节点信息。
    注意:此字段可能返回 null,表示取不到有效值。
    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,表示取不到有效值。
  • 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, DescribeReadOnlyGroups, ModifyDBInstanceDeployment。

    名称 类型 必选 描述
    Role String 节点类型,值可以为:
    Primary,代表主节点;
    Standby,代表备节点。
    示例值:Primary, Standby
    Zone String 节点所在可用区,例如 ap-guangzhou-1。
    示例值:ap-guangzhou-1

    Detail

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

    被如下接口引用:DescribeSlowQueryAnalysis。

    名称 类型 描述
    TotalTime Float 输入时间范围内所有慢sql执行的总时间,单位毫秒(ms)
    示例值:0.1
    TotalCallNum Integer 输入时间范围内所有慢sql总条数
    示例值:0
    AnalysisItems Array of AnalysisItems 慢SQL统计分析列表
    注意:此字段可能返回 null,表示取不到有效值。

    DurationAnalysis

    慢SQL耗时分段分析

    被如下接口引用:DescribeSlowQueryList。

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

    EncryptionKey

    KMS密钥信息

    被如下接口引用:DescribeEncryptionKeys。

    名称 类型 描述
    KeyId String KMS实例加密的KeyId。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:空
    KeyAlias String KMS实例加密Key的别名。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:PGSQL-KMS
    DEKCipherTextBlob String 实例加密密钥DEK的密文。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:空
    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 用户名
    Database String 数据库名字
    ErrTime String 错误发生时间
    ErrMsg String 错误消息

    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,表示取不到有效值。
    示例值:""

    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, DescribeLogBackups, DescribeParameterTemplates, DescribeReadOnlyGroups, DescribeServerlessDBInstances。

    名称 类型 必选 描述
    Name String 过滤键的名称。
    Values Array of String 一个或者多个过滤值。

    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

    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 用户名
    Calls Integer 调用次数
    CallsGrids Array of Integer 粒度点
    CostTime Float 花费总时间
    Rows Integer 影响的行数
    MinCostTime Float 花费最小时间
    MaxCostTime Float 花费最大时间
    FirstTime String 最早一条慢SQL时间
    LastTime String 最晚一条慢SQL时间
    SharedReadBlks Integer 读共享内存块数
    SharedWriteBlks Integer 写共享内存块数
    ReadCostTime Integer 读io总耗时
    WriteCostTime Integer 写io总耗时
    DatabaseName String 数据库名字
    NormalQuery String 脱敏后的慢SQL

    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,表示取不到有效值。
    SpecRelationSet Array of ParamSpecRelation 参数规格关联信息,内容为相应规格下的参数详细信息
    注意:此字段可能返回 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 参数模板名称
    示例值:test
    DBMajorVersion String 参数模板适用的数据库版本
    示例值:13
    DBEngine String 参数模板适用的数据库引擎
    示例值:postgresql
    TemplateDescription String 参数模板描述
    示例值:test

    PgDeal

    订单详情

    被如下接口引用:DescribeOrders。

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

    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,表示取不到有效值。
    示例值:空
    ReadOnlyGroupName String 只读组名字
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:空
    ProjectId Integer 项目id
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:空
    MasterDBInstanceId String 主实例id
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:空
    MinDelayEliminateReserve Integer 最小保留实例数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:空
    MaxReplayLatency Integer 延迟空间大小阈值
    示例值:空
    ReplayLatencyEliminate Integer 延迟大小开关
    示例值:空
    MaxReplayLag Float 延迟时间大小阈值
    示例值:空
    ReplayLagEliminate Integer 延迟时间开关
    示例值:空
    VpcId String 虚拟网络id
    示例值:空
    SubnetId String 子网id
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:空
    Region String 地域id
    示例值:空
    Zone String 地区id
    示例值:空
    Status String 状态
    示例值:空
    ReadOnlyDBInstanceList Array of DBInstance 实例详细信息
    示例值:空
    Rebalance Integer 自动负载均衡开关
    示例值:空
    DBInstanceNetInfo Array of DBInstanceNetInfo 网络信息
    示例值:空
    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 入站规则
    Outbound Array of PolicyRule 出站规则
    SecurityGroupId String 安全组ID
    示例值:sg-mpkb1net
    SecurityGroupName String 安全组名称
    示例值:securitygroup
    SecurityGroupDescription String 安全组备注
    示例值:安全组

    ServerlessDBAccount

    serverless账号描述

    被如下接口引用:DescribeServerlessDBInstances。

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

    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,表示取不到有效值。
    Ip String ip地址
    注意:此字段可能返回 null,表示取不到有效值。
    Port Integer 端口号
    注意:此字段可能返回 null,表示取不到有效值。
    Status String 状态
    注意:此字段可能返回 null,表示取不到有效值。
    NetType String 网络类型
    注意:此字段可能返回 null,表示取不到有效值。

    SlowlogDetail

    慢查询详情

    被如下接口引用:DescribeDBSlowlogs。

    名称 类型 描述
    TotalTime Float 花费总时间
    TotalCalls Integer 调用总次数
    NormalQueries Array of NormalQueryItem 脱敏后的慢SQL列表

    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, DescribeReadOnlyGroups, DescribeServerlessDBInstances。

    名称 类型 必选 描述
    TagKey String 标签键
    TagValue String 标签值

    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:可用;
    DEPRECATED:已弃用。
    示例值:AVAILABLE
    AvailableUpgradeTarget Array of String 该数据库版本(DBKernelVersion)可以升级到的版本号列表。
    示例值:["v12.4_r1.4"]

    Xlog

    数据库Xlog信息

    被如下接口引用:DescribeDBXlogs。

    名称 类型 描述
    Id Integer 备份文件唯一标识
    StartTime Timestamp 文件生成的开始时间
    EndTime Timestamp 文件生成的结束时间
    InternalAddr String 内网下载地址
    ExternalAddr String 外网下载地址
    Size Integer 备份文件大小

    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