tencentcloud-sdk-nodejs-mongodb 4.0.618 → 4.0.620

package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts

@@ -172,9 +172,9 @@ export interface CreateBackupDBInstanceResponse {
  */
 export interface DBInstancePrice {
     /**
-        * 单价
+     * 单价
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     UnitPrice: number;
     /**
      * 原价
@@ -270,20 +270,20 @@ export interface InstanceMultiParam {
      */
     EnumValue: Array<string>;
     /**
-        * 参数修改后是否需要重启才会生效。
+     * 参数修改后是否需要重启才会生效。
   - 1：需要重启后生效。
   - 0：无需重启，设置成功即可生效。
-        */
+     */
     NeedRestart: string;
     /**
      * 参数名称。
      */
     ParamName: string;
     /**
-        * 是否为运行中参数值。
+     * 是否为运行中参数值。
   - 1：运行中参数值。
   - 0：非运行中参数值。
-        */
+     */
     Status: number;
     /**
      * 参数说明。
@@ -495,9 +495,9 @@ export interface DescribeDBInstanceNodePropertyRequest {
      */
     NodeIds?: Array<string>;
     /**
-        * 节点角色。可选值包括：
+     * 节点角色。可选值包括：
   <ul><li>PRIMARY：主节点。</li><li>SECONDARY：从节点。</li><li>READONLY：只读节点。</li><li>ARBITER：仲裁节点。</li></ul>
-        */
+     */
     Roles?: Array<string>;
     /**
      * 该参数指定节点是否为Hidden节点，默认为false。
@@ -508,9 +508,9 @@ export interface DescribeDBInstanceNodePropertyRequest {
      */
     Priority?: number;
     /**
-        * 该参数指定节点投票权。
+     * 该参数指定节点投票权。
   <ul><li>1：具有投票权。</li><li>0：无投票权。</li></ul>
-        */
+     */
     Votes?: number;
     /**
      * 节点标签。
@@ -522,9 +522,9 @@ export interface DescribeDBInstanceNodePropertyRequest {
  */
 export interface DeleteAccountUserRequest {
     /**
-        * 指定待删除账号的实例 ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
+     * 指定待删除账号的实例 ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
   
-        */
+     */
     InstanceId: string;
     /**
      * 配置待删除的账号名。
@@ -685,9 +685,9 @@ export interface DescribeSlowLogsResponse {
      */
     Count?: number;
     /**
-        * 慢日志详情
+     * 慢日志详情
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     SlowLogs?: Array<string>;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -736,24 +736,24 @@ export interface BackupInfo {
      */
     BackupName: string;
     /**
-        * 备份备注
+     * 备份备注
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     BackupDesc: string;
     /**
-        * 备份文件大小，单位KB
+     * 备份文件大小，单位KB
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     BackupSize: number;
     /**
-        * 备份开始时间
+     * 备份开始时间
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     StartTime: string;
     /**
-        * 备份结束时间
+     * 备份结束时间
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     EndTime: string;
     /**
      * 备份状态，1-备份中，2-备份成功
@@ -785,16 +785,16 @@ export interface DescribeDBInstancesRequest {
      */
     Status?: Array<number>;
     /**
-        * 私有网络的 ID。
+     * 私有网络的 ID。
   - 基础网络则无需配置该参数。
   - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在**私有网络**页面获取其 ID。
-        */
+     */
     VpcId?: string;
     /**
-        * 私有网络的子网ID。
+     * 私有网络的子网ID。
   - 基础网络则无需配置该参数。
   - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在**私有网络**页面获取其子网 ID。
-        */
+     */
     SubnetId?: string;
     /**
      * 付费类型，取值范围如下：<ul><li>0：查询按量计费实例。</li><li>1：查询包年包月实例。</li><li>-1：查询按量计费与包年包月实例。</li></ul>
@@ -813,10 +813,10 @@ export interface DescribeDBInstancesRequest {
      */
     OrderBy?: string;
     /**
-        * 配置返回结果的排序方式。
+     * 配置返回结果的排序方式。
   - ASC：升序。
   - DESC：降序。
-        */
+     */
     OrderByType?: string;
     /**
      * 项目 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
@@ -836,47 +836,47 @@ export interface DescribeDBInstancesRequest {
  */
 export interface CurrentOp {
     /**
-        * 操作序号
+     * 操作序号
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     OpId: number;
     /**
-        * 操作所在的命名空间，形式如db.collection
+     * 操作所在的命名空间，形式如db.collection
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     Ns: string;
     /**
-        * 操作执行语句
+     * 操作执行语句
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     Query: string;
     /**
-        * 操作类型，可能的取值：aggregate、count、delete、distinct、find、findAndModify、getMore、insert、mapReduce、update和command
+     * 操作类型，可能的取值：aggregate、count、delete、distinct、find、findAndModify、getMore、insert、mapReduce、update和command
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     Op: string;
     /**
      * 操作所在的分片名称
      */
     ReplicaSetName: string;
     /**
-        * 筛选条件，节点状态，可能的取值为：Primary、Secondary
+     * 筛选条件，节点状态，可能的取值为：Primary、Secondary
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     State: string;
     /**
-        * 操作详细信息
+     * 操作详细信息
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     Operation: string;
     /**
      * 操作所在的节点名称
      */
     NodeName: string;
     /**
-        * 操作已执行时间（ms）
+     * 操作已执行时间（ms）
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     MicrosecsRunning: number;
 }
 /**
@@ -921,9 +921,9 @@ export interface Auth {
      */
     Mask: number;
     /**
-        * 指具有当前账号权限的数据库名。
+     * 指具有当前账号权限的数据库名。
   <ul><li>* ：表示所有数据库。</li><li>db.name：表示特定name的数据库。</li></ul>
-        */
+     */
     NameSpace: string;
 }
 /**
@@ -964,10 +964,10 @@ export interface InstanceIntegerParam {
      */
     Min: string;
     /**
-        * 参数修改之后是否需要重启生效。
+     * 参数修改之后是否需要重启生效。
   - 1:需要重启后生效。
   - 0：无需重启，设置成功即可生效。
-        */
+     */
     NeedRestart: string;
     /**
      * 参数名称。
@@ -982,10 +982,10 @@ export interface InstanceIntegerParam {
      */
     ValueType: string;
     /**
-        * 是否为运行中参数值。
+     * 是否为运行中参数值。
   - 1：运行中参数值。
   - 0：非运行中参数值。
-        */
+     */
     Status: number;
     /**
      * 冗余字段，可忽略。
@@ -1097,10 +1097,10 @@ export interface InstanceTextParam {
      */
     ValueType: string;
     /**
-        * 是否为运行中的参数值。
+     * 是否为运行中的参数值。
   - 1：运行中参数值。
   - 0：非运行中参数值。
-        */
+     */
     Status: string;
 }
 /**
@@ -1278,14 +1278,14 @@ export interface DescribeInstanceParamsRequest {
  */
 export interface NodeTag {
     /**
-        * 节点Tag key
+     * 节点Tag key
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     TagKey?: string;
     /**
-        * 节点Tag Value
+     * 节点Tag Value
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     TagValue?: string;
 }
 /**
@@ -1391,9 +1391,9 @@ export interface ClientConnection {
  */
 export interface ReplicateSetInfo {
     /**
-        * 节点属性
+     * 节点属性
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     Nodes: Array<NodeProperty>;
 }
 /**
@@ -1427,10 +1427,10 @@ export interface CreateBackupDownloadTaskRequest {
      */
     BackupName: string;
     /**
-        * 指定要下载的副本集的节点名称 或 分片集群的分片名称列表。
+     * 指定要下载的副本集的节点名称 或 分片集群的分片名称列表。
   如副本集cmgo-p8vnipr5，示例(固定取值)：BackupSets.0=cmgo-p8vnipr5_0，可下载全量数据。
   如分片集群cmgo-p8vnipr5，示例：BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1，即下载分片0和分片1的数据，分片集群如需全量下载，请按示例方式传入全部分片名称。
-        */
+     */
     BackupSets: Array<ReplicaSetInfo>;
 }
 /**
@@ -1488,9 +1488,9 @@ export interface SecurityGroupBound {
  */
 export interface DescribeDBInstanceNodePropertyResponse {
     /**
-        * Mongos节点属性。
+     * Mongos节点属性。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     Mongos: Array<NodeProperty>;
     /**
      * 副本集节点信息。
@@ -1526,9 +1526,9 @@ export interface DescribeCurrentOpRequest {
      */
     ReplicaSetName?: string;
     /**
-        * 筛选条件，节点状态，可能的取值为：primary
+     * 筛选条件，节点状态，可能的取值为：primary
   secondary
-        */
+     */
     State?: string;
     /**
      * 单次请求返回的数量，默认值为100，取值范围为[0,100]
@@ -1588,9 +1588,9 @@ export interface BackupDownloadTask {
      */
     BackupMethod: number;
     /**
-        * 发起备份时指定的备注信息
+     * 发起备份时指定的备注信息
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     BackupDesc: string;
 }
 /**
@@ -1619,9 +1619,9 @@ export interface DescribeDBBackupsRequest {
  */
 export interface DescribeClientConnectionsRequest {
     /**
-        * 指定待查询的实例ID，例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
+     * 指定待查询的实例ID，例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
   
-        */
+     */
     InstanceId: string;
     /**
      * 单次请求返回的数量。最小值为1，最大值为1000，默认值为1000。
@@ -1717,10 +1717,10 @@ export interface InstanceEnumParam {
      */
     EnumValue: Array<string>;
     /**
-        * 参数修改之后是否需要重启生效。
+     * 参数修改之后是否需要重启生效。
   - 1：需要重启后生效。
   - 0：无需重启，设置成功即可生效。
-        */
+     */
     NeedRestart: string;
     /**
      * 参数名称。
@@ -1735,10 +1735,10 @@ export interface InstanceEnumParam {
      */
     ValueType: string;
     /**
-        * 是否为运行中参数值。
+     * 是否为运行中参数值。
   - 1：运行中参数值。
   - 0：非运行中参数值。
-        */
+     */
     Status: number;
 }
 /**
@@ -1759,10 +1759,10 @@ export interface CreateBackupDBInstanceRequest {
      */
     InstanceId: string;
     /**
-        * 设置备份方式。
+     * 设置备份方式。
   - 0：逻辑备份。
   - 1：物理备份。
-        */
+     */
     BackupMethod: number;
     /**
      * 备份备注信息。
@@ -1791,59 +1791,59 @@ export interface SetAccountUserPrivilegeRequest {
  */
 export interface NodeProperty {
     /**
-        * 节点所在的可用区。
+     * 节点所在的可用区。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     Zone: string;
     /**
-        * 节点名称。
+     * 节点名称。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     NodeName: string;
     /**
-        * 节点访问地址。
+     * 节点访问地址。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     Address: string;
     /**
-        * 角色。
+     * 角色。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     Role: string;
     /**
-        * 是否为Hidden节点
+     * 是否为Hidden节点
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     Hidden: boolean;
     /**
-        * 节点状态，包括：ORMAL/STARTUP/RECOVERING/STARTUP2/UNKNOWN/DOWN/ROLLBACK/REMOVED等。
+     * 节点状态，包括：ORMAL/STARTUP/RECOVERING/STARTUP2/UNKNOWN/DOWN/ROLLBACK/REMOVED等。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     Status: string;
     /**
-        * 主从延迟，单位秒。
+     * 主从延迟，单位秒。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     SlaveDelay: number;
     /**
-        * 节点优先级。
+     * 节点优先级。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     Priority: number;
     /**
-        * 节点投票权。
+     * 节点投票权。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     Votes: number;
     /**
-        * 节点标签。
+     * 节点标签。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     Tags: Array<NodeTag>;
     /**
-        * 副本集Id。
+     * 副本集Id。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     ReplicateSetId: string;
 }
 /**
@@ -1877,44 +1877,44 @@ export interface CreateDBInstanceHourRequest {
      */
     Volume: number;
     /**
-        * 指副本集数量。
+     * 指副本集数量。
   - 创建副本集实例，该参数只能为1。
   - 创建分片实例，指分片的数量。具体售卖规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
-        */
+     */
     ReplicateSetNum: number;
     /**
      * 指每个副本集内节点个数。具体售卖规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
      */
     NodeNum: number;
     /**
-        * 指版本信息。具体售卖规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
+     * 指版本信息。具体售卖规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
   - MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本。
   - MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本。
   - MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。
   - MONGO_44_WT：MongoDB 4.4 WiredTiger存储引擎版本。
-        */
+     */
     MongoVersion: string;
     /**
-        * 机器类型。
+     * 机器类型。
   - HIO：高IO型。
   - HIO10G：高IO万兆。
-        */
+     */
     MachineCode: string;
     /**
      * 实例数量，最小值1，最大值为10。
      */
     GoodsNum: number;
     /**
-        * 可用区信息，输入格式如：ap-guangzhou-2。
+     * 可用区信息，输入格式如：ap-guangzhou-2。
   - 具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
   - 该参数为主可用区，如果多可用区部署，Zone必须是AvailabilityZoneList中的一个。
-        */
+     */
     Zone: string;
     /**
-        * 实例架构类型。
+     * 实例架构类型。
   - REPLSET：副本集。
   - SHARD：分片集群。
-        */
+     */
     ClusterType: string;
     /**
      * 私有网络ID。如果不设置该参数，则默认选择基础网络。
@@ -1937,11 +1937,11 @@ export interface CreateDBInstanceHourRequest {
      */
     Tags?: Array<TagInfo>;
     /**
-        * 实例类型。
+     * 实例类型。
   - 1：正式实例。
   - 3：只读实例。
   - 4：灾备实例。
-        */
+     */
     Clone?: number;
     /**
      * 父实例 ID。当参数**Clone**为3或者4时，即实例为只读或灾备实例时，该参数必须配置。
@@ -1952,40 +1952,40 @@ export interface CreateDBInstanceHourRequest {
      */
     SecurityGroup?: Array<string>;
     /**
-        * 克隆实例回档时间。
+     * 克隆实例回档时间。
   - 若为克隆实例，则必须配置该参数。输入格式示例：2021-08-13 16:30:00。
   - 回档时间范围：仅能回档7天内时间点的数据。
-        */
+     */
     RestoreTime?: string;
     /**
      * 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。
      */
     InstanceName?: string;
     /**
-        * 多可用区部署的节点列表。具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。
+     * 多可用区部署的节点列表。具体信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。
   - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如：3节点集群不支持2个节点部署在同一个区。
   - 不支持4.2及以上版本。
   - 不支持只读灾备实例。
   - 不能选择基础网络。
-        */
+     */
     AvailabilityZoneList?: Array<string>;
     /**
-        * Mongos CPU 核数。
+     * Mongos CPU 核数。
   - 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时，可选择性配置该参数。
   - 若不配置该参数，则根据Mongod节点规格默认适配 Mongos 规格，默认规格免费。
-        */
+     */
     MongosCpu?: number;
     /**
-        * Mongos 内存大小。
+     * Mongos 内存大小。
   - 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时，可选择性配置该参数。
   - 若不配置该参数，则根据Mongod节点规格默认适配 Mongos 规格，默认规格免费。
-        */
+     */
     MongosMemory?: number;
     /**
-        * Mongos 数量。
+     * Mongos 数量。
   - 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时，可选择性配置该参数。
   - 若不配置该参数，则根据Mongod节点规格默认适配 Mongos 规格，默认规格免费。
-        */
+     */
     MongosNodeNum?: number;
     /**
      * 只读节点数量，最大不超过7个。
@@ -2417,44 +2417,44 @@ export interface InstanceDetail {
      */
     RealInstanceId: string;
     /**
-        * mongos节点个数。
+     * mongos节点个数。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     MongosNodeNum: number;
     /**
-        * mongos节点内存。
+     * mongos节点内存。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     MongosMemory: number;
     /**
-        * mongos节点CPU核数。
+     * mongos节点CPU核数。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     MongosCpuNum: number;
     /**
-        * Config Server节点个数。
+     * Config Server节点个数。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     ConfigServerNodeNum: number;
     /**
-        * Config Server节点内存。
+     * Config Server节点内存。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     ConfigServerMemory: number;
     /**
-        * Config Server节点磁盘大小。
+     * Config Server节点磁盘大小。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     ConfigServerVolume: number;
     /**
-        * Config Server节点CPU核数。
+     * Config Server节点CPU核数。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     ConfigServerCpuNum: number;
     /**
-        * readonly节点个数。
+     * readonly节点个数。
   注意：此字段可能返回 null，表示取不到有效值。
-        */
+     */
     ReadonlyNodeNum: number;
 }
 /**
@@ -2475,19 +2475,19 @@ export interface ModifyDBInstanceSpecResponse {
  */
 export interface InstanceChargePrepaid {
     /**
-        * 购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。默认为1。
+     * 购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。默认为1。
   （InquirePriceRenewDBInstances，RenewDBInstances调用时必填）
-        */
+     */
     Period?: number;
     /**
-        * 自动续费标识。取值范围：
+     * 自动续费标识。取值范围：
   NOTIFY_AND_AUTO_RENEW：通知过期且自动续费
   NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费
   DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费
   
   默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。
   （InquirePriceRenewDBInstances，RenewDBInstances调用时必填）
-        */
+     */
     RenewFlag?: string;
 }
 /**