tencentcloud-sdk-nodejs

/** * 任务的详情信息 */ export interface TaskDetail { /** * 当前执行的子任务步骤名称。 */ CurrentStep?: string; /** * 当前任务所拥有的子步骤描述。 */ AllSteps?: string; /** * 任务的输入参数。 */ Input?: string; /** * 任务的输出参数。 */ Output?: string; /** * 指定实例配置完成变更后的切换时间，默认值：0 0: 此任务不需要切换 1：立即切换 2：指定时间切换 3：维护时间窗口内切换。 */ SwitchTag?: number; /** * 指定的切换时间。 */ SwitchTime?: string; /** * 任务的提示信息。 */ Message?: string; } /** * SetAutoRenewFlag请求参数结构体 */ export interface SetAutoRenewFlagRequest { /** * 实例ID集合。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。仅支持预付费（包年包月）的实例。支持同时操作多个实例。 */ DBInstanceIdSet: Array<string>; /** * 续费标记。0-正常续费；1-自动续费；2-到期不续费 */ AutoRenewFlag: number; } /** * DeleteBackupPlan返回参数结构体 */ export interface DeleteBackupPlanResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAccountPrivileges返回参数结构体 */ export interface DescribeAccountPrivilegesResponse { /** * 用户拥有数据库user_database的CREATE、CONNECT、TEMPORARY权限 */ PrivilegeSet?: Array<DatabasePrivilege>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDatabases请求参数结构体 */ export interface DescribeDatabasesRequest { /** * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/product/409/16773)接口获取 */ DBInstanceId: string; /** * 按照一个或者多个过滤条件进行查询，目前支持的过滤条件有：database-name：按照数据库名称过滤，类型为string。此处使用模糊匹配搜索符合条件的数据库。 */ Filters?: Array<Filter>; /** * 数据偏移量，从0开始。 */ Offset?: number; /** * 单次显示数量。建议最大取值100。默认值：20 */ Limit?: number; } /** * 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; } /** * DescribeAuditLogs请求参数结构体 */ export interface DescribeAuditLogsRequest { /** * 实例ID */ InstanceId: string; /** * 开始时间参数格式：2026-03-25 00:00:00 */ StartTime: string; /** * 结束时间参数格式：2026-03-25 01:00:00 */ EndTime: string; /** * 查询限制取值范围：[1, 100] */ Limit: number; /** * 产品名称参数格式：postgres */ Product: string; /** * 位移量取值范围：[0, 10000] */ Offset?: number; /** * 排序方法入参限制：Timestamp,AffectRows,ExecTime */ Order?: string; /** * 排序字段入参限制：ASC,DESC */ OrderBy?: string; /** * 过滤条件 */ Filter?: AuditLogFilter; } /** * DescribeMaintainTimeWindow请求参数结构体 */ export interface DescribeMaintainTimeWindowRequest { /** * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; } /** * DescribeAccounts请求参数结构体 */ export interface DescribeAccountsRequest { /** * 实例ID，形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** * 分页返回，每页最大返回数目，默认20，取值范围为1-100 */ Limit?: number; /** * 数据偏移量，从0开始。 */ Offset?: number; /** * 返回数据按照创建时间或者用户名排序。取值支持createTime、name、updateTime。createTime-按照创建时间排序；name-按照用户名排序; updateTime-按照更新时间排序。默认值：createTime */ OrderBy?: string; /** * 返回结果是升序还是降序。取值只能为desc或者asc。desc-降序；asc-升序默认值：desc */ OrderByType?: string; } /** * DeleteReadOnlyGroup返回参数结构体 */ export interface DeleteReadOnlyGroupResponse { /** * 流程ID */ FlowId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * OpenDBExtranetAccess请求参数结构体 */ export interface OpenDBExtranetAccessRequest { /** * 实例ID，形如postgres-hez4fh0v。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。 */ DBInstanceId: string; /** * 是否开通Ipv6外网，1：是，0：否默认值：0 */ IsIpv6?: number; } /** * CreateInstances请求参数结构体 */ export interface CreateInstancesRequest { /** * 售卖规格码。该参数可以通过调用<a href="https://cloud.tencent.com/document/api/409/89019">DescribeClasses</a>的返回值中的SpecCode字段来获取。 */ SpecCode: string; /** * 实例磁盘容量大小，单位：GB。该参数的设置步长为10。 */ Storage: number; /** * 购买实例数量，取值范围：[1-10]。一次性购买支持最大数量10个，若超过该数量，可进行多次调用进行购买。 */ InstanceCount: number; /** * 购买时长，单位：月。<li>预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36</li><li>后付费：只支持1</li> */ Period: number; /** * 实例字符集，目前只支持：<li> UTF8</li><li> LATIN1</li> */ Charset: string; /** * 实例根账号用户名，具体规范如下：<li>用户名需要1-16个字符，只能由字母、数字或下划线组成</li><li>不能为postgres</li><li>不能由数字和pg_开头</li><li>所有规则均不区分大小写</li> */ AdminName: string; /** * 实例根账号用户名对应的密码，长度8 ~ 32位，推荐使用12位以上的密码;不能以" / "开头; 必须包含以下四项，字符种类:<li>小写字母： [a ~ z]</li><li>大写字母：[A ～ Z]</li><li>数字：0 - 9</li><li>特殊字符：()`~!@#$%^&*-+=_|{}[]:;'<>,.?/</li> */ AdminPassword: string; /** * 实例所属主可用区，如：ap-guangzhou-3；若需要支持多可用区，在DBNodeSet.N字段中进行添加主可用区和备可用区信息； 可用区信息可以通过调用 <a href="https://cloud.tencent.com/document/api/409/16769">DescribeZones</a> 接口的返回值中的Zone字段来获取。 */ Zone: string; /** * PostgreSQL大版本号（该参数当前必传），版本信息可从<a href="https://cloud.tencent.com/document/api/409/89018">DescribeDBVersions</a>获取。目前支持10，11，12，13，14，15这几个大版本，详情见<a href="https://cloud.tencent.com/document/product/409/67018">内核版本概述</a>。 输入该参数时，会基于此大版本号创建对应的最新小版本的最新内核版本号实例。 */ DBMajorVersion?: string; /** * PostgreSQL社区大版本+小版本号。 一般场景不推荐传入该参数。如需指定，只能传当前大版本号下最新小版本号。 */ DBVersion?: string; /** * PostgreSQL内核版本号。 一般场景不推荐传入该参数。如需指定，只能传当前大版本号下最新内核版本号。 */ DBKernelVersion?: string; /** * 实例计费类型，目前支持：<li>PREPAID：预付费，即包年包月</li><li>POSTPAID_BY_HOUR：后付费，即按量计费</li>默认值：PREPAID */ InstanceChargeType?: string; /** * 私有网络ID，形如vpc-xxxxxxxx（该参数当前必传）。有效的VpcId可通过登录控制台查询；也可以调用接口 <a href="https://cloud.tencent.com/document/api/215/1372">DescribeVpcEx</a> ，从接口返回中的unVpcId字段获取。 */ VpcId?: string; /** * 私有网络子网ID，形如subnet-xxxxxxxx（该参数当前必传）。有效的私有网络子网ID可通过登录控制台查询；也可以调用接口 <a href="https://cloud.tencent.com/document/api/215/15784">DescribeSubnets </a>，从接口返回中的unSubnetId字段获取。 */ SubnetId?: string; /** * 实例节点部署信息，支持多可用区部署时需要指定每个节点的部署可用区信息。 可用区信息可以通过调用 <a href="https://cloud.tencent.com/document/api/409/16769">DescribeZones</a> 接口的返回值中的Zone字段来获取。 */ DBNodeSet?: Array<DBNode>; /** * 续费标记：<li>0：手动续费</li><li>1：自动续费</li>默认值：0 */ AutoRenewFlag?: number; /** * 是否自动使用代金券：<li>0：否</li><li>1：是</li>默认值：0 */ AutoVoucher?: number; /** * 代金券ID列表，目前仅支持指定一张代金券。 */ VoucherIds?: Array<string>; /** * 项目ID。默认取之为0，表示归属默认项目。 */ ProjectId?: number; /** * 活动ID。 */ ActivityId?: number; /** * 实例名称，仅支持长度小于60的中文/英文/数字/"_"/"-"，不指定实例名称则默认显示"未命名"。 */ Name?: string; /** * 实例需要绑定的Tag信息，默认为空；可以通过调用 <a href="https://cloud.tencent.com/document/api/651/35316">DescribeTags</a> 返回值中的 Tags 字段来获取。 */ TagList?: Array<Tag>; /** * 实例所属安全组，该参数可以通过调用 <a href="https://cloud.tencent.com/document/api/215/15808">DescribeSecurityGroups</a> 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。 */ SecurityGroupIds?: Array<string>; /** * 是否需要支持数据透明加密：<li>0：否</li><li>1：是</li>默认值：0参考[数据透明加密概述](https://cloud.tencent.com/document/product/409/71748) */ NeedSupportTDE?: number; /** * 自定义密钥的KeyId，若选择自定义密匙加密，则需要传入自定义密匙的KeyId，KeyId是CMK的唯一标识。 KeyId创建获取相关参考<a href="https://cloud.tencent.com/document/product/409/71749">开启透明数据加密</a> */ KMSKeyId?: string; /** * 使用KMS服务的地域，KMSRegion为空默认使用本地域的KMS，本地域不支持的情况下需自选其他KMS支持的地域。 KMSRegion相关介绍参考<a href="https://cloud.tencent.com/document/product/409/71749">开启透明数据加密</a> */ KMSRegion?: string; /** * 指定KMS服务的集群，KMSClusterId为空使用默认集群的KMS，若选择指定KMS集群，则需要传入KMSClusterId。 KMSClusterId相关介绍参考开启透明数据加密 */ KMSClusterId?: string; /** * 数据库引擎，支持：<li>postgresql：云数据库PostgreSQL</li><li>mssql_compatible：MSSQL兼容-云数据库PostgreSQL</li>默认值：postgresql */ DBEngine?: string; /** * 数据库引擎的配置信息，配置格式如下： {"$key1":"$value1", "$key2":"$value2"} 各引擎支持如下： mssql_compatible引擎：<li>migrationMode：数据库模式，可选参数，可取值：single-db（单数据库模式），multi-db（多数据库模式）。默认为single-db。</li><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><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"。</li> */ DBEngineConfig?: string; /** * 主从同步方式，支持： <li>Semi-sync：半同步</li><li>Async：异步</li>主实例默认值：Semi-sync只读实例默认值：Async */ SyncMode?: string; /** * 是否需要支持Ipv6：<li>0：否</li><li>1：是</li>默认值：0 */ NeedSupportIpv6?: number; /** * 实例是否开启删除保护: true-开启删除保护；false-关闭删除保护。 */ DeletionProtection?: boolean; /** * 实例存储类型，可选值：PHYSICAL_LOCAL_SSD：物理机本地ssd硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_SSD：ssd云硬盘 CLOUD_HSSD：增强型ssd云硬盘 */ StorageType?: string; } /** * 描述一种规格的信息 */ 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的主要版本编号 */ MajorVersion?: string; /** * PostgreSQL的内核版本编号 */ KernelVersion?: string; /** * 是否支持TDE数据加密功能，0-不支持，1-支持 */ IsSupportTDE?: number; } /** * ModifyDBInstanceSSLConfig请求参数结构体 */ export interface ModifyDBInstanceSSLConfigRequest { /** * 实例 ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** * 开启或关闭SSL。true - 开启；false - 关闭。 */ SSLEnabled: boolean; /** * SSL证书保护的唯一连接地址，若为主实例，可设置为内外网IP地址；若为只读实例，可设置为实例IP或只读组IP。在开启SSL或修改SSL保护的连接地址时，该参数为必传项；在关闭SSL时，该参数将被忽略。 */ ConnectAddress?: string; } /** * 参数模板的基本信息 */ export interface ParameterTemplate { /** * 参数模板ID */ TemplateId?: string; /** * 参数模板名称 */ TemplateName?: string; /** * 参数模板适用的数据库版本 */ DBMajorVersion?: string; /** * 参数模板适用的数据库引擎 */ DBEngine?: string; /** * 参数模板描述 */ TemplateDescription?: string; } /** * CreateDBInstanceNetworkAccess返回参数结构体 */ export interface CreateDBInstanceNetworkAccessResponse { /** * 流程ID，FlowId等同于TaskId */ FlowId?: number; /** * 任务ID */ TaskId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAvailableRecoveryTime返回参数结构体 */ export interface DescribeAvailableRecoveryTimeResponse { /** * 可恢复的最早时间，时区为东八区（UTC+8）。 */ RecoveryBeginTime?: string; /** * 可恢复的最晚时间，时区为东八区（UTC+8）。 */ RecoveryEndTime?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateBaseBackup请求参数结构体 */ export interface CreateBaseBackupRequest { /** * 实例ID。可通过<a href="https://cloud.tencent.com/document/api/409/16773">DescribeDBInstances</a>接口获取 */ DBInstanceId: string; /** * 备份方式枚举值：<ul><li>physical：物理备份</li><li>logical：逻辑备份</li><li>snapshot：快照备份</li></ul> */ BackupMethod?: string; } /** * ModifyDBInstanceReadOnlyGroup返回参数结构体 */ export interface ModifyDBInstanceReadOnlyGroupResponse { /** * 流程ID，FlowId等同于TaskId */ FlowId?: number; /** * 任务ID */ TaskId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据库实例规格 */ export interface ClassInfo { /** * 规格ID */ SpecCode?: string; /** * CPU核数 */ CPU?: number; /** * 内存大小，单位：MB */ Memory?: number; /** * 该规格所支持最大存储容量，单位：GB */ MaxStorage?: number; /** * 该规格所支持最小存储容量，单位：GB */ MinStorage?: number; /** * 该规格的预估QPS */ QPS?: number; } /** * SwitchDBInstancePrimary请求参数结构体 */ export interface SwitchDBInstancePrimaryRequest { /** * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** * 是否强制切换。强制切换时只要备节点可访问，无论主备延迟多大都会发起切换。只有SwitchTag为0时，才可使用立即切换。 <li>默认：false</li> */ Force?: boolean; /** * 指定实例配置完成变更后的切换时间。 <li>0：立即切换 </li> <li>1：指定时间切换</li> <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; } /** * DescribeCloneDBInstanceSpec请求参数结构体 */ export interface DescribeCloneDBInstanceSpecRequest { /** * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** * 基础备份集ID，可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取。此入参和RecoveryTargetTime必须选择一个传入。如与RecoveryTargetTime参数同时设置，则以此参数为准。 */ BackupSetId?: string; /** * 恢复目标时间，此入参和BackupSetId必须选择一个传入。时区以东八区（UTC+8）为准。 */ RecoveryTargetTime?: string; } /** * DescribeDBInstanceSecurityGroups返回参数结构体 */ export interface DescribeDBInstanceSecurityGroupsResponse { /** * 安全组信息数组 */ SecurityGroupSet?: Array<SecurityGroup>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 备份计划 */ export interface BackupPlan { /** * 备份周期 */ BackupPeriod?: string; /** * 数据备份保留时长。单位：天 */ BaseBackupRetentionPeriod?: number; /** * 开始备份的最早时间 */ MinBackupStartTime?: string; /** * 开始备份的最晚时间 */ MaxBackupStartTime?: string; /** * 备份类型枚举值：<ul><li>physical：物理备份</li><li>logical：逻辑备份</li><li>snapshot：快照备份</li></ul> */ BackupMethod?: string; /** * 备份计划ID */ PlanId?: string; /** * 备份计划自定义名称。 */ PlanName?: string; /** * 日志备份保留时长。单位：天 */ LogBackupRetentionPeriod?: number; /** * 创建时间。 */ CreatedTime?: string; /** * 最近一次的修改时间。 */ UpdatedTime?: string; /** * 备份计划类型。系统默认创建的为default，自定义的为custom。 */ PlanType?: string; /** * 备份周期类型。当前支持week、month。 */ BackupPeriodType?: string; } /** * RestoreDBInstanceObjects返回参数结构体 */ export interface RestoreDBInstanceObjectsResponse { /** * 任务ID */ TaskId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Proxy 节点信息。 */ export interface ProxyNode { /** * Proxy 节点 ID */ ProxyNodeId?: string; /** * Proxy 节点所在可用区 */ Zone?: string; /** * 节点 CPU 核数（核） */ Cpu?: number; /** * 节点内存大小（MB）单位：MB */ Mem?: number; /** * 节点状态：running/isolated/abnormal 等 */ Status?: string; /** * 节点当前连接数 */ Connection?: number; } /** * ModifyDBInstanceDeletionProtection请求参数结构体 */ export interface ModifyDBInstanceDeletionProtectionRequest { /** * 实例 ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** * 开启或关闭实例删除保护。true - 开启；false - 关闭。 */ DeletionProtection: boolean; } /** * Proxy 节点自定义规格信息，每个 Zone 对应一组节点配置。 */ export interface ProxyNodeCustom { /** * 该可用区下的 Proxy 节点数量取值范围：[1, 16] */ NodeCount: number; /** * Proxy 节点所在可用区 */ Zone: string; /** * Proxy 节点 CPU 核数（核） */ Cpu: number; /** * Proxy 节点内存大小（MB）单位：MB */ Mem: number; } /** * Proxy 路由信息，描述某个 Proxy 接入地址下到具体 PG 节点的路由规则。 */ export interface ProxyRoute { /** * 路由指向的 PG 节点 ID（实例或只读节点 ID） */ NodeId?: string; /** * 节点角色：master/slave/readonly */ Role?: string; /** * 路由权重，取值范围 [0, 100] */ Weight?: number; /** * 路由状态：available/unavailable */ Status?: string; } /** * DeleteLogBackup返回参数结构体 */ export interface DeleteLogBackupResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyReadOnlyGroupConfig请求参数结构体 */ export interface ModifyReadOnlyGroupConfigRequest { /** * 只读组ID。 */ ReadOnlyGroupId: string; /** * 只读组名称。仅支持长度小于60的中文/英文/数字/"_"/"-" */ ReadOnlyGroupName?: string; /** * 延迟时间配置开关：0关、1开 */ ReplayLagEliminate?: number; /** * 延迟日志大小配置开关：0关、1开 */ ReplayLatencyEliminate?: number; /** * 延迟日志大小阈值，单位MB。当开启延迟日志大小配置，应输入正整数 */ MaxReplayLatency?: number; /** * 延迟时间大小阈值，单位s。当开启延迟时间配置时，应输入正整数。 */ MaxReplayLag?: number; /** * 自动负载均衡开关：0关、1开 */ Rebalance?: number; /** * 延迟剔除最小保留实例数。取值范围[0,100] */ 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。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** * 只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取 */ ReadOnlyGroupId: string; } /** * DescribeProductConfig请求参数结构体 */ export interface DescribeProductConfigRequest { /** * 可用区名称 */ Zone?: string; /** * 数据库引擎，支持： 1、postgresql（云数据库PostgreSQL）； 2、mssql_compatible（MSSQL兼容-云数据库PostgreSQL）； 如不指定默认使用postgresql。 */ DBEngine?: string; /** * 实例存储类型，根据存储类型返回支持的版本和规格枚举值：<ul><li>PHYSICAL_LOCAL_SSD：物理机本地ssd硬盘</li><li>CLOUD_PREMIUM：高性能云硬盘</li><li>CLOUD_SSD： ssd云硬盘</li><li>CLOUD_HSSD：增强型ssd云硬盘</li></ul>默认值：PHYSICAL_LOCAL_SSD */ StorageType?: string; } /** * RemoveDBInstanceFromReadOnlyGroup请求参数结构体 */ export interface RemoveDBInstanceFromReadOnlyGroupRequest { /** * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** * 只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取 */ ReadOnlyGroupId: string; } /** * CreateAccount请求参数结构体 */ export interface CreateAccountRequest { /** * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** * 创建的账号名称。由字母（a-z, A-Z）、数字（0-9）、下划线（_）组成，以字母或（_）开头，最多63个字符。不能使用系统保留关键字，不能为postgres，且不能由pg_或tencentdb_开头 */ UserName: string; /** * 账号类型。当前支持normal、tencentDBSuper两个输入。normal指代普通用户，tencentDBSuper为拥有pg_tencentdb_superuser角色的账号。 */ Type: string; /** * 账号对应的密码。密码规则如下： <li>长度8 ~ 32位，推荐使用12位以上的密码</li> <li>不能以" / "开头</li> <li>必须包含以下四项:</li> 小写字母 a ~ z 大写字母 A ～ Z 数字 0 ～ 9 特殊字符 ()`~!@#$%^&*-+=_|{}[]:<>,.?/ */ Password?: string; /** * 账号备注。只允许英文字母、数字、下划线、中划线，以及全体汉字，限60个字符 */ Remark?: string; /** * 账号是否开启CAM验证 */ OpenCam?: boolean; } /** * DescribeTasks返回参数结构体 */ export interface DescribeTasksResponse { /** * 查询到的任务数量 */ TotalCount?: number; /** * 任务信息列表 */ TaskSet?: Array<TaskSet>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeMaintainTimeWindow返回参数结构体 */ export interface DescribeMaintainTimeWindowResponse { /** * 实例ID */ DBInstanceId?: string; /** * 维护开始时间。时区为东八区（UTC+8） */ MaintainStartTime?: string; /** * 维护持续时间。单位：小时 */ MaintainDuration?: number; /** * 维护周期 */ MaintainWeekDays?: Array<string>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 审计日志过滤条件 */ export interface AuditLogFilter { /** * 影响函数 */ AffectRows?: number; /** * 数据库名字 */ DBName?: Array<string>; /** * 执行时间 */ ExecTime?: number; /** * 主机Host */ Host?: Array<string>; /** * sql语句 */ Sql?: string; /** * 登录名 */ User?: Array<string>; /** * 审计类型 */ SqlType?: Array<string>; } /** * DescribeDedicatedClusters返回参数结构体 */ export interface DescribeDedicatedClustersResponse { /** * 专属集群信息 */ DedicatedClusterSet?: Array<DedicatedCluster>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RenewInstance请求参数结构体 */ export interface RenewInstanceRequest { /** * 实例ID，形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。仅支持预付费（包年包月）实例。 */ DBInstanceId: string; /** * 购买时长，单位：月。 <li>预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36</li> */ Period: number; /** * 是否自动使用代金券： <li>0：否</li> <li>1：是</li> 默认值：0 */ AutoVoucher?: number; /** * 代金券ID列表，目前仅支持指定一张代金券 */ VoucherIds?: Array<string>; } /** * DescribeBackupOverview请求参数结构体 */ export type DescribeBackupOverviewRequest = null; /** * DescribeRegions返回参数结构体 */ export interface DescribeRegionsResponse { /** * 返回的结果数量。 */ TotalCount?: number; /** * 地域信息集合。 */ RegionSet?: Array<RegionInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAuditInstanceList返回参数结构体 */ export interface DescribeAuditInstanceListResponse { /** * 实例数量 注意：此字段可能返回 null，表示取不到有效值。 */ TotalCount?: number; /** * 实例日志信息 注意：此字段可能返回 null，表示取不到有效值。 */ Items?: Array<AuditInstanceInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpgradeDBInstanceMajorVersion返回参数结构体 */ export interface UpgradeDBInstanceMajorVersionResponse { /** * 任务ID */ TaskId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyBackupDownloadRestriction请求参数结构体 */ export interface ModifyBackupDownloadRestrictionRequest { /** * 备份文件下载限制类型，NONE 无限制，内外网都可以下载；INTRANET 只允许内网下载；CUSTOMIZE 自定义限制下载的vpc或ip。当该参数取值为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 */ VpcId?: string; /** * 子网ID */ SubnetId?: string; /** * 连接数据库的协议类型，当前支持：postgresql、mssql（MSSQL兼容语法） */ ProtocolType?: string; } /** * 备份下载限制信息 */ export interface BackupDownloadRestriction { /** * 备份文件下载限制类型，NONE 无限制，内外网都可以下载；INTRANET 只允许内网下载；CUSTOMIZE 自定义限制下载的vpc或ip。当该参数取值为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。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** * 实例节点部署信息，支持多可用区部署时需要指定每个节点的部署可用区信息。可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。 */ DBNodeSet: Array<DBNode>; /** * 指定实例配置完成变更后的切换时间。 <li>0：立即切换 </li> <li>1：指定时间切换</li> <li>2：维护时间窗口内切换</li> */ 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，形如：pgrogrp-4t9c6g7k。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取 */ ReadOnlyGroupId: string; /** * 私有网络统一 ID，若是基础网络则传"0"。 */ VpcId: string; /** * 子网ID，若是基础网络则传"0"。 */ SubnetId: string; /** * 目标VIP地址。 */ Vip: string; } /** * 安全组规则信息 */ export interface PolicyRule { /** * 策略，ACCEPT 或者 DROP */ Action?: string; /** * 来源或目的 IP 或 IP 段，例如172.16.0.0/12 */ CidrIp?: string; /** * 端口 */ PortRange?: string; /** * 网络协议，支持 UDP、TCP 等 */ IpProtocol?: string; /** * 规则描述 */ Description?: string; } /** * DescribeBackupPlans请求参数结构体 */ export interface DescribeBackupPlansRequest { /** * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; } /** * 描述可用区的编码和状态信息 */ export interface ZoneInfo { /** * 该可用区的英文名称 */ Zone?: string; /** * 该可用区的中文名称 */ ZoneName?: string; /** * 该可用区对应的数字编号 */ ZoneId?: number; /** * 可用状态包含， UNAVAILABLE：不可用。 AVAILABLE：可用。 SELLOUT：售罄。 SUPPORTMODIFYONLY：支持变配。 */ ZoneState?: string; /** * 该可用区是否支持Ipv6 */ ZoneSupportIpv6?: number; /** * 该可用区对应的备可用区集合注意：此字段可能返回 null，表示取不到有效值。 */ StandbyZoneSet?: Array<string>; } /** * Proxy 接入地址信息，包含 VIP/VPort、读写分离与连接池相关配置以及对应路由列表。 */ export interface ProxyAddress { /** * Proxy 接入地址 ID */ AddressId?: string; /** * Proxy 接入地址 IP */ Vip?: string; /** * Proxy 接入地址端口 */ Vport?: number; /** * VPC ID */ VpcId?: string; /** * 子网 ID */ SubnetId?: string; /** * 接入地址描述 */ Description?: string; /** * 是否开启连接池：0-未开启，1-开启 */ ConnectionPool?: boolean; /** * 路由列表 */ Routes?: Array<ProxyRoute>; /** * 连接池大小 */ ConnectionPoolLimit?: number; } /** * OpenDBExtranetAccess返回参数结构体 */ export interface OpenDBExtranetAccessResponse { /** * 流程ID，FlowId等同于TaskId */ FlowId?: number; /** * 任务ID */ TaskId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateDatabase请求参数结构体 */ export 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; } /** * 实例绑定的标签信息，包含标签键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。默认值：asc。 */ OrderByType?: string; } /** * CreateBackupPlan请求参数结构体 */ export interface CreateBackupPlanRequest { /** * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** * 备份计划名称。 */ PlanName: string; /** * 创建的备份计划类型，当前仅支持month创建。 */ BackupPeriodType: string; /** * 备份的日期，示例是每个月的2号开启备份。 */ BackupPeriod: Array<string>; /** * 备份开始时间，不传跟随默认备份计划。 */ MinBackupStartTime?: string; /** * 备份结束时间，不传跟随默认计划。 */ MaxBackupStartTime?: string; /** * 数据备份保留时长，单位：天。取值范围为：[0,30000) BackupPeriodType为week时默认是7,为month时默认为31。 */ BaseBackupRetentionPeriod?: number; } /** * ModifyDBInstancesProject返回参数结构体 */ export interface ModifyDBInstancesProjectResponse { /** * 转移项目成功的实例个数 */ Count?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateBaseBackup返回参数结构体 */ export interface CreateBaseBackupResponse { /** * 数据备份集ID */ BaseBackupId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * LockAccount返回参数结构体 */ export interface LockAccountResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CloneDBInstance返回参数结构体 */ export interface CloneDBInstanceResponse { /** * 订单号。 */ DealName?: string; /** * 订单流水号。 */ BillId?: string; /** * 克隆出的新实例ID，当前只支持后付费返回该值。 */ DBInstanceId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDBInstanceReadOnlyGroup请求参数结构体 */ export interface ModifyDBInstanceReadOnlyGroupRequest { /** * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** * 当前实例所在只读组ID */ ReadOnlyGroupId: string; /** * 实例修改的目标只读组ID */ NewReadOnlyGroupId: string; } /** * AddDBInstanceToReadOnlyGroup返回参数结构体 */ export interface AddDBInstanceToReadOnlyGroupResponse { /** * 流程ID，FlowId等同于TaskId */ FlowId?: number; /** * 任务ID */ TaskId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * KMS密钥信息 */ export 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; } /** * 数据库数据备份信息 */ export 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; } /** * CreateReadOnlyDBInstance返回参数结构体 */ export interface CreateReadOnlyDBInstanceResponse { /** * 订单号列表。每个实例对应一个订单号 */ DealNames?: Array<string>; /** * 冻结流水号 */ BillId?: string; /** * 创建成功的实例ID集合，只在后付费情景下有返回值 */ DBInstanceIdSet?: Array<string>; /** * 入参有BillingParameters值时，出参才有值，值为商品下单的参数。 */ BillingParameters?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAvailableRecoveryTime请求参数结构体 */ export interface DescribeAvailableRecoveryTimeRequest { /** * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; } /** * CloseAccountCAM请求参数结构体 */ export interface CloseAccountCAMRequest { /** * 实例ID */ DBInstanceId: string; /** * 需要关闭CAM服务的账号名称 */ UserName: string; /** * 关闭CAM后，登录该账号所需要的新密码 */ Password: string; /** * 密码是否加密 */ PasswordEncrypt?: boolean; } /** * DescribeDBProxySpecs返回参数结构体 */ export interface DescribeDBProxySpecsResponse { /** * 规格列表 */ SpecSet?: Array<ProxySpecItem>; /** * 该实例是否支持开通 Proxy（仅传 DBInstanceId 时返回） */ SupportProxy?: boolean; /** * 可部署可用区列表（仅传 DBInstanceId 时返回） */ AvailableZones?: Array<string>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTasks请求参数结构体 */ export interface DescribeTasksRequest { /** * 按照任务ID进行查询。其余云API中返回的FlowId和TaskId等价。 */ TaskId?: number; /** * 按照数据库实例ID进行查询。 */ DBInstanceId?: string; /** * 任务的最早开始时间，形如2024-08-23 00:00:00,默认只展示180天内的数据。 */ MinStartTime?: string; /** * 任务的最晚开始时间，形如2024-08-23 00:00:00，默认为当前时间。 */ MaxStartTime?: string; /** * 每页显示数量，取值范围为1-100，默认为返回20条。 */ Limit?: number; /** * 数据偏移量，从0开始。 */ Offset?: number; /** * 排序字段，支持StartTime,EndTime，默认为StartTime。 */ OrderBy?: string; /** * 排序方式，包括升序：asc，降序：desc，默认为desc。 */ OrderByType?: string; } /** * DescribeDBInstanceParameters请求参数结构体 */ export interface DescribeDBInstanceParametersRequest { /** * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /** * 查询指定参数详情。ParamName为空或不传，默认返回全部参数列表 */ ParamName?: string; } /** * Proxy 实例（组）详细信息，包含基础信息、节点列表、接入地址列表。 */ export interface ProxyGroupInfo { /** * Proxy 实例 ID，格式形如：proxygroup-xxxxxxxx */ ProxyGroupId?: string; /** * Proxy 状态：running/isolated/offline 等 */ Status?: string; /** * Proxy 任务状态，无任务时为空 */ TaskStatus?: string; /** * Proxy 描述 */ Description?: string; /** * Proxy 内核版本号 */ ProxyVersion?: string; /** * 连接池阈值（连接数） */ ConnectionPoolLimit?: number; /** * Proxy 节点列表 */ ProxyNodeSet?: Array<ProxyNode>; /** * Proxy 接入地址列表 */ ProxyAddressSet?: Array<ProxyAddress>; /** * 创建时间，格式：YYYY-MM-DD HH:MM:SS */ CreateTime?: string; } /** * DescribeOrders返回参数结构体 */ export interface DescribeOrdersResponse { /** * 订单数量 */ TotalCount?: number; /** * 订单数组 */ Deals?: Array<PgDeal>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBackupDownloadURL返回参数结构体 */ export interface DescribeBackupDownloadURLResponse { /** * 备份的下载地址。 */ BackupDownloadURL?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyBaseBackupExpireTime返回参数结构体 */ export interface ModifyBaseBackupExpireTimeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyMaintainTimeWindow返回参数结构体 */ export interface ModifyMaintainTimeWindowResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * InquiryPriceCreateDBInstances返回参数结构体 */ export interface InquiryPriceCreateDBInstancesResponse { /** * 刊例价，单位：分 */ OriginalPrice?: number; /** * 折后实际付款金额，单位：分 */ Price?: number; /** * 币种。例如，CNY：人民币。 */ Currency?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteAuditLogFile返回参数结构体 */ export interface DeleteAuditLogFileResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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：可用； UPGRADE_ONLY：不可创建，此版本仅可升级至高版本； DEPRECATED：已弃用。 */ Status?: string; /** * 该数据库版本（DBKernelVersion）可以升级到的版本号列表。其中包含可升级的小版本号和可升级的大版本号（完整内核版本格式示例：v15.1_v1.6）。 */ AvailableUpgradeTarget?: Array<string>; } /** * CreateDBInstanceNetworkAccess请求参数结构体 */ export 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; } /** * ModifySwitchTimePeriod返回参数结构体 */ export interface ModifySwitchTimePeriodResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 任务列表信息 */ export 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; } /** * 数据库审计日志文件 */ export interface AuditLogFile { /** * 文件名 */ FileName?: string; /** * 任务状态枚举值：<ul><li>success：成功</li><li>running：创建中</li><li>failed：失败</li></ul> */ Status?: string; /** * 文件大小单位：MB */ FileSize?: number; /** * 创建时间 */ CreateTime?: string; /** * 下载链接 */ DownloadUrl?: string; /** * 错误信息 */ ErrMsg?: string; /** * 下载进度 */ Progress?: number; /** * 完成时间 */ FinishTime?: string; } /** * InquiryPriceCreateDBInstances请求参数结构体 */ export interface InquiryPriceCreateDBInstancesRequest { /** * 可用区名称。该参数可以通过调用<a href="https://cloud.tencent.com/document/product/409/16769"> DescribeZones</a> 接口的返回值中的Zone字段来获取。 */ Zone: string; /** * 规格ID。该参数可以通过调用<a href="https://cloud.tencent.com/document/product/409/89019">DescribeClasses</a>接口的返回值中的SpecCode字段来获取。 */ SpecCode: string; /** * 存储容量大小，单位：GB。该参数的设置步长为10。 */ 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（预付费，即包年包月）和 POSTPAID（按量计费）。 默认值：PREPAID */ InstanceChargeType?: string; /** * 实例类型，默认primary，支持如下： primary（双机高可用（一主一从）） readonly（只读实例） */ InstanceType?: string; /** * DB引擎，默认postgresql，支持如下： postgresql（云数据库PostgreSQL） mssql_compatible（MSSQL兼容-云数据库PostgreSQL） */ DBEngine?: string; /** * 实例存储类型，可选值：PHYSICAL_LOCAL_SSD：物理机本地ssd硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_SSD：ssd云硬盘 CLOUD_HSSD：增强型ssd云硬盘 */ StorageType?: string; } /** * DescribeDefaultParameters返回参数结构体 */ export interface DescribeDefaultParametersResponse { /** * 参数个数 */ TotalCount?: number; /** * 参数信息注意：此字段可能返回 null，表示取不到有效值。 */ ParamInfoSet?: Array<ParamInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBackupPlans返回参数结构体 */ export interface DescribeBackupPlansResponse { /** * 实例的备份计划集 */ Plans?: Array<BackupPlan>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBInstances请求参数结构体 */ export interface DescribeDBInstancesRequest { /** * 按照一个或者多个过滤条件进行查询，目前支持的过滤条件有： db-instance-id：按照实例ID过滤，类型为string db-instance-name：按照实例名过滤，支持模糊匹配，类型为string db-project-id：按照项目ID过滤，类型为integer db-pay-mode：按照实例付费模式过滤，prepaid - 预付费；postpaid - 后付费。类型为string db-tag-key：按照标签键过滤，类型为string db-private-ip：按照实例私有网络IP过滤，类型为string db-public-address：按照实例外网地址过滤，类型为string db-dedicated-cluster-id: 按照私有集群Id过滤，类型为string */ Filters?: Array<Filter>; /** * 每页显示数量，取值范围为0-100，传入0时，取默认配置。默认为返回10条。 */ Limit?: number; /** * 数据偏移量，从0开始。 */ Offset?: number; /** * 排序指标，如实例名、创建时间等，支持DBInstanceId,CreateTime,Name,EndTime。默认值：CreateTime。 */ OrderBy?: string; /** * 排序方式，包括升序：asc、降序：desc。默认值：asc。 */ OrderByType?: string; } /** * 只读组信息 */ export interface ReadOnlyGroup { /** * 只读组标识 */ ReadOnlyGroupId?: string; /** * 只读组名字 */ ReadOnlyGroupName?: string; /** * 项目id */ ProjectId?: number; /** * 主实例id */ MasterDBInstanceId?: string; /** * 最小保留实例数 */ MinDelayEliminateReserve?: number; /** * 延迟空间大小阈值。单位MB。 */ MaxReplayLatency?: number; /** * 延迟大小开关。0 - 关闭； 1 - 开启。 */ ReplayLatencyEliminate?: number; /** * 延迟时间大小阈值，单位：秒。 */ MaxReplayLag?: number; /** * 延迟时间开关。0 - 关闭； 1 - 开启。 */ ReplayLagEliminate?: number; /** * 虚拟网络id */ VpcId?: string; /** * 子网id */ SubnetId?: string; /** * 地域id */ Region?: string; /** * 地区id */ Zone?: string; /** * 状态。枚举值：creating、ok、modifying、deleting、deleted */ Status?: string; /** * 实例详细信息 */ ReadOnlyDBInstanceList?: Array<DBInstance>; /** * 自动负载均衡开关 */ Rebalance?: number; /** * 网络信息 */ DBInstanceNetInfo?: Array<DBInstanceNetInfo>; /** * 只读组网络信息列表（此字段已废弃）注意：此字段可能返回 null，表示取不到有效值。 */ NetworkAccessList?: Array<NetworkAccess>; } /** * ModifyDBInstanceSpec请求参数结构体 */ export interface ModifyDBInstanceSpecRequest { /** * 实例ID，形如：postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取 */ DBInstanceId: string; /**