tencentcloud-sdk-nodejs-mongodb 4.0.575 → 4.0.577

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.
@@ -52,7 +52,7 @@ class Client extends TencentCloudCommon.AbstractClient {
52
52
  return this.request("DescribeCurrentOp", req, cb);
53
53
  }
54
54
  /**
55
- * 本接口(DescribeClientConnections)用于查询实例客户端连接信息,包括连接IP和连接数量。
55
+ * 本接口(DescribeClientConnections)用于查询实例客户端连接信息,包括连接 IP 和连接数量。
56
56
  */
57
57
  async DescribeClientConnections(req, cb) {
58
58
  return this.request("DescribeClientConnections", req, cb);
@@ -70,7 +70,7 @@ class Client extends TencentCloudCommon.AbstractClient {
70
70
  return this.request("DescribeSecurityGroup", req, cb);
71
71
  }
72
72
  /**
73
- * 本接口(SetAccountUserPrivilege)用于设置mongodb实例的账号权限。
73
+ * 本接口(SetAccountUserPrivilege)用于设置实例的账号权限。
74
74
  */
75
75
  async SetAccountUserPrivilege(req, cb) {
76
76
  return this.request("SetAccountUserPrivilege", req, cb);
@@ -106,7 +106,7 @@ class Client extends TencentCloudCommon.AbstractClient {
106
106
  return this.request("DescribeAsyncRequestInfo", req, cb);
107
107
  }
108
108
  /**
109
- * 本接口(CreateAccountUser)用于创建mongodb实例账号。
109
+ * 本接口(CreateAccountUser)用于自定义实例访问账号。
110
110
  */
111
111
  async CreateAccountUser(req, cb) {
112
112
  return this.request("CreateAccountUser", req, cb);
@@ -172,7 +172,7 @@ class Client extends TencentCloudCommon.AbstractClient {
172
172
  return this.request("ModifyDBInstanceSpec", req, cb);
173
173
  }
174
174
  /**
175
- * 本接口(DescribeInstanceParams)用于查询当前实例可修改的参数列表。
175
+ * 本接口(DescribeInstanceParams)用于查询当前实例可修改的参数列表。
176
176
  */
177
177
  async DescribeInstanceParams(req, cb) {
178
178
  return this.request("DescribeInstanceParams", req, cb);
@@ -203,7 +203,7 @@ class Client extends TencentCloudCommon.AbstractClient {
203
203
  return this.request("AssignProject", req, cb);
204
204
  }
205
205
  /**
206
- * 本接口(DescribeAccountUsers)用于获取当前实例的全部账号。
206
+ * 本接口(DescribeAccountUsers)用于获取当前实例的全部账号。
207
207
  */
208
208
  async DescribeAccountUsers(req, cb) {
209
209
  return this.request("DescribeAccountUsers", req, cb);
@@ -221,7 +221,7 @@ class Client extends TencentCloudCommon.AbstractClient {
221
221
  return this.request("KillOps", req, cb);
222
222
  }
223
223
  /**
224
- * 备份实例接口
224
+ * 本接口(CreateBackupDBInstance)用于备份实例。
225
225
  */
226
226
  async CreateBackupDBInstance(req, cb) {
227
227
  return this.request("CreateBackupDBInstance", req, cb);
@@ -232,6 +232,12 @@ class Client extends TencentCloudCommon.AbstractClient {
232
232
  async InquirePriceRenewDBInstances(req, cb) {
233
233
  return this.request("InquirePriceRenewDBInstances", req, cb);
234
234
  }
235
+ /**
236
+ * 本接口(DeleteAccountUser)用于删除实例的自定义账号。
237
+ */
238
+ async DeleteAccountUser(req, cb) {
239
+ return this.request("DeleteAccountUser", req, cb);
240
+ }
235
241
  /**
236
242
  * 本接口(ModifyDBInstanceSecurityGroup)用于修改实例绑定的安全组
237
243
  */
@@ -150,7 +150,7 @@ export interface DescribeCurrentOpResponse {
150
150
  */
151
151
  export interface DescribeAccountUsersRequest {
152
152
  /**
153
- * 实例ID。
153
+ * 指定待获取账号的实例ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
154
154
  */
155
155
  InstanceId: string;
156
156
  }
@@ -159,9 +159,9 @@ export interface DescribeAccountUsersRequest {
159
159
  */
160
160
  export interface CreateBackupDBInstanceResponse {
161
161
  /**
162
- * 查询备份流程的状态
162
+ * 查询备份流程的状态。
163
163
  */
164
- AsyncRequestId: string;
164
+ AsyncRequestId?: string;
165
165
  /**
166
166
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
167
167
  */
@@ -254,13 +254,45 @@ export interface FlushInstanceRouterConfigResponse {
254
254
  RequestId?: string;
255
255
  }
256
256
  /**
257
- * DescribeSecurityGroup请求参数结构体
257
+ * 实例可修改参数Multi类型集合。
258
258
  */
259
- export interface DescribeSecurityGroupRequest {
259
+ export interface InstanceMultiParam {
260
260
  /**
261
- * 实例 ID。例如:cmgo-p8vn****。
261
+ * 参数当前值。
262
262
  */
263
- InstanceId: string;
263
+ CurrentValue: string;
264
+ /**
265
+ * 参数默认值。
266
+ */
267
+ DefaultValue: string;
268
+ /**
269
+ * 参考值范围。
270
+ */
271
+ EnumValue: Array<string>;
272
+ /**
273
+ * 参数修改后是否需要重启才会生效。
274
+ - 1:需要重启后生效。
275
+ - 0:无需重启,设置成功即可生效。
276
+ */
277
+ NeedRestart: string;
278
+ /**
279
+ * 参数名称。
280
+ */
281
+ ParamName: string;
282
+ /**
283
+ * 是否为运行中参数值。
284
+ - 1:运行中参数值。
285
+ - 0:非运行中参数值。
286
+ */
287
+ Status: number;
288
+ /**
289
+ * 参数说明。
290
+ */
291
+ Tips: Array<string>;
292
+ /**
293
+ * 当前值的类型描述,默认为multi。
294
+ */
295
+ ValueType: string;
264
296
  }
265
297
  /**
266
298
  * 用于描述MongoDB数据库慢日志统计信息
@@ -348,41 +380,13 @@ export interface IsolateDBInstanceResponse {
348
380
  RequestId?: string;
349
381
  }
350
382
  /**
351
- * 实例可修改参数Multi类型集合。
383
+ * DescribeSecurityGroup请求参数结构体
352
384
  */
353
- export interface InstanceMultiParam {
354
- /**
355
- * 当前值
356
- */
357
- CurrentValue: string;
358
- /**
359
- * 默认值
360
- */
361
- DefaultValue: string;
362
- /**
363
- * 指导值范围
364
- */
365
- EnumValue: Array<string>;
366
- /**
367
- * 是否需要重启生效 1:需要重启后生效;0:无需重启,设置成功即可生效;
368
- */
369
- NeedRestart: string;
370
- /**
371
- * 参数名称
372
- */
373
- ParamName: string;
374
- /**
375
- * 是否为运行中参数值 1:运行中参数值;0:非运行中参数值;
376
- */
377
- Status: number;
378
- /**
379
- * 参数说明
380
- */
381
- Tips: Array<string>;
385
+ export interface DescribeSecurityGroupRequest {
382
386
  /**
383
- * 当前值的类型描述,默认为multi
387
+ * 实例 ID。例如:cmgo-p8vn****。
384
388
  */
385
- ValueType: string;
389
+ InstanceId: string;
386
390
  }
387
391
  /**
388
392
  * DescribeBackupDownloadTask返回参数结构体
@@ -428,9 +432,9 @@ export interface DBInstanceInfo {
428
432
  */
429
433
  export interface SetAccountUserPrivilegeResponse {
430
434
  /**
431
- * 设置任务ID,用于查询是否设置完成
435
+ * 任务ID
432
436
  */
433
- FlowId: number;
437
+ FlowId?: number;
434
438
  /**
435
439
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
436
440
  */
@@ -514,21 +518,22 @@ export interface DescribeDBInstanceNodePropertyRequest {
514
518
  Tags?: Array<NodeTag>;
515
519
  }
516
520
  /**
517
- * 需要终止的操作
521
+ * DeleteAccountUser请求参数结构体
518
522
  */
519
- export interface Operation {
523
+ export interface DeleteAccountUserRequest {
520
524
  /**
521
- * 操作所在的分片名
522
- */
523
- ReplicaSetName: string;
525
+ * 指定待删除账号的实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
526
+
527
+ */
528
+ InstanceId: string;
524
529
  /**
525
- * 操作所在的节点名
530
+ * 配置待删除的账号名。
526
531
  */
527
- NodeName: string;
532
+ UserName: string;
528
533
  /**
529
- * 操作序号
534
+ * 配置 mongouser 对应的密码。mongouser为系统默认账号,输入其对应的密码。
530
535
  */
531
- OpId: number;
536
+ MongoUserPassword: string;
532
537
  }
533
538
  /**
534
539
  * mongodb售卖规格
@@ -635,7 +640,7 @@ export interface CreateAccountUserResponse {
635
640
  /**
636
641
  * 创建任务ID。
637
642
  */
638
- FlowId: number;
643
+ FlowId?: number;
639
644
  /**
640
645
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
641
646
  */
@@ -764,7 +769,7 @@ export interface BackupInfo {
764
769
  */
765
770
  export interface DescribeDBInstancesRequest {
766
771
  /**
767
- * 实例ID列表。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
772
+ * 实例 ID 列表。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
768
773
  */
769
774
  InstanceIds?: Array<string>;
770
775
  /**
@@ -939,47 +944,51 @@ export interface ResetDBInstancePasswordRequest {
939
944
  Password: string;
940
945
  }
941
946
  /**
942
- * 实例可修改参数integer类型集合。
947
+ * 实例可修改参数 Integer 类型集合。
943
948
  */
944
949
  export interface InstanceIntegerParam {
945
950
  /**
946
- * 当前值
951
+ * 参数当前值。
947
952
  */
948
953
  CurrentValue: string;
949
954
  /**
950
- * 默认值
955
+ * 参数默认值。
951
956
  */
952
957
  DefaultValue: string;
953
958
  /**
954
- * 最大值
959
+ * 参数最大值。
955
960
  */
956
961
  Max: string;
957
962
  /**
958
- * 最小值
963
+ * 最小值。
959
964
  */
960
965
  Min: string;
961
966
  /**
962
- * 是否需要重启生效 1:需要重启后生效;0:无需重启,设置成功即可生效;
963
- */
967
+ * 参数修改之后是否需要重启生效。
968
+ - 1:需要重启后生效。
969
+ - 0:无需重启,设置成功即可生效。
970
+ */
964
971
  NeedRestart: string;
965
972
  /**
966
- * 参数名称
973
+ * 参数名称。
967
974
  */
968
975
  ParamName: string;
969
976
  /**
970
- * 参数说明
977
+ * 参数说明。
971
978
  */
972
979
  Tips: Array<string>;
973
980
  /**
974
- * 参数类型
981
+ * 参数类型。
975
982
  */
976
983
  ValueType: string;
977
984
  /**
978
- * 是否为运行中参数值 1:运行中参数值;0:非运行中参数值;
979
- */
985
+ * 是否为运行中参数值。
986
+ - 1:运行中参数值。
987
+ - 0:非运行中参数值。
988
+ */
980
989
  Status: number;
981
990
  /**
982
- * 冗余字段,可忽略
991
+ * 冗余字段,可忽略。
983
992
  */
984
993
  Unit: string;
985
994
  }
@@ -1031,7 +1040,7 @@ export interface CreateDBInstanceResponse {
1031
1040
  */
1032
1041
  export interface CreateAccountUserRequest {
1033
1042
  /**
1034
- * 实例 ID。
1043
+ * 实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
1035
1044
  */
1036
1045
  InstanceId: string;
1037
1046
  /**
@@ -1056,40 +1065,42 @@ export interface CreateAccountUserRequest {
1056
1065
  AuthRole?: Array<Auth>;
1057
1066
  }
1058
1067
  /**
1059
- * 实例可修改参数text类型集合。
1068
+ * 实例可修改参数为 Text 类型的参数集合。
1060
1069
  */
1061
1070
  export interface InstanceTextParam {
1062
1071
  /**
1063
- * 当前值
1072
+ * 参数当前值。
1064
1073
  */
1065
1074
  CurrentValue: string;
1066
1075
  /**
1067
- * 默认值
1076
+ * 参数默认值。
1068
1077
  */
1069
1078
  DefaultValue: string;
1070
1079
  /**
1071
- * 是否需要重启
1080
+ * 修改参数值之后是否需要重启。
1072
1081
  */
1073
1082
  NeedRestart: string;
1074
1083
  /**
1075
- * 参数名称
1084
+ * 参数名称。
1076
1085
  */
1077
1086
  ParamName: string;
1078
1087
  /**
1079
- * text类型值
1088
+ * Text 类型参数对应的值。
1080
1089
  */
1081
1090
  TextValue: string;
1082
1091
  /**
1083
- * 参数说明
1092
+ * 参数说明。
1084
1093
  */
1085
1094
  Tips: Array<string>;
1086
1095
  /**
1087
- * 值类型说明
1096
+ * 参数值类型说明。
1088
1097
  */
1089
1098
  ValueType: string;
1090
1099
  /**
1091
- * 是否为运行中参数值 1:运行中参数值;0:非运行中参数值;
1092
- */
1100
+ * 是否为运行中的参数值。
1101
+ - 1:运行中参数值。
1102
+ - 0:非运行中参数值。
1103
+ */
1093
1104
  Status: string;
1094
1105
  }
1095
1106
  /**
@@ -1112,7 +1123,7 @@ export interface DescribeAccountUsersResponse {
1112
1123
  /**
1113
1124
  * 实例账号列表。
1114
1125
  */
1115
- Users: Array<UserInfo>;
1126
+ Users?: Array<UserInfo>;
1116
1127
  /**
1117
1128
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1118
1129
  */
@@ -1159,18 +1170,35 @@ export interface DescribeBackupDownloadTaskRequest {
1159
1170
  */
1160
1171
  Status?: Array<number>;
1161
1172
  }
1173
+ /**
1174
+ * 需要终止的操作
1175
+ */
1176
+ export interface Operation {
1177
+ /**
1178
+ * 操作所在的分片名
1179
+ */
1180
+ ReplicaSetName: string;
1181
+ /**
1182
+ * 操作所在的节点名
1183
+ */
1184
+ NodeName: string;
1185
+ /**
1186
+ * 操作序号
1187
+ */
1188
+ OpId: number;
1189
+ }
1162
1190
  /**
1163
1191
  * DescribeClientConnections返回参数结构体
1164
1192
  */
1165
1193
  export interface DescribeClientConnectionsResponse {
1166
1194
  /**
1167
- * 客户端连接信息,包括客户端IP和对应IP的连接数量。
1195
+ * 客户端连接信息,包括客户端 IP 和对应 IP 的连接数量。
1168
1196
  */
1169
- Clients: Array<ClientConnection>;
1197
+ Clients?: Array<ClientConnection>;
1170
1198
  /**
1171
1199
  * 满足条件的记录总条数,可用于分页查询。
1172
1200
  */
1173
- TotalCount: number;
1201
+ TotalCount?: number;
1174
1202
  /**
1175
1203
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1176
1204
  */
@@ -1241,7 +1269,7 @@ export interface UserInfo {
1241
1269
  */
1242
1270
  export interface DescribeInstanceParamsRequest {
1243
1271
  /**
1244
- * 实例ID
1272
+ * 指定待查询参数列表的实例ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
1245
1273
  */
1246
1274
  InstanceId: string;
1247
1275
  }
@@ -1591,15 +1619,16 @@ export interface DescribeDBBackupsRequest {
1591
1619
  */
1592
1620
  export interface DescribeClientConnectionsRequest {
1593
1621
  /**
1594
- * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1595
- */
1622
+ * 指定待查询的实例ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
1623
+
1624
+ */
1596
1625
  InstanceId: string;
1597
1626
  /**
1598
- * 单次请求返回的数量,最小值为1,最大值为1000,默认值为1000。
1627
+ * 单次请求返回的数量。最小值为1,最大值为1000,默认值为1000。
1599
1628
  */
1600
1629
  Limit?: number;
1601
1630
  /**
1602
- * 偏移量,默认值为0。
1631
+ * 偏移量,默认值为0。Offset=Limit*(页码-1)。
1603
1632
  */
1604
1633
  Offset?: number;
1605
1634
  }
@@ -1676,36 +1705,40 @@ export interface RenewDBInstancesResponse {
1676
1705
  */
1677
1706
  export interface InstanceEnumParam {
1678
1707
  /**
1679
- * 参数当前值
1708
+ * 参数当前值。
1680
1709
  */
1681
1710
  CurrentValue: string;
1682
1711
  /**
1683
- * 默认值
1712
+ * 参数默认值。
1684
1713
  */
1685
1714
  DefaultValue: string;
1686
1715
  /**
1687
- * 枚举值,所有支持的值
1716
+ * 枚举值,所有支持的值。
1688
1717
  */
1689
1718
  EnumValue: Array<string>;
1690
1719
  /**
1691
- * 是否需要重启生效 1:需要重启后生效;0:无需重启,设置成功即可生效;
1692
- */
1720
+ * 参数修改之后是否需要重启生效。
1721
+ - 1:需要重启后生效。
1722
+ - 0:无需重启,设置成功即可生效。
1723
+ */
1693
1724
  NeedRestart: string;
1694
1725
  /**
1695
- * 参数名称
1726
+ * 参数名称。
1696
1727
  */
1697
1728
  ParamName: string;
1698
1729
  /**
1699
- * 中英文说明
1730
+ * 参数说明。
1700
1731
  */
1701
1732
  Tips: Array<string>;
1702
1733
  /**
1703
- * 参数值类型说明
1734
+ * 参数值类型说明。
1704
1735
  */
1705
1736
  ValueType: string;
1706
1737
  /**
1707
- * 是否为运行中参数值 1:运行中参数值;0:非运行中参数值;
1708
- */
1738
+ * 是否为运行中参数值。
1739
+ - 1:运行中参数值。
1740
+ - 0:非运行中参数值。
1741
+ */
1709
1742
  Status: number;
1710
1743
  }
1711
1744
  /**
@@ -1722,15 +1755,17 @@ export interface RenameInstanceResponse {
1722
1755
  */
1723
1756
  export interface CreateBackupDBInstanceRequest {
1724
1757
  /**
1725
- * 实例id
1758
+ * 实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
1726
1759
  */
1727
1760
  InstanceId: string;
1728
1761
  /**
1729
- * 0-逻辑备份,1-物理备份
1730
- */
1762
+ * 设置备份方式。
1763
+ - 0:逻辑备份。
1764
+ - 1:物理备份。
1765
+ */
1731
1766
  BackupMethod: number;
1732
1767
  /**
1733
- * 备份备注
1768
+ * 备份备注信息。
1734
1769
  */
1735
1770
  BackupRemark?: string;
1736
1771
  }
@@ -1739,15 +1774,15 @@ export interface CreateBackupDBInstanceRequest {
1739
1774
  */
1740
1775
  export interface SetAccountUserPrivilegeRequest {
1741
1776
  /**
1742
- * 实例ID。
1777
+ * 指定待设置账号的实例ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
1743
1778
  */
1744
1779
  InstanceId: string;
1745
1780
  /**
1746
- * 账号名称。
1781
+ * 设置账号名称。
1747
1782
  */
1748
1783
  UserName: string;
1749
1784
  /**
1750
- * 权限信息。
1785
+ * 设置权限信息。
1751
1786
  */
1752
1787
  AuthRole: Array<Auth>;
1753
1788
  }
@@ -2086,6 +2121,19 @@ export interface TagInfo {
2086
2121
  */
2087
2122
  TagValue: string;
2088
2123
  }
2124
+ /**
2125
+ * DeleteAccountUser返回参数结构体
2126
+ */
2127
+ export interface DeleteAccountUserResponse {
2128
+ /**
2129
+ * 账户删除任务ID。
2130
+ */
2131
+ FlowId?: number;
2132
+ /**
2133
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2134
+ */
2135
+ RequestId?: string;
2136
+ }
2089
2137
  /**
2090
2138
  * DescribeDBInstances返回参数结构体
2091
2139
  */
@@ -2190,25 +2238,25 @@ export interface InquirePriceCreateDBInstancesRequest {
2190
2238
  */
2191
2239
  export interface DescribeInstanceParamsResponse {
2192
2240
  /**
2193
- * 值为枚举类型参数集合
2241
+ * 参数值为枚举类型参数集合。
2194
2242
  */
2195
- InstanceEnumParam: Array<InstanceEnumParam>;
2243
+ InstanceEnumParam?: Array<InstanceEnumParam>;
2196
2244
  /**
2197
- * 值为integer类型参数集合
2245
+ * 参数值为 Integer 类型参数集合。
2198
2246
  */
2199
- InstanceIntegerParam: Array<InstanceIntegerParam>;
2247
+ InstanceIntegerParam?: Array<InstanceIntegerParam>;
2200
2248
  /**
2201
- * 值为text类型的参数集合
2249
+ * 参数值为 Text 类型的参数集合。
2202
2250
  */
2203
- InstanceTextParam: Array<InstanceTextParam>;
2251
+ InstanceTextParam?: Array<InstanceTextParam>;
2204
2252
  /**
2205
- * 值为混合类型的参数集合
2253
+ * 参数值为混合类型的参数集合。
2206
2254
  */
2207
- InstanceMultiParam: Array<InstanceMultiParam>;
2255
+ InstanceMultiParam?: Array<InstanceMultiParam>;
2208
2256
  /**
2209
2257
  * 当前实例支持修改的参数个数统计 如0
2210
2258
  */
2211
- TotalCount: number;
2259
+ TotalCount?: number;
2212
2260
  /**
2213
2261
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2214
2262
  */