tencentcloud-sdk-nodejs-mongodb 4.0.548 → 4.0.550

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -466,13 +466,13 @@ export interface ModifyDBInstanceNetworkAddressRequest {
466
466
  */
467
467
  export interface CreateDBInstanceHourResponse {
468
468
  /**
469
- * 订单ID
469
+ * 订单ID
470
470
  */
471
- DealId: string;
471
+ DealId?: string;
472
472
  /**
473
- * 创建的实例ID列表
473
+ * 创建的实例ID列表。
474
474
  */
475
- InstanceIds: Array<string>;
475
+ InstanceIds?: Array<string>;
476
476
  /**
477
477
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
478
478
  */
@@ -1828,97 +1828,138 @@ export interface IsolateDBInstanceRequest {
1828
1828
  */
1829
1829
  export interface CreateDBInstanceHourRequest {
1830
1830
  /**
1831
- * 实例内存大小,单位:GB
1831
+ * 实例内存大小,单位:GB
1832
1832
  */
1833
1833
  Memory: number;
1834
1834
  /**
1835
- * 实例硬盘大小,单位:GB
1835
+ * 实例硬盘大小,单位:GB
1836
1836
  */
1837
1837
  Volume: number;
1838
1838
  /**
1839
- * 副本集个数,创建副本集实例时,该参数必须设置为1;创建分片实例时,具体参照查询云数据库的售卖规格返回参数
1840
- */
1839
+ * 指副本集数量。
1840
+ - 创建副本集实例,该参数只能为1。
1841
+ - 创建分片实例,指分片的数量。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
1842
+ */
1841
1843
  ReplicateSetNum: number;
1842
1844
  /**
1843
- * 每个副本集内节点个数,具体参照查询云数据库的售卖规格返回参数
1845
+ * 指每个副本集内节点个数。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
1844
1846
  */
1845
1847
  NodeNum: number;
1846
1848
  /**
1847
- * 版本号,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。参数与版本对应关系是MONGO_3_WT:MongoDB 3.2 WiredTiger存储引擎版本,MONGO_3_ROCKS:MongoDB 3.2 RocksDB存储引擎版本,MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本
1848
- */
1849
+ * 指版本信息。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
1850
+ - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
1851
+ - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
1852
+ - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
1853
+ - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
1854
+ */
1849
1855
  MongoVersion: string;
1850
1856
  /**
1851
- * 机器类型,HIO:高IO型;HIO10G:高IO万兆
1852
- */
1857
+ * 机器类型。
1858
+ - HIO:高IO型。
1859
+ - HIO10G:高IO万兆。
1860
+ */
1853
1861
  MachineCode: string;
1854
1862
  /**
1855
- * 实例数量,最小值1,最大值为10
1863
+ * 实例数量,最小值1,最大值为10
1856
1864
  */
1857
1865
  GoodsNum: number;
1858
1866
  /**
1859
- * 可用区信息,格式如:ap-guangzhou-2。注:此参数填写的是主可用区,如果选择多可用区部署,Zone必须是AvailabilityZoneList中的一个
1860
- */
1867
+ * 可用区信息,输入格式如:ap-guangzhou-2
1868
+ - 具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
1869
+ - 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
1870
+ */
1861
1871
  Zone: string;
1862
1872
  /**
1863
- * 实例类型,REPLSET-副本集,SHARD-分片集群
1864
- */
1873
+ * 实例架构类型。
1874
+ - REPLSET:副本集。
1875
+ - SHARD:分片集群。
1876
+ */
1865
1877
  ClusterType: string;
1866
1878
  /**
1867
- * 私有网络ID,如果不设置该参数则默认选择基础网络
1879
+ * 私有网络ID,如果不设置该参数,则默认选择基础网络。
1868
1880
  */
1869
1881
  VpcId?: string;
1870
1882
  /**
1871
- * 私有网络下的子网ID,如果设置了 VpcId,则 SubnetId必填
1883
+ * 私有网络下的子网 ID,如果配置参数 VpcId,则 SubnetId必须配置。
1872
1884
  */
1873
1885
  SubnetId?: string;
1874
1886
  /**
1875
- * 实例密码,不设置该参数则默认密码规则为 实例ID+"@"+主账户uin。举例实例id为cmgo-higv73ed,uin为100000001,则默认密码为"cmgo-higv73ed@100000001"。密码必须是8-16位字符,且至少包含字母、数字和字符 !@#%^*() 中的两种
1876
- */
1887
+ * 实例密码。
1888
+ - 不设置该参数,则默认密码格式为:实例ID+@+主账户uin。例如:实例 ID 为cmgo-higv73ed,UIN 为100000001,则默认密码为:cmgo-higv73ed@100000001。
1889
+ - 自定义密码长度为8-32个字符,至少包含字母、数字和字符(!@#%^*()_)中的两种。
1890
+ */
1877
1891
  Password?: string;
1878
1892
  /**
1879
- * 项目ID,不设置为默认项目
1893
+ * 项目ID。若不设置该参数,则为默认项目。
1880
1894
  */
1881
1895
  ProjectId?: number;
1882
1896
  /**
1883
- * 实例标签信息
1897
+ * 实例标签信息。
1884
1898
  */
1885
1899
  Tags?: Array<TagInfo>;
1886
1900
  /**
1887
- * 1:正式实例,2:临时实例,3:只读实例,4:灾备实例,5:克隆实例
1888
- */
1901
+ * 实例类型。
1902
+ - 1:正式实例。
1903
+ - 3:只读实例。
1904
+ - 4:灾备实例。
1905
+ */
1889
1906
  Clone?: number;
1890
1907
  /**
1891
- * 父实例Id,当Clone3或者4时,这个必须填
1908
+ * 父实例 ID。当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
1892
1909
  */
1893
1910
  Father?: string;
1894
1911
  /**
1895
- * 安全组
1912
+ * 安全组。
1896
1913
  */
1897
1914
  SecurityGroup?: Array<string>;
1898
1915
  /**
1899
- * 克隆实例回档时间。若是克隆实例,则必须填写,示例:2021-08-13 16:30:00。注:只能回档7天内的时间点
1900
- */
1916
+ * 克隆实例回档时间。
1917
+ - 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。
1918
+ - 回档时间范围:仅能回档7天内时间点的数据。
1919
+ */
1901
1920
  RestoreTime?: string;
1902
1921
  /**
1903
- * 实例名称。注:名称只支持长度为60个字符的中文、英文、数字、下划线_、分隔符-
1922
+ * 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符-
1904
1923
  */
1905
1924
  InstanceName?: string;
1906
1925
  /**
1907
- * 多可用区部署的节点列表,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。注:1、多可用区部署节点只能部署在3个不同可用区;2、为了保障跨可用区切换,不支持将集群的大多数节点部署在同一个可用区(如3节点集群不支持2个节点部署在同一个区);3、不支持4.2及以上版本;4、不支持只读灾备实例;5、不能选择基础网络
1908
- */
1926
+ * 多可用区部署的节点列表。具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。
1927
+ - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
1928
+ - 不支持4.2及以上版本。
1929
+ - 不支持只读灾备实例。
1930
+ - 不能选择基础网络。
1931
+ */
1909
1932
  AvailabilityZoneList?: Array<string>;
1910
1933
  /**
1911
- * mongos cpu数量,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果
1912
- */
1934
+ * Mongos CPU 核数。
1935
+ - 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时,可选择性配置该参数。
1936
+ - 若不配置该参数,则根据Mongod节点规格默认适配 Mongos 规格,默认规格免费。
1937
+ */
1913
1938
  MongosCpu?: number;
1914
1939
  /**
1915
- * mongos 内存大小,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果
1916
- */
1940
+ * Mongos 内存大小。
1941
+ - 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时,可选择性配置该参数。
1942
+ - 若不配置该参数,则根据Mongod节点规格默认适配 Mongos 规格,默认规格免费。
1943
+ */
1917
1944
  MongosMemory?: number;
1918
1945
  /**
1919
- * mongos 数量,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。注:为了保障高可用,最低需要购买3个mongos,上限为32个
1920
- */
1946
+ * Mongos 数量。
1947
+ - 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时,可选择性配置该参数。
1948
+ - 若不配置该参数,则根据Mongod节点规格默认适配 Mongos 规格,默认规格免费。
1949
+ */
1921
1950
  MongosNodeNum?: number;
1951
+ /**
1952
+ * 只读节点数量,最大不超过7个。
1953
+ */
1954
+ ReadonlyNodeNum?: number;
1955
+ /**
1956
+ * 指只读节点所属可用区。跨可用区部署实例,参数**ReadonlyNodeNum**不为**0**时,必须配置该参数。
1957
+ */
1958
+ ReadonlyNodeAvailabilityZoneList?: Array<string>;
1959
+ /**
1960
+ * Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。
1961
+ */
1962
+ HiddenZone?: string;
1922
1963
  }
1923
1964
  /**
1924
1965
  * AssignProject请求参数结构体