@alicloud/dds20151201 3.7.0 → 4.0.0

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/dist/client.d.ts CHANGED
@@ -268,6 +268,7 @@ export declare class CreateDBInstanceRequest extends $tea.Model {
268
268
  ownerAccount?: string;
269
269
  ownerId?: number;
270
270
  period?: number;
271
+ provisionedIops?: number;
271
272
  readonlyReplicas?: string;
272
273
  regionId?: string;
273
274
  replicationFactor?: string;
@@ -506,6 +507,7 @@ export declare class CreateShardingDBInstanceRequest extends $tea.Model {
506
507
  ownerId?: number;
507
508
  period?: number;
508
509
  protocolType?: string;
510
+ provisionedIops?: number;
509
511
  regionId?: string;
510
512
  replicaSet?: CreateShardingDBInstanceRequestReplicaSet[];
511
513
  resourceGroupId?: string;
@@ -1110,6 +1112,7 @@ export declare class DescribeAvailableResourceRequest extends $tea.Model {
1110
1112
  resourceOwnerAccount?: string;
1111
1113
  resourceOwnerId?: number;
1112
1114
  securityToken?: string;
1115
+ storageType?: string;
1113
1116
  zoneId?: string;
1114
1117
  static names(): {
1115
1118
  [key: string]: string;
@@ -1311,6 +1314,107 @@ export declare class DescribeBackupsResponse extends $tea.Model {
1311
1314
  [key: string]: any;
1312
1315
  });
1313
1316
  }
1317
+ export declare class DescribeClusterBackupsRequest extends $tea.Model {
1318
+ backupId?: string;
1319
+ DBInstanceId?: string;
1320
+ endTime?: string;
1321
+ isOnlyGetClusterBackUp?: boolean;
1322
+ ownerAccount?: string;
1323
+ ownerId?: number;
1324
+ pageNo?: number;
1325
+ pageSize?: number;
1326
+ resourceOwnerAccount?: string;
1327
+ resourceOwnerId?: number;
1328
+ securityToken?: string;
1329
+ startTime?: string;
1330
+ static names(): {
1331
+ [key: string]: string;
1332
+ };
1333
+ static types(): {
1334
+ [key: string]: any;
1335
+ };
1336
+ constructor(map?: {
1337
+ [key: string]: any;
1338
+ });
1339
+ }
1340
+ export declare class DescribeClusterBackupsResponseBody extends $tea.Model {
1341
+ clusterBackups?: DescribeClusterBackupsResponseBodyClusterBackups[];
1342
+ maxResults?: number;
1343
+ pageNumber?: number;
1344
+ pageSize?: number;
1345
+ requestId?: string;
1346
+ static names(): {
1347
+ [key: string]: string;
1348
+ };
1349
+ static types(): {
1350
+ [key: string]: any;
1351
+ };
1352
+ constructor(map?: {
1353
+ [key: string]: any;
1354
+ });
1355
+ }
1356
+ export declare class DescribeClusterBackupsResponse extends $tea.Model {
1357
+ headers: {
1358
+ [key: string]: string;
1359
+ };
1360
+ statusCode: number;
1361
+ body: DescribeClusterBackupsResponseBody;
1362
+ static names(): {
1363
+ [key: string]: string;
1364
+ };
1365
+ static types(): {
1366
+ [key: string]: any;
1367
+ };
1368
+ constructor(map?: {
1369
+ [key: string]: any;
1370
+ });
1371
+ }
1372
+ export declare class DescribeClusterRecoverTimeRequest extends $tea.Model {
1373
+ DBInstanceId?: string;
1374
+ ownerAccount?: string;
1375
+ ownerId?: number;
1376
+ resourceOwnerAccount?: string;
1377
+ resourceOwnerId?: number;
1378
+ securityToken?: string;
1379
+ static names(): {
1380
+ [key: string]: string;
1381
+ };
1382
+ static types(): {
1383
+ [key: string]: any;
1384
+ };
1385
+ constructor(map?: {
1386
+ [key: string]: any;
1387
+ });
1388
+ }
1389
+ export declare class DescribeClusterRecoverTimeResponseBody extends $tea.Model {
1390
+ requestId?: string;
1391
+ restoreRanges?: DescribeClusterRecoverTimeResponseBodyRestoreRanges[];
1392
+ static names(): {
1393
+ [key: string]: string;
1394
+ };
1395
+ static types(): {
1396
+ [key: string]: any;
1397
+ };
1398
+ constructor(map?: {
1399
+ [key: string]: any;
1400
+ });
1401
+ }
1402
+ export declare class DescribeClusterRecoverTimeResponse extends $tea.Model {
1403
+ headers: {
1404
+ [key: string]: string;
1405
+ };
1406
+ statusCode: number;
1407
+ body: DescribeClusterRecoverTimeResponseBody;
1408
+ static names(): {
1409
+ [key: string]: string;
1410
+ };
1411
+ static types(): {
1412
+ [key: string]: any;
1413
+ };
1414
+ constructor(map?: {
1415
+ [key: string]: any;
1416
+ });
1417
+ }
1314
1418
  export declare class DescribeDBInstanceAttributeRequest extends $tea.Model {
1315
1419
  DBInstanceId?: string;
1316
1420
  engine?: string;
@@ -1580,7 +1684,10 @@ export declare class DescribeDBInstanceTDEInfoRequest extends $tea.Model {
1580
1684
  });
1581
1685
  }
1582
1686
  export declare class DescribeDBInstanceTDEInfoResponseBody extends $tea.Model {
1687
+ encryptionKey?: string;
1688
+ encryptorName?: string;
1583
1689
  requestId?: string;
1690
+ roleARN?: string;
1584
1691
  TDEStatus?: string;
1585
1692
  static names(): {
1586
1693
  [key: string]: string;
@@ -4603,6 +4710,52 @@ export declare class TagResourcesResponse extends $tea.Model {
4603
4710
  [key: string]: any;
4604
4711
  });
4605
4712
  }
4713
+ export declare class TransferClusterBackupRequest extends $tea.Model {
4714
+ DBInstanceId?: string;
4715
+ ownerAccount?: string;
4716
+ ownerId?: number;
4717
+ resourceOwnerAccount?: string;
4718
+ resourceOwnerId?: number;
4719
+ securityToken?: string;
4720
+ static names(): {
4721
+ [key: string]: string;
4722
+ };
4723
+ static types(): {
4724
+ [key: string]: any;
4725
+ };
4726
+ constructor(map?: {
4727
+ [key: string]: any;
4728
+ });
4729
+ }
4730
+ export declare class TransferClusterBackupResponseBody extends $tea.Model {
4731
+ alreadyDone?: string;
4732
+ requestId?: string;
4733
+ static names(): {
4734
+ [key: string]: string;
4735
+ };
4736
+ static types(): {
4737
+ [key: string]: any;
4738
+ };
4739
+ constructor(map?: {
4740
+ [key: string]: any;
4741
+ });
4742
+ }
4743
+ export declare class TransferClusterBackupResponse extends $tea.Model {
4744
+ headers: {
4745
+ [key: string]: string;
4746
+ };
4747
+ statusCode: number;
4748
+ body: TransferClusterBackupResponseBody;
4749
+ static names(): {
4750
+ [key: string]: string;
4751
+ };
4752
+ static types(): {
4753
+ [key: string]: any;
4754
+ };
4755
+ constructor(map?: {
4756
+ [key: string]: any;
4757
+ });
4758
+ }
4606
4759
  export declare class TransformInstanceChargeTypeRequest extends $tea.Model {
4607
4760
  autoPay?: boolean;
4608
4761
  autoRenew?: string;
@@ -4613,6 +4766,7 @@ export declare class TransformInstanceChargeTypeRequest extends $tea.Model {
4613
4766
  ownerAccount?: string;
4614
4767
  ownerId?: number;
4615
4768
  period?: number;
4769
+ pricingCycle?: string;
4616
4770
  resourceOwnerAccount?: string;
4617
4771
  resourceOwnerId?: number;
4618
4772
  securityToken?: string;
@@ -5252,6 +5406,74 @@ export declare class DescribeBackupsResponseBodyBackups extends $tea.Model {
5252
5406
  [key: string]: any;
5253
5407
  });
5254
5408
  }
5409
+ export declare class DescribeClusterBackupsResponseBodyClusterBackupsBackups extends $tea.Model {
5410
+ backupDownloadURL?: string;
5411
+ backupEndTime?: string;
5412
+ backupId?: string;
5413
+ backupIntranetDownloadURL?: string;
5414
+ backupName?: string;
5415
+ backupSize?: string;
5416
+ backupStartTime?: string;
5417
+ backupStatus?: string;
5418
+ instanceName?: string;
5419
+ isAvail?: string;
5420
+ static names(): {
5421
+ [key: string]: string;
5422
+ };
5423
+ static types(): {
5424
+ [key: string]: any;
5425
+ };
5426
+ constructor(map?: {
5427
+ [key: string]: any;
5428
+ });
5429
+ }
5430
+ export declare class DescribeClusterBackupsResponseBodyClusterBackupsExtraInfo extends $tea.Model {
5431
+ registryFromHistory?: string;
5432
+ static names(): {
5433
+ [key: string]: string;
5434
+ };
5435
+ static types(): {
5436
+ [key: string]: any;
5437
+ };
5438
+ constructor(map?: {
5439
+ [key: string]: any;
5440
+ });
5441
+ }
5442
+ export declare class DescribeClusterBackupsResponseBodyClusterBackups extends $tea.Model {
5443
+ backups?: DescribeClusterBackupsResponseBodyClusterBackupsBackups[];
5444
+ clusterBackupEndTime?: string;
5445
+ clusterBackupId?: string;
5446
+ clusterBackupMode?: string;
5447
+ clusterBackupSize?: string;
5448
+ clusterBackupStartTime?: string;
5449
+ clusterBackupStatus?: string;
5450
+ extraInfo?: DescribeClusterBackupsResponseBodyClusterBackupsExtraInfo;
5451
+ isAvail?: number;
5452
+ progress?: string;
5453
+ static names(): {
5454
+ [key: string]: string;
5455
+ };
5456
+ static types(): {
5457
+ [key: string]: any;
5458
+ };
5459
+ constructor(map?: {
5460
+ [key: string]: any;
5461
+ });
5462
+ }
5463
+ export declare class DescribeClusterRecoverTimeResponseBodyRestoreRanges extends $tea.Model {
5464
+ restoreBeginTime?: string;
5465
+ restoreEndTime?: string;
5466
+ restoreType?: string;
5467
+ static names(): {
5468
+ [key: string]: string;
5469
+ };
5470
+ static types(): {
5471
+ [key: string]: any;
5472
+ };
5473
+ constructor(map?: {
5474
+ [key: string]: any;
5475
+ });
5476
+ }
5255
5477
  export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceConfigserverListConfigserverAttribute extends $tea.Model {
5256
5478
  connectString?: string;
5257
5479
  maxConnections?: number;
@@ -5407,6 +5629,7 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
5407
5629
  });
5408
5630
  }
5409
5631
  export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstance extends $tea.Model {
5632
+ burstingEnabled?: boolean;
5410
5633
  capacityUnit?: string;
5411
5634
  chargeType?: string;
5412
5635
  configserverList?: DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceConfigserverList;
@@ -5437,6 +5660,7 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
5437
5660
  mongosList?: DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceMongosList;
5438
5661
  networkType?: string;
5439
5662
  protocolType?: string;
5663
+ provisionedIops?: number;
5440
5664
  readonlyReplicas?: string;
5441
5665
  regionId?: string;
5442
5666
  replacateId?: string;
@@ -5450,6 +5674,7 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
5450
5674
  storageType?: string;
5451
5675
  syncPercent?: string;
5452
5676
  tags?: DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceTags;
5677
+ useClusterBackup?: boolean;
5453
5678
  VPCCloudInstanceIds?: string;
5454
5679
  VPCId?: string;
5455
5680
  vSwitchId?: string;
@@ -6039,6 +6264,7 @@ export declare class DescribePriceResponseBodyOrder extends $tea.Model {
6039
6264
  discountAmount?: string;
6040
6265
  originalAmount?: string;
6041
6266
  ruleIds?: DescribePriceResponseBodyOrderRuleIds;
6267
+ showDiscountInfo?: boolean;
6042
6268
  tradeAmount?: string;
6043
6269
  static names(): {
6044
6270
  [key: string]: string;
@@ -6143,6 +6369,7 @@ export declare class DescribeRegionsResponseBodyRegionsDdsRegionZones extends $t
6143
6369
  });
6144
6370
  }
6145
6371
  export declare class DescribeRegionsResponseBodyRegionsDdsRegion extends $tea.Model {
6372
+ endPoint?: string;
6146
6373
  regionId?: string;
6147
6374
  regionName?: string;
6148
6375
  zones?: DescribeRegionsResponseBodyRegionsDdsRegionZones;
@@ -6801,7 +7028,7 @@ export default class Client extends OpenApi {
6801
7028
  */
6802
7029
  deleteNode(request: DeleteNodeRequest): Promise<DeleteNodeResponse>;
6803
7030
  /**
6804
- * > This operation can query only the information of the root account.
7031
+ * > You can call this operation to query only the information of the root account.
6805
7032
  *
6806
7033
  * @param request DescribeAccountsRequest
6807
7034
  * @param runtime runtime options for this request RuntimeOptions
@@ -6809,7 +7036,7 @@ export default class Client extends OpenApi {
6809
7036
  */
6810
7037
  describeAccountsWithOptions(request: DescribeAccountsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAccountsResponse>;
6811
7038
  /**
6812
- * > This operation can query only the information of the root account.
7039
+ * > You can call this operation to query only the information of the root account.
6813
7040
  *
6814
7041
  * @param request DescribeAccountsRequest
6815
7042
  * @return DescribeAccountsResponse
@@ -6820,9 +7047,9 @@ export default class Client extends OpenApi {
6820
7047
  describeActiveOperationTaskTypeWithOptions(request: DescribeActiveOperationTaskTypeRequest, runtime: $Util.RuntimeOptions): Promise<DescribeActiveOperationTaskTypeResponse>;
6821
7048
  describeActiveOperationTaskType(request: DescribeActiveOperationTaskTypeRequest): Promise<DescribeActiveOperationTaskTypeResponse>;
6822
7049
  /**
6823
- * The role of the node in the instance. Valid values:
6824
- * * **primary**
6825
- * * **secondary**
7050
+ * * The instance must be in the running state when you call this operation.
7051
+ * * This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
7052
+ * * You can call this operation up to 30 times per minute. To call this operation at a higher frequency, use a Logstore. For more information, see [Manage a Logstore](~~48990~~).
6826
7053
  *
6827
7054
  * @param request DescribeAuditLogFilterRequest
6828
7055
  * @param runtime runtime options for this request RuntimeOptions
@@ -6830,9 +7057,9 @@ export default class Client extends OpenApi {
6830
7057
  */
6831
7058
  describeAuditLogFilterWithOptions(request: DescribeAuditLogFilterRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAuditLogFilterResponse>;
6832
7059
  /**
6833
- * The role of the node in the instance. Valid values:
6834
- * * **primary**
6835
- * * **secondary**
7060
+ * * The instance must be in the running state when you call this operation.
7061
+ * * This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
7062
+ * * You can call this operation up to 30 times per minute. To call this operation at a higher frequency, use a Logstore. For more information, see [Manage a Logstore](~~48990~~).
6836
7063
  *
6837
7064
  * @param request DescribeAuditLogFilterRequest
6838
7065
  * @return DescribeAuditLogFilterResponse
@@ -6928,6 +7155,10 @@ export default class Client extends OpenApi {
6928
7155
  describeBackupPolicy(request: DescribeBackupPolicyRequest): Promise<DescribeBackupPolicyResponse>;
6929
7156
  describeBackupsWithOptions(request: DescribeBackupsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeBackupsResponse>;
6930
7157
  describeBackups(request: DescribeBackupsRequest): Promise<DescribeBackupsResponse>;
7158
+ describeClusterBackupsWithOptions(request: DescribeClusterBackupsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeClusterBackupsResponse>;
7159
+ describeClusterBackups(request: DescribeClusterBackupsRequest): Promise<DescribeClusterBackupsResponse>;
7160
+ describeClusterRecoverTimeWithOptions(request: DescribeClusterRecoverTimeRequest, runtime: $Util.RuntimeOptions): Promise<DescribeClusterRecoverTimeResponse>;
7161
+ describeClusterRecoverTime(request: DescribeClusterRecoverTimeRequest): Promise<DescribeClusterRecoverTimeResponse>;
6931
7162
  describeDBInstanceAttributeWithOptions(request: DescribeDBInstanceAttributeRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBInstanceAttributeResponse>;
6932
7163
  describeDBInstanceAttribute(request: DescribeDBInstanceAttributeRequest): Promise<DescribeDBInstanceAttributeResponse>;
6933
7164
  /**
@@ -6988,7 +7219,7 @@ export default class Client extends OpenApi {
6988
7219
  */
6989
7220
  describeDBInstanceTDEInfo(request: DescribeDBInstanceTDEInfoRequest): Promise<DescribeDBInstanceTDEInfoResponse>;
6990
7221
  /**
6991
- * The list of replica set and standalone instances is displayed when the **DBInstanceType** parameter uses the default value **replicate**. To query the list of sharded cluster instances, you must set the **DBInstanceType** parameter to **sharding**.
7222
+ * The list of replica set and standalone instances is displayed when the **DBInstanceType** parameter uses the default value **replicate**. To query a list of sharded cluster instances, you must set the **DBInstanceType** parameter to **sharding**.
6992
7223
  *
6993
7224
  * @param request DescribeDBInstancesRequest
6994
7225
  * @param runtime runtime options for this request RuntimeOptions
@@ -6996,7 +7227,7 @@ export default class Client extends OpenApi {
6996
7227
  */
6997
7228
  describeDBInstancesWithOptions(request: DescribeDBInstancesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBInstancesResponse>;
6998
7229
  /**
6999
- * The list of replica set and standalone instances is displayed when the **DBInstanceType** parameter uses the default value **replicate**. To query the list of sharded cluster instances, you must set the **DBInstanceType** parameter to **sharding**.
7230
+ * The list of replica set and standalone instances is displayed when the **DBInstanceType** parameter uses the default value **replicate**. To query a list of sharded cluster instances, you must set the **DBInstanceType** parameter to **sharding**.
7000
7231
  *
7001
7232
  * @param request DescribeDBInstancesRequest
7002
7233
  * @return DescribeDBInstancesResponse
@@ -7343,10 +7574,10 @@ export default class Client extends OpenApi {
7343
7574
  modifyDBInstanceMaintainTimeWithOptions(request: ModifyDBInstanceMaintainTimeRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBInstanceMaintainTimeResponse>;
7344
7575
  modifyDBInstanceMaintainTime(request: ModifyDBInstanceMaintainTimeRequest): Promise<ModifyDBInstanceMaintainTimeResponse>;
7345
7576
  /**
7346
- * > operation is currently unavailable.
7577
+ * > This operation is applicable only to the ApsaraDB for MongoDB console of the previous version due to the change in the frequency at which the monitoring data of an ApsaraDB for MongoDB instance is collected.
7347
7578
  * Before you call this operation, make sure that the following requirements are met:
7348
- * * A replica set or sharded cluster instance is used.
7349
- * * MongoDB 3.4 (the latest minor version) or 4.0 must be selected.
7579
+ * * The instance is a replica set or sharded cluster instance.
7580
+ * * The instance runs MongoDB 3.4 (the latest minor version) or 4.0.
7350
7581
  *
7351
7582
  * @param request ModifyDBInstanceMonitorRequest
7352
7583
  * @param runtime runtime options for this request RuntimeOptions
@@ -7354,10 +7585,10 @@ export default class Client extends OpenApi {
7354
7585
  */
7355
7586
  modifyDBInstanceMonitorWithOptions(request: ModifyDBInstanceMonitorRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBInstanceMonitorResponse>;
7356
7587
  /**
7357
- * > operation is currently unavailable.
7588
+ * > This operation is applicable only to the ApsaraDB for MongoDB console of the previous version due to the change in the frequency at which the monitoring data of an ApsaraDB for MongoDB instance is collected.
7358
7589
  * Before you call this operation, make sure that the following requirements are met:
7359
- * * A replica set or sharded cluster instance is used.
7360
- * * MongoDB 3.4 (the latest minor version) or 4.0 must be selected.
7590
+ * * The instance is a replica set or sharded cluster instance.
7591
+ * * The instance runs MongoDB 3.4 (the latest minor version) or 4.0.
7361
7592
  *
7362
7593
  * @param request ModifyDBInstanceMonitorRequest
7363
7594
  * @return ModifyDBInstanceMonitorResponse
@@ -7643,7 +7874,7 @@ export default class Client extends OpenApi {
7643
7874
  */
7644
7875
  resetAccountPassword(request: ResetAccountPasswordRequest): Promise<ResetAccountPasswordResponse>;
7645
7876
  /**
7646
- * This operation can also be used to restart a shard or mongos node in a sharded cluster instance.
7877
+ * This operation can also be used to restart an instance, or restart a shard or mongos node in a sharded cluster instance.
7647
7878
  *
7648
7879
  * @param request RestartDBInstanceRequest
7649
7880
  * @param runtime runtime options for this request RuntimeOptions
@@ -7651,7 +7882,7 @@ export default class Client extends OpenApi {
7651
7882
  */
7652
7883
  restartDBInstanceWithOptions(request: RestartDBInstanceRequest, runtime: $Util.RuntimeOptions): Promise<RestartDBInstanceResponse>;
7653
7884
  /**
7654
- * This operation can also be used to restart a shard or mongos node in a sharded cluster instance.
7885
+ * This operation can also be used to restart an instance, or restart a shard or mongos node in a sharded cluster instance.
7655
7886
  *
7656
7887
  * @param request RestartDBInstanceRequest
7657
7888
  * @return RestartDBInstanceResponse
@@ -7720,6 +7951,8 @@ export default class Client extends OpenApi {
7720
7951
  * @return TagResourcesResponse
7721
7952
  */
7722
7953
  tagResources(request: TagResourcesRequest): Promise<TagResourcesResponse>;
7954
+ transferClusterBackupWithOptions(request: TransferClusterBackupRequest, runtime: $Util.RuntimeOptions): Promise<TransferClusterBackupResponse>;
7955
+ transferClusterBackup(request: TransferClusterBackupRequest): Promise<TransferClusterBackupResponse>;
7723
7956
  /**
7724
7957
  * 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.
7725
7958
  * Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements: