tenyun

/// <reference types="node" /> import { AxiosPromise, AxiosRequestConfig } from "axios"; /** 账户信息 */ declare interface AccountInfo { /** 实例ID，形如postgres-lnp6j617 */ DBInstanceId?: string; /** 账号 */ UserName?: string; /** 账号备注 */ Remark?: string; /** 账号状态。 1-创建中，2-正常，3-修改中，4-密码重置中，5-锁定中，-1-删除中 */ Status?: number; /** 账号创建时间 */ CreateTime?: string; /** 账号最后一次更新时间 */ UpdateTime?: string; /** 账号类型 */ UserType?: string; } /** 慢查询分析接口返回的分析详情，按照参数抽象之后进行分类 */ declare interface AnalysisItems { /** 慢SQL查询的数据库名 */ DatabaseName?: string; /** 慢SQL执行的用户名 */ UserName?: string; /** 抽象参数之后的慢SQL */ NormalQuery?: string; /** 慢SQL执行的客户端地址 */ ClientAddr?: string; /** 在选定时间范围内慢SQL语句执行的次数 */ CallNum?: number; /** 在选定时间范围内，慢SQL语句执行的次数占所有慢SQL的百分比。 */ CallPercent?: number; /** 在选定时间范围内，慢SQL执行的总时间 */ CostTime?: number; /** 在选定时间范围内，慢SQL语句执行的总时间占所有慢SQL的比例（小数返回） */ CostPercent?: number; /** 在选定时间范围内，慢SQL语句执行的耗时最短的时间（单位：ms） */ MinCostTime?: number; /** 在选定时间范围内，慢SQL语句执行的耗时最长的时间（单位：ms） */ MaxCostTime?: number; /** 在选定时间范围内，慢SQL语句执行的耗时平均时间（单位：ms） */ AvgCostTime?: number; /** 在选定时间范围内，慢SQL第一条开始执行的时间 */ FirstTime?: string; /** 在选定时间范围内，慢SQL最后一条开始执行的时间 */ LastTime?: string; } /** 备份下载限制信息 */ declare interface BackupDownloadRestriction { /** 备份文件下载限制类型，NONE 无限制，内外网都可以下载；INTRANET 只允许内网下载；CUSTOMIZE 自定义限制下载的vpc或ip。当该参数取值为CUSTOMIZE 时，vpc或ip信息至少填写一项 */ RestrictionType?: string; /** vpc限制效力，ALLOW 允许；DENY 拒绝。 */ VpcRestrictionEffect?: string; /** 允许或拒绝下载备份文件的vpcId列表。 */ VpcIdSet?: string[]; /** ip限制效力，ALLOW 允许；DENY 拒绝。 */ IpRestrictionEffect?: string; /** 允许或拒绝下载备份文件的ip列表。 */ IpSet?: string[]; } /** 备份计划 */ declare interface BackupPlan { /** 备份周期 */ BackupPeriod?: string; /** 数据备份保留时长。单位：天 */ BaseBackupRetentionPeriod?: number; /** 开始备份的最早时间 */ MinBackupStartTime?: string; /** 开始备份的最晚时间 */ MaxBackupStartTime?: string; /** 备份计划ID */ PlanId?: string; /** 备份计划自定义名称。 */ PlanName?: string; /** 日志备份保留时长。单位：天 */ LogBackupRetentionPeriod?: number; /** 创建时间。 */ CreatedTime?: string; /** 最近一次的修改时间。 */ UpdatedTime?: string; /** 备份计划类型。系统默认创建的为default，自定义的为custom。 */ PlanType?: string; /** 备份周期类型。当前支持week、month。 */ BackupPeriodType?: string; } /** 实例备份统计项 */ declare interface BackupSummary { /** 实例ID。 */ DBInstanceId?: string; /** 实例日志备份数量。 */ LogBackupCount?: number; /** 实例日志备份大小。 */ LogBackupSize?: number; /** 手动创建的实例数据备份数量。 */ ManualBaseBackupCount?: number; /** 手动创建的实例数据备份大小。 */ ManualBaseBackupSize?: number; /** 自动创建的实例数据备份数量。 */ AutoBaseBackupCount?: number; /** 自动创建的实例数据备份大小。 */ AutoBaseBackupSize?: number; /** 总备份数量 */ TotalBackupCount?: number; /** 总备份大小 */ TotalBackupSize?: number; } /** 数据库数据备份信息 */ declare interface BaseBackup { /** 实例ID。 */ DBInstanceId?: string; /** 备份文件唯一标识。 */ Id?: string; /** 备份文件名称。 */ Name?: string; /** 备份方式：physical - 物理备份、logical - 逻辑备份。 */ BackupMethod?: string; /** 备份模式：automatic - 自动备份、manual - 手动备份。 */ BackupMode?: string; /** 备份任务状态。枚举值：init、running、finished、failed、canceled */ State?: string; /** 备份集大小，单位bytes。 */ Size?: number; /** 备份的开始时间。 */ StartTime?: string; /** 备份的结束时间。 */ FinishTime?: string; /** 备份的过期时间。 */ ExpireTime?: string; } /** 数据库实例规格 */ declare interface ClassInfo { /** 规格ID */ SpecCode?: string; /** CPU核数 */ CPU?: number; /** 内存大小，单位：MB */ Memory?: number; /** 该规格所支持最大存储容量，单位：GB */ MaxStorage?: number; /** 该规格所支持最小存储容量，单位：GB */ MinStorage?: number; /** 该规格的预估QPS */ QPS?: number; } /** 数据库备份信息 */ declare interface DBBackup { /** 备份文件唯一标识 */ Id?: number; /** 文件生成的开始时间 */ StartTime?: string; /** 文件生成的结束时间 */ EndTime?: string; /** 文件大小(K) */ Size?: number; /** 策略（0-实例备份；1-多库备份） */ Strategy?: number; /** 类型（0-定时） */ Way?: number; /** 备份方式（1-完整） */ Type?: number; /** 状态（1-创建中；2-成功；3-失败） */ Status?: number; /** DB列表 */ DbList?: string[]; /** 内网下载地址 */ InternalAddr?: string; /** 外网下载地址 */ ExternalAddr?: string; /** 备份集ID */ SetId?: string; } /** 描述实例的详细信息 */ declare interface DBInstance { /** 实例所属地域，如: ap-guangzhou，对应RegionSet的Region字段。 */ Region?: string; /** 实例所属可用区，如：ap-guangzhou-3，对应ZoneSet的Zone字段。 */ Zone?: string; /** 私有网络ID，形如vpc-e6w23k31。有效的VpcId可通过登录控制台查询；也可以调用接口 [DescribeVpcs](https://cloud.tencent.com/document/api/215/15778) ，从接口返回中的unVpcId字段获取。 */ VpcId?: string; /** 私有网络子网ID，形如subnet-51lcif9y。有效的私有网络子网ID可通过登录控制台查询；也可以调用接口 [DescribeSubnets ](https://cloud.tencent.com/document/api/215/15784)，从接口返回中的unSubnetId字段获取。 */ SubnetId?: string; /** 实例ID。 */ DBInstanceId?: string; /** 实例名称。 */ DBInstanceName?: 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（主备切换中）、offlining(下线中)、deployment changing（可用区变更中）、cloning（恢复数据中）、parameter modifying（参数修改中）、log-switching（日志状态变更中）、restoring（恢复中）、expanding（变配中） */ DBInstanceStatus?: string; /** 实例分配的内存大小，单位：GB */ DBInstanceMemory?: number; /** 实例分配的存储空间大小，单位：GB */ DBInstanceStorage?: number; /** 实例分配的CPU数量，单位：个 */ DBInstanceCpu?: number; /** 售卖规格ID */ DBInstanceClass?: string; /** PostgreSQL大版本号，版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取，目前支持10，11，12，13，14，15这几个大版本。 */ DBMajorVersion?: string; /** PostgreSQL社区大版本+小版本号，如12.4，版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取。 */ DBVersion?: string; /** PostgreSQL内核版本号，如v12.7_r1.8，版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取。 */ DBKernelVersion?: string; /** 实例类型，类型有：primary：主实例readonly：只读实例guard：灾备实例temp：临时实例 */ DBInstanceType?: string; /** 实例版本，目前只支持standard（双机高可用版, 一主一从）。 */ DBInstanceVersion?: string; /** 实例字符集，目前只支持： UTF8 LATIN1 */ DBCharset?: string; /** 实例创建时间。 */ CreateTime?: string; /** 实例执行最后一次更新的时间。 */ UpdateTime?: string; /** 实例到期时间。 */ ExpireTime?: string; /** 实例隔离时间。 */ IsolatedTime?: string; /** 计费模式：prepaid：包年包月,预付费postpaid：按量计费，后付费 */ PayType?: string; /** 是否自动续费：0：手动续费1：自动续费默认值：0 */ AutoRenew?: number; /** 实例网络连接信息。 */ DBInstanceNetInfo?: DBInstanceNetInfo[]; /** 机器类型。 */ Type?: string; /** 用户的AppId。 */ AppId?: number; /** 实例的Uid。 */ Uid?: number; /** 项目ID。 */ ProjectId?: number; /** 实例绑定的标签信息。 */ TagList?: Tag[]; /** 主实例信息，仅在实例为只读实例时返回。 */ MasterDBInstanceId?: string; /** 只读实例数量。 */ ReadOnlyInstanceNum?: number; /** 只读实例在只读组中的状态。 */ StatusInReadonlyGroup?: string; /** 下线时间。 */ OfflineTime?: string; /** 实例的节点信息。 */ DBNodeSet?: DBNode[] | null; /** 实例是否支持TDE数据加密：0：不支持1：支持默认值：0TDE数据加密可参考[数据透明加密概述](https://cloud.tencent.com/document/product/409/71748) */ IsSupportTDE?: number; /** 数据库引擎，支持：postgresql：云数据库PostgreSQLmssql_compatible：MSSQL兼容-云数据库PostgreSQL默认值：postgresql */ DBEngine?: 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"。 */ DBEngineConfig?: string; /** 实例网络信息列表（此字段已废弃） */ NetworkAccessList?: NetworkAccess[] | null; /** 实例是否支持Ipv6：0：否1：是默认值：0 */ SupportIpv6?: number; } /** 描述实例的网络连接信息。 */ declare interface DBInstanceNetInfo { /** DNS域名 */ Address?: string; /** IP地址 */ Ip?: string; /** 连接Port地址 */ Port?: number; /** 网络类型，1、inner（基础网络内网地址）；2、private（私有网络内网地址）；3、public（基础网络或私有网络的外网地址）； */ NetType?: string; /** 网络连接状态，1、initing（未开通）；2、opened（已开通）；3、closed（已关闭）；4、opening（开通中）；5、closing（关闭中）； */ Status?: string; /** 私有网络ID */ VpcId?: string; /** 子网ID */ SubnetId?: string; /** 连接数据库的协议类型，当前支持：postgresql、mssql（MSSQL兼容语法） */ ProtocolType?: string; } /** 描述实例节点信息，包括节点类型、节点所在可用区、节点所在专属集群。 */ declare interface DBNode { /** 节点类型，值可以为：Primary，代表主节点；Standby，代表备节点。 */ Role: string; /** 节点所在可用区，例如 ap-guangzhou-1。 */ Zone: string; /** 专属集群ID */ DedicatedClusterId?: string; } /** 描述数据库详细信息，包括所有者、字符编码等 */ declare interface Database { /** 数据库名 */ DatabaseName?: string; /** 数据库所有者 */ DatabaseOwner?: string; /** 数据库字符编码 */ Encoding?: string; /** 数据库排序规则 */ Collate?: string; /** 数据库字符分类 */ Ctype?: string; /** 数据库是否允许连接 */ AllowConn?: boolean; /** 数据库最大连接数，-1表示无限制 */ ConnLimit?: number; /** 数据库权限列表 */ Privileges?: string; } /** 描述数据库中某个对象所属的类型、是在哪个数据库、模式、表中的对象。 */ declare interface DatabaseObject { /** 支持使用的数据库对象类型有：account,database,schema,sequence,procedure,type,function,table,view,matview,column。 */ ObjectType: string; /** 所描述的数据库对象名称 */ ObjectName: string; /** 所要描述的数据库对象，所属的数据库名称。当描述对象类型不为database时，此参数必选。 */ DatabaseName?: string; /** 所要描述的数据库对象，所属的模式名称。当描述对象不为database、schema时，此参数必选。 */ SchemaName?: string; /** 所要描述的数据库对象，所属的表名称。当描述的对象类型为column时，此参数必填。 */ TableName?: string; } /** 指定账号对数据库对象拥有的权限列表 */ declare interface DatabasePrivilege { /** 数据库对象，当ObjectType为database时，DatabaseName/SchemaName/TableName可为空；当ObjectType为schema时，SchemaName/TableName可为空；当ObjectType为column时，TableName不可为空，其余情况均可为空。 */ Object?: DatabaseObject | null; /** 指定账号对数据库对象拥有的权限列表 */ PrivilegeSet?: string[] | null; } /** 专属集群相关信息，用于查询用户的专属集群列表 */ declare interface DedicatedCluster { /** 专属集群ID */ DedicatedClusterId?: string; /** 专属集群名称 */ Name?: string; /** 专属集群所在可用区 */ Zone?: string; /** 灾备集群 */ StandbyDedicatedClusterSet?: string[]; /** 实例数量 */ InstanceCount?: number; /** Cpu总数量 */ CpuTotal?: number; /** Cpu可用数量 */ CpuAvailable?: number; /** 内存总量，单位GB */ MemTotal?: number; /** 内存可用量，单位GB */ MemAvailable?: number; /** 磁盘总量，单位GB */ DiskTotal?: number; /** 磁盘可用量，单位GB */ DiskAvailable?: number; } /** 慢SQL 统计分析接口返回详情 */ declare interface Detail { /** 输入时间范围内所有慢sql执行的总时间，单位毫秒（ms） */ TotalTime?: number; /** 输入时间范围内所有慢sql总条数 */ TotalCallNum?: number; /** 慢SQL统计分析列表 */ AnalysisItems?: AnalysisItems[]; } /** 慢SQL耗时分段分析 */ declare interface DurationAnalysis { /** 慢SQL耗时，时段 */ TimeSegment: string; /** 对应时段区间慢SQL 条数 */ Count: number; } /** KMS密钥信息 */ declare interface EncryptionKey { /** KMS实例加密的KeyId。 */ KeyId?: string; /** KMS实例加密Key的别名。 */ KeyAlias?: string; /** 实例加密密钥DEK的密文。 */ DEKCipherTextBlob?: string; /** 密钥是否启用，1-启用， 0-未启用。 */ IsEnabled?: number; /** KMS密钥所在地域。 */ KeyRegion?: string; /** DEK密钥创建时间。 */ CreateTime?: string; /** 密钥所在的KMS服务集群Id，为空表示密钥在默认的KMS集群中，不为空表示在指定的KMS服务集群中 */ KMSClusterId?: string; } /** 错误日志详情 */ declare interface ErrLogDetail { /** 用户名 */ UserName?: string; /** 数据库名字 */ Database?: string; /** 错误发生时间 */ ErrTime?: string; /** 错误消息 */ ErrMsg?: string; } /** 参数修改事件信息 */ declare interface EventInfo { /** 参数名 */ ParamName?: string; /** 原参数值 */ OldValue?: string; /** 本次修改期望参数值 */ NewValue?: string; /** 后台参数修改开始时间 */ ModifyTime?: string; /** 后台参数生效开始时间 */ EffectiveTime?: string; /** 修改状态。枚举值：in progress、success、paused */ State?: string; /** 操作者（一般为用户sub UIN） */ Operator?: string; /** 时间日志。 */ EventLog?: string; } /** 修改参数条目，以参数为维度 */ declare interface EventItem { /** 参数名 */ ParamName?: string; /** 修改事件数 */ EventCount?: number; /** 修改时间详情 */ EventDetail?: EventInfo[]; } /** 描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称等* 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。* 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。 */ declare interface Filter { /** 过滤键的名称。 */ Name?: string; /** 一个或者多个过滤值。 */ Values?: string[]; } /** 数据库日志备份信息 */ declare interface LogBackup { /** 实例ID。 */ DBInstanceId?: string; /** 备份文件唯一标识。 */ Id?: string; /** 备份文件名称。 */ Name?: string; /** 备份方式。枚举值，physical - 物理备份；logical - 逻辑备份。 */ BackupMethod?: string; /** 备份模式。枚举值，manual - 手动备份；automatic - 自动备份。 */ BackupMode?: string; /** 备份任务状态。枚举值：init、running、finished、failed、canceled */ State?: string; /** 备份集大小，单位bytes。 */ Size?: number; /** 备份的开始时间。 */ StartTime?: string; /** 备份的结束时间。 */ FinishTime?: string; /** 备份的过期时间。 */ ExpireTime?: string; } /** 用于修改数据库对象的权限，其中包含了数据库对象描述的数据结构、需要修改的权限列表以及修改的类型等。 */ declare interface ModifyPrivilege { /** 要修改的数据库对象及权限列表 */ DatabasePrivilege?: DatabasePrivilege; /** 修改的方式，当前仅支持grantObject、revokeObject、alterRole。grantObject代表授权、revokeObject代表收回权、alterRole代表修改账号类型。 */ ModifyType?: string; /** 当ModifyType为revokeObject才需要此参数，参数为true时，撤销权限会级联撤销。默认为false。 */ IsCascade?: boolean; } /** 网络相关信息。（该数据结构已废弃，网络相关信息使用DBInstanceNetInfo） */ declare interface NetworkAccess { /** 网络资源id，实例id或RO组id */ ResourceId?: string; /** 资源类型，1-实例 2-RO组 */ ResourceType?: number; /** 私有网络ID */ VpcId?: string; /** IPV4地址 */ Vip?: string; /** IPV6地址 */ Vip6?: string; /** 访问端口 */ Vport?: number; /** 子网ID */ SubnetId?: string; /** 网络状态，1-申请中，2-使用中，3-删除中，4-已删除 */ VpcStatus?: number; } /** 单条SlowQuery信息 */ declare interface NormalQueryItem { /** 用户名 */ UserName?: string; /** 调用次数 */ Calls?: number; /** 粒度点 */ CallsGrids?: number[]; /** 花费总时间 */ CostTime?: number; /** 影响的行数 */ Rows?: number; /** 花费最小时间 */ MinCostTime?: number; /** 花费最大时间 */ MaxCostTime?: number; /** 最早一条慢SQL时间 */ FirstTime?: string; /** 最晚一条慢SQL时间 */ LastTime?: string; /** 读共享内存块数 */ SharedReadBlks?: number; /** 写共享内存块数 */ SharedWriteBlks?: number; /** 读io总耗时 */ ReadCostTime?: number; /** 写io总耗时 */ WriteCostTime?: number; /** 数据库名字 */ DatabaseName?: string; /** 脱敏后的慢SQL */ NormalQuery?: string; } /** 批量修改参数 */ declare interface ParamEntry { /** 参数名 */ Name: string; /** 修改参数值。入参均以字符串形式传递，例如：小数”0.1“、整数”1000“、枚举”replica“ */ ExpectedValue: string; } /** 参数详情 */ declare interface ParamInfo { /** 参数ID */ ID?: number; /** 参数名 */ Name?: string; /** 参数值类型：integer（整型）、real（浮点型）、bool（布尔型）、enum（枚举类型）、mutil_enum（枚举类型、支持多选）。当参数类型为integer（整型）、real（浮点型）时，参数的取值范围根据返回值的Max、Min确定；当参数类型为bool（布尔型）时，参数设置值取值范围是true | false；当参数类型为enum（枚举类型）、mutil_enum（多枚举类型）时，参数的取值范围由返回值中的EnumValue确定。 */ ParamValueType?: string; /** 参数值单位。参数没有单位时，该字段返回空 */ Unit?: string; /** 参数默认值。以字符串形式返回 */ DefaultValue?: string; /** 参数当前运行值。以字符串形式返回 */ CurrentValue?: string; /** 数值类型（integer、real）参数，取值下界 */ Max?: number; /** 枚举类型参数，取值范围 */ EnumValue?: string[] | null; /** 数值类型（integer、real）参数，取值上界 */ Min?: number; /** 参数中文描述 */ ParamDescriptionCH?: string; /** 参数英文描述 */ ParamDescriptionEN?: string; /** 参数修改，是否重启生效。（true为需要，false为不需要） */ NeedReboot?: boolean; /** 参数中文分类 */ ClassificationCN?: string; /** 参数英文分类 */ ClassificationEN?: string; /** 是否和规格相关。（true为相关，false为不想关） */ SpecRelated?: boolean; /** 是否为重点参数。（true为重点参数，修改是需要重点关注，可能会影响实例性能） */ Advanced?: boolean; /** 参数最后一次修改时间 */ LastModifyTime?: string; /** 参数主备制约，0：无主备制约关系，1:备机参数值需比主机大，2:主机参数值需比备机大 */ StandbyRelated?: number; /** 参数版本关联信息，内容为相应内核版本下的参数详细信息 */ VersionRelationSet?: ParamVersionRelation[] | null; /** 参数规格关联信息，内容为相应规格下的参数详细信息 */ SpecRelationSet?: ParamSpecRelation[] | null; } /** 各规格下的参数信息 */ declare interface ParamSpecRelation { /** 参数名称 */ Name?: string; /** 参数信息所属规格 */ Memory?: string; /** 参数在该规格下的默认值 */ Value?: string; /** 参数值单位。参数没有单位时，该字段返回空 */ Unit?: string; /** 数值类型（integer、real）参数，取值上界 */ Max?: number; /** 数值类型（integer、real）参数，取值下界 */ Min?: number; /** 枚举类型参数，取值范围 */ EnumValue?: string[] | null; } /** 各版本下的参数信息 */ declare interface ParamVersionRelation { /** 参数名称 */ Name?: string; /** 参数信息所属内核版本 */ DBKernelVersion?: string; /** 参数在该版本该规格下的默认值 */ Value?: string; /** 参数值单位。参数没有单位时，该字段返回空 */ Unit?: string; /** 数值类型（integer、real）参数，取值上界 */ Max?: number; /** 数值类型（integer、real）参数，取值下界 */ Min?: number; /** 枚举类型参数，取值范围 */ EnumValue?: string[] | null; } /** 参数模板的基本信息 */ declare interface ParameterTemplate { /** 参数模板ID */ TemplateId?: string; /** 参数模板名称 */ TemplateName?: string; /** 参数模板适用的数据库版本 */ DBMajorVersion?: string; /** 参数模板适用的数据库引擎 */ DBEngine?: string; /** 参数模板描述 */ TemplateDescription?: string; } /** 订单详情 */ declare interface PgDeal { /** 订单名 */ DealName?: string; /** 所属用户 */ OwnerUin?: string; /** 订单涉及多少个实例 */ Count?: number; /** 付费模式。1-预付费；0-后付费 */ PayMode?: number; /** 异步任务流程ID */ FlowId?: number; /** 实例ID数组 */ DBInstanceIdSet?: string[]; } /** 安全组规则信息 */ declare interface PolicyRule { /** 策略，ACCEPT 或者 DROP */ Action?: string; /** 来源或目的 IP 或 IP 段，例如172.16.0.0/12 */ CidrIp?: string; /** 端口 */ PortRange?: string; /** 网络协议，支持 UDP、TCP 等 */ IpProtocol?: string; /** 规则描述 */ Description?: string; } /** 慢SQL查询接口返回慢SQL列表详情 */ declare interface RawSlowQuery { /** 慢SQL 语句 */ RawQuery: string; /** 慢SQL 查询的数据库 */ DatabaseName: string; /** 慢SQL执行耗时 */ Duration: number; /** 执行慢SQL的客户端 */ ClientAddr: string; /** 执行慢SQL的用户名 */ UserName: string; /** 慢SQL执行的开始时间 */ SessionStartTime: string; } /** 只读组信息 */ declare interface ReadOnlyGroup { /** 只读组标识 */ ReadOnlyGroupId?: string; /** 只读组名字 */ ReadOnlyGroupName?: string; /** 项目id */ ProjectId?: number; /** 主实例id */ MasterDBInstanceId?: string; /** 最小保留实例数 */ MinDelayEliminateReserve?: number; /** 延迟空间大小阈值 */ MaxReplayLatency?: number; /** 延迟大小开关 */ ReplayLatencyEliminate?: number; /** 延迟时间大小阈值 */ MaxReplayLag?: number; /** 延迟时间开关 */ ReplayLagEliminate?: number; /** 虚拟网络id */ VpcId?: string; /** 子网id */ SubnetId?: string; /** 地域id */ Region?: string; /** 地区id */ Zone?: string; /** 状态 */ Status?: string; /** 实例详细信息 */ ReadOnlyDBInstanceList?: DBInstance[]; /** 自动负载均衡开关 */ Rebalance?: number; /** 网络信息 */ DBInstanceNetInfo?: DBInstanceNetInfo[]; /** 只读组网络信息列表（此字段已废弃） */ NetworkAccessList?: NetworkAccess[] | null; } /** 描述地域的编码和状态等信息 */ declare interface RegionInfo { /** 该地域对应的英文名称 */ Region?: string; /** 该地域对应的中文名称 */ RegionName?: string; /** 该地域对应的数字编号 */ RegionId?: number; /** 可用状态，UNAVAILABLE表示不可用，AVAILABLE表示可用 */ RegionState?: string; /** 该地域是否支持国际站售卖，0：不支持，1：支持 */ SupportInternational?: number; } /** 安全组信息 */ declare interface SecurityGroup { /** 项目Id */ ProjectId?: number; /** 创建时间 */ CreateTime?: string; /** 入站规则 */ Inbound?: PolicyRule[]; /** 出站规则 */ Outbound?: PolicyRule[]; /** 安全组ID */ SecurityGroupId?: string; /** 安全组名称 */ SecurityGroupName?: string; /** 安全组备注 */ SecurityGroupDescription?: string; } /** serverless账号描述 */ declare interface ServerlessDBAccount { /** 用户名 */ DBUser?: string; /** 密码 */ DBPassword?: string; /** 连接数限制 */ DBConnLimit?: number; } /** serverless实例描述 */ declare interface ServerlessDBInstance { /** 实例id，唯一标识符 */ DBInstanceId?: string; /** 实例名称 */ DBInstanceName?: string; /** 实例状态 */ DBInstanceStatus?: string; /** 地域 */ Region?: string; /** 可用区 */ Zone?: string; /** 项目id */ ProjectId?: number; /** 私有网络Id */ VpcId?: string; /** 子网id */ SubnetId?: string; /** 字符集 */ DBCharset?: string; /** 数据库版本 */ DBVersion?: string; /** 创建时间 */ CreateTime?: string; /** 实例网络信息 */ DBInstanceNetInfo?: ServerlessDBInstanceNetInfo[]; /** 实例账户信息 */ DBAccountSet?: ServerlessDBAccount[]; /** 实例下的db信息 */ DBDatabaseList?: string[]; /** 实例绑定的标签数组 */ TagList?: Tag[]; /** 数据库内核版本 */ DBKernelVersion?: string; /** 数据库主要版本 */ DBMajorVersion?: string; } /** serverless实例网络信息描述 */ declare interface ServerlessDBInstanceNetInfo { /** 地址 */ Address?: string; /** ip地址 */ Ip?: string; /** 端口号 */ Port?: number; /** 状态 */ Status?: string; /** 网络类型 */ NetType?: string; } /** 慢查询详情 */ declare interface SlowlogDetail { /** 花费总时间 */ TotalTime?: number; /** 调用总次数 */ TotalCalls?: number; /** 脱敏后的慢SQL列表 */ NormalQueries?: NormalQueryItem[]; } /** 描述某个地域下某个可用区的可售卖规格详细信息。 */ declare interface SpecInfo { /** 地域英文编码，对应RegionSet的Region字段 */ Region?: string; /** 区域英文编码，对应ZoneSet的Zone字段 */ Zone?: string; /** 规格详细信息列表 */ SpecItemInfoList?: SpecItemInfo[]; /** 支持KMS的地域 */ SupportKMSRegions?: string[]; } /** 描述一种规格的信息 */ declare interface SpecItemInfo { /** 规格ID */ SpecCode?: string; /** PostgreSQL的版本编号 */ Version?: string; /** 内核编号对应的完整版本名称 */ VersionName?: string; /** CPU核数 */ Cpu?: number; /** 内存大小，单位：MB */ Memory?: number; /** 该规格所支持最大存储容量，单位：GB */ MaxStorage?: number; /** 该规格所支持最小存储容量，单位：GB */ MinStorage?: number; /** 该规格的预估QPS */ Qps?: number; /** 【该字段废弃】 */ Pid?: number; /** 机器类型 */ Type?: string; /** PostgreSQL的主要版本编号 */ MajorVersion?: string; /** PostgreSQL的内核版本编号 */ KernelVersion?: string; /** 是否支持TDE数据加密功能，0-不支持，1-支持 */ IsSupportTDE?: number; } /** 实例绑定的标签信息，包含标签键TagKey和标签值TagValue */ declare interface Tag { /** 标签键 */ TagKey: string; /** 标签值 */ TagValue: string; } /** 任务的详情信息 */ declare interface TaskDetail { /** 当前执行的子任务步骤名称。 */ CurrentStep?: string; /** 当前任务所拥有的子步骤描述。 */ AllSteps?: string; /** 任务的输入参数。 */ Input?: string; /** 任务的输出参数。 */ Output?: string; /** 指定实例配置完成变更后的切换时间，默认值：00: 此任务不需要切换1：立即切换2：指定时间切换3：维护时间窗口内切换。 */ SwitchTag?: number; /** 指定的切换时间。 */ SwitchTime?: string; /** 任务的提示信息。 */ Message?: string; } /** 任务列表信息 */ declare interface TaskSet { /** 任务ID。 */ TaskId?: number; /** 任务的类型。 */ TaskType?: string; /** 任务实例的实例ID。 */ DBInstanceId?: string; /** 任务的开始时间。 */ StartTime?: string; /** 任务的结束时间。 */ EndTime?: string; /** 任务的运行状态，包括Running,Success,WaitSwitch,Fail,Pause。 */ Status?: string; /** 任务的执行进度，取值范围0-100。 */ Progress?: number; /** 任务的详情信息 */ TaskDetail?: TaskDetail; } /** 数据库版本号信息 */ declare interface Version { /** 数据库引擎，支持：1、postgresql（云数据库PostgreSQL）；2、mssql_compatible（MSSQL兼容-云数据库PostgreSQL）； */ DBEngine?: string; /** 数据库版本，例如：12.4 */ DBVersion?: string; /** 数据库主要版本，例如：12 */ DBMajorVersion?: string; /** 数据库内核版本，例如：v12.4_r1.3 */ DBKernelVersion?: string; /** 数据库内核支持的特性列表。例如，TDE：支持数据加密。 */ SupportedFeatureNames?: string[]; /** 数据库版本状态，包括：AVAILABLE：可用；UPGRADE_ONLY：不可创建，此版本仅可升级至高版本；DEPRECATED：已弃用。 */ Status?: string; /** 该数据库版本（DBKernelVersion）可以升级到的版本号列表。其中包含可升级的小版本号和可升级的大版本号（完整内核版本格式示例：v15.1_v1.6）。 */ AvailableUpgradeTarget?: string[]; } /** 数据库Xlog信息 */ declare interface Xlog { /** 备份文件唯一标识 */ Id?: number; /** 文件生成的开始时间 */ StartTime?: string; /** 文件生成的结束时间 */ EndTime?: string; /** 内网下载地址 */ InternalAddr?: string; /** 外网下载地址 */ ExternalAddr?: string; /** 备份文件大小 */ Size?: number; } /** 描述可用区的编码和状态信息 */ declare interface ZoneInfo { /** 该可用区的英文名称 */ Zone: string; /** 该可用区的中文名称 */ ZoneName: string; /** 该可用区对应的数字编号 */ ZoneId: number; /** 可用状态包含，UNAVAILABLE：不可用。AVAILABLE：可用。SELLOUT：售罄。SUPPORTMODIFYONLY：支持变配。 */ ZoneState: string; /** 该可用区是否支持Ipv6 */ ZoneSupportIpv6: number; /** 该可用区对应的备可用区集合 */ StandbyZoneSet: string[] | null; } declare interface AddDBInstanceToReadOnlyGroupRequest { /** 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** 只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取 */ ReadOnlyGroupId: string; } declare interface AddDBInstanceToReadOnlyGroupResponse { /** 流程ID */ FlowId?: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CloneDBInstanceRequest { /** 克隆的源实例ID。 */ DBInstanceId: string; /** 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。 */ SpecCode: string; /** 实例容量大小，单位：GB。 */ Storage: number; /** 购买时长，单位：月。- 预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36- 后付费：只支持1 */ Period: number; /** 续费标记：- 0：手动续费- 1：自动续费默认值：0 */ AutoRenewFlag: number; /** 私有网络ID，形如vpc-xxxxxxxx。有效的VpcId可通过登录控制台查询；也可以调用接口 [DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372) ，从接口返回中的unVpcId字段获取。 */ VpcId: string; /** 私有网络子网ID，形如subnet-xxxxxxxx。有效的私有网络子网ID可通过登录控制台查询；也可以调用接口 [DescribeSubnets ](https://cloud.tencent.com/document/api/215/15784)，从接口返回中的unSubnetId字段获取。 */ SubnetId: string; /** 新购的实例名称，仅支持长度小于60的中文/英文/数字/"_"/"-"，不指定实例名称则默认显示"未命名"。 */ Name?: string; /** 实例计费类型，目前支持：- PREPAID：预付费，即包年包月- POSTPAID_BY_HOUR：后付费，即按量计费默认值：PREPAID */ InstanceChargeType?: string; /** 实例所属安全组，该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。 */ SecurityGroupIds?: string[]; /** 项目ID。 */ ProjectId?: number; /** 实例需要绑定的Tag信息，默认为空；可以通过调用 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 返回值中的 Tags 字段来获取。 */ TagList?: Tag[]; /** 实例节点部署信息，支持多可用区部署时需要指定每个节点的部署可用区信息。可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。 */ DBNodeSet?: DBNode[]; /** 是否自动使用代金券：- 0：否- 1：是默认值：0 */ AutoVoucher?: number; /** 代金券ID列表。 */ VoucherIds?: string; /** 活动ID。 */ ActivityId?: number; /** 基础备份集ID。 */ BackupSetId?: string; /** 恢复时间点。 */ RecoveryTargetTime?: string; /** 主从同步方式，支持： Semi-sync：半同步Async：异步主实例默认值：Semi-sync只读实例默认值：Async */ SyncMode?: string; } declare interface CloneDBInstanceResponse { /** 订单号。 */ DealName?: string; /** 订单流水号。 */ BillId?: string; /** 克隆出的新实例ID，当前只支持后付费返回该值。 */ DBInstanceId?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CloseDBExtranetAccessRequest { /** 实例ID，形如postgres-6r233v55 */ DBInstanceId: string; /** 是否关闭Ipv6外网，1：是，0：否 */ IsIpv6?: number; } declare interface CloseDBExtranetAccessResponse { /** 异步任务流程ID */ FlowId?: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateAccountRequest { /** 实例ID。 */ DBInstanceId: string; /** 创建的账号名称。 */ UserName: string; /** 账号对应的密码。 */ Password: string; /** 账号类型。当前支持normal、tencentDBSuper两个输入。normal指代普通用户，tencentDBSuper为拥有pg_tencentdb_superuser角色的账号。 */ Type: string; /** 账号备注。 */ Remark?: string; } declare interface CreateAccountResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateBackupPlanRequest { /** 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** 备份计划名称。 */ PlanName: string; /** 创建的备份计划类型，当前仅支持month创建。 */ BackupPeriodType: string; /** 备份的日期，示例是每个月的2号开启备份。 */ BackupPeriod: string[]; /** 备份开始时间，不传跟随默认备份计划。 */ MinBackupStartTime?: string; /** 备份结束时间，不传跟随默认计划。 */ MaxBackupStartTime?: string; /** 数据备份保留时长，单位：天。取值范围为：[0,30000)BackupPeriodType为week时默认是7,为month时默认为31。 */ BaseBackupRetentionPeriod?: number; } declare interface CreateBackupPlanResponse { /** 备份策略的ID. */ PlanId?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateBaseBackupRequest { /** 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; } declare interface CreateBaseBackupResponse { /** 数据备份集ID */ BaseBackupId?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateDBInstanceNetworkAccessRequest { /** 实例ID，形如：postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** 私有网络统一 ID。 */ VpcId: string; /** 子网ID。 */ SubnetId: string; /** 是否指定分配vip true-指定分配 false-自动分配。 */ IsAssignVip: boolean; /** 目标VIP地址。当不指定该参数，且IsAssignVip为true时，默认自动分配Vip。 */ Vip?: string; } declare interface CreateDBInstanceNetworkAccessResponse { /** 流程ID。 */ FlowId?: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateDatabaseRequest { /** 实例ID，形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** 创建的数据库名。名称规范：由字母（a-z, A-Z）、数字（0-9）、下划线（_）组成，以字母或（_）开头，最多63个字符。不能使用系统保留关键字，不能为postgres。 */ DatabaseName: string; /** 数据库的所有者。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取 */ DatabaseOwner: string; /** 数据库的字符编码。支持的常用字符集包括：UTF8、LATIN1、LATIN2、WIN1250、WIN1251、WIN1252、KOI8R、EUC_JP、EUC_KR默认值：UTF8 */ Encoding?: string; /** 数据库的排序规则 */ Collate?: string; /** 数据库的字符分类 */ Ctype?: string; } declare interface CreateDatabaseResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateInstancesRequest { /** 实例所属主可用区，如：ap-guangzhou-3；若需要支持多可用区，在DBNodeSet.N字段中进行添加主可用区和备可用区信息；可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。 */ Zone: string; /** 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。 */ SpecCode: string; /** 实例磁盘容量大小，单位：GB。该参数的设置步长为10。 */ Storage: number; /** 购买实例数量，取值范围：[1-10]。一次性购买支持最大数量10个，若超过该数量，可进行多次调用进行购买。 */ InstanceCount: number; /** 购买时长，单位：月。预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36后付费：只支持1 */ Period: number; /** 实例字符集，目前只支持： UTF8 LATIN1 */ Charset: string; /** 实例根账号用户名，具体规范如下：用户名需要1-16个字符，只能由字母、数字或下划线组成不能为postgres不能由数字和pg_开头所有规则均不区分大小写 */ AdminName: string; /** 实例根账号用户名对应的密码，长度8 ~ 32位，推荐使用12位以上的密码;不能以" / "开头;必须包含以下四项，字符种类:小写字母： [a ~ z]大写字母：[A ～ Z]数字：0 - 9特殊字符：()`~!@#$%^&*-+=_|{}[]:;'<>,.?/ */ AdminPassword: string; /** PostgreSQL大版本号（该参数当前必传），版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取。目前支持10，11，12，13，14，15这几个大版本，详情见[内核版本概述](https://cloud.tencent.com/document/product/409/67018)。输入该参数时，会基于此大版本号创建对应的最新小版本的最新内核版本号实例。 */ DBMajorVersion?: string; /** PostgreSQL社区大版本+小版本号。一般场景不推荐传入该参数。如需指定，只能传当前大版本号下最新小版本号。 */ DBVersion?: string; /** PostgreSQL内核版本号。一般场景不推荐传入该参数。如需指定，只能传当前大版本号下最新内核版本号。 */ DBKernelVersion?: string; /** 实例计费类型，目前支持：PREPAID：预付费，即包年包月POSTPAID_BY_HOUR：后付费，即按量计费默认值：PREPAID */ InstanceChargeType?: string; /** 私有网络ID，形如vpc-xxxxxxxx（该参数当前必传）。有效的VpcId可通过登录控制台查询；也可以调用接口 [DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372) ，从接口返回中的unVpcId字段获取。 */ VpcId?: string; /** 私有网络子网ID，形如subnet-xxxxxxxx（该参数当前必传）。有效的私有网络子网ID可通过登录控制台查询；也可以调用接口 [DescribeSubnets ](https://cloud.tencent.com/document/api/215/15784)，从接口返回中的unSubnetId字段获取。 */ SubnetId?: string; /** 实例节点部署信息，支持多可用区部署时需要指定每个节点的部署可用区信息。可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。 */ DBNodeSet?: DBNode[]; /** 续费标记：0：手动续费1：自动续费默认值：0 */ AutoRenewFlag?: number; /** 是否自动使用代金券：0：否1：是默认值：0 */ AutoVoucher?: number; /** 代金券ID列表，目前仅支持指定一张代金券。 */ VoucherIds?: string[]; /** 项目ID。默认取之为0，表示归属默认项目。 */ ProjectId?: number; /** 活动ID。 */ ActivityId?: number; /** 实例名称，仅支持长度小于60的中文/英文/数字/"_"/"-"，不指定实例名称则默认显示"未命名"。 */ Name?: string; /** 实例需要绑定的Tag信息，默认为空；可以通过调用 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 返回值中的 Tags 字段来获取。 */ TagList?: Tag[]; /** 实例所属安全组，该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。 */ SecurityGroupIds?: string[]; /** 是否需要支持数据透明加密：0：否1：是默认值：0参考[数据透明加密概述](https://cloud.tencent.com/document/product/409/71748) */ NeedSupportTDE?: number; /** 自定义密钥的KeyId，若选择自定义密匙加密，则需要传入自定义密匙的KeyId，KeyId是CMK的唯一标识。KeyId创建获取相关参考[开启透明数据加密](https://cloud.tencent.com/document/product/409/71749) */ KMSKeyId?: string; /** 使用KMS服务的地域，KMSRegion为空默认使用本地域的KMS，本地域不支持的情况下需自选其他KMS支持的地域。KMSRegion相关介绍参考[开启透明数据加密](https://cloud.tencent.com/document/product/409/71749) */ KMSRegion?: string; /** 指定KMS服务的集群，KMSClusterId为空使用默认集群的KMS，若选择指定KMS集群，则需要传入KMSClusterId。 KMSClusterId相关介绍参考开启透明数据加密 */ KMSClusterId?: string; /** 数据库引擎，支持：postgresql：云数据库PostgreSQLmssql_compatible：MSSQL兼容-云数据库PostgreSQL默认值：postgresql */ DBEngine?: 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"。 */ DBEngineConfig?: string; /** 主从同步方式，支持： Semi-sync：半同步Async：异步主实例默认值：Semi-sync只读实例默认值：Async */ SyncMode?: string; /** 是否需要支持Ipv6：0：否1：是默认值：0 */ NeedSupportIpv6?: number; } declare interface CreateInstancesResponse { /** 订单号列表。每个实例对应一个订单号。 */ DealNames?: string[]; /** 冻结流水号。 */ BillId?: string; /** 创建成功的实例ID集合，只在后付费情景下有返回值。 */ DBInstanceIdSet?: string[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateParameterTemplateRequest { /** 模板名称，长度为1～60个字符，仅支持数字,英文大小写字母、中文以及特殊字符_-./()（）[]+=：:@ */ TemplateName: string; /** 数据库大版本号，例如：11，12，13。可通过[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)接口获取 */ DBMajorVersion: string; /** 数据库引擎，例如：postgresql，mssql_compatible */ DBEngine: string; /** 参数模板描述，长度为0～60个字符，仅支持数字,英文大小写字母、中文以及特殊字符_-./()（）[]+=：:@ */ TemplateDescription?: string; } declare interface CreateParameterTemplateResponse { /** 参数模板ID，用于唯一确认参数模板 */ TemplateId?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateReadOnlyDBInstanceRequest { /** 实例所属主可用区，如：ap-guangzhou-3；可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。 */ Zone: string; /** 只读实例的主实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ MasterDBInstanceId: string; /** 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。 */ SpecCode: string; /** 实例硬盘容量大小，单位：GB。该参数的设置步长为10。 */ Storage: number; /** 购买实例数量，取值范围：[1-10]。一次性购买支持最大数量10个，若超过该数量，可进行多次调用进行购买。 */ InstanceCount: number; /** 购买时长，单位：月。预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36后付费：只支持1 */ Period: number; /** 私有网络ID，形如vpc-xxxxxxxx（该参数当前必传）。有效的VpcId可通过登录控制台查询；也可以调用接口 [DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372) ，从接口返回中的unVpcId字段获取。 */ VpcId?: string; /** 私有网络子网ID，形如subnet-xxxxxxxx（该参数当前必传）。有效的私有网络子网ID可通过登录控制台查询；也可以调用接口 [DescribeSubnets ](https://cloud.tencent.com/document/api/215/15784)，从接口返回中的unSubnetId字段获取。 */ SubnetId?: string; /** 实例计费类型，目前支持：PREPAID：预付费，即包年包月。POSTPAID_BY_HOUR：后付费，即按量计费。默认值：PREPAID。如果主实例为后付费，只读实例必须也为后付费。 */ InstanceChargeType?: string; /** 是否自动使用代金券：0：否1：是默认值：0 */ AutoVoucher?: number; /** 代金券ID列表，目前仅支持指定一张代金券。 */ VoucherIds?: string[]; /** 续费标记：0：手动续费1：自动续费默认值：0 */ AutoRenewFlag?: number; /** 项目ID。默认值为0，表示归属默认项目。 */ ProjectId?: number; /** 优惠活动ID */ ActivityId?: number; /** 只读组ID。 */ ReadOnlyGroupId?: string; /** 实例需要绑定的Tag信息，默认为空；可以通过调用 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 返回值中的 Tags 字段来获取。 */ TagList?: Tag; /** 实例所属安全组，该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。 */ SecurityGroupIds?: string[]; /** 是否需要支持Ipv6：0：否1：是默认值：0 */ NeedSupportIpv6?: number; /** 实例名。仅支持长度小于60的中文/英文/数字/"_"/"-" */ Name?: string; /** 不再需要指定，内核版本号与主实例保持一致 */ DBVersion?: string; /** 专属集群ID */ DedicatedClusterId?: string; } declare interface CreateReadOnlyDBInstanceResponse { /** 订单号列表。每个实例对应一个订单号 */ DealNames?: string[]; /** 冻结流水号 */ BillId?: string; /** 创建成功的实例ID集合，只在后付费情景下有返回值 */ DBInstanceIdSet?: string[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateReadOnlyGroupNetworkAccessRequest { /** RO组ID，形如：pgrogrp-4t9c6g7k。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取 */ ReadOnlyGroupId: string; /** 私有网络统一 ID。 */ VpcId: string; /** 子网ID。 */ SubnetId: string; /** 是否指定分配vip true-指定分配 false-自动分配。 */ IsAssignVip: boolean; /** 目标VIP地址。当不指定该参数，且IsAssignVip为true时，默认自动分配Vip。 */ Vip?: string; } declare interface CreateReadOnlyGroupNetworkAccessResponse { /** 流程ID。 */ FlowId?: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateReadOnlyGroupRequest { /** 主实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ MasterDBInstanceId: string; /** 只读组名称。仅支持长度小于60的中文/英文/数字/"_"/"-"。 */ Name: string; /** 项目ID。默认值为0，表示归属于默认项目。 */ ProjectId?: number; /** 私有网络ID。注：默认使用基础网络，当前不支持基础网络，故该参数必填。 */ VpcId?: string; /** 子网ID。注：默认使用基础网络，当前不支持基础网络，故该参数必填。 */ SubnetId?: string; /** 延迟时间大小开关：0关、1开。该参数必填。 */ ReplayLagEliminate?: number; /** 延迟空间大小开关： 0关、1开。该参数的填写需要与ReplayLagEliminate一致。 */ ReplayLatencyEliminate?: number; /** 延迟时间大小阈值，取值为正整数，单位s。当ReplayLagEliminate为1时，该参数必填；当ReplayLagEliminate为0时，该参数需填0。 */ MaxReplayLag?: number; /** 延迟空间大小阈值，取值为正整数，单位MB。当ReplayLatencyEliminate为1时，该参数必填；当ReplayLatencyEliminate为0时，该参数需填0。 */ MaxReplayLatency?: number; /** 延迟剔除最小保留实例数。取值范围[0,100]。当ReplayLatencyEliminate为1时，该参数必填；当ReplayLagEliminate为0时，该参数无效。 */ MinDelayEliminateReserve?: number; /** 安全组id */ SecurityGroupIds?: string[]; } declare interface CreateReadOnlyGroupResponse { /** 只读组ID */ ReadOnlyGroupId?: string; /** 流程ID */ FlowId?: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateServerlessDBInstanceRequest { /** 可用区ID。公测阶段仅支持ap-shanghai-2、ap-beijing-1,ap-guangzhou-2. */ Zone: string; /** DB实例名称，同一个账号下该值必须唯一。 */ DBInstanceName: string; /** PostgreSQL内核版本，目前只支持：10.4。 */ DBVersion: string; /** PostgreSQL数据库字符集，目前支持UTF8。 */ DBCharset: string; /** 项目ID。 */ ProjectId?: number; /** 私有网络ID。 */ VpcId?: string; /** 私有网络子网ID。 */ SubnetId?: string; /** 实例需要绑定的标签数组信息 */ TagList?: Tag[]; } declare interface CreateServerlessDBInstanceResponse { /** 实例ID，该ID全局唯一，如：postgres-xxxxx */ DBInstanceId?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DeleteAccountRequest { /** 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** 删除的账号名称。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取 */ UserName: string; } declare interface DeleteAccountResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DeleteBackupPlanRequest { /** 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** 备份计划的ID。可通过[DescribeBackupPlans](https://cloud.tencent.com/document/api/409/68069)接口获取 */ PlanId: string; } declare interface DeleteBackupPlanResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DeleteBaseBackupRequest { /** 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** 数据备份ID。可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取。7天内自动备份集不允许删除。 */ BaseBackupId: string; } declare interface DeleteBaseBackupResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DeleteDBInstanceNetworkAccessRequest { /** 实例ID，形如：postgres-6bwgamo3。 */ DBInstanceId: string; /** 私有网络统一 ID，若是基础网络则传"0"。 */ VpcId: string; /** 子网ID，若是基础网络则传"0"。 */ SubnetId: string; /** 目标VIP地址。 */ Vip: string; } declare interface DeleteDBInstanceNetworkAccessResponse { /** 流程ID。 */ FlowId?: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DeleteLogBackupRequest { /** 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** 日志备份ID。可通过[DescribeLogBackups](https://cloud.tencent.com/document/api/409/89021)接口获取。注：7天内自动备份集不允许删除。 */ LogBackupId: string; } declare interface DeleteLogBackupResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DeleteParameterTemplateRequest { /** 参数模板ID，用于唯一确认待操作的参数模板。可通过[DescribeParameterTemplates](https://cloud.tencent.com/document/api/409/84067)接口获取 */ TemplateId: string; } declare interface DeleteParameterTemplateResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DeleteReadOnlyGroupNetworkAccessRequest { /** RO组ID，形如：pgro-4t9c6g7k。 */ ReadOnlyGroupId: string; /** 私有网络统一 ID，若是基础网络则传"0"。 */ VpcId: string; /** 子网ID，若是基础网络则传"0"。 */ SubnetId: string; /** 目标VIP地址。 */ Vip: string; } declare interface DeleteReadOnlyGroupNetworkAccessResponse { /** 流程ID。 */ FlowId?: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DeleteReadOnlyGroupRequest { /** 待删除只读组ID */ ReadOnlyGroupId: string; } declare interface DeleteReadOnlyGroupResponse { /** 流程ID */ FlowId?: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeAccountPrivilegesRequest { /** 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** 查询此账号对某数据库对象所拥有的权限信息。账号名可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取 */ UserName: string; /** 要查询的数据库对象信息 */ DatabaseObjectSet: DatabaseObject[]; } declare interface DescribeAccountPrivilegesResponse { /** 用户拥有数据库user_database的CREATE、CONNECT、TEMPORARY权限 */ PrivilegeSet?: DatabasePrivilege[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeAccountsRequest { /** 实例ID，形如postgres-6fego161 */ DBInstanceId: string; /** 分页返回，每页最大返回数目，默认20，取值范围为1-100 */ Limit?: number; /** 数据偏移量，从0开始。 */ Offset?: number; /** 返回数据按照创建时间或者用户名排序。取值支持createTime、name、updateTime。createTime-按照创建时间排序；name-按照用户名排序; updateTime-按照更新时间排序。 */ OrderBy?: string; /** 返回结果是升序还是降序。取值只能为desc或者asc。desc-降序；asc-升序 */ OrderByType?: string; } declare interface DescribeAccountsResponse { /** 本次调用接口共返回了多少条数据。 */ TotalCount?: number; /** 账号列表详细信息。当CreateTime项为0000-00-00 00:00:00时，意味着对应账号是直连数据库创建的，并非通过CreateAccount接口创建。 */ Details?: AccountInfo[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeAvailableRecoveryTimeRequest { /** 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; } declare interface DescribeAvailableRecoveryTimeResponse { /** 可恢复的最早时间，时区为东八区（UTC+8）。 */ RecoveryBeginTime?: string; /** 可恢复的最晚时间，时区为东八区（UTC+8）。 */ RecoveryEndTime?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeBackupDownloadRestrictionRequest { } declare interface DescribeBackupDownloadRestrictionResponse { /** 备份文件下载限制类型，NONE 无限制，内外网都可以下载；INTRANET 只允许内网下载；CUSTOMIZE 自定义限制下载的vpc或ip。 */ RestrictionType?: string; /** vpc限制效力，ALLOW 允许；DENY 拒绝。 */ VpcRestrictionEffect?: string; /** 允许或拒绝下载备份文件的vpcId列表。 */ VpcIdSet?: string[]; /** ip限制效力，ALLOW 允许；DENY 拒绝。 */ IpRestrictionEffect?: string; /** 允许或拒绝下载备份文件的ip列表。 */ IpSet?: string[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeBackupDownloadURLRequest { /** 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** 备份类型，目前支持：LogBackup，BaseBackup。 */ BackupType: string; /** 备份的唯一ID。 */ BackupId: string; /** 链接的有效时间，取值为[0,36]，默认为12小时。 */ URLExpireTime?: number; /** 备份下载限制 */ BackupDownloadRestriction?: BackupDownloadRestriction; } declare interface DescribeBackupDownloadURLResponse { /** 备份的下载地址。 */ BackupDownloadURL?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeBackupOverviewRequest { } declare interface DescribeBackupOverviewResponse { /** 总免费空间大小，单位byte。 */ TotalFreeSize: number; /** 已使用免费空间大小，单位byte。 */ UsedFreeSize: number; /** 已使用收费空间大小，单位byte。 */ UsedBillingSize: number; /** 日志备份数量。 */ LogBackupCount: number; /** 日志备份大小，单位byte。 */ LogBackupSize: number; /** 手动创建的基础备份数量。 */ ManualBaseBackupCount: number; /** 手动创建的基础备份大小，单位byte。 */ ManualBaseBackupSize: number; /** 自动创建的基础备份数量。 */ AutoBaseBackupCount: number; /** 自动创建的基础备份大小，单位byte。 */ AutoBaseBackupSize: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeBackupPlansRequest { /** 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; } declare interface DescribeBackupPlansResponse { /** 实例的备份计划集 */ Plans?: BackupPlan[]; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeBackupSummariesRequest { /** 每页显示数量，取值范围为1-100，默认为返回10条。 */ Limit?: number; /** 数据偏移量，从0开始。 */ Offset?: number; /** 按照一个或者多个过滤条件进行查询，目前支持的过滤条件有：db-instance-id：按照实例ID过滤，类型为string。db-instance-name：按照实例名过滤，类型为string。db-instance-ip：按照实例私有网络IP地址过滤，类型为string。 */ Filters?: Filter[]; /** 排序字段，支持TotalBackupSize,LogBackupSize,ManualBaseBackupSize,AutoBaseBackupSize。 */ OrderBy?: string; /** 排序方式，包括升序：asc，降序：desc。 */ OrderByType?: string; } declare interface DescribeBackupSummariesResponse { /** 备份统计信息列表。 */ BackupSummarySet?: BackupSummary[]; /** 查询到的所有备份信息数量。 */ TotalCount?: number; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface DescribeBaseBackupsRequest { /** 备份的最小结束时间，形如2018-01-01 00:00:00。默认为7天前。 */ MinFinishTime?: string; /** 备份的最大结束时间，形如2018-01-01 00:00:00。默认为当前时间。 */ MaxFinishTime?: string; /** 按照一个或者多个过滤条件进行查询，目前支持的过滤条件有：db-instance-id：按照实例ID过滤，类型为string。db-instance-name：按照实例名过滤，支持模糊匹配，类型为string。db-instance-ip：按照实例私有网络IP地址过滤，类型为string。base-backup-id：按照备份集ID过滤，类型为string。db-instance-status：按实例状态过滤，类型为string。取值参考[DBInstance](https://cloud.tencent.com/document/api/409/16778)结构的DBInstanceStatus字段。 */ Filters?: Filter[]; /** 每页显示数量，取值范围为1-100，默认为返回10条。 */ Limit?: number; /** 数据偏移量，从0开始。 */ Offset?: number; /** 排序字段，支持StartTime,FinishTime,Size。默认值：StartTime。 */ Or