@nocobase/plugin-verification

/** * CreateDBInstances请求参数结构体 */ export interface CreateDBInstancesRequest { /** * 售卖规格ID。该参数可以通过调用DescribeClasses的返回值中的SpecCode字段来获取。 */ SpecCode: string; /** * 实例容量大小，单位：GB。 */ Storage: number; /** * 一次性购买的实例数量。取值1-100 */ InstanceCount: number; /** * 购买时长，单位：月。目前只支持1,2,3,4,5,6,7,8,9,10,11,12,24,36这些值，按量计费模式下该参数传1。 */ Period: number; /** * 可用区ID。该参数可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。 */ Zone: string; /** * 项目ID。 */ ProjectId?: number; /** * PostgreSQL社区大版本+小版本号。一般场景不推荐传入该参数。如需指定，只能传当前大版本号下最新小版本号。 */ DBVersion?: string; /** * 实例计费类型。目前支持：PREPAID（预付费，即包年包月），POSTPAID_BY_HOUR（后付费，即按量计费）。默认值：PREPAID。 */ InstanceChargeType?: string; /** * 是否自动使用代金券。1（是），0（否），默认不使用。 */ AutoVoucher?: number; /** * 代金券ID列表，目前仅支持指定一张代金券。 */ VoucherIds?: Array<string>; /** * 私有网络ID。 */ VpcId?: string; /** * 私有网络子网ID。 */ SubnetId?: string; /** * 续费标记：0-正常续费（默认）；1-自动续费； */ AutoRenewFlag?: number; /** * 活动ID */ ActivityId?: number; /** * 实例名(后续支持) */ Name?: string; /** * 是否需要支持Ipv6，1：是，0：否 */ NeedSupportIpv6?: number; /** * 实例需要绑定的Tag信息，默认为空 */ TagList?: Array<Tag>; /** * 安全组id */ SecurityGroupIds?: Array<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内核版本号。一般场景不推荐传入该参数。如需指定，只能传当前大版本号下最新内核版本号。 */ DBKernelVersion?: string; } /** * SetAutoRenewFlag请求参数结构体 */ export interface SetAutoRenewFlagRequest { /** * 实例ID集合。注意：当前已不支持同时操作多个实例，这里只能传入单个实例ID。 */ DBInstanceIdSet: Array<string>; /** * 续费标记。0-正常续费；1-自动续费；2-到期不续费 */ AutoRenewFlag: number; } /** * DescribeDatabases请求参数结构体 */ export interface DescribeDatabasesRequest { /** * 实例ID */ DBInstanceId: string; } /** * DescribeDBXlogs请求参数结构体 */ export interface DescribeDBXlogsRequest { /** * 实例ID，形如postgres-4wdeb0zv。 */ DBInstanceId: string; /** * 查询开始时间，形如2018-06-10 17:06:38，起始时间不得小于7天以前 */ StartTime: string; /** * 查询结束时间，形如2018-06-10 17:06:38 */ EndTime: string; /** * 分页返回，表示返回第几页的条目。从第0页开始计数。 */ Offset?: number; /** * 分页返回，表示每页有多少条目。取值为1-100。 */ Limit?: number; } /** * CreateReadOnlyGroupNetworkAccess请求参数结构体 */ export interface CreateReadOnlyGroupNetworkAccessRequest { /** * RO组ID，形如：pgro-4t9c6g7k。 */ ReadOnlyGroupId: string; /** * 私有网络统一 ID。 */ VpcId: string; /** * 子网ID。 */ SubnetId: string; /** * 是否指定分配vip true-指定分配 false-自动分配。 */ IsAssignVip: boolean; /** * 目标VIP地址。 */ Vip?: string; } /** * DescribeAccounts请求参数结构体 */ export interface DescribeAccountsRequest { /** * 实例ID，形如postgres-6fego161 */ DBInstanceId: string; /** * 分页返回，每页最大返回数目，默认10，取值范围为1-100 */ Limit?: number; /** * 数据偏移量，从0开始。 */ Offset?: number; /** * 返回数据按照创建时间或者用户名排序。取值只能为createTime或者name。createTime-按照创建时间排序；name-按照用户名排序 */ OrderBy?: string; /** * 返回结果是升序还是降序。取值只能为desc或者asc。desc-降序；asc-升序 */ OrderByType?: string; } /** * DeleteReadOnlyGroup返回参数结构体 */ export interface DeleteReadOnlyGroupResponse { /** * 流程ID 注意：此字段可能返回 null，表示取不到有效值。 */ FlowId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * OpenDBExtranetAccess请求参数结构体 */ export interface OpenDBExtranetAccessRequest { /** * 实例ID，形如postgres-hez4fh0v */ DBInstanceId: string; /** * 是否开通Ipv6外网，1：是，0：否 */ IsIpv6?: number; } /** * CreateInstances请求参数结构体 */ export 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。 */ Storage: number; /** * 购买实例数量，取值范围：[1-10]。一次性购买支持最大数量10个，若超过该数量，可进行多次调用进行购买。 */ InstanceCount: number; /** * 购买时长，单位：月。 <li>预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36 <li>后付费：只支持1 */ Period: number; /** * 实例字符集，目前只支持： <li> UTF8 <li> LATIN1 */ Charset: string; /** * 实例根账号用户名，具体规范如下： <li>用户名需要1-16个字符，只能由字母、数字或下划线组成 <li>不能为postgres <li>不能由数字和pg_开头 <li>所有规则均不区分大小写 */ AdminName: string; /** * 实例根账号用户名对应的密码，长度8 ~ 32位，推荐使用12位以上的密码;不能以" / "开头; 必须包含以下四项，字符种类: <li>小写字母： [a ~ z] <li>大写字母：[A ～ Z] <li>数字：0 - 9 <li>特殊字符：()`~!@#$%^&*-+=_|{}[]:;'<>,.?/ */ 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; /** * 实例计费类型，目前支持： <li>PREPAID：预付费，即包年包月 <li>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?: Array<DBNode>; /** * 续费标记： <li>0：手动续费 <li>1：自动续费默认值：0 */ AutoRenewFlag?: number; /** * 是否自动使用代金券： <li>0：否 <li>1：是默认值：0 */ AutoVoucher?: number; /** * 代金券ID列表，目前仅支持指定一张代金券。 */ VoucherIds?: Array<string>; /** * 项目ID。 */ ProjectId?: number; /** * 活动ID。 */ ActivityId?: number; /** * 实例名称，仅支持长度小于60的中文/英文/数字/"_"/"-"，不指定实例名称则默认显示"未命名"。 */ Name?: string; /** * 实例需要绑定的Tag信息，默认为空；可以通过调用 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 返回值中的 Tags 字段来获取。 */ TagList?: Array<Tag>; /** * 实例所属安全组，该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。 */ SecurityGroupIds?: Array<string>; /** * 是否需要支持数据透明加密： <li>0：否 <li>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; /** * 数据库引擎，支持： <li>postgresql：云数据库PostgreSQL <li>mssql_compatible：MSSQL兼容-云数据库PostgreSQL 默认值：postgresql */ DBEngine?: string; /** * 数据库引擎的配置信息，配置格式如下： {"$key1":"$value1", "$key2":"$value2"} 各引擎支持如下： mssql_compatible引擎： <li>migrationMode：数据库模式，可选参数，可取值：single-db（单数据库模式），multi-db（多数据库模式）。默认为single-db。 <li>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"。 <li>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; /** * 主从同步方式，支持： <li>Semi-sync：半同步 <li>Async：异步主实例默认值：Semi-sync 只读实例默认值：Async */ SyncMode?: string; /** * 是否需要支持Ipv6： <li>0：否 <li>1：是默认值：0 */ NeedSupportIpv6?: number; } /** * 描述一种规格的信息 */ export 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的主要版本编号注意：此字段可能返回 null，表示取不到有效值。 */ MajorVersion: string; /** * PostgreSQL的内核版本编号注意：此字段可能返回 null，表示取不到有效值。 */ KernelVersion: string; /** * 是否支持TDE数据加密功能，0-不支持，1-支持注意：此字段可能返回 null，表示取不到有效值。 */ IsSupportTDE: number; } /** * 参数模板的基本信息 */ export interface ParameterTemplate { /** * 参数模板ID */ TemplateId: string; /** * 参数模板名称 */ TemplateName: string; /** * 参数模板适用的数据库版本 */ DBMajorVersion: string; /** * 参数模板适用的数据库引擎 */ DBEngine: string; /** * 参数模板描述 */ TemplateDescription: string; } /** * CreateDBInstanceNetworkAccess返回参数结构体 */ export interface CreateDBInstanceNetworkAccessResponse { /** * 流程ID。注意：此字段可能返回 null，表示取不到有效值。 */ FlowId?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAvailableRecoveryTime返回参数结构体 */ export interface DescribeAvailableRecoveryTimeResponse { /** * 可恢复的最早时间，时区为东八区（UTC+8）。 */ RecoveryBeginTime?: string; /** * 可恢复的最晚时间，时区为东八区（UTC+8）。 */ RecoveryEndTime?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateBaseBackup请求参数结构体 */ export interface CreateBaseBackupRequest { /** * 实例ID。 */ DBInstanceId: string; } /** * ModifyDBInstanceReadOnlyGroup返回参数结构体 */ export interface ModifyDBInstanceReadOnlyGroupResponse { /** * 流程ID */ FlowId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据库实例规格 */ export interface ClassInfo { /** * 规格ID */ SpecCode: string; /** * CPU核数 */ CPU: number; /** * 内存大小，单位：MB */ Memory: number; /** * 该规格所支持最大存储容量，单位：GB */ MaxStorage: number; /** * 该规格所支持最小存储容量，单位：GB */ MinStorage: number; /** * 该规格的预估QPS */ QPS: number; } /** * DescribeCloneDBInstanceSpec请求参数结构体 */ export interface DescribeCloneDBInstanceSpecRequest { /** * 实例ID。 */ DBInstanceId: string; /** * 基础备份集ID，此入参和RecoveryTargetTime必须选择一个传入。如与RecoveryTargetTime参数同时设置，则以此参数为准。 */ BackupSetId?: string; /** * 恢复目标时间，此入参和BackupSetId必须选择一个传入。时区以东八区（UTC+8）为准。 */ RecoveryTargetTime?: string; } /** * DescribeDBInstanceSecurityGroups返回参数结构体 */ export interface DescribeDBInstanceSecurityGroupsResponse { /** * 安全组信息数组 */ SecurityGroupSet?: Array<SecurityGroup>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 备份计划 */ export interface BackupPlan { /** * 备份周期 */ BackupPeriod: string; /** * 基础备份保留时长 */ BaseBackupRetentionPeriod: number; /** * 开始备份的最早时间 */ MinBackupStartTime: string; /** * 开始备份的最晚时间 */ MaxBackupStartTime: string; } /** * SwitchDBInstancePrimary请求参数结构体 */ export interface SwitchDBInstancePrimaryRequest { /** * 实例ID */ DBInstanceId: string; /** * 是否强制切换。强制切换时只要备节点可访问，无论主备延迟多大都会发起切换。只有SwitchTag为0时，才可使用立即切换。 <li>默认：false */ Force?: boolean; /** * 指定实例配置完成变更后的切换时间。 <li>0：立即切换 <li>1：指定时间切换 <li>2：维护时间窗口内切换 <li>默认值：0 */ SwitchTag?: number; /** * 切换开始时间，时间格式：HH:MM:SS，例如：01:00:00。当SwitchTag为0或2时，该参数失效。 */ SwitchStartTime?: string; /** * 切换截止时间，时间格式：HH:MM:SS，例如：01:30:00。当SwitchTag为0或2时，该参数失效。SwitchStartTime和SwitchEndTime时间窗口不能小于30分钟。 */ SwitchEndTime?: string; } /** * OpenServerlessDBExtranetAccess请求参数结构体 */ export interface OpenServerlessDBExtranetAccessRequest { /** * 实例的唯一标识符 */ DBInstanceId?: string; /** * 实例名称 */ DBInstanceName?: string; } /** * RenewInstance返回参数结构体 */ export interface RenewInstanceResponse { /** * 订单名 */ DealName: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteServerlessDBInstance返回参数结构体 */ export interface DeleteServerlessDBInstanceResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteLogBackup返回参数结构体 */ export interface DeleteLogBackupResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyReadOnlyGroupConfig请求参数结构体 */ export interface ModifyReadOnlyGroupConfigRequest { /** * 只读组ID */ ReadOnlyGroupId: string; /** * 只读组名称 */ ReadOnlyGroupName?: string; /** * 延迟时间配置开关：0关、1开 */ ReplayLagEliminate?: number; /** * 延迟日志大小配置开关：0关、1开 */ ReplayLatencyEliminate?: number; /** * 延迟日志大小阈值，单位MB */ MaxReplayLatency?: number; /** * 延迟时间大小阈值，单位ms */ MaxReplayLag?: number; /** * 自动负载均衡开关：0关、1开 */ Rebalance?: number; /** * 延迟剔除最小保留实例数 */ MinDelayEliminateReserve?: number; } /** * 实例备份统计项 */ export interface BackupSummary { /** * 实例ID。 */ DBInstanceId: string; /** * 实例日志备份数量。 */ LogBackupCount: number; /** * 实例日志备份大小。 */ LogBackupSize: number; /** * 手动创建的实例基础备份数量。 */ ManualBaseBackupCount: number; /** * 手动创建的实例基础备份大小。 */ ManualBaseBackupSize: number; /** * 自动创建的实例基础备份数量。 */ AutoBaseBackupCount: number; /** * 自动创建的实例基础备份大小。 */ AutoBaseBackupSize: number; /** * 总备份数量 */ TotalBackupCount: number; /** * 总备份大小 */ TotalBackupSize: number; } /** * AddDBInstanceToReadOnlyGroup请求参数结构体 */ export interface AddDBInstanceToReadOnlyGroupRequest { /** * 实例ID */ DBInstanceId: string; /** * 只读组ID */ ReadOnlyGroupId: string; } /** * DescribeProductConfig请求参数结构体 */ export interface DescribeProductConfigRequest { /** * 可用区名称 */ Zone?: string; /** * 数据库引擎，支持： 1、postgresql（云数据库PostgreSQL）； 2、mssql_compatible（MSSQL兼容-云数据库PostgreSQL）；如不指定默认使用postgresql。 */ DBEngine?: string; } /** * RemoveDBInstanceFromReadOnlyGroup请求参数结构体 */ export interface RemoveDBInstanceFromReadOnlyGroupRequest { /** * 实例ID */ DBInstanceId: string; /** * 只读组ID */ ReadOnlyGroupId: string; } /** * InitDBInstances返回参数结构体 */ export interface InitDBInstancesResponse { /** * 实例ID集合。 */ DBInstanceIdSet?: Array<string>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDefaultParameters请求参数结构体 */ export interface DescribeDefaultParametersRequest { /** * 数据库版本，大版本号，例如11，12，13 */ DBMajorVersion: string; /** * 数据库引擎，例如：postgresql,mssql_compatible */ DBEngine: string; } /** * RenewInstance请求参数结构体 */ export interface RenewInstanceRequest { /** * 实例ID，形如postgres-6fego161 */ DBInstanceId: string; /** * 续费多少个月 */ Period: number; /** * 是否自动使用代金券,1是,0否，默认不使用 */ AutoVoucher?: number; /** * 代金券ID列表，目前仅支持指定一张代金券 */ VoucherIds?: Array<string>; } /** * DescribeBackupOverview请求参数结构体 */ export declare type DescribeBackupOverviewRequest = null; /** * DescribeRegions返回参数结构体 */ export interface DescribeRegionsResponse { /** * 返回的结果数量。 */ TotalCount: number; /** * 地域信息集合。 */ RegionSet: Array<RegionInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyBaseBackupExpireTime返回参数结构体 */ export interface ModifyBaseBackupExpireTimeResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpgradeDBInstanceMajorVersion返回参数结构体 */ export interface UpgradeDBInstanceMajorVersionResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyBackupDownloadRestriction请求参数结构体 */ export interface ModifyBackupDownloadRestrictionRequest { /** * 备份文件下载限制类型，NONE 无限制，内外网都可以下载；INTRANET 只允许内网下载；CUSTOMIZE 自定义限制下载的vpc或ip。 */ RestrictionType: string; /** * vpc限制效力，ALLOW 允许；DENY 拒绝。 */ VpcRestrictionEffect?: string; /** * 允许或拒绝下载备份文件的vpcId列表。 */ VpcIdSet?: Array<string>; /** * ip限制效力，ALLOW 允许；DENY 拒绝。 */ IpRestrictionEffect?: string; /** * 允许或拒绝下载备份文件的ip列表。 */ IpSet?: Array<string>; } /** * 描述实例的网络连接信息。 */ export 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 注意：此字段可能返回 null，表示取不到有效值。 */ VpcId: string; /** * 子网ID 注意：此字段可能返回 null，表示取不到有效值。 */ SubnetId: string; /** * 连接数据库的协议类型，当前支持：postgresql、mssql（MSSQL兼容语法）注意：此字段可能返回 null，表示取不到有效值。 */ ProtocolType: string; } /** * 备份下载限制信息 */ export interface BackupDownloadRestriction { /** * 备份文件下载限制类型，NONE 无限制，内外网都可以下载；INTRANET 只允许内网下载；CUSTOMIZE 自定义限制下载的vpc或ip。 */ RestrictionType?: string; /** * vpc限制效力，ALLOW 允许；DENY 拒绝。 */ VpcRestrictionEffect?: string; /** * 允许或拒绝下载备份文件的vpcId列表。 */ VpcIdSet?: Array<string>; /** * ip限制效力，ALLOW 允许；DENY 拒绝。 */ IpRestrictionEffect?: string; /** * 允许或拒绝下载备份文件的ip列表。 */ IpSet?: Array<string>; } /** * ModifyDBInstanceDeployment请求参数结构体 */ export interface ModifyDBInstanceDeploymentRequest { /** * 实例ID。 */ DBInstanceId: string; /** * 实例节点部署信息，支持多可用区部署时需要指定每个节点的部署可用区信息。可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。 */ DBNodeSet: Array<DBNode>; /** * 指定实例配置完成变更后的切换时间。 <li>0：立即切换 <li>1：指定时间切换 <li>2：维护时间窗口内切换默认值：0 */ SwitchTag: number; /** * 切换开始时间，时间格式：HH:MM:SS，例如：01:00:00。当SwitchTag为0或2时，该参数失效。 */ SwitchStartTime?: string; /** * 切换截止时间，时间格式：HH:MM:SS，例如：01:30:00。当SwitchTag为0或2时，该参数失效。 */ SwitchEndTime?: string; } /** * DeleteReadOnlyGroupNetworkAccess请求参数结构体 */ export interface DeleteReadOnlyGroupNetworkAccessRequest { /** * RO组ID，形如：pgro-4t9c6g7k。 */ ReadOnlyGroupId: string; /** * 私有网络统一 ID，若是基础网络则传"0"。 */ VpcId: string; /** * 子网ID，若是基础网络则传"0"。 */ SubnetId: string; /** * 目标VIP地址。 */ Vip: string; } /** * DescribeBackupDownloadRestriction请求参数结构体 */ export declare type DescribeBackupDownloadRestrictionRequest = null; /** * 描述可用区的编码和状态信息 */ export interface ZoneInfo { /** * 该可用区的英文名称 */ Zone: string; /** * 该可用区的中文名称 */ ZoneName: string; /** * 该可用区对应的数字编号 */ ZoneId: number; /** * 可用状态包含， UNAVAILABLE：不可用。 AVAILABLE：可用。 SELLOUT：售罄。 SUPPORTMODIFYONLY：支持变配。 */ ZoneState: string; /** * 该可用区是否支持Ipv6 */ ZoneSupportIpv6: number; /** * 该可用区对应的备可用区集合注意：此字段可能返回 null，表示取不到有效值。 */ StandbyZoneSet: Array<string>; } /** * DescribeReadOnlyGroups返回参数结构体 */ export interface DescribeReadOnlyGroupsResponse { /** * 只读组列表 */ ReadOnlyGroupList?: Array<ReadOnlyGroup>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 单条SlowQuery信息 */ export interface NormalQueryItem { /** * 用户名 */ UserName: string; /** * 调用次数 */ Calls: number; /** * 粒度点 */ CallsGrids: Array<number | bigint>; /** * 花费总时间 */ 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; } /** * 实例绑定的标签信息，包含标签键TagKey和标签值TagValue */ export interface Tag { /** * 标签键 */ TagKey: string; /** * 标签值 */ TagValue: string; } /** * DescribeBackupSummaries请求参数结构体 */ export 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?: Array<Filter>; /** * 排序字段，支持TotalBackupSize,LogBackupSize,ManualBaseBackupSize,AutoBaseBackupSize。 */ OrderBy?: string; /** * 排序方式，包括升序：asc，降序：desc。 */ OrderByType?: string; } /** * DescribeDBInstanceAttribute请求参数结构体 */ export interface DescribeDBInstanceAttributeRequest { /** * 实例ID */ DBInstanceId: string; } /** * CloseServerlessDBExtranetAccess请求参数结构体 */ export interface CloseServerlessDBExtranetAccessRequest { /** * 实例唯一标识符 */ DBInstanceId?: string; /** * 实例名称 */ DBInstanceName?: string; } /** * CreateBaseBackup返回参数结构体 */ export interface CreateBaseBackupResponse { /** * 基础备份集ID */ BaseBackupId?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CloneDBInstance返回参数结构体 */ export interface CloneDBInstanceResponse { /** * 订单号。注意：此字段可能返回 null，表示取不到有效值。 */ DealName?: string; /** * 订单流水号。注意：此字段可能返回 null，表示取不到有效值。 */ BillId?: string; /** * 克隆出的新实例ID，当前只支持后付费返回该值。注意：此字段可能返回 null，表示取不到有效值。 */ DBInstanceId?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDBInstanceReadOnlyGroup请求参数结构体 */ export interface ModifyDBInstanceReadOnlyGroupRequest { /** * 实例ID */ DBInstanceId: string; /** * 当前实例所在只读组ID */ ReadOnlyGroupId: string; /** * 实例修改的目标只读组ID */ NewReadOnlyGroupId: string; } /** * AddDBInstanceToReadOnlyGroup返回参数结构体 */ export interface AddDBInstanceToReadOnlyGroupResponse { /** * 流程ID */ FlowId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据库基础备份信息 */ export interface BaseBackup { /** * 实例ID。 */ DBInstanceId?: string; /** * 备份文件唯一标识。 */ Id?: string; /** * 备份文件名称。 */ Name?: string; /** * 备份方式：物理备份、逻辑备份。 */ BackupMethod?: string; /** * 备份模式：自动备份、手动备份。 */ BackupMode?: string; /** * 备份任务状态。 */ State?: string; /** * 备份集大小，单位bytes。 */ Size?: number; /** * 备份的开始时间。 */ StartTime?: string; /** * 备份的结束时间。 */ FinishTime?: string; /** * 备份的过期时间。 */ ExpireTime?: string; } /** * CreateReadOnlyDBInstance返回参数结构体 */ export interface CreateReadOnlyDBInstanceResponse { /** * 订单号列表。每个实例对应一个订单号 */ DealNames?: Array<string>; /** * 冻结流水号 */ BillId?: string; /** * 创建成功的实例ID集合，只在后付费情景下有返回值 */ DBInstanceIdSet?: Array<string>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAvailableRecoveryTime请求参数结构体 */ export interface DescribeAvailableRecoveryTimeRequest { /** * 实例ID */ DBInstanceId: string; } /** * 慢SQL耗时分段分析 */ export interface DurationAnalysis { /** * 慢SQL耗时，时段 */ TimeSegment: string; /** * 对应时段区间慢SQL 条数 */ Count: number; } /** * DescribeDBInstanceParameters请求参数结构体 */ export interface DescribeDBInstanceParametersRequest { /** * 实例ID */ DBInstanceId: string; /** * 查询指定参数详情。ParamName为空或不传，默认返回全部参数列表 */ ParamName?: string; } /** * DescribeOrders返回参数结构体 */ export interface DescribeOrdersResponse { /** * 订单数量 */ TotalCount?: number; /** * 订单数组 */ Deals?: Array<PgDeal>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBackupDownloadURL返回参数结构体 */ export interface DescribeBackupDownloadURLResponse { /** * 备份的下载地址。 */ BackupDownloadURL?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * OpenServerlessDBExtranetAccess返回参数结构体 */ export interface OpenServerlessDBExtranetAccessResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyParameterTemplate请求参数结构体 */ export interface ModifyParameterTemplateRequest { /** * 参数模板ID，用于唯一确认参数模板，不可修改 */ TemplateId: string; /** * 参数模板名称，长度为1～60个字符，仅支持数字,英文大小写字母、中文以及特殊字符_-./()（）[]+=：:@ 注：若该字段为空，则保持原参数模板名称 */ TemplateName?: string; /** * 参数模板描述，长度为0～60个字符，仅支持数字,英文大小写字母、中文以及特殊字符_-./()（）[]+=：:@ 注：若不传入该参数，则保持原参数模板描述 */ TemplateDescription?: string; /** * 需要修改或添加的参数集合，注：同一参数不能同时出现在修改添加集合和删除集合中 */ ModifyParamEntrySet?: Array<ParamEntry>; /** * 需要从模板中删除的参数集合，注：同一参数不能同时出现在修改添加集合和删除集合中 */ DeleteParamSet?: Array<string>; } /** * InquiryPriceCreateDBInstances返回参数结构体 */ export interface InquiryPriceCreateDBInstancesResponse { /** * 刊例价，单位：分 */ OriginalPrice?: number; /** * 折后实际付款金额，单位：分 */ Price?: number; /** * 币种。例如，CNY：人民币。 */ Currency?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据库版本号信息 */ export 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: Array<string>; /** * 数据库版本状态，包括： AVAILABLE：可用； DEPRECATED：已弃用。 */ Status: string; /** * 该数据库版本（DBKernelVersion）可以升级到的版本号列表。 */ AvailableUpgradeTarget: Array<string>; } /** * CreateDBInstanceNetworkAccess请求参数结构体 */ export interface CreateDBInstanceNetworkAccessRequest { /** * 实例ID，形如：postgres-6bwgamo3。 */ DBInstanceId: string; /** * 私有网络统一 ID。 */ VpcId: string; /** * 子网ID。 */ SubnetId: string; /** * 是否指定分配vip true-指定分配 false-自动分配。 */ IsAssignVip: boolean; /** * 目标VIP地址。 */ Vip?: string; } /** * ModifySwitchTimePeriod返回参数结构体 */ export interface ModifySwitchTimePeriodResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * InquiryPriceCreateDBInstances请求参数结构体 */ export interface InquiryPriceCreateDBInstancesRequest { /** * 可用区ID。该参数可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。 */ Zone: string; /** * 规格ID。该参数可以通过调用DescribeClasses接口的返回值中的SpecCode字段来获取。 */ SpecCode: string; /** * 存储容量大小，单位：GB。 */ Storage: number; /** * 实例数量。目前最大数量不超过100，如需一次性创建更多实例，请联系客服支持。 */ InstanceCount: number; /** * 购买时长，单位：月。目前只支持1,2,3,4,5,6,7,8,9,10,11,12,24,36这些值。 */ Period: number; /** * 【弃字段，不再生效】，计费ID。该参数可以通过调用DescribeProductConfig接口的返回值中的Pid字段来获取。 */ Pid?: number; /** * 实例计费类型。目前只支持：PREPAID（预付费，即包年包月）。 */ InstanceChargeType?: string; /** * 实例类型，默认primary，支持如下： primary（双机高可用（一主一从）） readonly（只读实例） */ InstanceType?: string; /** * DB引擎，默认postgresql，支持如下： postgresql（云数据库PostgreSQL） mssql_compatible（MSSQL兼容-云数据库PostgreSQL） */ DBEngine?: string; } /** * DescribeDefaultParameters返回参数结构体 */ export interface DescribeDefaultParametersResponse { /** * 参数个数 */ TotalCount: number; /** * 参数信息注意：此字段可能返回 null，表示取不到有效值。 */ ParamInfoSet: Array<ParamInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * serverless实例网络信息描述 */ export interface ServerlessDBInstanceNetInfo { /** * 地址注意：此字段可能返回 null，表示取不到有效值。 */ Address: string; /** * ip地址注意：此字段可能返回 null，表示取不到有效值。 */ Ip: string; /** * 端口号注意：此字段可能返回 null，表示取不到有效值。 */ Port: number; /** * 状态注意：此字段可能返回 null，表示取不到有效值。 */ Status: string; /** * 网络类型注意：此字段可能返回 null，表示取不到有效值。 */ NetType: string; } /** * DescribeBackupPlans返回参数结构体 */ export interface DescribeBackupPlansResponse { /** * 实例的备份计划集 */ Plans: Array<BackupPlan>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBInstances请求参数结构体 */ export interface DescribeDBInstancesRequest { /** * 按照一个或者多个过滤条件进行查询，目前支持的过滤条件有： db-instance-id：按照实例ID过滤，类型为string db-instance-name：按照实例名过滤，类型为string db-project-id：按照项目ID过滤，类型为integer db-pay-mode：按照付费模式过滤，类型为string db-tag-key：按照标签键过滤，类型为string */ Filters?: Array<Filter>; /** * 每页显示数量，取值范围为1-100，默认为返回10条。 */ Limit?: number; /** * 数据偏移量，从0开始。 */ Offset?: number; /** * 排序指标，如实例名、创建时间等，支持DBInstanceId,CreateTime,Name,EndTime */ OrderBy?: string; /** * 排序方式，包括升序：asc、降序：desc。 */ OrderByType?: string; } /** * 只读组信息 */ export interface ReadOnlyGroup { /** * 只读组标识注意：此字段可能返回 null，表示取不到有效值。 */ ReadOnlyGroupId: string; /** * 只读组名字注意：此字段可能返回 null，表示取不到有效值。 */ ReadOnlyGroupName: string; /** * 项目id 注意：此字段可能返回 null，表示取不到有效值。 */ ProjectId: number; /** * 主实例id 注意：此字段可能返回 null，表示取不到有效值。 */ MasterDBInstanceId: string; /** * 最小保留实例数注意：此字段可能返回 null，表示取不到有效值。 */ MinDelayEliminateReserve: number; /** * 延迟空间大小阈值 */ MaxReplayLatency: number; /** * 延迟大小开关 */ ReplayLatencyEliminate: number; /** * 延迟时间大小阈值 */ MaxReplayLag: number; /** * 延迟时间开关 */ ReplayLagEliminate: number; /** * 虚拟网络id */ VpcId: string; /** * 子网id 注意：此字段可能返回 null，表示取不到有效值。 */ SubnetId: string; /** * 地域id */ Region: string; /** * 地区id */ Zone: string; /** * 状态 */ Status: string; /** * 实例详细信息 */ ReadOnlyDBInstanceList: Array<DBInstance>; /** * 自动负载均衡开关 */ Rebalance: number; /** * 网络信息 */ DBInstanceNetInfo: Array<DBInstanceNetInfo>; /** * 只读组网络信息列表（此字段已废弃）注意：此字段可能返回 null，表示取不到有效值。 */ NetworkAccessList: Array<NetworkAccess>; } /** * ModifyDBInstanceSpec请求参数结构体 */ export interface ModifyDBInstanceSpecRequest { /** * 实例ID，形如：postgres-6bwgamo3。 */ DBInstanceId: string; /** * 修改后的实例内存大小，单位GiB。 */ Memory: number; /** * 修改后的实例磁盘大小，单位GiB。 */ Storage: number; /** * 是否自动使用代金券： <li>0：否 <li>1：是默认值：0 */ AutoVoucher?: number; /** * 代金券ID列表，目前仅支持指定一张代金券。 */ VoucherIds?: Array<string>; /** * 活动ID。 */ ActivityId?: number; /** * 指定实例配置完成变更后的切换时间。 <li>0：立即切换 <li>1：指定时间切换 <li>2：维护时间窗口内切换默认值：0 */ SwitchTag?: number; /** * 切换开始时间，时间格式：HH:MM:SS，例如：01:00:00。当SwitchTag为0或2时，该参数失效。 */ SwitchStartTime?: string; /** * 切换截止时间，时间格式：HH:MM:SS，例如：01:30:00。当SwitchTag为0或2时，该参数失效。 */ SwitchEndTime?: string; } /** * ModifyAccountRemark返回参数结构体 */ export interface ModifyAccountRemarkResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpgradeDBInstance请求参数结构体 */ export interface UpgradeDBInstanceRequest { /** * 升级后的实例内存大小，单位GB */ Memory: number; /** * 升级后的实例磁盘大小，单位GB */ Storage: number; /** * 实例ID，形如postgres-lnp6j617 */ DBInstanceId: string; /** * 是否自动使用代金券,1是,0否，默认不使用 */ AutoVoucher?: number; /** * 代金券ID列表，目前仅支持指定一张代金券 */ VoucherIds?: Array<string>; /** * 活动ID */ ActivityId?: number; /** * 指定实例配置完成变更后的切换时间，默认为立即切换，入参为 0 ：立即切换。1：指定时间切换。 */ SwitchTag?: number; /** * 切换开始时间 */ SwitchStartTime?: string; /** * 切换截止时间 */ SwitchEndTime?: string; } /** * DescribeZones请求参数结构体 */ export declare type DescribeZonesRequest = null; /** * 描述某个地域下某个可用区的可售卖规格详细信息。 */ export interface SpecInfo { /** * 地域英文编码，对应RegionSet的Region字段 */ Region: string; /** * 区域英文编码，对应ZoneSet的Zone字段 */ Zone: string; /** * 规格详细信息列表 */ SpecItemInfoList: Array<SpecItemInfo>; /** * 支持KMS的地域注意：此字段可能返回 null，表示取不到有效值。 */ SupportKMSRegions: Array<string>; } /** * ModifyBackupDownloadRestriction返回参数结构体 */ export interface ModifyBackupDownloadRestrictionResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述各版本下的参数信息 */ export interface ParamVersionRelation { /** * 参数名称注意：此字段可能返回 null，表示取不到有效值。 */ Name: string; /** * 参数信息所属内核版本注意：此字段可能返回 null，表示取不到有效值。 */ DBKernelVersion: string; /** * 参数在该版本该规格下的默认值注意：此字段可能返回 null，表示取不到有效值。 */ Value: string; /** * 参数值单位。参数没有单位时，该字段返回空注意：此字段可能返回 null，表示取不到有效值。 */ Unit: string; /** * 数值类型（integer、real）参数，取值上界注意：此字段可能返回 null，表示取不到有效值。 */ Max: number; /** * 数值类型（integer、real）参数，取值下界注意：此字段可能返回 null，表示取不到有效值。 */ Min: number; /** * 枚举类型参数，取值范围注意：此字段可能返回 null，表示取不到有效值。 */ EnumValue: Array<string>; } /** * DescribeLogBackups请求参数结构体 */ export interface DescribeLogBackupsRequest { /** * 备份的最小结束时间，形如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。 */ Filters?: Array<Filter>; /** * 每页显示数量，取值范围为1-100，默认为返回10条。 */ Limit?: number; /** * 数据偏移量，从0开始。 */ Offset?: number; /** * 排序字段，支持StartTime,FinishTime,Size。 */ OrderBy?: string; /** * 排序方式，包括升序：asc，降序：desc。 */ OrderByType?: string; } /** * SetAutoRenewFlag返回参数结构体 */ export interface SetAutoRenewFlagResponse { /** * 设置成功的实例个数 */ Count: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 网络相关信息。（该数据结构已废弃，网络相关信息使用DBInstanceNetInfo） */ export interface NetworkAccess { /** * 网络资源id，实例id或RO组id 注意：此字段可能返回 null，表示取不到有效值。 */ ResourceId: string; /** * 资源类型，1-实例 2-RO组注意：此字段可能返回 null，表示取不到有效值。 */ ResourceType: number; /** * 私有网络ID 注意：此字段可能返回 null，表示取不到有效值。 */ VpcId: string; /** * IPV4地址注意：此字段可能返回 null，表示取不到有效值。 */ Vip: string; /** * IPV6地址注意：此字段可能返回 null，表示取不到有效值。 */ Vip6: string; /** * 访问端口注意：此字段可能返回 null，表示取不到有效值。 */ Vport: number; /** * 子网ID 注意：此字段可能返回 null，表示取不到有效值。 */ SubnetId: string; /** * 网络状态，1-申请中，2-使用中，3-删除中，4-已删除注意：此字段可能返回 null，表示取不到有效值。 */ VpcStatus: number; } /** * ResetAccountPassword返回参数结构体 */ export interface ResetAccountPasswordResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RemoveDBInstanceFromReadOnlyGroup返回参数结构体 */ export interface RemoveDBInstanceFromReadOnlyGroupResponse { /** * 流程ID */ FlowId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDBInstancesProject返回参数结构体 */ export interface ModifyDBInstancesProjectResponse { /** * 转移项目成功的实例个数 */ Count?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeParameterTemplates返回参数结构体 */ export interface DescribeParameterTemplatesResponse { /** * 符合查询条件的参数模板总数 */ TotalCount: number; /** * 参数模板列表 */ ParameterTemplateSet: Array<ParameterTemplate>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述各规格下的参数信息 */ export interface ParamSpecRelation { /** * 参数名称注意：此字段可能返回 null，表示取不到有效值。 */ Name: string; /** * 参数信息所属规格注意：此字段可能返回 null，表示取不到有效值。 */ Memory: string; /** * 参数在该规格下的默认值注意：此字段可能返回 null，表示取不到有效值。 */ Value: string; /** * 参数值单位。参数没有单位时，该字段返回空注意：此字段可能返回 null，表示取不到有效值。 */ Unit: string; /** * 数值类型（integer、real）参数，取值上界注意：此字段可能返回 null，表示取不到有效值。 */ Max: number; /** * 数值类型（integer、real）参数，取值下界注意：此字段可能返回 null，表示取不到有效值。 */ Min: number; /** * 枚举类型参数，取值范围注意：此字段可能返回 null，表示取不到有效值。 */ EnumValue: Array<string>; } /** * SwitchDBInstancePrimary返回参数结构体 */ export interface SwitchDBInstancePrimaryResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDBInstanceHAConfig请求参数结构体 */ export interface ModifyDBInstanceHAConfigRequest { /** * 实例ID */ DBInstanceId: string; /** * 主从同步方式： <li>Semi-sync：半同步 <li>Async：异步 */ SyncMode: string; /** * 高可用备机最大延迟数据量。备节点延迟数据量小于等于该值，且备节点延迟时间小于等于MaxStandbyLag时，可以切换为主节点。 <li>单位：byte <li>参数范围：[1073741824, 322122547200] */ MaxStandbyLatency: number; /** * 高可用备机最大延迟时间。备节点延迟时间小于等于该值，且备节点延迟数据量小于等于MaxStandbyLatency时，可以切换为主节点。 <li>单位：s <li>参数范围：[5, 10] */ MaxStandbyLag: number; /** * 同步备机最大延迟数据量。备机延迟数据量小于等于该值，且该备机延迟时间小于等于MaxSyncStandbyLag时，则该备机采用同步复制；否则，采用异步复制。该参数值针对SyncMode设置为Semi-sync的实例有效。半同步实例禁止退化为异步复制时，不设置MaxSyncStandbyLatency、MaxSyncStandbyLag。半同步实例允许退化异步复制时，PostgreSQL 9版本的实例须设置MaxSyncStandbyLatency且不设置MaxSyncStandbyLag，PostgreSQL 10及以上版本的实例须设置MaxSyncStandbyLatency、MaxSyncStandbyLag。 */ MaxSyncStandbyLatency?: number; /** * 同步备机最大延迟时间。备机延迟时间小于等于该值，且该备机延迟数据量小于等于MaxSyncStandbyLatency时，则该备机采用同步复制；否则，采用异步复制。该参数值针对SyncMode设置为Semi-sync的实例有效。半同步实例禁止退化为异步复制时，不设置MaxSyncStandbyLatency、MaxSyncStandbyLag。半同步实例允许退化异步复制时，PostgreSQL 9版本的实例须设置MaxSyncStandbyLatency且不设置MaxSyncStandbyLag，PostgreSQL 10及以上版本的实例须设置MaxSyncStandbyLatency、MaxSyncStandbyLag， */ MaxSyncStandbyLag?: number; } /** * 订单详情 */ export interface PgDeal { /** * 订单名 */ DealName: string; /** * 所属用户 */ OwnerUin: string; /** * 订单涉及多少个实例 */ Count: number; /** * 付费模式。1-预付费；0-后付费 */ PayMode: number; /** * 异步任务流程ID */ FlowId: number; /** * 实例ID数组 */ DBInstanceIdSet: Array<string>; } /** * DeleteReadOnlyGroupNetworkAccess返回参数结构体 */ export interface DeleteReadOnlyGroupNetworkAccessResponse { /** * 流程ID。注意：此字段可能返回 null，表示取不到有效值。 */ FlowId: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBackupSummaries返回参数结构体 */ export interface DescribeBackupSummariesResponse { /** * 备份统计信息列表。 */ BackupSummarySet: Array<BackupSummary>; /** * 查询到的所有备份信息数量。 */ TotalCount: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBErrlogs请求参数结构体 */ export interface DescribeDBErrlogsRequest { /** * 实例ID。 */ DBInstanceId: string; /** * 查询起始时间，形如2018-01-01 00:00:00。日志保留时间默认为7天，起始时间不能超出保留时间范围。 */ StartTime: string; /** * 查询结束时间，形如2018-01-01 00:00:00。 */ EndTime: string; /** * 数据库名字。 */ DatabaseName?: string; /** * 搜索关键字。 */ SearchKeys?: Array<string>; /** * 每页显示数量，取值范围为1-100。默认值为50。 */ Limit?: number; /** * 数据偏移量，从0开始。默认值为0。 */ Offset?: number; } /** * 数据库备份信息 */ export 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: Array<string>; /** * 内网下载地址 */ InternalAddr: string; /** * 外网下载地址 */ ExternalAddr: string; /** * 备份集ID 注意：此字段可能返回 null，表示取不到有效值。 */ SetId: string; } /** * serverless账号描述 */ export interface ServerlessDBAccount { /** * 用户名注意：此字段可能返回 null，表示取不到有效值。 */ DBUser: string; /** * 密码注意：此字段可能返回 null，表示取不到有效值。 */ DBPassword: string; /** * 连接数限制注意：此字段可能返回 null，表示取不到有效值。 */ DBConnLimit: number; } /** * CloneDBInstance请求参数结构体 */ export interface CloneDBInstanceRequest { /** * 克隆的源实例ID。 */ DBInstanceId: string; /** * 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。 */ SpecCode: string; /** * 实例容量大小，单位：GB。 */ Storage: number; /** * 购买时长，单位：月。 <li>预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36 <li>后付费：只支持1 */ Period: number; /** * 续费标记： <li>0：手动续费 <li>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; /** * 实例计费类型，目前支持： <li>PREPAID：预付费，即包年包月 <li>POSTPAID_BY_HOUR：后付费，即按量计费默认值：PREPAID */ InstanceChargeType?: string; /** * 实例所属安全组，该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。 */ SecurityGroupIds?: Array<string>; /** * 项目ID。 */ ProjectId?: number; /** * 实例需要绑定的Tag信息，默认为空；可以通过调用 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 返回值中的 Tags 字段来获取。 */ TagList?: Array<Tag>; /** * 实例节点部署信息，支持多可用区部署时需要指定每个节点的部署可用区信息。可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。 */ DBNodeSet?: Array<DBNode>; /** * 是否自动使用代金券： <li>0：否 <li>1：是默认值：0 */ AutoVoucher?: number; /** * 代金券ID列表。 */ VoucherIds?: string; /** * 活动ID。 */ ActivityId?: number; /** * 基础备份集ID。 */ BackupSetId?: string; /** * 恢复时间点。 */ RecoveryTargetTime?: string; /** * 主从同步方式，支持： <li>Semi-sync：半同步 <li>Async：异步主实例默认值：Semi-sync 只读实例默认值：Async */ SyncMode?: string; } /** * DeleteParameterTemplate请求参数结构体 */ export interface DeleteParameterTemplateRequest { /** * 参数模板ID，用于唯一确认待操作的参数模板 */ TemplateId: string; } /** * DescribeClasses请求参数结构体 */ export interface DescribeClassesRequest { /** * 可用区ID。可以通过接口DescribeZones获取。 */ Zone: string; /** * 数据库引擎，支持： 1、postgresql（云数据库PostgreSQL）； 2、mssql_compatible（MSSQL兼容-云数据库PostgreSQL）； */ DBEngine: string; /** * 数据库主版本号。例如12，13，可以通过接口DescribeDBVersions获取。 */ DBMajorVersion: string; } /** * DescribeParamsEvent请求参数结构体 */ export interface DescribeParamsEventRequest { /** * 实例DB ID */ DBInstanceId: string; } /** * 参数修改事件信息 */ export interface EventInfo { /** * 参数名注意：此字段可能返回 null，表示取不到有效值。 */ ParamName: string; /** * 原参数值注意：此字段可能返回 null，表示取不到有效值。 */ OldValue: string; /** * 本次修改期望参数值注意：此字段可能返回 null，表示取不到有效值。 */ NewValue: string; /** * 后台参数修改开始时间注意：此字段可能返回 null，表示取不到有效值。 */ ModifyTime: string; /** * 后台参数生效开始时间注意：此字段可能返回 null，表示取不到有效值。 */ EffectiveTime: string; /** * 修改状态注意：此字段可能返回 null，表示取不到有效值。 */ State: string; /** * 操作者（一般为用户sub UIN）注意：此字段可能返回 null，表示取不到有效值。 */ Operator: string; /** * 时间日志。注意：此字段可能返回 null，表示取不到有效值。 */ EventLog: string; } /** * CreateInstances返回参数结构体 */ export interface CreateInstancesResponse { /** * 订单号列表。每个实例对应一个订单号。 */ DealNames?: Array<string>; /** * 冻结流水号。 */ BillId?: string; /** * 创建成功的实例ID集合，只在后付费情景下有返回值。 */ DBInstanceIdSet?: Array<string>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 慢查询分析接口返回的分析详情，按照参数抽象之后进行分类 */ export 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: