@alicloud/dds20151201 7.0.1 → 7.1.1

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.
package/src/client.ts CHANGED
@@ -422,6 +422,7 @@ export class CheckRecoveryConditionRequest extends $tea.Model {
422
422
  * cn-hangzhou
423
423
  */
424
424
  destRegion?: string;
425
+ engineVersion?: string;
425
426
  /**
426
427
  * @remarks
427
428
  * The instance architecture. Valid values:
@@ -496,6 +497,7 @@ export class CheckRecoveryConditionRequest extends $tea.Model {
496
497
  backupId: 'BackupId',
497
498
  databaseNames: 'DatabaseNames',
498
499
  destRegion: 'DestRegion',
500
+ engineVersion: 'EngineVersion',
499
501
  instanceType: 'InstanceType',
500
502
  ownerAccount: 'OwnerAccount',
501
503
  ownerId: 'OwnerId',
@@ -514,6 +516,7 @@ export class CheckRecoveryConditionRequest extends $tea.Model {
514
516
  backupId: 'string',
515
517
  databaseNames: 'string',
516
518
  destRegion: 'string',
519
+ engineVersion: 'string',
517
520
  instanceType: 'string',
518
521
  ownerAccount: 'string',
519
522
  ownerId: 'number',
@@ -982,7 +985,7 @@ export class CreateDBInstanceRequest extends $tea.Model {
982
985
  encryptionKey?: string;
983
986
  /**
984
987
  * @remarks
985
- * The database engine of the instance. The value is fixed as **MongoDB**.
988
+ * The database engine of the instance. Set the value to **MongoDB**.
986
989
  *
987
990
  * @example
988
991
  * MongoDB
@@ -1126,6 +1129,17 @@ export class CreateDBInstanceRequest extends $tea.Model {
1126
1129
  * 2022-03-13T12:11:14Z
1127
1130
  */
1128
1131
  restoreTime?: string;
1132
+ /**
1133
+ * @remarks
1134
+ * The backup restore type of the instance.
1135
+ * - 0: restore an instance to the specified backup set.
1136
+ * - 1: restore an instance to the specified time.
1137
+ * - 2: restore an released instance to the specified backup set.
1138
+ * - 3:restore an instance to the specified cross-regional backup set.
1139
+ *
1140
+ * @example
1141
+ * 0
1142
+ */
1129
1143
  restoreType?: string;
1130
1144
  /**
1131
1145
  * @remarks
@@ -1182,17 +1196,22 @@ export class CreateDBInstanceRequest extends $tea.Model {
1182
1196
  * dds-bp1ee12ad351****
1183
1197
  */
1184
1198
  srcDBInstanceId?: string;
1185
- srcRegion?: string;
1186
1199
  /**
1187
1200
  * @remarks
1188
- * The storage engine of the instance. Default value: WiredTiger. Valid values:
1201
+ * The region ID of the instance.
1202
+ *
1203
+ * > - This parameter is required when restore type is set to 2 or 3.
1189
1204
  *
1190
- * * **WiredTiger**
1191
- * * **RocksDB**
1192
- * * **TerarkDB**
1205
+ * @example
1206
+ * 2
1207
+ */
1208
+ srcRegion?: string;
1209
+ /**
1210
+ * @remarks
1211
+ * The storage engine of the instance. Set the value to **WiredTiger**.
1193
1212
  *
1194
- * > * When you call this operation to clone an instance or restore an instance from the recycle bin, set the value of this parameter to the storage engine of the source instance.
1195
- * > * For more information about the limits on database versions and storage engines, see [MongoDB versions and storage engines](https://help.aliyun.com/document_detail/61906.html).
1213
+ * > * If you call this operation to clone an instance or restore an instance from the recycle bin, set this parameter to the storage engine of the source instance.
1214
+ * > * For more information about the limits on database versions and storage engines of an instance, see [MongoDB versions and storage engines](https://help.aliyun.com/document_detail/61906.html).
1196
1215
  *
1197
1216
  * @example
1198
1217
  * WiredTiger
@@ -2051,6 +2070,15 @@ export class CreateShardingDBInstanceRequest extends $tea.Model {
2051
2070
  * true
2052
2071
  */
2053
2072
  autoRenew?: string;
2073
+ /**
2074
+ * @remarks
2075
+ * The ID of the backup set.
2076
+ *
2077
+ * > When you call this operation to clone an instance based on the backup set, this parameter is required. The **SrcDBInstanceId** parameter is also required.
2078
+ *
2079
+ * @example
2080
+ * cb-xxx
2081
+ */
2054
2082
  backupId?: string;
2055
2083
  /**
2056
2084
  * @remarks
@@ -2059,7 +2087,7 @@ export class CreateShardingDBInstanceRequest extends $tea.Model {
2059
2087
  * * **PostPaid** (default): pay-as-you-go
2060
2088
  * * **PrePaid**: subscription
2061
2089
  *
2062
- * > If you set this parameter to **PrePaid**, you must also specify the **Period** parameter.
2090
+ * > If this parameter is set to **PrePaid**, you must also configure the **Period** parameter.
2063
2091
  *
2064
2092
  * @example
2065
2093
  * PrePaid
@@ -2092,10 +2120,19 @@ export class CreateShardingDBInstanceRequest extends $tea.Model {
2092
2120
  * test
2093
2121
  */
2094
2122
  DBInstanceDescription?: string;
2123
+ /**
2124
+ * @remarks
2125
+ * The region of the backup set used for the cross-region backup and restoration.
2126
+ *
2127
+ * > This parameter is required when you set the RestoreType parameter to 3.
2128
+ *
2129
+ * @example
2130
+ * cn-hangzhou
2131
+ */
2095
2132
  destRegion?: string;
2096
2133
  /**
2097
2134
  * @remarks
2098
- * Specifies whether to enable disk encryption.
2135
+ * Indicates whether disk encryption is enabled.
2099
2136
  *
2100
2137
  * @example
2101
2138
  * true
@@ -2121,17 +2158,17 @@ export class CreateShardingDBInstanceRequest extends $tea.Model {
2121
2158
  engine?: string;
2122
2159
  /**
2123
2160
  * @remarks
2124
- * The version of the database engine. Valid values:
2161
+ * The database engine version of the instance. Valid values:
2125
2162
  *
2163
+ * * **7.0**
2126
2164
  * * **6.0**
2127
2165
  * * **5.0**
2128
2166
  * * **4.4**
2129
2167
  * * **4.2**
2130
2168
  * * **4.0**
2131
- * * **3.4**
2132
2169
  *
2133
- * > * For more information about the limits on database versions and storage engines, see [MongoDB versions and storage engines](https://help.aliyun.com/document_detail/61906.html).
2134
- * > * If you call this operation to clone an instance, set the value of this parameter to the engine version of the source instance.
2170
+ * > * For more information about the limits on database versions and storage engines, see [MongoDB versions and storage engines](https://help.aliyun.com/document_detail/61906.html).
2171
+ * > * If you call this operation to clone an instance, set the value of this parameter to the database engine version of the source instance.
2135
2172
  *
2136
2173
  * This parameter is required.
2137
2174
  *
@@ -2187,7 +2224,9 @@ export class CreateShardingDBInstanceRequest extends $tea.Model {
2187
2224
  mongos?: CreateShardingDBInstanceRequestMongos[];
2188
2225
  /**
2189
2226
  * @remarks
2190
- * The network type of the instance. Set the value to VPC.
2227
+ * The network type of the instance.
2228
+ *
2229
+ * Set the value to **VPC**.
2191
2230
  *
2192
2231
  * @example
2193
2232
  * VPC
@@ -2211,8 +2250,8 @@ export class CreateShardingDBInstanceRequest extends $tea.Model {
2211
2250
  * @remarks
2212
2251
  * The access protocol type of the instance. Valid values:
2213
2252
  *
2214
- * * **mongodb**: the MongoDB protocol
2215
- * * **dynamodb**: the DynamoDB protocol
2253
+ * * **mongodb**
2254
+ * * **dynamodb**
2216
2255
  *
2217
2256
  * @example
2218
2257
  * mongodb
@@ -2263,6 +2302,16 @@ export class CreateShardingDBInstanceRequest extends $tea.Model {
2263
2302
  * 2022-03-08T02:30:25Z
2264
2303
  */
2265
2304
  restoreTime?: string;
2305
+ /**
2306
+ * @remarks
2307
+ * The backup restore type of the instance.
2308
+ * - 1: restore an instance to the specified time.
2309
+ * - 2: restore an released instance to the specified backup set.
2310
+ * - 3:restore an instance to the specified cross-regional backup set.
2311
+ *
2312
+ * @example
2313
+ * 1
2314
+ */
2266
2315
  restoreType?: string;
2267
2316
  /**
2268
2317
  * @remarks
@@ -2320,13 +2369,22 @@ export class CreateShardingDBInstanceRequest extends $tea.Model {
2320
2369
  * dds-bp11483712c1****
2321
2370
  */
2322
2371
  srcDBInstanceId?: string;
2372
+ /**
2373
+ * @remarks
2374
+ * The region ID of the instance.
2375
+ *
2376
+ * > This parameter is required when restore type is set to 2 or 3.
2377
+ *
2378
+ * @example
2379
+ * cn-beijing
2380
+ */
2323
2381
  srcRegion?: string;
2324
2382
  /**
2325
2383
  * @remarks
2326
2384
  * The storage engine of the instance. Set the value to **WiredTiger**.
2327
2385
  *
2328
- * > * If you call this operation to clone an instance, set the value of this parameter to the storage engine of the source instance.
2329
- * > * For more information about the limits on database versions and storage engines, see [MongoDB versions and storage engines](https://help.aliyun.com/document_detail/61906.html).
2386
+ * > * If you call this operation to clone an instance, set the value of this parameter to the storage engine of the source instance.
2387
+ * > * For more information about the limits on database versions and storage engines, see [MongoDB versions and storage engines](https://help.aliyun.com/document_detail/61906.html).
2330
2388
  *
2331
2389
  * @example
2332
2390
  * WiredTiger
@@ -4703,12 +4761,29 @@ export class DescribeBackupPolicyRequest extends $tea.Model {
4703
4761
  * dds-bp16cb162771****
4704
4762
  */
4705
4763
  DBInstanceId?: string;
4764
+ /**
4765
+ * @remarks
4766
+ * The architecture of the instance. Valid values:
4767
+ *
4768
+ * * **sharding**: sharded cluster instance
4769
+ * * **replicate**: replica set or standalone instance
4770
+ *
4771
+ * @example
4772
+ * sharding
4773
+ */
4706
4774
  instanceType?: string;
4707
4775
  ownerAccount?: string;
4708
4776
  ownerId?: number;
4709
4777
  resourceOwnerAccount?: string;
4710
4778
  resourceOwnerId?: number;
4711
4779
  securityToken?: string;
4780
+ /**
4781
+ * @remarks
4782
+ * The region ID of the instance.
4783
+ *
4784
+ * @example
4785
+ * cn-beijing
4786
+ */
4712
4787
  srcRegion?: string;
4713
4788
  static names(): { [key: string]: string } {
4714
4789
  return {
@@ -4769,12 +4844,82 @@ export class DescribeBackupPolicyResponseBody extends $tea.Model {
4769
4844
  * 30
4770
4845
  */
4771
4846
  backupRetentionPeriod?: string;
4847
+ /**
4848
+ * @remarks
4849
+ * The backup retention policy configured for the instance. Valid values:
4850
+ *
4851
+ * 1. 0: All backup sets are immediately deleted when the instance is released.
4852
+ * 2. 1: Automatic backup is performed and the backup set is retained for a long period of time when the instance is released.
4853
+ * 3. 2: Automatic backup is performed and all backup sets are retained for a long period of time when the instance is released.
4854
+ *
4855
+ * For more information, see [Retain the backup files of an ApsaraDB for MongoDB instance for a long period of time](https://help.aliyun.com/document_detail/2779111.html).
4856
+ *
4857
+ * @example
4858
+ * 0
4859
+ */
4772
4860
  backupRetentionPolicyOnClusterDeletion?: number;
4861
+ /**
4862
+ * @remarks
4863
+ * The retention period of Cross-regional backup.
4864
+ * Valid values:
4865
+ *
4866
+ * * **Monday**
4867
+ * * **Tuesday**
4868
+ * * **Wednesday**
4869
+ * * **Thursday**
4870
+ * * **Friday**
4871
+ * * **Saturday**
4872
+ * * **Sunday**
4873
+ *
4874
+ * @example
4875
+ * Monday
4876
+ */
4773
4877
  crossBackupPeriod?: string;
4878
+ /**
4879
+ * @remarks
4880
+ * The retention type of Cross-regional log backup.
4881
+ *
4882
+ * - delay : retain the backup for a period of time.
4883
+ * - never : retain the backup permanently.
4884
+ *
4885
+ * @example
4886
+ * delay
4887
+ */
4774
4888
  crossLogRetentionType?: string;
4889
+ /**
4890
+ * @remarks
4891
+ * The retention time of Cross-regional log backup.
4892
+ *
4893
+ * @example
4894
+ * 7
4895
+ */
4775
4896
  crossLogRetentionValue?: number;
4897
+ /**
4898
+ * @remarks
4899
+ * The retention type of Cross-regional backup.
4900
+ *
4901
+ * - delay : retain the backup for a period of time.
4902
+ * - never : retain the backup permanently.
4903
+ *
4904
+ * @example
4905
+ * delay
4906
+ */
4776
4907
  crossRetentionType?: string;
4908
+ /**
4909
+ * @remarks
4910
+ * The retention time of Cross-regional backup.
4911
+ *
4912
+ * @example
4913
+ * 7
4914
+ */
4777
4915
  crossRetentionValue?: number;
4916
+ /**
4917
+ * @remarks
4918
+ * The region ID of the cross-regional backup..
4919
+ *
4920
+ * @example
4921
+ * cn-shenzhen
4922
+ */
4778
4923
  destRegion?: string;
4779
4924
  /**
4780
4925
  * @remarks
@@ -4787,6 +4932,15 @@ export class DescribeBackupPolicyResponseBody extends $tea.Model {
4787
4932
  * 1
4788
4933
  */
4789
4934
  enableBackupLog?: number;
4935
+ /**
4936
+ * @remarks
4937
+ * Whether to turn on cross-regional log backup.
4938
+ * - 1: turn on . Used for sharded cluster.
4939
+ * - 0: turn off. Used for replicate set.
4940
+ *
4941
+ * @example
4942
+ * 1
4943
+ */
4790
4944
  enableCrossLogBackup?: number;
4791
4945
  /**
4792
4946
  * @remarks
@@ -4828,6 +4982,13 @@ export class DescribeBackupPolicyResponseBody extends $tea.Model {
4828
4982
  * 09:00Z-10:00Z
4829
4983
  */
4830
4984
  preferredBackupTime?: string;
4985
+ /**
4986
+ * @remarks
4987
+ * The time of next standard backup.
4988
+ *
4989
+ * @example
4990
+ * 2024-06-19T19:11Z
4991
+ */
4831
4992
  preferredNextBackupTime?: string;
4832
4993
  /**
4833
4994
  * @remarks
@@ -4848,6 +5009,13 @@ export class DescribeBackupPolicyResponseBody extends $tea.Model {
4848
5009
  * Standard
4849
5010
  */
4850
5011
  snapshotBackupType?: string;
5012
+ /**
5013
+ * @remarks
5014
+ * The region ID of the instance.
5015
+ *
5016
+ * @example
5017
+ * cn-hangzhou
5018
+ */
4851
5019
  srcRegion?: string;
4852
5020
  static names(): { [key: string]: string } {
4853
5021
  return {
@@ -5208,6 +5376,15 @@ export class DescribeBackupsRequest extends $tea.Model {
5208
5376
  * dds-bp1a7009eb24****
5209
5377
  */
5210
5378
  DBInstanceId?: string;
5379
+ /**
5380
+ * @remarks
5381
+ * The region ID of the Cross-regional backup.
5382
+ *
5383
+ * > This parameter is required for the Cross-regional backup.
5384
+ *
5385
+ * @example
5386
+ * cn-hangzhou
5387
+ */
5211
5388
  destRegion?: string;
5212
5389
  /**
5213
5390
  * @remarks
@@ -5231,7 +5408,7 @@ export class DescribeBackupsRequest extends $tea.Model {
5231
5408
  ownerId?: number;
5232
5409
  /**
5233
5410
  * @remarks
5234
- * The page number of the page to return.
5411
+ * The number of the page to return. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: **1**.
5235
5412
  *
5236
5413
  * @example
5237
5414
  * 1
@@ -5239,7 +5416,7 @@ export class DescribeBackupsRequest extends $tea.Model {
5239
5416
  pageNumber?: number;
5240
5417
  /**
5241
5418
  * @remarks
5242
- * The number of entries to return on each page. Valid values:
5419
+ * The number of entries to return per page. Valid values:
5243
5420
  *
5244
5421
  * * **30** (default)
5245
5422
  * * **50**
@@ -5251,6 +5428,16 @@ export class DescribeBackupsRequest extends $tea.Model {
5251
5428
  pageSize?: number;
5252
5429
  resourceOwnerAccount?: string;
5253
5430
  resourceOwnerId?: number;
5431
+ /**
5432
+ * @remarks
5433
+ * The region ID of the instance.
5434
+ *
5435
+ * >- This parameter is required if you want to query the backup sets of a released instance.
5436
+ * >- This parameter is required if you want to query cross-region backups.
5437
+ *
5438
+ * @example
5439
+ * cn-beijing
5440
+ */
5254
5441
  srcRegion?: string;
5255
5442
  /**
5256
5443
  * @remarks
@@ -5727,7 +5914,7 @@ export class DescribeDBInstanceAttributeRequest extends $tea.Model {
5727
5914
  DBInstanceId?: string;
5728
5915
  /**
5729
5916
  * @remarks
5730
- * The database engine of the instance. Set the value to **MongoDB**.
5917
+ * The database engine. Set the value to **MongoDB**.
5731
5918
  *
5732
5919
  * @example
5733
5920
  * MongoDB
@@ -5735,10 +5922,10 @@ export class DescribeDBInstanceAttributeRequest extends $tea.Model {
5735
5922
  engine?: string;
5736
5923
  /**
5737
5924
  * @remarks
5738
- * Specifies whether to delete the instance. Valid values:
5925
+ * Specifies whether to query instances that are deleted. Valid values:
5739
5926
  *
5740
- * - **false**: queries the details of running instances.
5741
- * - **true**: queries the details of deleted instances.
5927
+ * * **false**: queries instances that are running.
5928
+ * * **true**: queries instance that are deleted.
5742
5929
  *
5743
5930
  * @example
5744
5931
  * false
@@ -5795,7 +5982,7 @@ export class DescribeDBInstanceAttributeRequest extends $tea.Model {
5795
5982
  export class DescribeDBInstanceAttributeResponseBody extends $tea.Model {
5796
5983
  /**
5797
5984
  * @remarks
5798
- * The information of the instance.
5985
+ * The instance details.
5799
5986
  */
5800
5987
  DBInstances?: DescribeDBInstanceAttributeResponseBodyDBInstances;
5801
5988
  /**
@@ -10109,6 +10296,170 @@ export class DescribeReplicaSetRoleResponse extends $tea.Model {
10109
10296
  }
10110
10297
  }
10111
10298
 
10299
+ export class DescribeRestoreDBInstanceListRequest extends $tea.Model {
10300
+ /**
10301
+ * @remarks
10302
+ * Find instances created after the specified time, formatted as <i>yyyy-MM-dd</i>T<i>HH:00:00</i>Z (UTC time).
10303
+ *
10304
+ * >
10305
+ * > - The time must be on the hour.
10306
+ * > - The time cannot be earlier than 7 days before the current time.
10307
+ *
10308
+ * This parameter is required.
10309
+ *
10310
+ * @example
10311
+ * 2024-07-24T14:00:00Z
10312
+ */
10313
+ creationTimeAfter?: string;
10314
+ /**
10315
+ * @remarks
10316
+ * The instance ID.
10317
+ *
10318
+ * This parameter is required.
10319
+ *
10320
+ * @example
10321
+ * dds-bp114f14849d****
10322
+ */
10323
+ DBInstanceId?: string;
10324
+ ownerAccount?: string;
10325
+ ownerId?: number;
10326
+ /**
10327
+ * @remarks
10328
+ * The page number.
10329
+ *
10330
+ * @example
10331
+ * 1
10332
+ */
10333
+ pageNumber?: number;
10334
+ /**
10335
+ * @remarks
10336
+ * The number of entries returned per page.
10337
+ *
10338
+ * @example
10339
+ * 30
10340
+ */
10341
+ pageSize?: number;
10342
+ resourceOwnerAccount?: string;
10343
+ resourceOwnerId?: number;
10344
+ static names(): { [key: string]: string } {
10345
+ return {
10346
+ creationTimeAfter: 'CreationTimeAfter',
10347
+ DBInstanceId: 'DBInstanceId',
10348
+ ownerAccount: 'OwnerAccount',
10349
+ ownerId: 'OwnerId',
10350
+ pageNumber: 'PageNumber',
10351
+ pageSize: 'PageSize',
10352
+ resourceOwnerAccount: 'ResourceOwnerAccount',
10353
+ resourceOwnerId: 'ResourceOwnerId',
10354
+ };
10355
+ }
10356
+
10357
+ static types(): { [key: string]: any } {
10358
+ return {
10359
+ creationTimeAfter: 'string',
10360
+ DBInstanceId: 'string',
10361
+ ownerAccount: 'string',
10362
+ ownerId: 'number',
10363
+ pageNumber: 'number',
10364
+ pageSize: 'number',
10365
+ resourceOwnerAccount: 'string',
10366
+ resourceOwnerId: 'number',
10367
+ };
10368
+ }
10369
+
10370
+ constructor(map?: { [key: string]: any }) {
10371
+ super(map);
10372
+ }
10373
+ }
10374
+
10375
+ export class DescribeRestoreDBInstanceListResponseBody extends $tea.Model {
10376
+ /**
10377
+ * @remarks
10378
+ * DB instances list.
10379
+ */
10380
+ DBInstances?: DescribeRestoreDBInstanceListResponseBodyDBInstances;
10381
+ /**
10382
+ * @remarks
10383
+ * The page number.
10384
+ *
10385
+ * @example
10386
+ * 1
10387
+ */
10388
+ pageNumber?: number;
10389
+ /**
10390
+ * @remarks
10391
+ * The number of entries returned per page.
10392
+ *
10393
+ * @example
10394
+ * 30
10395
+ */
10396
+ pageSize?: number;
10397
+ /**
10398
+ * @remarks
10399
+ * The request ID.
10400
+ *
10401
+ * @example
10402
+ * 1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx
10403
+ */
10404
+ requestId?: string;
10405
+ /**
10406
+ * @remarks
10407
+ * The number of instances in the query results.
10408
+ *
10409
+ * @example
10410
+ * 5
10411
+ */
10412
+ totalCount?: number;
10413
+ static names(): { [key: string]: string } {
10414
+ return {
10415
+ DBInstances: 'DBInstances',
10416
+ pageNumber: 'PageNumber',
10417
+ pageSize: 'PageSize',
10418
+ requestId: 'RequestId',
10419
+ totalCount: 'TotalCount',
10420
+ };
10421
+ }
10422
+
10423
+ static types(): { [key: string]: any } {
10424
+ return {
10425
+ DBInstances: DescribeRestoreDBInstanceListResponseBodyDBInstances,
10426
+ pageNumber: 'number',
10427
+ pageSize: 'number',
10428
+ requestId: 'string',
10429
+ totalCount: 'number',
10430
+ };
10431
+ }
10432
+
10433
+ constructor(map?: { [key: string]: any }) {
10434
+ super(map);
10435
+ }
10436
+ }
10437
+
10438
+ export class DescribeRestoreDBInstanceListResponse extends $tea.Model {
10439
+ headers?: { [key: string]: string };
10440
+ statusCode?: number;
10441
+ body?: DescribeRestoreDBInstanceListResponseBody;
10442
+ static names(): { [key: string]: string } {
10443
+ return {
10444
+ headers: 'headers',
10445
+ statusCode: 'statusCode',
10446
+ body: 'body',
10447
+ };
10448
+ }
10449
+
10450
+ static types(): { [key: string]: any } {
10451
+ return {
10452
+ headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
10453
+ statusCode: 'number',
10454
+ body: DescribeRestoreDBInstanceListResponseBody,
10455
+ };
10456
+ }
10457
+
10458
+ constructor(map?: { [key: string]: any }) {
10459
+ super(map);
10460
+ }
10461
+ }
10462
+
10112
10463
  export class DescribeRoleZoneInfoRequest extends $tea.Model {
10113
10464
  /**
10114
10465
  * @remarks
@@ -10762,7 +11113,7 @@ export class DescribeShardingNetworkAddressResponseBody extends $tea.Model {
10762
11113
  compatibleConnections?: DescribeShardingNetworkAddressResponseBodyCompatibleConnections;
10763
11114
  /**
10764
11115
  * @remarks
10765
- * The endpoints of ApsaraDB for MongoDB instances.
11116
+ * The endpoints of the ApsaraDB for MongoDB sharded cluster instance.
10766
11117
  */
10767
11118
  networkAddresses?: DescribeShardingNetworkAddressResponseBodyNetworkAddresses;
10768
11119
  /**
@@ -11886,11 +12237,25 @@ export class MigrateAvailableZoneRequest extends $tea.Model {
11886
12237
  * Immediately
11887
12238
  */
11888
12239
  effectiveTime?: string;
12240
+ /**
12241
+ * @remarks
12242
+ * The ID of the destination hidden zone.
12243
+ *
12244
+ * @example
12245
+ * cn-shanghai-n
12246
+ */
11889
12247
  hiddenZoneId?: string;
11890
12248
  ownerAccount?: string;
11891
12249
  ownerId?: number;
11892
12250
  resourceOwnerAccount?: string;
11893
12251
  resourceOwnerId?: number;
12252
+ /**
12253
+ * @remarks
12254
+ * The ID of the destination secondary zone.
12255
+ *
12256
+ * @example
12257
+ * cn-hangzhou-h
12258
+ */
11894
12259
  secondaryZoneId?: string;
11895
12260
  /**
11896
12261
  * @remarks
@@ -12658,7 +13023,7 @@ export class ModifyAuditPolicyResponse extends $tea.Model {
12658
13023
  export class ModifyBackupPolicyRequest extends $tea.Model {
12659
13024
  /**
12660
13025
  * @remarks
12661
- * The frequency at which high-frequency backup is created. Valid values:
13026
+ * The frequency at which high-frequency backups are generated. Valid values:
12662
13027
  *
12663
13028
  * * **-1**: High-frequency backup is disabled.
12664
13029
  * * **30**: High-frequency backups are generated every 30 minutes.
@@ -12672,9 +13037,9 @@ export class ModifyBackupPolicyRequest extends $tea.Model {
12672
13037
  *
12673
13038
  * >
12674
13039
  *
12675
- * * If the **SnapshotBackupType** parameter is set to **Standard**, this parameter is set to -1 and cannot be changed.
13040
+ * * If you set the **SnapshotBackupType** parameter to **Standard**, you must fix the value of this parameter to -1.
12676
13041
  *
12677
- * * High-frequency backup takes effect only when the **SnapshotBackupType** parameter is set to **Flash** and the value of this parameter is greater than 0.
13042
+ * * High-frequency backup takes effect only when you set the **SnapshotBackupType** parameter to **Flash** and this parameter to a value greater than 0.
12678
13043
  *
12679
13044
  * @example
12680
13045
  * -1
@@ -12694,12 +13059,95 @@ export class ModifyBackupPolicyRequest extends $tea.Model {
12694
13059
  * 30
12695
13060
  */
12696
13061
  backupRetentionPeriod?: number;
13062
+ /**
13063
+ * @remarks
13064
+ * The backup retention policy configured for the instance. Valid values:
13065
+ *
13066
+ * 1. 0: All backup sets are immediately deleted when the instance is released.
13067
+ * 2. 1: Automatic backup is performed and the backup set is retained for a long period of time when the instance is released.
13068
+ * 3. 2: Automatic backup is performed and all backup sets are retained for a long period of time when the instance is released.
13069
+ *
13070
+ * For more information, see [Retain the backup files of an ApsaraDB for MongoDB instance for a long period of time](https://help.aliyun.com/document_detail/4920562.html).
13071
+ *
13072
+ * @example
13073
+ * 2
13074
+ */
12697
13075
  backupRetentionPolicyOnClusterDeletion?: number;
13076
+ /**
13077
+ * @remarks
13078
+ * The retention period of Cross-regional backup.
13079
+ * Valid values:
13080
+ *
13081
+ * * **Monday**
13082
+ * * **Tuesday**
13083
+ * * **Wednesday**
13084
+ * * **Thursday**
13085
+ * * **Friday**
13086
+ * * **Saturday**
13087
+ * * **Sunday**
13088
+ *
13089
+ * **
13090
+ *
13091
+ *
13092
+ *
13093
+ *
13094
+ *
13095
+ * >- Separate multiple values with commas (,).
13096
+ * >- When SnapshotBackupType is set to standard, this value needs to be a subset of the PreferredBackupPeriod.
13097
+ *
13098
+ * @example
13099
+ * Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
13100
+ */
12698
13101
  crossBackupPeriod?: string;
13102
+ /**
13103
+ * @remarks
13104
+ * The operation strategy of Cross-regional backup.
13105
+ * - update
13106
+ * - delete
13107
+ *
13108
+ * @example
13109
+ * update
13110
+ */
12699
13111
  crossBackupType?: string;
13112
+ /**
13113
+ * @remarks
13114
+ * The retention type of Cross-regional log backup.
13115
+ *
13116
+ * - delay : retain the backup for a period of time.
13117
+ * - never : retain the backup permanently.
13118
+ *
13119
+ * @example
13120
+ * delay
13121
+ */
12700
13122
  crossLogRetentionType?: string;
13123
+ /**
13124
+ * @remarks
13125
+ * The retention time of Cross-regional log backup, 3 - 1825 days.
13126
+ *
13127
+ * @example
13128
+ * 3
13129
+ */
12701
13130
  crossLogRetentionValue?: number;
13131
+ /**
13132
+ * @remarks
13133
+ * The retention type of Cross-regional backup.
13134
+ *
13135
+ * - delay : retain the backup for a period of time.
13136
+ * - never : retain the backup permanently.
13137
+ *
13138
+ * @example
13139
+ * delay
13140
+ */
12702
13141
  crossRetentionType?: string;
13142
+ /**
13143
+ * @remarks
13144
+ * The retention time of Cross-regional backup, 3 - 1825 days.
13145
+ * >
13146
+ * > - Used and must be used when CrossRetentionType is delay.
13147
+ *
13148
+ * @example
13149
+ * 7
13150
+ */
12703
13151
  crossRetentionValue?: number;
12704
13152
  /**
12705
13153
  * @remarks
@@ -12711,6 +13159,15 @@ export class ModifyBackupPolicyRequest extends $tea.Model {
12711
13159
  * dds-bp16cb162771****
12712
13160
  */
12713
13161
  DBInstanceId?: string;
13162
+ /**
13163
+ * @remarks
13164
+ * The region id of Cross-regional backup.
13165
+ * >
13166
+ * > - Required for Cross-regional backup.
13167
+ *
13168
+ * @example
13169
+ * cn-hangzhou
13170
+ */
12714
13171
  destRegion?: string;
12715
13172
  /**
12716
13173
  * @remarks
@@ -12723,12 +13180,37 @@ export class ModifyBackupPolicyRequest extends $tea.Model {
12723
13180
  * 0
12724
13181
  */
12725
13182
  enableBackupLog?: number;
13183
+ /**
13184
+ * @remarks
13185
+ * Whether to turn on cross-regional log backup.
13186
+ * - 1:turn on . Used for sharded cluster.
13187
+ * - 0: turn off. Used for replicate set.
13188
+ *
13189
+ * @example
13190
+ * 1
13191
+ */
12726
13192
  enableCrossLogBackup?: number;
12727
13193
  /**
12728
13194
  * @remarks
12729
13195
  * The number of days for which high-frequency backups are retained. Before you use this parameter, make sure that you specify the BackupInterval parameter. By default, high-frequency backups are retained for one day.
13196
+ *
13197
+ * @example
13198
+ * 1
12730
13199
  */
12731
13200
  highFrequencyBackupRetention?: number;
13201
+ /**
13202
+ * @remarks
13203
+ * The instance architecture. Valid values:
13204
+ *
13205
+ * * replicate
13206
+ * * sharding
13207
+ *
13208
+ * > * This parameter is required for Cross-regional backup.
13209
+ * > * This parameter is required for backup recovery of deleted instances.
13210
+ *
13211
+ * @example
13212
+ * replicate
13213
+ */
12732
13214
  instanceType?: string;
12733
13215
  /**
12734
13216
  * @remarks
@@ -12754,6 +13236,10 @@ export class ModifyBackupPolicyRequest extends $tea.Model {
12754
13236
  * * **Saturday**
12755
13237
  * * **Sunday**
12756
13238
  *
13239
+ * **
13240
+ *
13241
+ * **Notice**: To ensure data security, make sure that the system backs up data at least twice a week.
13242
+ *
12757
13243
  * > Separate multiple values with commas (,).
12758
13244
  *
12759
13245
  * @example
@@ -12783,6 +13269,17 @@ export class ModifyBackupPolicyRequest extends $tea.Model {
12783
13269
  * Standard
12784
13270
  */
12785
13271
  snapshotBackupType?: string;
13272
+ /**
13273
+ * @remarks
13274
+ * The region ID of the instance.
13275
+ *
13276
+ * >
13277
+ * > - Required for Cross-regional backup.
13278
+ * > - Required for backup recovery of deleted instances.
13279
+ *
13280
+ * @example
13281
+ * cn-beijing
13282
+ */
12786
13283
  srcRegion?: string;
12787
13284
  static names(): { [key: string]: string } {
12788
13285
  return {
@@ -16757,6 +17254,10 @@ export class RestartDBInstanceResponse extends $tea.Model {
16757
17254
  export class RestartNodeRequest extends $tea.Model {
16758
17255
  /**
16759
17256
  * @remarks
17257
+ * The instance ID.
17258
+ *
17259
+ * > If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.
17260
+ *
16760
17261
  * This parameter is required.
16761
17262
  *
16762
17263
  * @example
@@ -16764,6 +17265,11 @@ export class RestartNodeRequest extends $tea.Model {
16764
17265
  */
16765
17266
  DBInstanceId?: string;
16766
17267
  /**
17268
+ * @remarks
17269
+ * The ID of the shard, mongos, or ConfigServer node in a child instance of the sharded cluster instance.
17270
+ *
17271
+ * > If you set the **DBInstanceId** parameter to the ID of a sharded cluster instance, you must specify this parameter.
17272
+ *
16767
17273
  * @example
16768
17274
  * d-bp128a003436****
16769
17275
  */
@@ -16774,6 +17280,11 @@ export class RestartNodeRequest extends $tea.Model {
16774
17280
  resourceOwnerId?: number;
16775
17281
  /**
16776
17282
  * @remarks
17283
+ * The role ID of the node.
17284
+ *
17285
+ * 1. You can call the [DescribeReplicaSetRole](https://help.aliyun.com/document_detail/468469.html) operation to query the role ID of a node in a replica set instance.
17286
+ * 2. You can call the [DescribeRoleZoneInfo](https://help.aliyun.com/document_detail/468472.html) operation to query the role ID of a node in a sharded cluster instance.
17287
+ *
16777
17288
  * This parameter is required.
16778
17289
  *
16779
17290
  * @example
@@ -16811,6 +17322,9 @@ export class RestartNodeRequest extends $tea.Model {
16811
17322
 
16812
17323
  export class RestartNodeResponseBody extends $tea.Model {
16813
17324
  /**
17325
+ * @remarks
17326
+ * The request ID.
17327
+ *
16814
17328
  * @example
16815
17329
  * ECBCA991-XXXX-XXXX-834C-B3E8007F33AA
16816
17330
  */
@@ -17232,7 +17746,7 @@ export class TransformInstanceChargeTypeRequest extends $tea.Model {
17232
17746
  * * **true**
17233
17747
  * * **false**
17234
17748
  *
17235
- * > Default value: **true**.
17749
+ * > Default value: **true**.
17236
17750
  *
17237
17751
  * @example
17238
17752
  * true
@@ -17263,8 +17777,8 @@ export class TransformInstanceChargeTypeRequest extends $tea.Model {
17263
17777
  * @remarks
17264
17778
  * The billing method of the instance. Valid values:
17265
17779
  *
17266
- * * **PrePaid**: subscription
17267
- * * **PostPaid**: pay-as-you-go
17780
+ * * **PrePaid:** subscription.
17781
+ * * **PostPaid:** pay-as-you-go.
17268
17782
  *
17269
17783
  * This parameter is required.
17270
17784
  *
@@ -17274,10 +17788,7 @@ export class TransformInstanceChargeTypeRequest extends $tea.Model {
17274
17788
  chargeType?: string;
17275
17789
  /**
17276
17790
  * @remarks
17277
- * Specifies whether to use coupons. Default value: null. Valid values:
17278
- *
17279
- * * **default** or **null**: uses coupons.
17280
- * * **youhuiquan_promotion_option_id_for_blank**: does not use coupons.
17791
+ * The coupon code. Default value: `youhuiquan_promotion_option_id_for_blank`.
17281
17792
  *
17282
17793
  * @example
17283
17794
  * youhuiquan_promotion_option_id_for_blank
@@ -17285,7 +17796,7 @@ export class TransformInstanceChargeTypeRequest extends $tea.Model {
17285
17796
  couponNo?: string;
17286
17797
  /**
17287
17798
  * @remarks
17288
- * The ID of the instance
17799
+ * The ID of the instance.
17289
17800
  *
17290
17801
  * This parameter is required.
17291
17802
  *
@@ -17297,10 +17808,7 @@ export class TransformInstanceChargeTypeRequest extends $tea.Model {
17297
17808
  ownerId?: number;
17298
17809
  /**
17299
17810
  * @remarks
17300
- * The subscription duration. Valid values:
17301
- *
17302
- * * If the PricingCycle parameter is set to Month, the valid values of this parameter range from **1** to **9**.
17303
- * * If the PricingCycle parameter is set to Year, the valid values of this parameter are **1**, **2**, **3**, and **5**.
17811
+ * The subscription duration of the instance. Unit: months. Valid values: **1, 2, 3, 4, 5, 6, 7, 8, 9******, **12**, **24**, and **36**.
17304
17812
  *
17305
17813
  * @example
17306
17814
  * 1
@@ -17308,12 +17816,12 @@ export class TransformInstanceChargeTypeRequest extends $tea.Model {
17308
17816
  period?: number;
17309
17817
  /**
17310
17818
  * @remarks
17311
- * The unit of the subscription duration. Valid values:
17819
+ * 实例付费时长单位
17820
+ * 取值说明:
17821
+ * - **Month:** 月
17822
+ * - **Year:** 年
17312
17823
  *
17313
- * * **Month**
17314
- * * **Year**
17315
- *
17316
- * Default value: Month.
17824
+ * 默认值:Month
17317
17825
  *
17318
17826
  * @example
17319
17827
  * Month
@@ -17363,7 +17871,7 @@ export class TransformInstanceChargeTypeRequest extends $tea.Model {
17363
17871
  export class TransformInstanceChargeTypeResponseBody extends $tea.Model {
17364
17872
  /**
17365
17873
  * @remarks
17366
- * The ID of the order.
17874
+ * The order ID.
17367
17875
  *
17368
17876
  * @example
17369
17877
  * 21084641369****
@@ -17371,7 +17879,7 @@ export class TransformInstanceChargeTypeResponseBody extends $tea.Model {
17371
17879
  orderId?: string;
17372
17880
  /**
17373
17881
  * @remarks
17374
- * The ID of the request.
17882
+ * The request ID.
17375
17883
  *
17376
17884
  * @example
17377
17885
  * D8F1D721-6439-4257-A89C-F1E8E9C9****
@@ -17762,6 +18270,7 @@ export class UpgradeDBInstanceEngineVersionRequest extends $tea.Model {
17762
18270
  ownerId?: number;
17763
18271
  resourceOwnerAccount?: string;
17764
18272
  resourceOwnerId?: number;
18273
+ switchMode?: number;
17765
18274
  static names(): { [key: string]: string } {
17766
18275
  return {
17767
18276
  DBInstanceId: 'DBInstanceId',
@@ -17770,6 +18279,7 @@ export class UpgradeDBInstanceEngineVersionRequest extends $tea.Model {
17770
18279
  ownerId: 'OwnerId',
17771
18280
  resourceOwnerAccount: 'ResourceOwnerAccount',
17772
18281
  resourceOwnerId: 'ResourceOwnerId',
18282
+ switchMode: 'SwitchMode',
17773
18283
  };
17774
18284
  }
17775
18285
 
@@ -17781,6 +18291,7 @@ export class UpgradeDBInstanceEngineVersionRequest extends $tea.Model {
17781
18291
  ownerId: 'number',
17782
18292
  resourceOwnerAccount: 'string',
17783
18293
  resourceOwnerId: 'number',
18294
+ switchMode: 'number',
17784
18295
  };
17785
18296
  }
17786
18297
 
@@ -17855,6 +18366,7 @@ export class UpgradeDBInstanceKernelVersionRequest extends $tea.Model {
17855
18366
  ownerId?: number;
17856
18367
  resourceOwnerAccount?: string;
17857
18368
  resourceOwnerId?: number;
18369
+ switchMode?: string;
17858
18370
  static names(): { [key: string]: string } {
17859
18371
  return {
17860
18372
  DBInstanceId: 'DBInstanceId',
@@ -17862,6 +18374,7 @@ export class UpgradeDBInstanceKernelVersionRequest extends $tea.Model {
17862
18374
  ownerId: 'OwnerId',
17863
18375
  resourceOwnerAccount: 'ResourceOwnerAccount',
17864
18376
  resourceOwnerId: 'ResourceOwnerId',
18377
+ switchMode: 'SwitchMode',
17865
18378
  };
17866
18379
  }
17867
18380
 
@@ -17872,6 +18385,7 @@ export class UpgradeDBInstanceKernelVersionRequest extends $tea.Model {
17872
18385
  ownerId: 'number',
17873
18386
  resourceOwnerAccount: 'string',
17874
18387
  resourceOwnerId: 'number',
18388
+ switchMode: 'string',
17875
18389
  };
17876
18390
  }
17877
18391
 
@@ -18114,8 +18628,8 @@ export class CreateShardingDBInstanceRequestReplicaSet extends $tea.Model {
18114
18628
  * @remarks
18115
18629
  * The instance type of the shard node. For more information, see [Sharded cluster instance types](https://help.aliyun.com/document_detail/311414.html).
18116
18630
  *
18117
- * > * **N** specifies the serial number of the shard node for which the instance type is specified. For example, **ReplicaSet.2.Class** specifies the instance type of the second shard node.
18118
- * > * Valid values for **N**: **2** to **32**.
18631
+ * > * **N** specifies the serial number of the shard node for which the instance type is specified. For example, **ReplicaSet.2.Class** specifies the instance type of the second shard node.
18632
+ * > * Valid values of **N**: **2** to **32**.
18119
18633
  *
18120
18634
  * This parameter is required.
18121
18635
  *
@@ -18125,11 +18639,11 @@ export class CreateShardingDBInstanceRequestReplicaSet extends $tea.Model {
18125
18639
  class?: string;
18126
18640
  /**
18127
18641
  * @remarks
18128
- * The number of read-only nodes in shard node N.
18642
+ * The number of read-only nodes in the shard node.
18129
18643
  *
18130
- * Valid values: **0**, 1, 2, 3, 4, and **5**. Default value: **0**.
18644
+ * Valid values: **0**, **1, 2, 3, 4, and 5**. Default value: **0**.
18131
18645
  *
18132
- * > **N** specifies the serial number of the shard node for which you want to set the number of read-only nodes. For example, **ReplicaSet.2.ReadonlyReplicas** specifies the number of read-only nodes in the second shard node.
18646
+ * > **N** specifies the serial number of the shard node for which you want to set the number of read-only nodes. **ReplicaSet.2.ReadonlyReplicas** specifies the number of read-only nodes in the second shard node.
18133
18647
  *
18134
18648
  * @example
18135
18649
  * 0
@@ -18137,10 +18651,10 @@ export class CreateShardingDBInstanceRequestReplicaSet extends $tea.Model {
18137
18651
  readonlyReplicas?: number;
18138
18652
  /**
18139
18653
  * @remarks
18140
- * The storage space of the shard node. Unit: GB.
18654
+ * The storage capacity of the shard node. Unit: GB.
18141
18655
  *
18142
- * > * The values that can be specified for this parameter vary based on the instance types. For more information, see [Sharded cluster instance types](https://help.aliyun.com/document_detail/311414.html).
18143
- * > * **N** specifies the serial number of the shard node for which the storage space is specified. For example, **ReplicaSet.2.Storage** specifies the storage space of the second shard node.
18656
+ * > * The values that can be specified for this parameter vary based on the instance types. For more information, see [Sharded cluster instance types](https://help.aliyun.com/document_detail/311414.html).
18657
+ * > * **N** specifies the serial number of the shard node for which the storage space is specified. For example, **ReplicaSet.2.Storage** specifies the storage space of the second shard node.
18144
18658
  *
18145
18659
  * This parameter is required.
18146
18660
  *
@@ -19377,7 +19891,7 @@ export class DescribeBackupsResponseBodyBackupsBackup extends $tea.Model {
19377
19891
  * @remarks
19378
19892
  * The internal download URL of the backup set.
19379
19893
  *
19380
- * > You can use the URL to download the specified backup set on an Elastic Compute Service (ECS) instance that is in the same Virtual Private Cloud (VPC) as the ApsaraDB for MongoDB instance.
19894
+ * > You can use the URL to download the specified backup set on an Elastic Compute Service (ECS) instance that is in the same virtual private cloud (VPC) as the ApsaraDB for MongoDB instance.
19381
19895
  */
19382
19896
  backupIntranetDownloadURL?: string;
19383
19897
  /**
@@ -19404,14 +19918,28 @@ export class DescribeBackupsResponseBodyBackupsBackup extends $tea.Model {
19404
19918
  * @remarks
19405
19919
  * The backup mode of the backup set. Valid values:
19406
19920
  *
19407
- * * **Automated**:
19921
+ * * **Automated**
19408
19922
  * * **Manual**
19409
19923
  *
19410
19924
  * @example
19411
19925
  * Automated
19412
19926
  */
19413
19927
  backupMode?: string;
19928
+ /**
19929
+ * @remarks
19930
+ * The name of the backup set (invalid now).
19931
+ *
19932
+ * @example
19933
+ * 12345678.tar.gz
19934
+ */
19414
19935
  backupName?: string;
19936
+ /**
19937
+ * @remarks
19938
+ * The scale of the backup set (invalid now).
19939
+ *
19940
+ * @example
19941
+ * DBInstance
19942
+ */
19415
19943
  backupScale?: string;
19416
19944
  /**
19417
19945
  * @remarks
@@ -19451,6 +19979,16 @@ export class DescribeBackupsResponseBodyBackupsBackup extends $tea.Model {
19451
19979
  * FullBackup
19452
19980
  */
19453
19981
  backupType?: string;
19982
+ engineVersion?: string;
19983
+ /**
19984
+ * @remarks
19985
+ * Availability of the backup set.
19986
+ * - 0: unavailable
19987
+ * - 1: available
19988
+ *
19989
+ * @example
19990
+ * 1
19991
+ */
19454
19992
  isAvail?: boolean;
19455
19993
  static names(): { [key: string]: string } {
19456
19994
  return {
@@ -19468,6 +20006,7 @@ export class DescribeBackupsResponseBodyBackupsBackup extends $tea.Model {
19468
20006
  backupStartTime: 'BackupStartTime',
19469
20007
  backupStatus: 'BackupStatus',
19470
20008
  backupType: 'BackupType',
20009
+ engineVersion: 'EngineVersion',
19471
20010
  isAvail: 'IsAvail',
19472
20011
  };
19473
20012
  }
@@ -19488,6 +20027,7 @@ export class DescribeBackupsResponseBodyBackupsBackup extends $tea.Model {
19488
20027
  backupStartTime: 'string',
19489
20028
  backupStatus: 'string',
19490
20029
  backupType: 'string',
20030
+ engineVersion: 'string',
19491
20031
  isAvail: 'boolean',
19492
20032
  };
19493
20033
  }
@@ -19797,6 +20337,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackups extends $tea.Model
19797
20337
  * OK
19798
20338
  */
19799
20339
  clusterBackupStatus?: string;
20340
+ engineVersion?: string;
19800
20341
  /**
19801
20342
  * @remarks
19802
20343
  * The additional information in the JSON format.
@@ -19831,6 +20372,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackups extends $tea.Model
19831
20372
  clusterBackupSize: 'ClusterBackupSize',
19832
20373
  clusterBackupStartTime: 'ClusterBackupStartTime',
19833
20374
  clusterBackupStatus: 'ClusterBackupStatus',
20375
+ engineVersion: 'EngineVersion',
19834
20376
  extraInfo: 'ExtraInfo',
19835
20377
  isAvail: 'IsAvail',
19836
20378
  progress: 'Progress',
@@ -19847,6 +20389,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackups extends $tea.Model
19847
20389
  clusterBackupSize: 'string',
19848
20390
  clusterBackupStartTime: 'string',
19849
20391
  clusterBackupStatus: 'string',
20392
+ engineVersion: 'string',
19850
20393
  extraInfo: DescribeClusterBackupsResponseBodyClusterBackupsExtraInfo,
19851
20394
  isAvail: 'number',
19852
20395
  progress: 'string',
@@ -19915,6 +20458,27 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceConfigs
19915
20458
  * dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com
19916
20459
  */
19917
20460
  connectString?: string;
20461
+ /**
20462
+ * @remarks
20463
+ * The minor version of the current MongoDB kernel.
20464
+ *
20465
+ * @example
20466
+ * mongodb_20230613_4.0.25
20467
+ */
20468
+ currentKernelVersion?: string;
20469
+ /**
20470
+ * @remarks
20471
+ * The lock status of the Configserver node. Valid values:
20472
+ *
20473
+ * * **Unlock**: The instance is not locked.
20474
+ * * **ManualLock**: The instance is manually locked.
20475
+ * * **LockByExpiration**: The instance is automatically locked due to instance expiration.
20476
+ * * **LockByRestoration**: The instance is automatically locked before a rollback.
20477
+ * * **LockByDiskQuota**: The instance is automatically locked because its storage capacity is exhausted and the instance is inaccessible.
20478
+ *
20479
+ * @example
20480
+ * Unlock
20481
+ */
19918
20482
  lockMode?: string;
19919
20483
  /**
19920
20484
  * @remarks
@@ -19983,6 +20547,7 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceConfigs
19983
20547
  static names(): { [key: string]: string } {
19984
20548
  return {
19985
20549
  connectString: 'ConnectString',
20550
+ currentKernelVersion: 'CurrentKernelVersion',
19986
20551
  lockMode: 'LockMode',
19987
20552
  maxConnections: 'MaxConnections',
19988
20553
  maxIOPS: 'MaxIOPS',
@@ -19998,6 +20563,7 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceConfigs
19998
20563
  static types(): { [key: string]: any } {
19999
20564
  return {
20000
20565
  connectString: 'string',
20566
+ currentKernelVersion: 'string',
20001
20567
  lockMode: 'string',
20002
20568
  maxConnections: 'number',
20003
20569
  maxIOPS: 'number',
@@ -20043,6 +20609,27 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceMongosL
20043
20609
  * s-bp1d8c262a15****.mongodb.rds.aliyuncs.com
20044
20610
  */
20045
20611
  connectSting?: string;
20612
+ /**
20613
+ * @remarks
20614
+ * The minor version of the current MongoDB kernel.
20615
+ *
20616
+ * @example
20617
+ * mongodb_20220518_4.0.21
20618
+ */
20619
+ currentKernelVersion?: string;
20620
+ /**
20621
+ * @remarks
20622
+ * The lock status of the instance. Valid values:
20623
+ *
20624
+ * * **Unlock**: The instance is not locked.
20625
+ * * **ManualLock**: The instance is manually locked.
20626
+ * * **LockByExpiration**: The instance is automatically locked due to instance expiration.
20627
+ * * **LockByRestoration**: The instance is automatically locked before a rollback.
20628
+ * * **LockByDiskQuota**: The instance is automatically locked because its storage capacity is exhausted and the instance is inaccessible.
20629
+ *
20630
+ * @example
20631
+ * Unlock
20632
+ */
20046
20633
  lockMode?: string;
20047
20634
  /**
20048
20635
  * @remarks
@@ -20131,6 +20718,7 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceMongosL
20131
20718
  static names(): { [key: string]: string } {
20132
20719
  return {
20133
20720
  connectSting: 'ConnectSting',
20721
+ currentKernelVersion: 'CurrentKernelVersion',
20134
20722
  lockMode: 'LockMode',
20135
20723
  maxConnections: 'MaxConnections',
20136
20724
  maxIOPS: 'MaxIOPS',
@@ -20148,6 +20736,7 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceMongosL
20148
20736
  static types(): { [key: string]: any } {
20149
20737
  return {
20150
20738
  connectSting: 'string',
20739
+ currentKernelVersion: 'string',
20151
20740
  lockMode: 'string',
20152
20741
  maxConnections: 'number',
20153
20742
  maxIOPS: 'number',
@@ -20312,6 +20901,27 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceShardLi
20312
20901
  * d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****
20313
20902
  */
20314
20903
  connectString?: string;
20904
+ /**
20905
+ * @remarks
20906
+ * The minor version of the current MongoDB kernel.
20907
+ *
20908
+ * @example
20909
+ * mongodb_20230613_4.0.25
20910
+ */
20911
+ currentKernelVersion?: string;
20912
+ /**
20913
+ * @remarks
20914
+ * The lock status of the shard node. Valid values:
20915
+ *
20916
+ * * **Unlock**: The instance is not locked.
20917
+ * * **ManualLock**: The instance is manually locked.
20918
+ * * **LockByExpiration**: The instance is automatically locked due to instance expiration.
20919
+ * * **LockByRestoration**: The instance is automatically locked before a rollback.
20920
+ * * **LockByDiskQuota**: The instance is automatically locked because its storage capacity is exhausted and the instance is inaccessible.
20921
+ *
20922
+ * @example
20923
+ * Unlock
20924
+ */
20315
20925
  lockMode?: string;
20316
20926
  /**
20317
20927
  * @remarks
@@ -20323,7 +20933,7 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceShardLi
20323
20933
  maxConnections?: number;
20324
20934
  /**
20325
20935
  * @remarks
20326
- * shard节点的最大云盘吞吐量。
20936
+ * The maximum MBPS of the shard node.
20327
20937
  *
20328
20938
  * @example
20329
20939
  * 350
@@ -20396,6 +21006,7 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceShardLi
20396
21006
  static names(): { [key: string]: string } {
20397
21007
  return {
20398
21008
  connectString: 'ConnectString',
21009
+ currentKernelVersion: 'CurrentKernelVersion',
20399
21010
  lockMode: 'LockMode',
20400
21011
  maxConnections: 'MaxConnections',
20401
21012
  maxDiskMbps: 'MaxDiskMbps',
@@ -20413,6 +21024,7 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceShardLi
20413
21024
  static types(): { [key: string]: any } {
20414
21025
  return {
20415
21026
  connectString: 'string',
21027
+ currentKernelVersion: 'string',
20416
21028
  lockMode: 'string',
20417
21029
  maxConnections: 'number',
20418
21030
  maxDiskMbps: 'string',
@@ -20536,7 +21148,7 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstance extend
20536
21148
  chargeType?: string;
20537
21149
  /**
20538
21150
  * @remarks
20539
- * The information of the Configserver nodes.
21151
+ * The details of the ConfigServer node.
20540
21152
  *
20541
21153
  * > This parameter is returned if the instance is a sharded cluster instance.
20542
21154
  */
@@ -20795,7 +21407,7 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstance extend
20795
21407
  maxIOPS?: number;
20796
21408
  /**
20797
21409
  * @remarks
20798
- * 实例的最大云盘吞吐量,单位MB/s。
21410
+ * The maximum MBPS of the instance.
20799
21411
  *
20800
21412
  * @example
20801
21413
  * 350
@@ -20803,7 +21415,7 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstance extend
20803
21415
  maxMBPS?: number;
20804
21416
  /**
20805
21417
  * @remarks
20806
- * The information of the mongos nodes.
21418
+ * The details of the mongos node.
20807
21419
  *
20808
21420
  * > This parameter is returned if the instance is a sharded cluster instance.
20809
21421
  */
@@ -20938,7 +21550,7 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstance extend
20938
21550
  secondaryZoneId?: string;
20939
21551
  /**
20940
21552
  * @remarks
20941
- * The information of the shard nodes.
21553
+ * The details of the shard node.
20942
21554
  *
20943
21555
  * > This parameter is returned if the instance is a sharded cluster instance.
20944
21556
  */
@@ -25920,6 +26532,14 @@ export class DescribeReplicaSetRoleResponseBodyReplicaSetsReplicaSet extends $te
25920
26532
  * 3717
25921
26533
  */
25922
26534
  connectionPort?: string;
26535
+ /**
26536
+ * @remarks
26537
+ * The connection type of the node.
26538
+ *
26539
+ * @example
26540
+ * SRV
26541
+ */
26542
+ connectionType?: string;
25923
26543
  /**
25924
26544
  * @remarks
25925
26545
  * The remaining duration of the classic network endpoint. Unit: seconds.
@@ -25963,6 +26583,7 @@ export class DescribeReplicaSetRoleResponseBodyReplicaSetsReplicaSet extends $te
25963
26583
  return {
25964
26584
  connectionDomain: 'ConnectionDomain',
25965
26585
  connectionPort: 'ConnectionPort',
26586
+ connectionType: 'ConnectionType',
25966
26587
  expiredTime: 'ExpiredTime',
25967
26588
  networkType: 'NetworkType',
25968
26589
  replicaSetRole: 'ReplicaSetRole',
@@ -25974,6 +26595,7 @@ export class DescribeReplicaSetRoleResponseBodyReplicaSetsReplicaSet extends $te
25974
26595
  return {
25975
26596
  connectionDomain: 'string',
25976
26597
  connectionPort: 'string',
26598
+ connectionType: 'string',
25977
26599
  expiredTime: 'string',
25978
26600
  networkType: 'string',
25979
26601
  replicaSetRole: 'string',
@@ -26005,6 +26627,180 @@ export class DescribeReplicaSetRoleResponseBodyReplicaSets extends $tea.Model {
26005
26627
  }
26006
26628
  }
26007
26629
 
26630
+ export class DescribeRestoreDBInstanceListResponseBodyDBInstancesDBInstance extends $tea.Model {
26631
+ /**
26632
+ * @remarks
26633
+ * The time of instance creation, formatted as <i>yyyy-MM-dd</i>T<i>HH:00:00</i>Z (UTC time).
26634
+ *
26635
+ * @example
26636
+ * 2022-01-02T07:43:59Z
26637
+ */
26638
+ creationTime?: string;
26639
+ /**
26640
+ * @remarks
26641
+ * The description of the instance.
26642
+ *
26643
+ * @example
26644
+ * test-database
26645
+ */
26646
+ DBInstanceDescription?: string;
26647
+ /**
26648
+ * @remarks
26649
+ * The instance ID.
26650
+ *
26651
+ * @example
26652
+ * dds-bp12c5b040dc****
26653
+ */
26654
+ DBInstanceId?: string;
26655
+ /**
26656
+ * @remarks
26657
+ * The status of the instance. For more information, see [Instance states](https://help.aliyun.com/document_detail/63870.html).
26658
+ *
26659
+ * @example
26660
+ * Running
26661
+ */
26662
+ DBInstanceStatus?: string;
26663
+ /**
26664
+ * @remarks
26665
+ * The architecture of the instance. Valid values:
26666
+ *
26667
+ * * **sharding**: sharded cluster instance
26668
+ * * **replicate**: replica set or standalone instance
26669
+ *
26670
+ * @example
26671
+ * replicate
26672
+ */
26673
+ DBInstanceType?: string;
26674
+ /**
26675
+ * @remarks
26676
+ * The database engine version of the instance. Valid values:
26677
+ *
26678
+ * * **7.0**
26679
+ * * **6.0**
26680
+ * * **5.0**
26681
+ * * **4.4**
26682
+ * * **4.2**
26683
+ * * **4.0**
26684
+ * * **3.4**
26685
+ *
26686
+ * @example
26687
+ * 4.2
26688
+ */
26689
+ engineVersion?: string;
26690
+ /**
26691
+ * @remarks
26692
+ * The secondary availability zone 2 for the instance when implementing multi-AZ deployment.
26693
+ *
26694
+ * @example
26695
+ * cn-hangzhou-h
26696
+ */
26697
+ hiddenZoneId?: string;
26698
+ /**
26699
+ * @remarks
26700
+ * Specifies whether the instance is deleted. Valid values:
26701
+ *
26702
+ * * **0**: not deleted
26703
+ * * **1**: deleted
26704
+ *
26705
+ * @example
26706
+ * 0
26707
+ */
26708
+ isDeleted?: number;
26709
+ /**
26710
+ * @remarks
26711
+ * The locked state of the instance, value description:
26712
+ * - Unlock: Normal.
26713
+ * - ManualLock: Manually triggered lock.
26714
+ * - LockByExpiration: Automatically locked due to expiration.
26715
+ * - LockByRestoration: Automatically locked before restoration.
26716
+ * - LockByDiskQuota: Automatically locked due to disk quota exceeded.
26717
+ *
26718
+ * @example
26719
+ * Unlock
26720
+ */
26721
+ lockMode?: string;
26722
+ /**
26723
+ * @remarks
26724
+ * The region ID of the instance.
26725
+ *
26726
+ * @example
26727
+ * cn-hangzhou
26728
+ */
26729
+ regionId?: string;
26730
+ /**
26731
+ * @remarks
26732
+ * The secondary availability zone 1 for the instance when implementing multi-AZ deployment.
26733
+ *
26734
+ * @example
26735
+ * cn-hangzhou-i
26736
+ */
26737
+ secondaryZoneId?: string;
26738
+ /**
26739
+ * @remarks
26740
+ * The zone ID of the instance.
26741
+ *
26742
+ * @example
26743
+ * cn-hangzhou-g
26744
+ */
26745
+ zoneId?: string;
26746
+ static names(): { [key: string]: string } {
26747
+ return {
26748
+ creationTime: 'CreationTime',
26749
+ DBInstanceDescription: 'DBInstanceDescription',
26750
+ DBInstanceId: 'DBInstanceId',
26751
+ DBInstanceStatus: 'DBInstanceStatus',
26752
+ DBInstanceType: 'DBInstanceType',
26753
+ engineVersion: 'EngineVersion',
26754
+ hiddenZoneId: 'HiddenZoneId',
26755
+ isDeleted: 'IsDeleted',
26756
+ lockMode: 'LockMode',
26757
+ regionId: 'RegionId',
26758
+ secondaryZoneId: 'SecondaryZoneId',
26759
+ zoneId: 'ZoneId',
26760
+ };
26761
+ }
26762
+
26763
+ static types(): { [key: string]: any } {
26764
+ return {
26765
+ creationTime: 'string',
26766
+ DBInstanceDescription: 'string',
26767
+ DBInstanceId: 'string',
26768
+ DBInstanceStatus: 'string',
26769
+ DBInstanceType: 'string',
26770
+ engineVersion: 'string',
26771
+ hiddenZoneId: 'string',
26772
+ isDeleted: 'number',
26773
+ lockMode: 'string',
26774
+ regionId: 'string',
26775
+ secondaryZoneId: 'string',
26776
+ zoneId: 'string',
26777
+ };
26778
+ }
26779
+
26780
+ constructor(map?: { [key: string]: any }) {
26781
+ super(map);
26782
+ }
26783
+ }
26784
+
26785
+ export class DescribeRestoreDBInstanceListResponseBodyDBInstances extends $tea.Model {
26786
+ DBInstance?: DescribeRestoreDBInstanceListResponseBodyDBInstancesDBInstance[];
26787
+ static names(): { [key: string]: string } {
26788
+ return {
26789
+ DBInstance: 'DBInstance',
26790
+ };
26791
+ }
26792
+
26793
+ static types(): { [key: string]: any } {
26794
+ return {
26795
+ DBInstance: { 'type': 'array', 'itemType': DescribeRestoreDBInstanceListResponseBodyDBInstancesDBInstance },
26796
+ };
26797
+ }
26798
+
26799
+ constructor(map?: { [key: string]: any }) {
26800
+ super(map);
26801
+ }
26802
+ }
26803
+
26008
26804
  export class DescribeRoleZoneInfoResponseBodyZoneInfosZoneInfo extends $tea.Model {
26009
26805
  /**
26010
26806
  * @remarks
@@ -26423,6 +27219,17 @@ export class DescribeShardingNetworkAddressResponseBodyCompatibleConnections ext
26423
27219
  }
26424
27220
 
26425
27221
  export class DescribeShardingNetworkAddressResponseBodyNetworkAddressesNetworkAddress extends $tea.Model {
27222
+ /**
27223
+ * @remarks
27224
+ * The public endpoint type. Valid values:
27225
+ *
27226
+ * * **SRV**
27227
+ * * **Normal**
27228
+ *
27229
+ * @example
27230
+ * SRV
27231
+ */
27232
+ connectionType?: string;
26426
27233
  /**
26427
27234
  * @remarks
26428
27235
  * The remaining duration of the classic network endpoint. Unit: seconds.
@@ -26498,6 +27305,14 @@ export class DescribeShardingNetworkAddressResponseBodyNetworkAddressesNetworkAd
26498
27305
  * Primary
26499
27306
  */
26500
27307
  role?: string;
27308
+ /**
27309
+ * @remarks
27310
+ * Txt record which can be used to store MongoDB-related meta data, such as version, configuration parameters and etc. With the combination of txt record and other technology, for example SRV record, the MongoDB client can complete the complex service discovery and configuration passing.
27311
+ *
27312
+ * @example
27313
+ * mongo.example.com. IN TXT "config=replicaSet=myReplicaSet"
27314
+ */
27315
+ txtRecord?: string;
26501
27316
  /**
26502
27317
  * @remarks
26503
27318
  * The VPC ID of the instance.
@@ -26520,6 +27335,7 @@ export class DescribeShardingNetworkAddressResponseBodyNetworkAddressesNetworkAd
26520
27335
  vswitchId?: string;
26521
27336
  static names(): { [key: string]: string } {
26522
27337
  return {
27338
+ connectionType: 'ConnectionType',
26523
27339
  expiredTime: 'ExpiredTime',
26524
27340
  IPAddress: 'IPAddress',
26525
27341
  networkAddress: 'NetworkAddress',
@@ -26528,6 +27344,7 @@ export class DescribeShardingNetworkAddressResponseBodyNetworkAddressesNetworkAd
26528
27344
  nodeType: 'NodeType',
26529
27345
  port: 'Port',
26530
27346
  role: 'Role',
27347
+ txtRecord: 'TxtRecord',
26531
27348
  VPCId: 'VPCId',
26532
27349
  vswitchId: 'VswitchId',
26533
27350
  };
@@ -26535,6 +27352,7 @@ export class DescribeShardingNetworkAddressResponseBodyNetworkAddressesNetworkAd
26535
27352
 
26536
27353
  static types(): { [key: string]: any } {
26537
27354
  return {
27355
+ connectionType: 'string',
26538
27356
  expiredTime: 'string',
26539
27357
  IPAddress: 'string',
26540
27358
  networkAddress: 'string',
@@ -26543,6 +27361,7 @@ export class DescribeShardingNetworkAddressResponseBodyNetworkAddressesNetworkAd
26543
27361
  nodeType: 'string',
26544
27362
  port: 'string',
26545
27363
  role: 'string',
27364
+ txtRecord: 'string',
26546
27365
  VPCId: 'string',
26547
27366
  vswitchId: 'string',
26548
27367
  };
@@ -27300,6 +28119,10 @@ export default class Client extends OpenApi {
27300
28119
  query["DestRegion"] = request.destRegion;
27301
28120
  }
27302
28121
 
28122
+ if (!Util.isUnset(request.engineVersion)) {
28123
+ query["EngineVersion"] = request.engineVersion;
28124
+ }
28125
+
27303
28126
  if (!Util.isUnset(request.instanceType)) {
27304
28127
  query["InstanceType"] = request.instanceType;
27305
28128
  }
@@ -27522,7 +28345,7 @@ export default class Client extends OpenApi {
27522
28345
  * Creates or clones an ApsaraDB for MongoDB replica set instance.
27523
28346
  *
27524
28347
  * @remarks
27525
- * Make sure that you fully understand the billing methods and [pricing](https://www.aliyun.com/price/product#/mongodb/detail/mongodb_computeudr_dp_cn) of ApsaraDB for MongoDB before you call this operation.
28348
+ * Make sure that you fully understand the billing methods and [pricing](https://www.alibabacloud.com/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB before you call this operation.
27526
28349
  * For more information about the instance types of ApsaraDB for MongoDB instances, see [Instance types](https://www.alibabacloud.com/help/en/mongodb/product-overview/instance-types-1).
27527
28350
  * To create sharded cluster instances, you can call the [CreateShardingDBInstance](~~CreateShardingDBInstance~~) operation.
27528
28351
  *
@@ -27718,7 +28541,7 @@ export default class Client extends OpenApi {
27718
28541
  * Creates or clones an ApsaraDB for MongoDB replica set instance.
27719
28542
  *
27720
28543
  * @remarks
27721
- * Make sure that you fully understand the billing methods and [pricing](https://www.aliyun.com/price/product#/mongodb/detail/mongodb_computeudr_dp_cn) of ApsaraDB for MongoDB before you call this operation.
28544
+ * Make sure that you fully understand the billing methods and [pricing](https://www.alibabacloud.com/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB before you call this operation.
27722
28545
  * For more information about the instance types of ApsaraDB for MongoDB instances, see [Instance types](https://www.alibabacloud.com/help/en/mongodb/product-overview/instance-types-1).
27723
28546
  * To create sharded cluster instances, you can call the [CreateShardingDBInstance](~~CreateShardingDBInstance~~) operation.
27724
28547
  *
@@ -28016,7 +28839,7 @@ export default class Client extends OpenApi {
28016
28839
  * Creates or clones an ApsaraDB for MongoDB sharded cluster instance.
28017
28840
  *
28018
28841
  * @remarks
28019
- * Make sure that you fully understand the billing methods and [pricing](https://www.aliyun.com/price/product#/mongodb/detail) of ApsaraDB for MongoDB before you call this operation.
28842
+ * Make sure that you fully understand the billing methods and [pricing](https://www.alibabacloud.com/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB before you call this operation.
28020
28843
  * * For more information about the instance types of ApsaraDB for MongoDB, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
28021
28844
  * * To create standalone instances and replica set instances, you can call the [CreateDBInstance](https://help.aliyun.com/document_detail/61763.html) operation.
28022
28845
  *
@@ -28200,7 +29023,7 @@ export default class Client extends OpenApi {
28200
29023
  * Creates or clones an ApsaraDB for MongoDB sharded cluster instance.
28201
29024
  *
28202
29025
  * @remarks
28203
- * Make sure that you fully understand the billing methods and [pricing](https://www.aliyun.com/price/product#/mongodb/detail) of ApsaraDB for MongoDB before you call this operation.
29026
+ * Make sure that you fully understand the billing methods and [pricing](https://www.alibabacloud.com/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB before you call this operation.
28204
29027
  * * For more information about the instance types of ApsaraDB for MongoDB, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
28205
29028
  * * To create standalone instances and replica set instances, you can call the [CreateDBInstance](https://help.aliyun.com/document_detail/61763.html) operation.
28206
29029
  *
@@ -31654,6 +32477,76 @@ export default class Client extends OpenApi {
31654
32477
  return await this.describeReplicaSetRoleWithOptions(request, runtime);
31655
32478
  }
31656
32479
 
32480
+ /**
32481
+ * Queries ApsaraDB for MongoDB instances whose backups are restored within seven days.
32482
+ *
32483
+ * @param request - DescribeRestoreDBInstanceListRequest
32484
+ * @param runtime - runtime options for this request RuntimeOptions
32485
+ * @returns DescribeRestoreDBInstanceListResponse
32486
+ */
32487
+ async describeRestoreDBInstanceListWithOptions(request: DescribeRestoreDBInstanceListRequest, runtime: $Util.RuntimeOptions): Promise<DescribeRestoreDBInstanceListResponse> {
32488
+ Util.validateModel(request);
32489
+ let query = { };
32490
+ if (!Util.isUnset(request.creationTimeAfter)) {
32491
+ query["CreationTimeAfter"] = request.creationTimeAfter;
32492
+ }
32493
+
32494
+ if (!Util.isUnset(request.DBInstanceId)) {
32495
+ query["DBInstanceId"] = request.DBInstanceId;
32496
+ }
32497
+
32498
+ if (!Util.isUnset(request.ownerAccount)) {
32499
+ query["OwnerAccount"] = request.ownerAccount;
32500
+ }
32501
+
32502
+ if (!Util.isUnset(request.ownerId)) {
32503
+ query["OwnerId"] = request.ownerId;
32504
+ }
32505
+
32506
+ if (!Util.isUnset(request.pageNumber)) {
32507
+ query["PageNumber"] = request.pageNumber;
32508
+ }
32509
+
32510
+ if (!Util.isUnset(request.pageSize)) {
32511
+ query["PageSize"] = request.pageSize;
32512
+ }
32513
+
32514
+ if (!Util.isUnset(request.resourceOwnerAccount)) {
32515
+ query["ResourceOwnerAccount"] = request.resourceOwnerAccount;
32516
+ }
32517
+
32518
+ if (!Util.isUnset(request.resourceOwnerId)) {
32519
+ query["ResourceOwnerId"] = request.resourceOwnerId;
32520
+ }
32521
+
32522
+ let req = new $OpenApi.OpenApiRequest({
32523
+ query: OpenApiUtil.query(query),
32524
+ });
32525
+ let params = new $OpenApi.Params({
32526
+ action: "DescribeRestoreDBInstanceList",
32527
+ version: "2015-12-01",
32528
+ protocol: "HTTPS",
32529
+ pathname: "/",
32530
+ method: "POST",
32531
+ authType: "AK",
32532
+ style: "RPC",
32533
+ reqBodyType: "formData",
32534
+ bodyType: "json",
32535
+ });
32536
+ return $tea.cast<DescribeRestoreDBInstanceListResponse>(await this.callApi(params, req, runtime), new DescribeRestoreDBInstanceListResponse({}));
32537
+ }
32538
+
32539
+ /**
32540
+ * Queries ApsaraDB for MongoDB instances whose backups are restored within seven days.
32541
+ *
32542
+ * @param request - DescribeRestoreDBInstanceListRequest
32543
+ * @returns DescribeRestoreDBInstanceListResponse
32544
+ */
32545
+ async describeRestoreDBInstanceList(request: DescribeRestoreDBInstanceListRequest): Promise<DescribeRestoreDBInstanceListResponse> {
32546
+ let runtime = new $Util.RuntimeOptions({ });
32547
+ return await this.describeRestoreDBInstanceListWithOptions(request, runtime);
32548
+ }
32549
+
31657
32550
  /**
31658
32551
  * Queries the role and zone of each node in an ApsaraDB for MongoDB instance.
31659
32552
  *
@@ -32991,6 +33884,9 @@ export default class Client extends OpenApi {
32991
33884
  /**
32992
33885
  * Modifies a backup policy for an ApsaraDB for MongoDB instance.
32993
33886
  *
33887
+ * @remarks
33888
+ * Cross-regional backup only supports MongoDB sharded cluster instance and MongoDB replica set.
33889
+ *
32994
33890
  * @param request - ModifyBackupPolicyRequest
32995
33891
  * @param runtime - runtime options for this request RuntimeOptions
32996
33892
  * @returns ModifyBackupPolicyResponse
@@ -33114,6 +34010,9 @@ export default class Client extends OpenApi {
33114
34010
  /**
33115
34011
  * Modifies a backup policy for an ApsaraDB for MongoDB instance.
33116
34012
  *
34013
+ * @remarks
34014
+ * Cross-regional backup only supports MongoDB sharded cluster instance and MongoDB replica set.
34015
+ *
33117
34016
  * @param request - ModifyBackupPolicyRequest
33118
34017
  * @returns ModifyBackupPolicyResponse
33119
34018
  */
@@ -35255,7 +36154,13 @@ export default class Client extends OpenApi {
35255
36154
  }
35256
36155
 
35257
36156
  /**
35258
- * 重启副本集单个节点
36157
+ * Restarts a node in an ApsaraDB for MongoDB instance.
36158
+ *
36159
+ * @remarks
36160
+ * You can call this operation to restart a node in a replica set instance or a child instance in a sharded cluster instance.
36161
+ * > When you call this operation, the instance must meet the following requirements:
36162
+ * * The instance is in the Running state.
36163
+ * * The instance is a replica set or sharded cluster instance of the standard edition.
35259
36164
  *
35260
36165
  * @param request - RestartNodeRequest
35261
36166
  * @param runtime - runtime options for this request RuntimeOptions
@@ -35310,7 +36215,13 @@ export default class Client extends OpenApi {
35310
36215
  }
35311
36216
 
35312
36217
  /**
35313
- * 重启副本集单个节点
36218
+ * Restarts a node in an ApsaraDB for MongoDB instance.
36219
+ *
36220
+ * @remarks
36221
+ * You can call this operation to restart a node in a replica set instance or a child instance in a sharded cluster instance.
36222
+ * > When you call this operation, the instance must meet the following requirements:
36223
+ * * The instance is in the Running state.
36224
+ * * The instance is a replica set or sharded cluster instance of the standard edition.
35314
36225
  *
35315
36226
  * @param request - RestartNodeRequest
35316
36227
  * @returns RestartNodeResponse
@@ -35562,12 +36473,12 @@ export default class Client extends OpenApi {
35562
36473
  * Changes the billing method of an instance from pay-as-you-go to subscription or from subscription to pay-as-you-go.
35563
36474
  *
35564
36475
  * @remarks
35565
- * Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.aliyun.com/price/product#/mongodb/detail) of ApsaraDB for MongoDB.
36476
+ * Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.alibabacloud.com/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB
35566
36477
  * Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
35567
36478
  * * The instance is in the Running state.
35568
36479
  * * Your instance has no unpaid billing method change orders.
35569
36480
  * * The instance type is available for purchase. For more information about unavailable instance types, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
35570
- * > To change the billing method of an instance whose instance type is no longer available to purchase, call the [ModifyDBInstanceSpec](https://help.aliyun.com/document_detail/61816.html) or [ModifyNodeSpec](https://help.aliyun.com/document_detail/61923.html) operation to first change the instance type.
36481
+ * > To change the billing method of an instance whose instance type is no longer available to purchase, call the [ModifyDBInstanceSpec](https://help.aliyun.com/document_detail/61816.html) or [ModifyNodeSpec](https://help.aliyun.com/document_detail/61923.html) operation to change the instance type first.
35571
36482
  *
35572
36483
  * @param request - TransformInstanceChargeTypeRequest
35573
36484
  * @param runtime - runtime options for this request RuntimeOptions
@@ -35645,12 +36556,12 @@ export default class Client extends OpenApi {
35645
36556
  * Changes the billing method of an instance from pay-as-you-go to subscription or from subscription to pay-as-you-go.
35646
36557
  *
35647
36558
  * @remarks
35648
- * Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.aliyun.com/price/product#/mongodb/detail) of ApsaraDB for MongoDB.
36559
+ * Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.alibabacloud.com/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB
35649
36560
  * Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
35650
36561
  * * The instance is in the Running state.
35651
36562
  * * Your instance has no unpaid billing method change orders.
35652
36563
  * * The instance type is available for purchase. For more information about unavailable instance types, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
35653
- * > To change the billing method of an instance whose instance type is no longer available to purchase, call the [ModifyDBInstanceSpec](https://help.aliyun.com/document_detail/61816.html) or [ModifyNodeSpec](https://help.aliyun.com/document_detail/61923.html) operation to first change the instance type.
36564
+ * > To change the billing method of an instance whose instance type is no longer available to purchase, call the [ModifyDBInstanceSpec](https://help.aliyun.com/document_detail/61816.html) or [ModifyNodeSpec](https://help.aliyun.com/document_detail/61923.html) operation to change the instance type first.
35654
36565
  *
35655
36566
  * @param request - TransformInstanceChargeTypeRequest
35656
36567
  * @returns TransformInstanceChargeTypeResponse
@@ -35886,6 +36797,10 @@ export default class Client extends OpenApi {
35886
36797
  query["ResourceOwnerId"] = request.resourceOwnerId;
35887
36798
  }
35888
36799
 
36800
+ if (!Util.isUnset(request.switchMode)) {
36801
+ query["SwitchMode"] = request.switchMode;
36802
+ }
36803
+
35889
36804
  let req = new $OpenApi.OpenApiRequest({
35890
36805
  query: OpenApiUtil.query(query),
35891
36806
  });
@@ -35955,6 +36870,10 @@ export default class Client extends OpenApi {
35955
36870
  query["ResourceOwnerId"] = request.resourceOwnerId;
35956
36871
  }
35957
36872
 
36873
+ if (!Util.isUnset(request.switchMode)) {
36874
+ query["SwitchMode"] = request.switchMode;
36875
+ }
36876
+
35958
36877
  let req = new $OpenApi.OpenApiRequest({
35959
36878
  query: OpenApiUtil.query(query),
35960
36879
  });