tencentcloud-sdk-nodejs-cdb 4.1.62 → 4.1.63

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tencentcloud-sdk-nodejs-cdb",
-  "version": "4.1.62",
+  "version": "4.1.63",
   "description": "腾讯云 API NODEJS SDK",
   "main": "./tencentcloud/index.js",
   "module": "./es/index.js",

package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts

@@ -39,7 +39,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     BalanceRoGroupLoad(req: BalanceRoGroupLoadRequest, cb?: (error: string, rep: BalanceRoGroupLoadResponse) => void): Promise<BalanceRoGroupLoadResponse>;
     /**
-     * 本接口(IsolateDBInstance)用于隔离云数据库实例，隔离后不能通过IP和端口访问数据库。隔离的实例可在回收站中进行开机。若为欠费隔离，请尽快进行充值。
+     * 本接口（IsolateDBInstance）用于隔离云数据库实例，隔离后不能通过IP和端口访问数据库。隔离的实例可在回收站中进行开机。若为欠费隔离，请尽快进行充值。
      */
     IsolateDBInstance(req: IsolateDBInstanceRequest, cb?: (error: string, rep: IsolateDBInstanceResponse) => void): Promise<IsolateDBInstanceResponse>;
     /**
@@ -202,7 +202,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     DisassociateSecurityGroups(req: DisassociateSecurityGroupsRequest, cb?: (error: string, rep: DisassociateSecurityGroupsResponse) => void): Promise<DisassociateSecurityGroupsResponse>;
     /**
-     * 本接口(RenewDBInstance)用于续费云数据库实例，支持付费模式为包年包月的实例。按量计费实例可通过该接口续费为包年包月的实例。
+     * 本接口（RenewDBInstance）用于续费云数据库实例，支持付费模式为包年包月的实例。按量计费实例可通过该接口续费为包年包月的实例。
      */
     RenewDBInstance(req: RenewDBInstanceRequest, cb?: (error: string, rep: RenewDBInstanceResponse) => void): Promise<RenewDBInstanceResponse>;
     /**
@@ -289,11 +289,11 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     CreateBackup(req: CreateBackupRequest, cb?: (error: string, rep: CreateBackupResponse) => void): Promise<CreateBackupResponse>;
     /**
-     * 本接口(ModifyDBInstanceVipVport)用于修改云数据库实例的IP和端口号，也可进行基础网络转 VPC 网络和 VPC 网络下的子网变更。
+     * 本接口（ModifyDBInstanceVipVport）用于修改云数据库实例的IP和端口号，也可进行基础网络转 VPC 网络和 VPC 网络下的子网变更。
      */
     ModifyDBInstanceVipVport(req: ModifyDBInstanceVipVportRequest, cb?: (error: string, rep: ModifyDBInstanceVipVportResponse) => void): Promise<ModifyDBInstanceVipVportResponse>;
     /**
-     * 本接口(DescribeDBInstanceConfig)用于云数据库实例的配置信息，包括同步模式，部署模式等。
+     * 本接口（DescribeDBInstanceConfig）用于查询云数据库实例的配置信息，包括同步模式，部署模式等。
      */
     DescribeDBInstanceConfig(req: DescribeDBInstanceConfigRequest, cb?: (error: string, rep: DescribeDBInstanceConfigResponse) => void): Promise<DescribeDBInstanceConfigResponse>;
     /**
@@ -747,7 +747,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     ModifyRemoteBackupConfig(req: ModifyRemoteBackupConfigRequest, cb?: (error: string, rep: ModifyRemoteBackupConfigResponse) => void): Promise<ModifyRemoteBackupConfigResponse>;
     /**
-     * 本接口(DeleteTimeWindow)用于删除云数据库实例的维护时间窗口。删除实例维护时间窗口之后，默认的维护时间窗为 03:00-04:00，即当选择在维护时间窗口内切换访问新实例时，默认会在 03:00-04:00 点进行切换访问新实例。
+     * 本接口（DeleteTimeWindow）用于删除云数据库实例的维护时间窗口。删除实例维护时间窗口之后，默认的维护时间窗为每天的03:00-04:00，数据校验延迟阈值为10秒，即当选择在维护时间窗口内切换访问新实例时，默认会在03:00-04:00点进行切换访问新实例。
      */
     DeleteTimeWindow(req: DeleteTimeWindowRequest, cb?: (error: string, rep: DeleteTimeWindowResponse) => void): Promise<DeleteTimeWindowResponse>;
 }

package/tencentcloud/services/cdb/v20170320/cdb_client.js

@@ -77,7 +77,7 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("BalanceRoGroupLoad", req, cb);
     }
     /**
-     * 本接口(IsolateDBInstance)用于隔离云数据库实例，隔离后不能通过IP和端口访问数据库。隔离的实例可在回收站中进行开机。若为欠费隔离，请尽快进行充值。
+     * 本接口（IsolateDBInstance）用于隔离云数据库实例，隔离后不能通过IP和端口访问数据库。隔离的实例可在回收站中进行开机。若为欠费隔离，请尽快进行充值。
      */
     async IsolateDBInstance(req, cb) {
         return this.request("IsolateDBInstance", req, cb);
@@ -312,7 +312,7 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("DisassociateSecurityGroups", req, cb);
     }
     /**
-     * 本接口(RenewDBInstance)用于续费云数据库实例，支持付费模式为包年包月的实例。按量计费实例可通过该接口续费为包年包月的实例。
+     * 本接口（RenewDBInstance）用于续费云数据库实例，支持付费模式为包年包月的实例。按量计费实例可通过该接口续费为包年包月的实例。
      */
     async RenewDBInstance(req, cb) {
         return this.request("RenewDBInstance", req, cb);
@@ -439,13 +439,13 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("CreateBackup", req, cb);
     }
     /**
-     * 本接口(ModifyDBInstanceVipVport)用于修改云数据库实例的IP和端口号，也可进行基础网络转 VPC 网络和 VPC 网络下的子网变更。
+     * 本接口（ModifyDBInstanceVipVport）用于修改云数据库实例的IP和端口号，也可进行基础网络转 VPC 网络和 VPC 网络下的子网变更。
      */
     async ModifyDBInstanceVipVport(req, cb) {
         return this.request("ModifyDBInstanceVipVport", req, cb);
     }
     /**
-     * 本接口(DescribeDBInstanceConfig)用于云数据库实例的配置信息，包括同步模式，部署模式等。
+     * 本接口（DescribeDBInstanceConfig）用于查询云数据库实例的配置信息，包括同步模式，部署模式等。
      */
     async DescribeDBInstanceConfig(req, cb) {
         return this.request("DescribeDBInstanceConfig", req, cb);
@@ -1113,7 +1113,7 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ModifyRemoteBackupConfig", req, cb);
     }
     /**
-     * 本接口(DeleteTimeWindow)用于删除云数据库实例的维护时间窗口。删除实例维护时间窗口之后，默认的维护时间窗为 03:00-04:00，即当选择在维护时间窗口内切换访问新实例时，默认会在 03:00-04:00 点进行切换访问新实例。
+     * 本接口（DeleteTimeWindow）用于删除云数据库实例的维护时间窗口。删除实例维护时间窗口之后，默认的维护时间窗为每天的03:00-04:00，数据校验延迟阈值为10秒，即当选择在维护时间窗口内切换访问新实例时，默认会在03:00-04:00点进行切换访问新实例。
      */
     async DeleteTimeWindow(req, cb) {
         return this.request("DeleteTimeWindow", req, cb);

package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts

@@ -1090,11 +1090,11 @@ export interface RollbackTableName {
  */
 export interface CloseWanServiceRequest {
     /**
-     * 实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。
+     * 实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。可传入只读组 ID 关闭只读组外网访问。
      */
     InstanceId: string;
     /**
-     * 变更集群版实例只读组时，InstanceId传实例id，需要额外指定该参数表示操作只读组。 如果操作读写节点则不需指定该参数。
+     * 变更云盘版实例只读组时，InstanceId 传实例 ID，需要额外指定该参数表示操作只读组。如果操作读写节点则不需指定该参数。
      */
     OpResourceId?: string;
 }
@@ -1401,7 +1401,7 @@ export interface ProxyAllocation {
  */
 export interface StopCpuExpandRequest {
     /**
-     * 实例 ID 。
+     * 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
      */
     InstanceId: string;
 }
@@ -2434,12 +2434,12 @@ export interface DescribeBinlogsRequest {
 export interface TimeIntervalStrategy {
     /**
      * 开始扩容时间。
-  说明：此值的格式为 Integer 的时间戳。
+  说明：此值的格式为 Integer 的时间戳（秒级）。
      */
     StartTime?: number;
     /**
      * 结束扩容时间。
-  说明：此值的格式为 Integer 的时间戳。
+  说明：此值的格式为 Integer 的时间戳（秒级）。
      */
     EndTime?: number;
 }
@@ -3063,7 +3063,7 @@ export interface DescribeErrorLogDataResponse {
  */
 export interface AddTimeWindowRequest {
     /**
-     * 实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。
+     * 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
      */
     InstanceId: string;
     /**
@@ -3095,7 +3095,7 @@ export interface AddTimeWindowRequest {
      */
     Sunday?: Array<string>;
     /**
-     * 最大延迟阈值，仅对主实例和灾备实例有效。
+     * 最大延迟阈值（秒），仅对主实例和灾备实例有效。默认值：10，取值范围：1-10的整数。
      */
     MaxDelayTime?: number;
 }
@@ -3567,7 +3567,7 @@ export interface DescribeTimeWindowResponse {
  */
 export interface StopCpuExpandResponse {
     /**
-     * 异步任务 ID 。可以调用DescribeAsyncRequest 传入该 ID ，进行任务执行进度的查询
+     * 异步任务 ID。在调用 [DescribeAsyncRequestInfo](https://cloud.tencent.com/document/api/236/20410) 进行任务执行进度的查询时，可以传入该 ID。
      */
     AsyncRequestId?: string;
     /**
@@ -3735,7 +3735,7 @@ export interface DescribeProjectSecurityGroupsRequest {
  */
 export interface StopReplicationRequest {
     /**
-     * 实例 ID。仅支持只读实例。
+     * 实例 ID。仅支持只读实例。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
      */
     InstanceId: string;
 }
@@ -3809,7 +3809,7 @@ export interface DescribeAsyncRequestInfoRequest {
  */
 export interface BalanceRoGroupLoadRequest {
     /**
-     * RO 组的 ID，格式如：cdbrg-c1nl9rpv。
+     * RO 组的 ID，格式如：cdbrg-c1nl9rpv。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 获取。
      */
     RoGroupId: string;
 }
@@ -3949,29 +3949,29 @@ export interface DescribeDBInstanceConfigResponse {
     /**
      * 主实例数据保护方式，可能的返回值：0 - 异步复制方式，1 - 半同步复制方式，2 - 强同步复制方式。
      */
-    ProtectMode: number;
+    ProtectMode?: number;
     /**
      * 主实例部署方式，可能的返回值：0 - 单可用部署，1 - 多可用区部署。
      */
-    DeployMode: number;
+    DeployMode?: number;
     /**
      * 实例可用区信息，格式如 "ap-shanghai-1"。
      */
-    Zone: string;
+    Zone?: string;
     /**
      * 备库的配置信息。
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    SlaveConfig: SlaveConfig;
+    SlaveConfig?: SlaveConfig;
     /**
      * 强同步实例第二备库的配置信息。
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    BackupConfig: BackupConfig;
+    BackupConfig?: BackupConfig;
     /**
      * 是否切换备库。
      */
-    Switched: boolean;
+    Switched?: boolean;
     /**
      * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
      */
@@ -5557,6 +5557,7 @@ export interface RoGroup {
     RoGroupMode: string;
     /**
      * 只读组 ID。
+  说明：若此数据结构在购买实例操作中被使用，则当只读组模式选择 join 时，此项为必填。
      */
     RoGroupId?: string;
     /**
@@ -5568,7 +5569,7 @@ export interface RoGroup {
      */
     RoOfflineDelay?: number;
     /**
-     * 延迟阈值。
+     * 延迟阈值。单位：秒。值范围：1-10000，整数。
      */
     RoMaxDelayTime?: number;
     /**
@@ -5612,7 +5613,7 @@ export interface RoGroup {
      */
     RoGroupZone?: string;
     /**
-     * 延迟复制时间。
+     * 延迟复制时间。单位：秒。值范围：1-259200，整数。
      */
     DelayReplicationTime?: number;
 }
@@ -6194,7 +6195,7 @@ export interface RollbackTask {
  */
 export interface StartReplicationRequest {
     /**
-     * 实例 ID。仅支持只读实例。
+     * 实例 ID。仅支持只读实例。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
      */
     InstanceId: string;
 }
@@ -7389,11 +7390,11 @@ export interface ModifyDBInstanceVipVportRequest {
      */
     InstanceId: string;
     /**
-     * 目标 IP。该参数和 DstPort 参数，两者必传一个。
+     * 目标 IP。
      */
     DstIp?: string;
     /**
-     * 目标端口，支持范围为：[1024-65535]。该参数和 DstIp 参数，两者必传一个。
+     * 目标端口，支持范围为：[1024-65535]。
      */
     DstPort?: number;
     /**
@@ -7617,6 +7618,7 @@ export interface ModifyDBInstanceProjectRequest {
     InstanceIds: Array<string>;
     /**
      * 实例所属项目的 ID，可在账号中心下的项目管理页面查询。
+  说明：此项为必填。
      */
     NewProjectId?: number;
 }
@@ -9330,11 +9332,11 @@ export interface AutoStrategy {
      */
     ShrinkPeriod?: number;
     /**
-     * 弹性扩容观测周期（秒级）
+     * 弹性扩容观测周期（秒级），可取值为：5，30，45，60，180，300，600，900，1800。
      */
     ExpandSecondPeriod?: number;
     /**
-     * 缩容观测周期（秒级）
+     * 缩容观测周期（秒级），可取值为：300。
      */
     ShrinkSecondPeriod?: number;
 }
@@ -9971,7 +9973,7 @@ export interface AuditRuleTemplateInfo {
  */
 export interface ModifyTimeWindowRequest {
     /**
-     * 实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。
+     * 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
      */
     InstanceId: string;
     /**
@@ -9993,7 +9995,7 @@ export interface ModifyTimeWindowRequest {
      */
     Weekdays?: Array<string>;
     /**
-     * 数据延迟阈值，仅对主实例和灾备实例有效，不传默认修改为10
+     * 数据延迟阈值（秒），仅对主实例和灾备实例有效。不传默认不修改，保持原来的阈值，取值范围：1-10的整数。
      */
     MaxDelayTime?: number;
 }