tencentcloud-sdk-nodejs-mongodb 4.0.254 → 4.0.259

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.
@@ -270,6 +270,51 @@ export interface CreateBackupDBInstanceResponse {
270
270
  RequestId?: string
271
271
  }
272
272
 
273
+ /**
274
+ * 实例分片详情
275
+ */
276
+ export interface ShardInfo {
277
+ /**
278
+ * 分片已使用容量
279
+ */
280
+ UsedVolume: number
281
+
282
+ /**
283
+ * 分片ID
284
+ */
285
+ ReplicaSetId: string
286
+
287
+ /**
288
+ * 分片名
289
+ */
290
+ ReplicaSetName: string
291
+
292
+ /**
293
+ * 分片内存规格,单位为MB
294
+ */
295
+ Memory: number
296
+
297
+ /**
298
+ * 分片磁盘规格,单位为MB
299
+ */
300
+ Volume: number
301
+
302
+ /**
303
+ * 分片Oplog大小,单位为MB
304
+ */
305
+ OplogSize: number
306
+
307
+ /**
308
+ * 分片从节点数
309
+ */
310
+ SecondaryNum: number
311
+
312
+ /**
313
+ * 分片物理id
314
+ */
315
+ RealReplicaSetId: string
316
+ }
317
+
273
318
  /**
274
319
  * 数据库实例价格
275
320
  */
@@ -700,6 +745,46 @@ export interface BackupInfo {
700
745
  BackupMethod: number
701
746
  }
702
747
 
748
+ /**
749
+ * 安全组信息
750
+ */
751
+ export interface SecurityGroup {
752
+ /**
753
+ * 所属项目id
754
+ */
755
+ ProjectId: number
756
+
757
+ /**
758
+ * 创建时间
759
+ */
760
+ CreateTime: string
761
+
762
+ /**
763
+ * 入站规则
764
+ */
765
+ Inbound: Array<SecurityGroupBound>
766
+
767
+ /**
768
+ * 出站规则
769
+ */
770
+ Outbound: Array<SecurityGroupBound>
771
+
772
+ /**
773
+ * 安全组id
774
+ */
775
+ SecurityGroupId: string
776
+
777
+ /**
778
+ * 安全组名称
779
+ */
780
+ SecurityGroupName: string
781
+
782
+ /**
783
+ * 安全组备注
784
+ */
785
+ SecurityGroupRemark: string
786
+ }
787
+
703
788
  /**
704
789
  * InquirePriceRenewDBInstances请求参数结构体
705
790
  */
@@ -1066,6 +1151,61 @@ export interface OfflineIsolatedDBInstanceRequest {
1066
1151
  InstanceId: string
1067
1152
  }
1068
1153
 
1154
+ /**
1155
+ * 实例可修改参数integer类型集合。
1156
+ */
1157
+ export interface InstanceIntegerParam {
1158
+ /**
1159
+ * 当前值
1160
+ */
1161
+ CurrentValue: string
1162
+
1163
+ /**
1164
+ * 默认值
1165
+ */
1166
+ DefaultValue: string
1167
+
1168
+ /**
1169
+ * 最大值
1170
+ */
1171
+ Max: string
1172
+
1173
+ /**
1174
+ * 最小值
1175
+ */
1176
+ Min: string
1177
+
1178
+ /**
1179
+ * 是否徐亚哦重启后生效 1:需要重启;0:无需重启
1180
+ */
1181
+ NeedRestart: string
1182
+
1183
+ /**
1184
+ * 参数名称
1185
+ */
1186
+ ParamName: string
1187
+
1188
+ /**
1189
+ * 参数说明
1190
+ */
1191
+ Tips: Array<string>
1192
+
1193
+ /**
1194
+ * 参数类型
1195
+ */
1196
+ ValueType: string
1197
+
1198
+ /**
1199
+ * 是否正常获取到,1:未正常获取;0:正常获取,仅对前端有实际意义;
1200
+ */
1201
+ Status: number
1202
+
1203
+ /**
1204
+ * 暂时未用到,前端使用redis侧代码,为了兼容,保留该参数
1205
+ */
1206
+ Unit: string
1207
+ }
1208
+
1069
1209
  /**
1070
1210
  * DescribeCurrentOp请求参数结构体
1071
1211
  */
@@ -1242,6 +1382,41 @@ export interface CreateDBInstanceResponse {
1242
1382
  RequestId?: string
1243
1383
  }
1244
1384
 
1385
+ /**
1386
+ * DescribeInstanceParams返回参数结构体
1387
+ */
1388
+ export interface DescribeInstanceParamsResponse {
1389
+ /**
1390
+ * 值为枚举类型参数集合
1391
+ */
1392
+ InstanceEnumParam: Array<InstanceEnumParam>
1393
+
1394
+ /**
1395
+ * 值为integer类型参数集合
1396
+ */
1397
+ InstanceIntegerParam: Array<InstanceIntegerParam>
1398
+
1399
+ /**
1400
+ * 值为text类型的参数集合
1401
+ */
1402
+ InstanceTextParam: Array<InstanceTextParam>
1403
+
1404
+ /**
1405
+ * 值为混合类型的参数集合
1406
+ */
1407
+ InstanceMultiParam: Array<InstanceMultiParam>
1408
+
1409
+ /**
1410
+ * 当前实例支持修改的参数个数统计 如0
1411
+ */
1412
+ TotalCount: number
1413
+
1414
+ /**
1415
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1416
+ */
1417
+ RequestId?: string
1418
+ }
1419
+
1245
1420
  /**
1246
1421
  * DescribeSlowLogs请求参数结构体
1247
1422
  */
@@ -1367,6 +1542,51 @@ export interface DescribeDBBackupsRequest {
1367
1542
  Offset?: number
1368
1543
  }
1369
1544
 
1545
+ /**
1546
+ * 实例可修改参数Multi类型集合。
1547
+ */
1548
+ export interface InstanceMultiParam {
1549
+ /**
1550
+ * 当前值
1551
+ */
1552
+ CurrentValue: string
1553
+
1554
+ /**
1555
+ * 默认值
1556
+ */
1557
+ DefaultValue: string
1558
+
1559
+ /**
1560
+ * 指导值范围
1561
+ */
1562
+ EnumValue: Array<string>
1563
+
1564
+ /**
1565
+ * 是否需要重启
1566
+ */
1567
+ NeedRestart: string
1568
+
1569
+ /**
1570
+ * 参数名称
1571
+ */
1572
+ ParamName: string
1573
+
1574
+ /**
1575
+ * 状态值
1576
+ */
1577
+ Status: number
1578
+
1579
+ /**
1580
+ * 参数说明
1581
+ */
1582
+ Tips: Array<string>
1583
+
1584
+ /**
1585
+ * 值类型,multi混合类型
1586
+ */
1587
+ ValueType: string
1588
+ }
1589
+
1370
1590
  /**
1371
1591
  * DescribeClientConnections请求参数结构体
1372
1592
  */
@@ -1433,43 +1653,48 @@ export interface ModifyDBInstanceSpecResponse {
1433
1653
  }
1434
1654
 
1435
1655
  /**
1436
- * 安全组信息
1656
+ * 实例可修改参数text类型集合。
1437
1657
  */
1438
- export interface SecurityGroup {
1658
+ export interface InstanceTextParam {
1439
1659
  /**
1440
- * 所属项目id
1660
+ * 当前值(暂未使用)
1441
1661
  */
1442
- ProjectId: number
1662
+ CurrentValue: string
1443
1663
 
1444
1664
  /**
1445
- * 创建时间
1665
+ * 默认值(暂未使用)
1446
1666
  */
1447
- CreateTime: string
1667
+ DefaultValue: string
1448
1668
 
1449
1669
  /**
1450
- * 入站规则
1670
+ * 是否需要重启(暂未使用)
1451
1671
  */
1452
- Inbound: Array<SecurityGroupBound>
1672
+ NeedRestart: string
1453
1673
 
1454
1674
  /**
1455
- * 出站规则
1675
+ * 参数名称(暂未使用)
1456
1676
  */
1457
- Outbound: Array<SecurityGroupBound>
1677
+ ParamName: string
1458
1678
 
1459
1679
  /**
1460
- * 安全组id
1680
+ * text类型值(暂未使用)
1461
1681
  */
1462
- SecurityGroupId: string
1682
+ TextValue: string
1463
1683
 
1464
1684
  /**
1465
- * 安全组名称
1685
+ * 说明(暂未使用)
1466
1686
  */
1467
- SecurityGroupName: string
1687
+ Tips: Array<string>
1468
1688
 
1469
1689
  /**
1470
- * 安全组备注
1690
+ * 值类型(暂未使用)
1471
1691
  */
1472
- SecurityGroupRemark: string
1692
+ ValueType: string
1693
+
1694
+ /**
1695
+ * 值获取状态(暂未使用)
1696
+ */
1697
+ Status: string
1473
1698
  }
1474
1699
 
1475
1700
  /**
@@ -1587,6 +1812,51 @@ export interface RenewDBInstancesResponse {
1587
1812
  RequestId?: string
1588
1813
  }
1589
1814
 
1815
+ /**
1816
+ * 实例可修改参数枚举类型集合。
1817
+ */
1818
+ export interface InstanceEnumParam {
1819
+ /**
1820
+ * 参数当前值
1821
+ */
1822
+ CurrentValue: string
1823
+
1824
+ /**
1825
+ * 默认值
1826
+ */
1827
+ DefaultValue: string
1828
+
1829
+ /**
1830
+ * 枚举值,所有支持的值
1831
+ */
1832
+ EnumValue: Array<string>
1833
+
1834
+ /**
1835
+ * 是否需要重启后生效,"1"需要,"0"无需重启
1836
+ */
1837
+ NeedRestart: string
1838
+
1839
+ /**
1840
+ * 参数名称
1841
+ */
1842
+ ParamName: string
1843
+
1844
+ /**
1845
+ * 中英文说明
1846
+ */
1847
+ Tips: Array<string>
1848
+
1849
+ /**
1850
+ * 参数值类型说明
1851
+ */
1852
+ ValueType: string
1853
+
1854
+ /**
1855
+ * 是否获取到参数,1为获取,前端正常显示,0:前段显示loading
1856
+ */
1857
+ Status: number
1858
+ }
1859
+
1590
1860
  /**
1591
1861
  * DescribeBackupDownloadTask返回参数结构体
1592
1862
  */
@@ -2055,23 +2325,13 @@ export interface CreateBackupDBInstanceRequest {
2055
2325
  }
2056
2326
 
2057
2327
  /**
2058
- * 需要终止的操作
2328
+ * DescribeInstanceParams请求参数结构体
2059
2329
  */
2060
- export interface Operation {
2061
- /**
2062
- * 操作所在的分片名
2063
- */
2064
- ReplicaSetName: string
2065
-
2330
+ export interface DescribeInstanceParamsRequest {
2066
2331
  /**
2067
- * 操作所在的节点名
2068
- */
2069
- NodeName: string
2070
-
2071
- /**
2072
- * 操作序号
2332
+ * 实例ID
2073
2333
  */
2074
- OpId: number
2334
+ InstanceId: string
2075
2335
  }
2076
2336
 
2077
2337
  /**
@@ -2127,46 +2387,21 @@ export interface RenewDBInstancesRequest {
2127
2387
  }
2128
2388
 
2129
2389
  /**
2130
- * 实例分片详情
2390
+ * 需要终止的操作
2131
2391
  */
2132
- export interface ShardInfo {
2133
- /**
2134
- * 分片已使用容量
2135
- */
2136
- UsedVolume: number
2137
-
2138
- /**
2139
- * 分片ID
2140
- */
2141
- ReplicaSetId: string
2142
-
2392
+ export interface Operation {
2143
2393
  /**
2144
- * 分片名
2394
+ * 操作所在的分片名
2145
2395
  */
2146
2396
  ReplicaSetName: string
2147
2397
 
2148
2398
  /**
2149
- * 分片内存规格,单位为MB
2150
- */
2151
- Memory: number
2152
-
2153
- /**
2154
- * 分片磁盘规格,单位为MB
2155
- */
2156
- Volume: number
2157
-
2158
- /**
2159
- * 分片Oplog大小,单位为MB
2160
- */
2161
- OplogSize: number
2162
-
2163
- /**
2164
- * 分片从节点数
2399
+ * 操作所在的节点名
2165
2400
  */
2166
- SecondaryNum: number
2401
+ NodeName: string
2167
2402
 
2168
2403
  /**
2169
- * 分片物理id
2404
+ * 操作序号
2170
2405
  */
2171
- RealReplicaSetId: string
2406
+ OpId: number
2172
2407
  }
@@ -1,5 +1,5 @@
1
1
  import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
2
- import { ResetDBInstancePasswordResponse, DescribeSpecInfoRequest, KillOpsRequest, CreateDBInstanceRequest, DescribeSecurityGroupResponse, DescribeCurrentOpResponse, IsolateDBInstanceResponse, CreateBackupDBInstanceResponse, DescribeBackupAccessResponse, InquirePriceCreateDBInstancesRequest, IsolateDBInstanceRequest, DescribeSlowLogPatternsResponse, CreateDBInstanceHourRequest, AssignProjectRequest, CreateBackupDownloadTaskResponse, InquirePriceModifyDBInstanceSpecRequest, InquirePriceRenewDBInstancesRequest, DescribeAsyncRequestInfoRequest, KillOpsResponse, CreateBackupDownloadTaskRequest, DescribeSlowLogPatternsRequest, DescribeSlowLogsResponse, FlushInstanceRouterConfigResponse, InquirePriceModifyDBInstanceSpecResponse, DescribeSpecInfoResponse, InquirePriceRenewDBInstancesResponse, ResetDBInstancePasswordRequest, DescribeDBInstancesResponse, OfflineIsolatedDBInstanceRequest, DescribeCurrentOpRequest, DescribeDBInstanceDealRequest, DescribeDBInstancesRequest, DescribeAsyncRequestInfoResponse, CreateDBInstanceResponse, DescribeSlowLogsRequest, AssignProjectResponse, DescribeDBBackupsRequest, DescribeClientConnectionsRequest, DescribeDBInstanceDealResponse, ModifyDBInstanceSpecResponse, OfflineIsolatedDBInstanceResponse, DescribeBackupDownloadTaskRequest, DescribeBackupAccessRequest, RenameInstanceRequest, DescribeSecurityGroupRequest, RenewDBInstancesResponse, DescribeBackupDownloadTaskResponse, RenameInstanceResponse, DescribeClientConnectionsResponse, FlushInstanceRouterConfigRequest, DescribeDBBackupsResponse, ModifyDBInstanceSpecRequest, CreateDBInstanceHourResponse, CreateBackupDBInstanceRequest, InquirePriceCreateDBInstancesResponse, RenewDBInstancesRequest } from "./mongodb_models";
2
+ import { ResetDBInstancePasswordResponse, DescribeSpecInfoRequest, KillOpsRequest, CreateDBInstanceRequest, DescribeSecurityGroupResponse, DescribeCurrentOpResponse, IsolateDBInstanceResponse, CreateBackupDBInstanceResponse, DescribeBackupAccessResponse, InquirePriceCreateDBInstancesRequest, IsolateDBInstanceRequest, DescribeSlowLogPatternsResponse, CreateDBInstanceHourRequest, AssignProjectRequest, CreateBackupDownloadTaskResponse, InquirePriceModifyDBInstanceSpecRequest, InquirePriceRenewDBInstancesRequest, DescribeAsyncRequestInfoRequest, KillOpsResponse, CreateBackupDownloadTaskRequest, DescribeSlowLogPatternsRequest, DescribeSlowLogsResponse, FlushInstanceRouterConfigResponse, InquirePriceModifyDBInstanceSpecResponse, DescribeSpecInfoResponse, InquirePriceRenewDBInstancesResponse, ResetDBInstancePasswordRequest, DescribeDBInstancesResponse, OfflineIsolatedDBInstanceRequest, DescribeCurrentOpRequest, DescribeDBInstanceDealRequest, DescribeDBInstancesRequest, DescribeAsyncRequestInfoResponse, CreateDBInstanceResponse, DescribeInstanceParamsResponse, DescribeSlowLogsRequest, AssignProjectResponse, DescribeDBBackupsRequest, DescribeClientConnectionsRequest, DescribeDBInstanceDealResponse, ModifyDBInstanceSpecResponse, OfflineIsolatedDBInstanceResponse, DescribeBackupDownloadTaskRequest, DescribeBackupAccessRequest, RenameInstanceRequest, DescribeSecurityGroupRequest, RenewDBInstancesResponse, DescribeBackupDownloadTaskResponse, RenameInstanceResponse, DescribeClientConnectionsResponse, FlushInstanceRouterConfigRequest, DescribeDBBackupsResponse, ModifyDBInstanceSpecRequest, CreateDBInstanceHourResponse, CreateBackupDBInstanceRequest, DescribeInstanceParamsRequest, InquirePriceCreateDBInstancesResponse, RenewDBInstancesRequest } from "./mongodb_models";
3
3
  /**
4
4
  * mongodb client
5
5
  * @class
@@ -88,6 +88,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
88
88
  * 本接口(ModifyDBInstanceSpec)用于调整MongoDB云数据库实例配置。接口支持的售卖规格,可从查询云数据库的售卖规格(DescribeSpecInfo)获取。
89
89
  */
90
90
  ModifyDBInstanceSpec(req: ModifyDBInstanceSpecRequest, cb?: (error: string, rep: ModifyDBInstanceSpecResponse) => void): Promise<ModifyDBInstanceSpecResponse>;
91
+ /**
92
+ * 本接口(DescribeInstanceParams)用于查询当前实例可修改的参数列表。
93
+ */
94
+ DescribeInstanceParams(req: DescribeInstanceParamsRequest, cb?: (error: string, rep: DescribeInstanceParamsResponse) => void): Promise<DescribeInstanceParamsResponse>;
91
95
  /**
92
96
  * 本接口(DescribeSpecInfo)用于查询实例的售卖规格。
93
97
  */
@@ -149,6 +149,12 @@ class Client extends TencentCloudCommon.AbstractClient {
149
149
  async ModifyDBInstanceSpec(req, cb) {
150
150
  return this.request("ModifyDBInstanceSpec", req, cb);
151
151
  }
152
+ /**
153
+ * 本接口(DescribeInstanceParams)用于查询当前实例可修改的参数列表。
154
+ */
155
+ async DescribeInstanceParams(req, cb) {
156
+ return this.request("DescribeInstanceParams", req, cb);
157
+ }
152
158
  /**
153
159
  * 本接口(DescribeSpecInfo)用于查询实例的售卖规格。
154
160
  */