tencentcloud-sdk-nodejs-cynosdb 4.0.688 → 4.0.690

package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js

@@ -58,7 +58,7 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ModifyResourcePackageClusters", req, cb);
     }
     /**
-     * 创建审计规则模版
+     * 创建审计规则模板
      */
     async CreateAuditRuleTemplate(req, cb) {
         return this.request("CreateAuditRuleTemplate", req, cb);
@@ -232,7 +232,7 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ModifyVipVport", req, cb);
     }
     /**
-     * 删除审计规则模版
+     * 删除审计规则模板
      */
     async DeleteAuditRuleTemplates(req, cb) {
         return this.request("DeleteAuditRuleTemplates", req, cb);
@@ -574,7 +574,7 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("SearchClusterDatabases", req, cb);
     }
     /**
-     * 修改审计规则模版
+     * 修改审计规则模板
      */
     async ModifyAuditRuleTemplates(req, cb) {
         return this.request("ModifyAuditRuleTemplates", req, cb);
@@ -610,7 +610,7 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("DeleteAuditLogFile", req, cb);
     }
     /**
-     * 查询审计规则模版信息
+     * 查询审计规则模板信息
      */
     async DescribeAuditRuleTemplates(req, cb) {
         return this.request("DescribeAuditRuleTemplates", req, cb);

package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts

@@ -54,7 +54,8 @@ export interface ModifyProxyRwSplitRequest {
      */
     ConsistencyType?: string;
     /**
-     * 一致性超时时间
+     * 一致性超时时间。
+  取值范围：0~1000000（微秒）,设置0则表示若只读实例出现延迟, 导致一致性策略不满足, 请求将一直等待。
      */
     ConsistencyTimeOut?: string;
     /**
@@ -62,7 +63,8 @@ export interface ModifyProxyRwSplitRequest {
      */
     WeightMode?: string;
     /**
-     * 实例只读权重
+     * 实例只读权重。
+  该参数必填。
      */
     InstanceWeights?: Array<ProxyInstanceWeight>;
     /**
@@ -74,7 +76,8 @@ export interface ModifyProxyRwSplitRequest {
      */
     AutoAddRo?: string;
     /**
-     * 是否打开读写分离
+     * 是否打开读写分离。
+  该参数已废弃，请通过RwType设置读写属性。
      */
     OpenRw?: string;
     /**
@@ -83,7 +86,8 @@ export interface ModifyProxyRwSplitRequest {
      */
     RwType?: string;
     /**
-     * 事务拆分
+     * 事务拆分。
+  在一个事务中拆分读和写到不同的实例上去执行。
      */
     TransSplit?: boolean;
     /**
@@ -102,7 +106,8 @@ export interface ModifyProxyRwSplitRequest {
      */
     ConnectionPoolType?: string;
     /**
-     * 连接池时间
+     * 连接池时间。
+  可选范围:0~300（秒）
      */
     ConnectionPoolTimeOut?: number;
 }
@@ -164,23 +169,33 @@ export interface DescribeAccountPrivilegesResponse {
     RequestId?: string;
 }
 /**
- * 实例的审计规则详情，DescribeAuditRuleWithInstanceIds接口的出参。
+ * 实例的审计规则详情。
  */
 export interface InstanceAuditRule {
     /**
      * 实例ID。
      */
-    InstanceId: string;
+    InstanceId?: string;
     /**
      * 是否是规则审计。true-规则审计，false-全审计。
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    AuditRule: boolean;
+    AuditRule?: boolean;
     /**
      * 审计规则详情。仅当AuditRule=true时有效。
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    AuditRuleFilters: Array<AuditRuleFilters>;
+    AuditRuleFilters?: Array<AuditRuleFilters>;
+    /**
+     * 是否是审计策略
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    OldRule?: boolean;
+    /**
+     * 实例应用的规则模板详情
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    RuleTemplates?: Array<RuleTemplateInfo>;
 }
 /**
  * 数据库代理，读写分离实例权重
@@ -292,7 +307,7 @@ export interface DescribeBackupConfigRequest {
  */
 export interface ModifyAuditRuleTemplatesRequest {
     /**
-     * 审计规则模版ID。
+     * 审计规则模板ID。
      */
     RuleTemplateIds: Array<string>;
     /**
@@ -300,13 +315,21 @@ export interface ModifyAuditRuleTemplatesRequest {
      */
     RuleFilters?: Array<RuleFilters>;
     /**
-     * 修改后的规则模版名称。
+     * 修改后的规则模板名称。
      */
     RuleTemplateName?: string;
     /**
-     * 修改后的规则模版描述。
+     * 修改后的规则模板描述。
      */
     Description?: string;
+    /**
+     * 告警等级。1-低风险，2-中风险，3-高风险。
+     */
+    AlarmLevel?: number;
+    /**
+     * 告警策略。0-不告警，1-告警。
+     */
+    AlarmPolicy?: number;
 }
 /**
  * DescribeAccounts请求参数结构体
@@ -493,11 +516,13 @@ export interface RollBackClusterRequest {
      */
     RollbackStrategy: string;
     /**
-     * 回档ID
+     * 备份文件ID。
+  回档策略为按备份文件回档时必填。
      */
     RollbackId: number;
     /**
-     * 期望回档时间
+     * 期望回档时间。
+  回档策略为timeRollback按时间点回档时必填。
      */
     ExpectTime?: string;
     /**
@@ -524,11 +549,11 @@ export interface DescribeAuditLogFilesResponse {
     /**
      * 符合条件的审计日志文件个数。
      */
-    TotalCount: number;
+    TotalCount?: number;
     /**
      * 审计日志文件详情。
      */
-    Items: Array<AuditLogFile>;
+    Items?: Array<AuditLogFile>;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
@@ -645,6 +670,27 @@ export interface ModifyInstanceNameRequest {
      */
     InstanceName: string;
 }
+/**
+ * SwitchClusterVpc请求参数结构体
+ */
+export interface SwitchClusterVpcRequest {
+    /**
+     * 集群ID
+     */
+    ClusterId: string;
+    /**
+     * 字符串vpc id
+     */
+    UniqVpcId: string;
+    /**
+     * 字符串子网id
+     */
+    UniqSubnetId: string;
+    /**
+     * 旧地址回收时间
+     */
+    OldIpReserveHours: number;
+}
 /**
  * ModifyClusterDatabase返回参数结构体
  */
@@ -1131,25 +1177,17 @@ export interface UpgradeProxyVersionRequest {
     IsInMaintainPeriod?: string;
 }
 /**
- * SwitchClusterVpc请求参数结构体
+ * OfflineInstance请求参数结构体
  */
-export interface SwitchClusterVpcRequest {
+export interface OfflineInstanceRequest {
     /**
      * 集群ID
      */
     ClusterId: string;
     /**
-     * 字符串vpc id
-     */
-    UniqVpcId: string;
-    /**
-     * 字符串子网id
-     */
-    UniqSubnetId: string;
-    /**
-     * 旧地址回收时间
+     * 实例ID数组
      */
-    OldIpReserveHours: number;
+    InstanceIdList: Array<string>;
 }
 /**
  * DescribeAuditLogs返回参数结构体
@@ -1539,7 +1577,7 @@ export interface CreateClustersResponse {
  */
 export interface SetRenewFlagRequest {
     /**
-     * 需操作的实例ID
+     * 需操作的集群ID
      */
     ResourceIds: Array<string>;
     /**
@@ -1547,6 +1585,41 @@ export interface SetRenewFlagRequest {
      */
     AutoRenewFlag: number;
 }
+/**
+ * 规则模板内容
+ */
+export interface RuleTemplateInfo {
+    /**
+     * 规则模板ID。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    RuleTemplateId?: string;
+    /**
+     * 规则模板名称。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    RuleTemplateName?: string;
+    /**
+     * 规则内容。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    RuleFilters?: Array<RuleFilters>;
+    /**
+     * 告警等级。1-低风险，2-中风险，3-高风险。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    AlarmLevel?: number;
+    /**
+     * 告警策略。0-不告警，1-告警。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    AlarmPolicy?: number;
+    /**
+     * 规则描述。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Description?: string;
+}
 /**
  * 审计规则的规则过滤条件
  */
@@ -2146,7 +2219,7 @@ export interface CreateAccountsRequest {
  */
 export interface DeleteAuditRuleTemplatesRequest {
     /**
-     * 审计规则模版ID。
+     * 审计规则模板ID。
      */
     RuleTemplateIds: Array<string>;
 }
@@ -2157,12 +2230,12 @@ export interface DescribeAuditRuleTemplatesResponse {
     /**
      * 符合查询条件的实例总数。
      */
-    TotalCount: number;
+    TotalCount?: number;
     /**
-     * 规则模版详细信息列表。
+     * 规则模板详细信息列表。
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    Items: Array<AuditRuleTemplateInfo>;
+    Items?: Array<AuditRuleTemplateInfo>;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
@@ -2489,7 +2562,7 @@ export interface SetRenewFlagResponse {
     /**
      * 操作成功实例数
      */
-    Count: number;
+    Count?: number;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
@@ -2660,12 +2733,12 @@ export interface DescribeAuditRuleWithInstanceIdsResponse {
     /**
      * 无
      */
-    TotalCount: number;
+    TotalCount?: number;
     /**
      * 实例审计规则信息。
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    Items: Array<InstanceAuditRule>;
+    Items?: Array<InstanceAuditRule>;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
@@ -3514,7 +3587,7 @@ export interface ModifyAuditServiceRequest {
      */
     AuditRuleFilters?: Array<AuditRuleFilters>;
     /**
-     * 规则模版ID。
+     * 规则模板ID。
      */
     RuleTemplateIds?: Array<string>;
 }
@@ -3808,9 +3881,13 @@ export interface OpenAuditServiceRequest {
      */
     AuditRuleFilters?: Array<AuditRuleFilters>;
     /**
-     * 规则模版ID。同AuditRuleFilters都不填是全审计。
+     * 规则模板ID。同AuditRuleFilters都不填是全审计。
      */
     RuleTemplateIds?: Array<string>;
+    /**
+     * 审计类型。true-全审计；默认false-规则审计。
+     */
+    AuditAll?: boolean;
 }
 /**
  * 查询过滤器
@@ -4221,17 +4298,29 @@ export interface RollbackTimeRange {
     TimeRangeEnd: string;
 }
 /**
- * OfflineInstance请求参数结构体
+ * 审计日志命中规则模板的基本信息
  */
-export interface OfflineInstanceRequest {
+export interface LogRuleTemplateInfo {
     /**
-     * 集群ID
+     * 模板ID
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    ClusterId: string;
+    RuleTemplateId?: string;
     /**
-     * 实例ID数组
+     * 规则模板名
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    InstanceIdList: Array<string>;
+    RuleTemplateName?: string;
+    /**
+     * 告警等级。1-低风险，2-中风险，3-高风险。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    AlarmLevel?: string;
+    /**
+     * 规则模板变更状态：0-未变更；1-已变更；2-已删除
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    RuleTemplateStatus?: number;
 }
 /**
  * ModifyClusterPasswordComplexity请求参数结构体
@@ -4762,7 +4851,7 @@ export interface CreateProxyEndPointRequest {
      */
     ConnectionPoolTimeOut?: number;
     /**
-     * 安全组ID数组
+     * 绑定的安全组ID数组
      */
     SecurityGroupIds?: Array<string>;
     /**
@@ -4770,7 +4859,7 @@ export interface CreateProxyEndPointRequest {
      */
     Description?: string;
     /**
-     * vip信息
+     * 想要绑定的vip信息，需与UniqueVpcId对应。
      */
     Vip?: string;
     /**
@@ -4783,7 +4872,10 @@ export interface CreateProxyEndPointRequest {
      */
     AutoAddRo?: string;
     /**
-     * 是否开启故障转移
+     * 是否开启故障转移。
+  yes：开启
+  no：不开启。
+  数据库代理出现故障时，链接地址将会路由到主实例
      */
     FailOver?: string;
     /**
@@ -4797,11 +4889,11 @@ export interface CreateProxyEndPointRequest {
      */
     RwType?: string;
     /**
-     * 一致性超时时间
+     * 一致性超时时间。取值范围：0~1000000（微秒）,设置0则表示若只读实例出现延迟, 导致一致性策略不满足, 请求将一直等待
      */
     ConsistencyTimeOut?: number;
     /**
-     * 事务拆分
+     * 是否开启事务拆分。在一个事务中拆分读和写到不同的实例上去执行
      */
     TransSplit?: boolean;
     /**
@@ -4868,30 +4960,55 @@ export interface DescribeRollbackTimeValidityResponse {
     RequestId?: string;
 }
 /**
- * 审计规则模版的详情
+ * 审计规则模板的详情
  */
 export interface AuditRuleTemplateInfo {
     /**
-     * 规则模版ID。
+     * 规则模板ID。
      */
-    RuleTemplateId: string;
+    RuleTemplateId?: string;
     /**
-     * 规则模版名称。
+     * 规则模板名称。
      */
-    RuleTemplateName: string;
+    RuleTemplateName?: string;
     /**
-     * 规则模版的过滤条件
+     * 规则模板的过滤条件
      */
-    RuleFilters: Array<RuleFilters>;
+    RuleFilters?: Array<RuleFilters>;
     /**
-     * 规则模版描述。
+     * 规则模板描述。
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    Description: string;
+    Description?: string;
+    /**
+     * 规则模板创建时间。
+     */
+    CreateAt?: string;
+    /**
+     * 规则模板修改时间。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    UpdateAt?: string;
+    /**
+     * 告警等级。1-低风险，2-中风险，3-高风险。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    AlarmLevel?: number;
+    /**
+     * 告警策略。0-不告警，1-告警。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    AlarmPolicy?: number;
     /**
-     * 规则模版创建时间。
+     * 模版状态。0-无任务 ，1-修改中。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Status?: number;
+    /**
+     * 规则模板应用在哪些在实例。
+  注意：此字段可能返回 null，表示取不到有效值。
      */
-    CreateAt: string;
+    AffectedInstances?: Array<string>;
 }
 /**
  * DescribeInstanceSlowQueries返回参数结构体
@@ -5159,13 +5276,21 @@ export interface CreateAuditRuleTemplateRequest {
      */
     RuleFilters: Array<RuleFilters>;
     /**
-     * 规则模版名称。
+     * 规则模板名称。
      */
     RuleTemplateName: string;
     /**
-     * 规则模版描述。
+     * 规则模板描述。
      */
     Description?: string;
+    /**
+     * 告警等级。1-低风险，2-中风险，3-高风险
+     */
+    AlarmLevel?: number;
+    /**
+     * 告警策略。0-不告警，1-告警。
+     */
+    AlarmPolicy?: number;
 }
 /**
  * UpgradeProxy返回参数结构体
@@ -5565,10 +5690,10 @@ export interface CynosdbCluster {
  */
 export interface CreateAuditRuleTemplateResponse {
     /**
-     * 生成的规则模版ID。
+     * 生成的规则模板ID。
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    RuleTemplateId: string;
+    RuleTemplateId?: string;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
@@ -5898,11 +6023,11 @@ export declare type OpenClusterReadOnlyInstanceGroupAccessRequest = null;
  */
 export interface DescribeAuditRuleTemplatesRequest {
     /**
-     * 规则模版ID。
+     * 规则模板ID。
      */
     RuleTemplateIds?: Array<string>;
     /**
-     * 规则模版名称
+     * 规则模板名称
      */
     RuleTemplateNames?: Array<string>;
     /**
@@ -5913,6 +6038,14 @@ export interface DescribeAuditRuleTemplatesRequest {
      * 偏移量，默认值为 0。
      */
     Offset?: number;
+    /**
+     * 告警等级。1-低风险，2-中风险，3-高风险。
+     */
+    AlarmLevel?: number;
+    /**
+     * 告警策略。0-不告警，1-告警。
+     */
+    AlarmPolicy?: number;
 }
 /**
  * 实例可售卖规格详细信息，创建实例时Cpu/Memory确定实例规格，存储可选大小为[MinStorageSize,MaxStorageSize]
@@ -7300,6 +7433,7 @@ export interface ModifyInstanceNameResponse {
 export interface AuditRuleFilters {
     /**
      * 单条审计规则。
+  注意：此字段可能返回 null，表示取不到有效值。
      */
     RuleFilters: Array<RuleFilters>;
 }
@@ -7601,6 +7735,11 @@ export interface AuditLog {
   注意：此字段可能返回 null，表示取不到有效值。
      */
     NsTime?: number;
+    /**
+     * 日志命中规则模板的基本信息
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    TemplateInfo?: Array<LogRuleTemplateInfo>;
 }
 /**
  * DescribeInstanceSpecs返回参数结构体
@@ -7882,28 +8021,13 @@ export interface InstanceAuditLogFilter {
     /**
      * 过滤项。目前支持以下搜索条件：
   
-  包含、不包含、包含（分词维度）、不包含（分词维度）:
-  sql - SQL详情
+  包含、不包含、包含（分词维度）、不包含（分词维度）: sql - SQL详情；alarmLevel - 告警等级；ruleTemplateId - 规则模板Id
   
-  等于、不等于、包含、不包含：
-  host - 客户端地址；
-  user - 用户名；
-  dbName - 数据库名称；
+  等于、不等于、包含、不包含： host - 客户端地址； user - 用户名； dbName - 数据库名称；
   
-  等于、不等于：
-  sqlType - SQL类型；
-  errCode - 错误码；
-  threadId - 线程ID；
+  等于、不等于： sqlType - SQL类型； errCode - 错误码； threadId - 线程ID；
   
-  范围搜索（时间类型统一为微妙）：
-  execTime - 执行时间；
-  lockWaitTime - 锁等待时间；
-  ioWaitTime - IO等待时间；
-  trxLivingTime - 事物持续时间；
-  cpuTime - cpu时间；
-  checkRows - 扫描行数；
-  affectRows - 影响行数；
-  sentRows - 返回行数。
+  范围搜索（时间类型统一为微秒）： execTime - 执行时间； lockWaitTime - 执行时间； ioWaitTime - IO等待时间； trxLivingTime - 事物持续时间； cpuTime - cpu时间； checkRows - 扫描行数； affectRows - 影响行数； sentRows - 返回行数。
      */
     Type: string;
     /**