@alicloud/dds20151201 7.0.1 → 7.1.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
@@ -309,6 +309,7 @@ export declare class CheckRecoveryConditionRequest extends $tea.Model {
309
309
  * cn-hangzhou
310
310
  */
311
311
  destRegion?: string;
312
+ engineVersion?: string;
312
313
  /**
313
314
  * @remarks
314
315
  * The instance architecture. Valid values:
@@ -748,7 +749,7 @@ export declare class CreateDBInstanceRequest extends $tea.Model {
748
749
  encryptionKey?: string;
749
750
  /**
750
751
  * @remarks
751
- * The database engine of the instance. The value is fixed as **MongoDB**.
752
+ * The database engine of the instance. Set the value to **MongoDB**.
752
753
  *
753
754
  * @example
754
755
  * MongoDB
@@ -892,6 +893,17 @@ export declare class CreateDBInstanceRequest extends $tea.Model {
892
893
  * 2022-03-13T12:11:14Z
893
894
  */
894
895
  restoreTime?: string;
896
+ /**
897
+ * @remarks
898
+ * The backup restore type of the instance.
899
+ * - 0: restore an instance to the specified backup set.
900
+ * - 1: restore an instance to the specified time.
901
+ * - 2: restore an released instance to the specified backup set.
902
+ * - 3:restore an instance to the specified cross-regional backup set.
903
+ *
904
+ * @example
905
+ * 0
906
+ */
895
907
  restoreType?: string;
896
908
  /**
897
909
  * @remarks
@@ -948,17 +960,22 @@ export declare class CreateDBInstanceRequest extends $tea.Model {
948
960
  * dds-bp1ee12ad351****
949
961
  */
950
962
  srcDBInstanceId?: string;
951
- srcRegion?: string;
952
963
  /**
953
964
  * @remarks
954
- * The storage engine of the instance. Default value: WiredTiger. Valid values:
965
+ * The region ID of the instance.
955
966
  *
956
- * * **WiredTiger**
957
- * * **RocksDB**
958
- * * **TerarkDB**
967
+ * > - This parameter is required when restore type is set to 2 or 3.
959
968
  *
960
- * > * 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.
961
- * > * 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).
969
+ * @example
970
+ * 2
971
+ */
972
+ srcRegion?: string;
973
+ /**
974
+ * @remarks
975
+ * The storage engine of the instance. Set the value to **WiredTiger**.
976
+ *
977
+ * > * 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.
978
+ * > * 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).
962
979
  *
963
980
  * @example
964
981
  * WiredTiger
@@ -1561,6 +1578,15 @@ export declare class CreateShardingDBInstanceRequest extends $tea.Model {
1561
1578
  * true
1562
1579
  */
1563
1580
  autoRenew?: string;
1581
+ /**
1582
+ * @remarks
1583
+ * The ID of the backup set.
1584
+ *
1585
+ * > When you call this operation to clone an instance based on the backup set, this parameter is required. The **SrcDBInstanceId** parameter is also required.
1586
+ *
1587
+ * @example
1588
+ * cb-xxx
1589
+ */
1564
1590
  backupId?: string;
1565
1591
  /**
1566
1592
  * @remarks
@@ -1569,7 +1595,7 @@ export declare class CreateShardingDBInstanceRequest extends $tea.Model {
1569
1595
  * * **PostPaid** (default): pay-as-you-go
1570
1596
  * * **PrePaid**: subscription
1571
1597
  *
1572
- * > If you set this parameter to **PrePaid**, you must also specify the **Period** parameter.
1598
+ * > If this parameter is set to **PrePaid**, you must also configure the **Period** parameter.
1573
1599
  *
1574
1600
  * @example
1575
1601
  * PrePaid
@@ -1602,10 +1628,19 @@ export declare class CreateShardingDBInstanceRequest extends $tea.Model {
1602
1628
  * test
1603
1629
  */
1604
1630
  DBInstanceDescription?: string;
1631
+ /**
1632
+ * @remarks
1633
+ * The region of the backup set used for the cross-region backup and restoration.
1634
+ *
1635
+ * > This parameter is required when you set the RestoreType parameter to 3.
1636
+ *
1637
+ * @example
1638
+ * cn-hangzhou
1639
+ */
1605
1640
  destRegion?: string;
1606
1641
  /**
1607
1642
  * @remarks
1608
- * Specifies whether to enable disk encryption.
1643
+ * Indicates whether disk encryption is enabled.
1609
1644
  *
1610
1645
  * @example
1611
1646
  * true
@@ -1631,17 +1666,17 @@ export declare class CreateShardingDBInstanceRequest extends $tea.Model {
1631
1666
  engine?: string;
1632
1667
  /**
1633
1668
  * @remarks
1634
- * The version of the database engine. Valid values:
1669
+ * The database engine version of the instance. Valid values:
1635
1670
  *
1671
+ * * **7.0**
1636
1672
  * * **6.0**
1637
1673
  * * **5.0**
1638
1674
  * * **4.4**
1639
1675
  * * **4.2**
1640
1676
  * * **4.0**
1641
- * * **3.4**
1642
1677
  *
1643
- * > * 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).
1644
- * > * If you call this operation to clone an instance, set the value of this parameter to the engine version of the source instance.
1678
+ * > * 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).
1679
+ * > * If you call this operation to clone an instance, set the value of this parameter to the database engine version of the source instance.
1645
1680
  *
1646
1681
  * This parameter is required.
1647
1682
  *
@@ -1697,7 +1732,9 @@ export declare class CreateShardingDBInstanceRequest extends $tea.Model {
1697
1732
  mongos?: CreateShardingDBInstanceRequestMongos[];
1698
1733
  /**
1699
1734
  * @remarks
1700
- * The network type of the instance. Set the value to VPC.
1735
+ * The network type of the instance.
1736
+ *
1737
+ * Set the value to **VPC**.
1701
1738
  *
1702
1739
  * @example
1703
1740
  * VPC
@@ -1721,8 +1758,8 @@ export declare class CreateShardingDBInstanceRequest extends $tea.Model {
1721
1758
  * @remarks
1722
1759
  * The access protocol type of the instance. Valid values:
1723
1760
  *
1724
- * * **mongodb**: the MongoDB protocol
1725
- * * **dynamodb**: the DynamoDB protocol
1761
+ * * **mongodb**
1762
+ * * **dynamodb**
1726
1763
  *
1727
1764
  * @example
1728
1765
  * mongodb
@@ -1773,6 +1810,16 @@ export declare class CreateShardingDBInstanceRequest extends $tea.Model {
1773
1810
  * 2022-03-08T02:30:25Z
1774
1811
  */
1775
1812
  restoreTime?: string;
1813
+ /**
1814
+ * @remarks
1815
+ * The backup restore type of the instance.
1816
+ * - 1: restore an instance to the specified time.
1817
+ * - 2: restore an released instance to the specified backup set.
1818
+ * - 3:restore an instance to the specified cross-regional backup set.
1819
+ *
1820
+ * @example
1821
+ * 1
1822
+ */
1776
1823
  restoreType?: string;
1777
1824
  /**
1778
1825
  * @remarks
@@ -1830,13 +1877,22 @@ export declare class CreateShardingDBInstanceRequest extends $tea.Model {
1830
1877
  * dds-bp11483712c1****
1831
1878
  */
1832
1879
  srcDBInstanceId?: string;
1880
+ /**
1881
+ * @remarks
1882
+ * The region ID of the instance.
1883
+ *
1884
+ * > This parameter is required when restore type is set to 2 or 3.
1885
+ *
1886
+ * @example
1887
+ * cn-beijing
1888
+ */
1833
1889
  srcRegion?: string;
1834
1890
  /**
1835
1891
  * @remarks
1836
1892
  * The storage engine of the instance. Set the value to **WiredTiger**.
1837
1893
  *
1838
- * > * If you call this operation to clone an instance, set the value of this parameter to the storage engine of the source instance.
1839
- * > * 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).
1894
+ * > * If you call this operation to clone an instance, set the value of this parameter to the storage engine of the source instance.
1895
+ * > * 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).
1840
1896
  *
1841
1897
  * @example
1842
1898
  * WiredTiger
@@ -3518,12 +3574,29 @@ export declare class DescribeBackupPolicyRequest extends $tea.Model {
3518
3574
  * dds-bp16cb162771****
3519
3575
  */
3520
3576
  DBInstanceId?: string;
3577
+ /**
3578
+ * @remarks
3579
+ * The architecture of the instance. Valid values:
3580
+ *
3581
+ * * **sharding**: sharded cluster instance
3582
+ * * **replicate**: replica set or standalone instance
3583
+ *
3584
+ * @example
3585
+ * sharding
3586
+ */
3521
3587
  instanceType?: string;
3522
3588
  ownerAccount?: string;
3523
3589
  ownerId?: number;
3524
3590
  resourceOwnerAccount?: string;
3525
3591
  resourceOwnerId?: number;
3526
3592
  securityToken?: string;
3593
+ /**
3594
+ * @remarks
3595
+ * The region ID of the instance.
3596
+ *
3597
+ * @example
3598
+ * cn-beijing
3599
+ */
3527
3600
  srcRegion?: string;
3528
3601
  static names(): {
3529
3602
  [key: string]: string;
@@ -3563,12 +3636,82 @@ export declare class DescribeBackupPolicyResponseBody extends $tea.Model {
3563
3636
  * 30
3564
3637
  */
3565
3638
  backupRetentionPeriod?: string;
3639
+ /**
3640
+ * @remarks
3641
+ * The backup retention policy configured for the instance. Valid values:
3642
+ *
3643
+ * 1. 0: All backup sets are immediately deleted when the instance is released.
3644
+ * 2. 1: Automatic backup is performed and the backup set is retained for a long period of time when the instance is released.
3645
+ * 3. 2: Automatic backup is performed and all backup sets are retained for a long period of time when the instance is released.
3646
+ *
3647
+ * 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).
3648
+ *
3649
+ * @example
3650
+ * 0
3651
+ */
3566
3652
  backupRetentionPolicyOnClusterDeletion?: number;
3653
+ /**
3654
+ * @remarks
3655
+ * The retention period of Cross-regional backup.
3656
+ * Valid values:
3657
+ *
3658
+ * * **Monday**
3659
+ * * **Tuesday**
3660
+ * * **Wednesday**
3661
+ * * **Thursday**
3662
+ * * **Friday**
3663
+ * * **Saturday**
3664
+ * * **Sunday**
3665
+ *
3666
+ * @example
3667
+ * Monday
3668
+ */
3567
3669
  crossBackupPeriod?: string;
3670
+ /**
3671
+ * @remarks
3672
+ * The retention type of Cross-regional log backup.
3673
+ *
3674
+ * - delay : retain the backup for a period of time.
3675
+ * - never : retain the backup permanently.
3676
+ *
3677
+ * @example
3678
+ * delay
3679
+ */
3568
3680
  crossLogRetentionType?: string;
3681
+ /**
3682
+ * @remarks
3683
+ * The retention time of Cross-regional log backup.
3684
+ *
3685
+ * @example
3686
+ * 7
3687
+ */
3569
3688
  crossLogRetentionValue?: number;
3689
+ /**
3690
+ * @remarks
3691
+ * The retention type of Cross-regional backup.
3692
+ *
3693
+ * - delay : retain the backup for a period of time.
3694
+ * - never : retain the backup permanently.
3695
+ *
3696
+ * @example
3697
+ * delay
3698
+ */
3570
3699
  crossRetentionType?: string;
3700
+ /**
3701
+ * @remarks
3702
+ * The retention time of Cross-regional backup.
3703
+ *
3704
+ * @example
3705
+ * 7
3706
+ */
3571
3707
  crossRetentionValue?: number;
3708
+ /**
3709
+ * @remarks
3710
+ * The region ID of the cross-regional backup..
3711
+ *
3712
+ * @example
3713
+ * cn-shenzhen
3714
+ */
3572
3715
  destRegion?: string;
3573
3716
  /**
3574
3717
  * @remarks
@@ -3581,6 +3724,15 @@ export declare class DescribeBackupPolicyResponseBody extends $tea.Model {
3581
3724
  * 1
3582
3725
  */
3583
3726
  enableBackupLog?: number;
3727
+ /**
3728
+ * @remarks
3729
+ * Whether to turn on cross-regional log backup.
3730
+ * - 1: turn on . Used for sharded cluster.
3731
+ * - 0: turn off. Used for replicate set.
3732
+ *
3733
+ * @example
3734
+ * 1
3735
+ */
3584
3736
  enableCrossLogBackup?: number;
3585
3737
  /**
3586
3738
  * @remarks
@@ -3622,6 +3774,13 @@ export declare class DescribeBackupPolicyResponseBody extends $tea.Model {
3622
3774
  * 09:00Z-10:00Z
3623
3775
  */
3624
3776
  preferredBackupTime?: string;
3777
+ /**
3778
+ * @remarks
3779
+ * The time of next standard backup.
3780
+ *
3781
+ * @example
3782
+ * 2024-06-19T19:11Z
3783
+ */
3625
3784
  preferredNextBackupTime?: string;
3626
3785
  /**
3627
3786
  * @remarks
@@ -3642,6 +3801,13 @@ export declare class DescribeBackupPolicyResponseBody extends $tea.Model {
3642
3801
  * Standard
3643
3802
  */
3644
3803
  snapshotBackupType?: string;
3804
+ /**
3805
+ * @remarks
3806
+ * The region ID of the instance.
3807
+ *
3808
+ * @example
3809
+ * cn-hangzhou
3810
+ */
3645
3811
  srcRegion?: string;
3646
3812
  static names(): {
3647
3813
  [key: string]: string;
@@ -3872,6 +4038,15 @@ export declare class DescribeBackupsRequest extends $tea.Model {
3872
4038
  * dds-bp1a7009eb24****
3873
4039
  */
3874
4040
  DBInstanceId?: string;
4041
+ /**
4042
+ * @remarks
4043
+ * The region ID of the Cross-regional backup.
4044
+ *
4045
+ * > This parameter is required for the Cross-regional backup.
4046
+ *
4047
+ * @example
4048
+ * cn-hangzhou
4049
+ */
3875
4050
  destRegion?: string;
3876
4051
  /**
3877
4052
  * @remarks
@@ -3895,7 +4070,7 @@ export declare class DescribeBackupsRequest extends $tea.Model {
3895
4070
  ownerId?: number;
3896
4071
  /**
3897
4072
  * @remarks
3898
- * The page number of the page to return.
4073
+ * 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**.
3899
4074
  *
3900
4075
  * @example
3901
4076
  * 1
@@ -3903,7 +4078,7 @@ export declare class DescribeBackupsRequest extends $tea.Model {
3903
4078
  pageNumber?: number;
3904
4079
  /**
3905
4080
  * @remarks
3906
- * The number of entries to return on each page. Valid values:
4081
+ * The number of entries to return per page. Valid values:
3907
4082
  *
3908
4083
  * * **30** (default)
3909
4084
  * * **50**
@@ -3915,6 +4090,16 @@ export declare class DescribeBackupsRequest extends $tea.Model {
3915
4090
  pageSize?: number;
3916
4091
  resourceOwnerAccount?: string;
3917
4092
  resourceOwnerId?: number;
4093
+ /**
4094
+ * @remarks
4095
+ * The region ID of the instance.
4096
+ *
4097
+ * >- This parameter is required if you want to query the backup sets of a released instance.
4098
+ * >- This parameter is required if you want to query cross-region backups.
4099
+ *
4100
+ * @example
4101
+ * cn-beijing
4102
+ */
3918
4103
  srcRegion?: string;
3919
4104
  /**
3920
4105
  * @remarks
@@ -4248,7 +4433,7 @@ export declare class DescribeDBInstanceAttributeRequest extends $tea.Model {
4248
4433
  DBInstanceId?: string;
4249
4434
  /**
4250
4435
  * @remarks
4251
- * The database engine of the instance. Set the value to **MongoDB**.
4436
+ * The database engine. Set the value to **MongoDB**.
4252
4437
  *
4253
4438
  * @example
4254
4439
  * MongoDB
@@ -4256,10 +4441,10 @@ export declare class DescribeDBInstanceAttributeRequest extends $tea.Model {
4256
4441
  engine?: string;
4257
4442
  /**
4258
4443
  * @remarks
4259
- * Specifies whether to delete the instance. Valid values:
4444
+ * Specifies whether to query instances that are deleted. Valid values:
4260
4445
  *
4261
- * - **false**: queries the details of running instances.
4262
- * - **true**: queries the details of deleted instances.
4446
+ * * **false**: queries instances that are running.
4447
+ * * **true**: queries instance that are deleted.
4263
4448
  *
4264
4449
  * @example
4265
4450
  * false
@@ -4293,7 +4478,7 @@ export declare class DescribeDBInstanceAttributeRequest extends $tea.Model {
4293
4478
  export declare class DescribeDBInstanceAttributeResponseBody extends $tea.Model {
4294
4479
  /**
4295
4480
  * @remarks
4296
- * The information of the instance.
4481
+ * The instance details.
4297
4482
  */
4298
4483
  DBInstances?: DescribeDBInstanceAttributeResponseBodyDBInstances;
4299
4484
  /**
@@ -7466,6 +7651,95 @@ export declare class DescribeReplicaSetRoleResponse extends $tea.Model {
7466
7651
  [key: string]: any;
7467
7652
  });
7468
7653
  }
7654
+ export declare class DescribeRestoreDBInstanceListRequest extends $tea.Model {
7655
+ /**
7656
+ * @remarks
7657
+ * This parameter is required.
7658
+ *
7659
+ * @example
7660
+ * 2024-07-24T14:00:00Z
7661
+ */
7662
+ creationTimeAfter?: string;
7663
+ /**
7664
+ * @remarks
7665
+ * This parameter is required.
7666
+ *
7667
+ * @example
7668
+ * dds-bp114f14849d****
7669
+ */
7670
+ DBInstanceId?: string;
7671
+ ownerAccount?: string;
7672
+ ownerId?: number;
7673
+ /**
7674
+ * @example
7675
+ * 1
7676
+ */
7677
+ pageNumber?: number;
7678
+ /**
7679
+ * @example
7680
+ * 30
7681
+ */
7682
+ pageSize?: number;
7683
+ resourceOwnerAccount?: string;
7684
+ resourceOwnerId?: number;
7685
+ static names(): {
7686
+ [key: string]: string;
7687
+ };
7688
+ static types(): {
7689
+ [key: string]: any;
7690
+ };
7691
+ constructor(map?: {
7692
+ [key: string]: any;
7693
+ });
7694
+ }
7695
+ export declare class DescribeRestoreDBInstanceListResponseBody extends $tea.Model {
7696
+ DBInstances?: DescribeRestoreDBInstanceListResponseBodyDBInstances;
7697
+ /**
7698
+ * @example
7699
+ * 1
7700
+ */
7701
+ pageNumber?: number;
7702
+ /**
7703
+ * @example
7704
+ * 30
7705
+ */
7706
+ pageSize?: number;
7707
+ /**
7708
+ * @example
7709
+ * 1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx
7710
+ */
7711
+ requestId?: string;
7712
+ /**
7713
+ * @example
7714
+ * 5
7715
+ */
7716
+ totalCount?: number;
7717
+ static names(): {
7718
+ [key: string]: string;
7719
+ };
7720
+ static types(): {
7721
+ [key: string]: any;
7722
+ };
7723
+ constructor(map?: {
7724
+ [key: string]: any;
7725
+ });
7726
+ }
7727
+ export declare class DescribeRestoreDBInstanceListResponse extends $tea.Model {
7728
+ headers?: {
7729
+ [key: string]: string;
7730
+ };
7731
+ statusCode?: number;
7732
+ body?: DescribeRestoreDBInstanceListResponseBody;
7733
+ static names(): {
7734
+ [key: string]: string;
7735
+ };
7736
+ static types(): {
7737
+ [key: string]: any;
7738
+ };
7739
+ constructor(map?: {
7740
+ [key: string]: any;
7741
+ });
7742
+ }
7469
7743
  export declare class DescribeRoleZoneInfoRequest extends $tea.Model {
7470
7744
  /**
7471
7745
  * @remarks
@@ -8766,11 +9040,25 @@ export declare class MigrateAvailableZoneRequest extends $tea.Model {
8766
9040
  * Immediately
8767
9041
  */
8768
9042
  effectiveTime?: string;
9043
+ /**
9044
+ * @remarks
9045
+ * The ID of the destination hidden zone.
9046
+ *
9047
+ * @example
9048
+ * cn-shanghai-n
9049
+ */
8769
9050
  hiddenZoneId?: string;
8770
9051
  ownerAccount?: string;
8771
9052
  ownerId?: number;
8772
9053
  resourceOwnerAccount?: string;
8773
9054
  resourceOwnerId?: number;
9055
+ /**
9056
+ * @remarks
9057
+ * The ID of the destination secondary zone.
9058
+ *
9059
+ * @example
9060
+ * cn-hangzhou-h
9061
+ */
8774
9062
  secondaryZoneId?: string;
8775
9063
  /**
8776
9064
  * @remarks
@@ -9314,7 +9602,7 @@ export declare class ModifyAuditPolicyResponse extends $tea.Model {
9314
9602
  export declare class ModifyBackupPolicyRequest extends $tea.Model {
9315
9603
  /**
9316
9604
  * @remarks
9317
- * The frequency at which high-frequency backup is created. Valid values:
9605
+ * The frequency at which high-frequency backups are generated. Valid values:
9318
9606
  *
9319
9607
  * * **-1**: High-frequency backup is disabled.
9320
9608
  * * **30**: High-frequency backups are generated every 30 minutes.
@@ -9328,9 +9616,9 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
9328
9616
  *
9329
9617
  * >
9330
9618
  *
9331
- * * If the **SnapshotBackupType** parameter is set to **Standard**, this parameter is set to -1 and cannot be changed.
9619
+ * * If you set the **SnapshotBackupType** parameter to **Standard**, you must fix the value of this parameter to -1.
9332
9620
  *
9333
- * * High-frequency backup takes effect only when the **SnapshotBackupType** parameter is set to **Flash** and the value of this parameter is greater than 0.
9621
+ * * High-frequency backup takes effect only when you set the **SnapshotBackupType** parameter to **Flash** and this parameter to a value greater than 0.
9334
9622
  *
9335
9623
  * @example
9336
9624
  * -1
@@ -9347,15 +9635,98 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
9347
9635
  * * If your instance is created after September 10, 2021, backups are retained for 30 days by default.
9348
9636
  *
9349
9637
  * @example
9350
- * 30
9638
+ * 30
9639
+ */
9640
+ backupRetentionPeriod?: number;
9641
+ /**
9642
+ * @remarks
9643
+ * The backup retention policy configured for the instance. Valid values:
9644
+ *
9645
+ * 1. 0: All backup sets are immediately deleted when the instance is released.
9646
+ * 2. 1: Automatic backup is performed and the backup set is retained for a long period of time when the instance is released.
9647
+ * 3. 2: Automatic backup is performed and all backup sets are retained for a long period of time when the instance is released.
9648
+ *
9649
+ * 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).
9650
+ *
9651
+ * @example
9652
+ * 2
9653
+ */
9654
+ backupRetentionPolicyOnClusterDeletion?: number;
9655
+ /**
9656
+ * @remarks
9657
+ * The retention period of Cross-regional backup.
9658
+ * Valid values:
9659
+ *
9660
+ * * **Monday**
9661
+ * * **Tuesday**
9662
+ * * **Wednesday**
9663
+ * * **Thursday**
9664
+ * * **Friday**
9665
+ * * **Saturday**
9666
+ * * **Sunday**
9667
+ *
9668
+ * **
9669
+ *
9670
+ *
9671
+ *
9672
+ *
9673
+ *
9674
+ * >- Separate multiple values with commas (,).
9675
+ * >- When SnapshotBackupType is set to standard, this value needs to be a subset of the PreferredBackupPeriod.
9676
+ *
9677
+ * @example
9678
+ * Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
9679
+ */
9680
+ crossBackupPeriod?: string;
9681
+ /**
9682
+ * @remarks
9683
+ * The operation strategy of Cross-regional backup.
9684
+ * - update
9685
+ * - delete
9686
+ *
9687
+ * @example
9688
+ * update
9689
+ */
9690
+ crossBackupType?: string;
9691
+ /**
9692
+ * @remarks
9693
+ * The retention type of Cross-regional log backup.
9694
+ *
9695
+ * - delay : retain the backup for a period of time.
9696
+ * - never : retain the backup permanently.
9697
+ *
9698
+ * @example
9699
+ * delay
9700
+ */
9701
+ crossLogRetentionType?: string;
9702
+ /**
9703
+ * @remarks
9704
+ * The retention time of Cross-regional log backup, 3 - 1825 days.
9705
+ *
9706
+ * @example
9707
+ * 3
9708
+ */
9709
+ crossLogRetentionValue?: number;
9710
+ /**
9711
+ * @remarks
9712
+ * The retention type of Cross-regional backup.
9713
+ *
9714
+ * - delay : retain the backup for a period of time.
9715
+ * - never : retain the backup permanently.
9716
+ *
9717
+ * @example
9718
+ * delay
9351
9719
  */
9352
- backupRetentionPeriod?: number;
9353
- backupRetentionPolicyOnClusterDeletion?: number;
9354
- crossBackupPeriod?: string;
9355
- crossBackupType?: string;
9356
- crossLogRetentionType?: string;
9357
- crossLogRetentionValue?: number;
9358
9720
  crossRetentionType?: string;
9721
+ /**
9722
+ * @remarks
9723
+ * The retention time of Cross-regional backup, 3 - 1825 days.
9724
+ * >
9725
+ * > - Used and must be used when CrossRetentionType is delay.
9726
+ *
9727
+ * @example
9728
+ * 7
9729
+ */
9359
9730
  crossRetentionValue?: number;
9360
9731
  /**
9361
9732
  * @remarks
@@ -9367,6 +9738,15 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
9367
9738
  * dds-bp16cb162771****
9368
9739
  */
9369
9740
  DBInstanceId?: string;
9741
+ /**
9742
+ * @remarks
9743
+ * The region id of Cross-regional backup.
9744
+ * >
9745
+ * > - Required for Cross-regional backup.
9746
+ *
9747
+ * @example
9748
+ * cn-hangzhou
9749
+ */
9370
9750
  destRegion?: string;
9371
9751
  /**
9372
9752
  * @remarks
@@ -9379,12 +9759,37 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
9379
9759
  * 0
9380
9760
  */
9381
9761
  enableBackupLog?: number;
9762
+ /**
9763
+ * @remarks
9764
+ * Whether to turn on cross-regional log backup.
9765
+ * - 1:turn on . Used for sharded cluster.
9766
+ * - 0: turn off. Used for replicate set.
9767
+ *
9768
+ * @example
9769
+ * 1
9770
+ */
9382
9771
  enableCrossLogBackup?: number;
9383
9772
  /**
9384
9773
  * @remarks
9385
9774
  * 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.
9775
+ *
9776
+ * @example
9777
+ * 1
9386
9778
  */
9387
9779
  highFrequencyBackupRetention?: number;
9780
+ /**
9781
+ * @remarks
9782
+ * The instance architecture. Valid values:
9783
+ *
9784
+ * * replicate
9785
+ * * sharding
9786
+ *
9787
+ * > * This parameter is required for Cross-regional backup.
9788
+ * > * This parameter is required for backup recovery of deleted instances.
9789
+ *
9790
+ * @example
9791
+ * replicate
9792
+ */
9388
9793
  instanceType?: string;
9389
9794
  /**
9390
9795
  * @remarks
@@ -9410,6 +9815,10 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
9410
9815
  * * **Saturday**
9411
9816
  * * **Sunday**
9412
9817
  *
9818
+ * **
9819
+ *
9820
+ * **Notice**: To ensure data security, make sure that the system backs up data at least twice a week.
9821
+ *
9413
9822
  * > Separate multiple values with commas (,).
9414
9823
  *
9415
9824
  * @example
@@ -9439,6 +9848,17 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
9439
9848
  * Standard
9440
9849
  */
9441
9850
  snapshotBackupType?: string;
9851
+ /**
9852
+ * @remarks
9853
+ * The region ID of the instance.
9854
+ *
9855
+ * >
9856
+ * > - Required for Cross-regional backup.
9857
+ * > - Required for backup recovery of deleted instances.
9858
+ *
9859
+ * @example
9860
+ * cn-beijing
9861
+ */
9442
9862
  srcRegion?: string;
9443
9863
  static names(): {
9444
9864
  [key: string]: string;
@@ -12295,6 +12715,10 @@ export declare class RestartDBInstanceResponse extends $tea.Model {
12295
12715
  export declare class RestartNodeRequest extends $tea.Model {
12296
12716
  /**
12297
12717
  * @remarks
12718
+ * The instance ID.
12719
+ *
12720
+ * > If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.
12721
+ *
12298
12722
  * This parameter is required.
12299
12723
  *
12300
12724
  * @example
@@ -12302,6 +12726,11 @@ export declare class RestartNodeRequest extends $tea.Model {
12302
12726
  */
12303
12727
  DBInstanceId?: string;
12304
12728
  /**
12729
+ * @remarks
12730
+ * The ID of the shard, mongos, or ConfigServer node in a child instance of the sharded cluster instance.
12731
+ *
12732
+ * > If you set the **DBInstanceId** parameter to the ID of a sharded cluster instance, you must specify this parameter.
12733
+ *
12305
12734
  * @example
12306
12735
  * d-bp128a003436****
12307
12736
  */
@@ -12312,6 +12741,11 @@ export declare class RestartNodeRequest extends $tea.Model {
12312
12741
  resourceOwnerId?: number;
12313
12742
  /**
12314
12743
  * @remarks
12744
+ * The role ID of the node.
12745
+ *
12746
+ * 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.
12747
+ * 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.
12748
+ *
12315
12749
  * This parameter is required.
12316
12750
  *
12317
12751
  * @example
@@ -12330,6 +12764,9 @@ export declare class RestartNodeRequest extends $tea.Model {
12330
12764
  }
12331
12765
  export declare class RestartNodeResponseBody extends $tea.Model {
12332
12766
  /**
12767
+ * @remarks
12768
+ * The request ID.
12769
+ *
12333
12770
  * @example
12334
12771
  * ECBCA991-XXXX-XXXX-834C-B3E8007F33AA
12335
12772
  */
@@ -12626,7 +13063,7 @@ export declare class TransformInstanceChargeTypeRequest extends $tea.Model {
12626
13063
  * * **true**
12627
13064
  * * **false**
12628
13065
  *
12629
- * > Default value: **true**.
13066
+ * > Default value: **true**.
12630
13067
  *
12631
13068
  * @example
12632
13069
  * true
@@ -12657,8 +13094,8 @@ export declare class TransformInstanceChargeTypeRequest extends $tea.Model {
12657
13094
  * @remarks
12658
13095
  * The billing method of the instance. Valid values:
12659
13096
  *
12660
- * * **PrePaid**: subscription
12661
- * * **PostPaid**: pay-as-you-go
13097
+ * * **PrePaid:** subscription.
13098
+ * * **PostPaid:** pay-as-you-go.
12662
13099
  *
12663
13100
  * This parameter is required.
12664
13101
  *
@@ -12668,10 +13105,7 @@ export declare class TransformInstanceChargeTypeRequest extends $tea.Model {
12668
13105
  chargeType?: string;
12669
13106
  /**
12670
13107
  * @remarks
12671
- * Specifies whether to use coupons. Default value: null. Valid values:
12672
- *
12673
- * * **default** or **null**: uses coupons.
12674
- * * **youhuiquan_promotion_option_id_for_blank**: does not use coupons.
13108
+ * The coupon code. Default value: `youhuiquan_promotion_option_id_for_blank`.
12675
13109
  *
12676
13110
  * @example
12677
13111
  * youhuiquan_promotion_option_id_for_blank
@@ -12679,7 +13113,7 @@ export declare class TransformInstanceChargeTypeRequest extends $tea.Model {
12679
13113
  couponNo?: string;
12680
13114
  /**
12681
13115
  * @remarks
12682
- * The ID of the instance
13116
+ * The ID of the instance.
12683
13117
  *
12684
13118
  * This parameter is required.
12685
13119
  *
@@ -12691,10 +13125,7 @@ export declare class TransformInstanceChargeTypeRequest extends $tea.Model {
12691
13125
  ownerId?: number;
12692
13126
  /**
12693
13127
  * @remarks
12694
- * The subscription duration. Valid values:
12695
- *
12696
- * * If the PricingCycle parameter is set to Month, the valid values of this parameter range from **1** to **9**.
12697
- * * If the PricingCycle parameter is set to Year, the valid values of this parameter are **1**, **2**, **3**, and **5**.
13128
+ * The subscription duration of the instance. Unit: months. Valid values: **1, 2, 3, 4, 5, 6, 7, 8, 9******, **12**, **24**, and **36**.
12698
13129
  *
12699
13130
  * @example
12700
13131
  * 1
@@ -12702,12 +13133,12 @@ export declare class TransformInstanceChargeTypeRequest extends $tea.Model {
12702
13133
  period?: number;
12703
13134
  /**
12704
13135
  * @remarks
12705
- * The unit of the subscription duration. Valid values:
12706
- *
12707
- * * **Month**
12708
- * * **Year**
13136
+ * 实例付费时长单位
13137
+ * 取值说明:
13138
+ * - **Month:** 月
13139
+ * - **Year:** 年
12709
13140
  *
12710
- * Default value: Month.
13141
+ * 默认值:Month
12711
13142
  *
12712
13143
  * @example
12713
13144
  * Month
@@ -12728,7 +13159,7 @@ export declare class TransformInstanceChargeTypeRequest extends $tea.Model {
12728
13159
  export declare class TransformInstanceChargeTypeResponseBody extends $tea.Model {
12729
13160
  /**
12730
13161
  * @remarks
12731
- * The ID of the order.
13162
+ * The order ID.
12732
13163
  *
12733
13164
  * @example
12734
13165
  * 21084641369****
@@ -12736,7 +13167,7 @@ export declare class TransformInstanceChargeTypeResponseBody extends $tea.Model
12736
13167
  orderId?: string;
12737
13168
  /**
12738
13169
  * @remarks
12739
- * The ID of the request.
13170
+ * The request ID.
12740
13171
  *
12741
13172
  * @example
12742
13173
  * D8F1D721-6439-4257-A89C-F1E8E9C9****
@@ -13025,6 +13456,7 @@ export declare class UpgradeDBInstanceEngineVersionRequest extends $tea.Model {
13025
13456
  ownerId?: number;
13026
13457
  resourceOwnerAccount?: string;
13027
13458
  resourceOwnerId?: number;
13459
+ switchMode?: number;
13028
13460
  static names(): {
13029
13461
  [key: string]: string;
13030
13462
  };
@@ -13085,6 +13517,7 @@ export declare class UpgradeDBInstanceKernelVersionRequest extends $tea.Model {
13085
13517
  ownerId?: number;
13086
13518
  resourceOwnerAccount?: string;
13087
13519
  resourceOwnerId?: number;
13520
+ switchMode?: string;
13088
13521
  static names(): {
13089
13522
  [key: string]: string;
13090
13523
  };
@@ -13275,8 +13708,8 @@ export declare class CreateShardingDBInstanceRequestReplicaSet extends $tea.Mode
13275
13708
  * @remarks
13276
13709
  * The instance type of the shard node. For more information, see [Sharded cluster instance types](https://help.aliyun.com/document_detail/311414.html).
13277
13710
  *
13278
- * > * **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.
13279
- * > * Valid values for **N**: **2** to **32**.
13711
+ * > * **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.
13712
+ * > * Valid values of **N**: **2** to **32**.
13280
13713
  *
13281
13714
  * This parameter is required.
13282
13715
  *
@@ -13286,11 +13719,11 @@ export declare class CreateShardingDBInstanceRequestReplicaSet extends $tea.Mode
13286
13719
  class?: string;
13287
13720
  /**
13288
13721
  * @remarks
13289
- * The number of read-only nodes in shard node N.
13722
+ * The number of read-only nodes in the shard node.
13290
13723
  *
13291
- * Valid values: **0**, 1, 2, 3, 4, and **5**. Default value: **0**.
13724
+ * Valid values: **0**, **1, 2, 3, 4, and 5**. Default value: **0**.
13292
13725
  *
13293
- * > **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.
13726
+ * > **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.
13294
13727
  *
13295
13728
  * @example
13296
13729
  * 0
@@ -13298,10 +13731,10 @@ export declare class CreateShardingDBInstanceRequestReplicaSet extends $tea.Mode
13298
13731
  readonlyReplicas?: number;
13299
13732
  /**
13300
13733
  * @remarks
13301
- * The storage space of the shard node. Unit: GB.
13734
+ * The storage capacity of the shard node. Unit: GB.
13302
13735
  *
13303
- * > * 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).
13304
- * > * **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.
13736
+ * > * 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).
13737
+ * > * **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.
13305
13738
  *
13306
13739
  * This parameter is required.
13307
13740
  *
@@ -14236,7 +14669,7 @@ export declare class DescribeBackupsResponseBodyBackupsBackup extends $tea.Model
14236
14669
  * @remarks
14237
14670
  * The internal download URL of the backup set.
14238
14671
  *
14239
- * > 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.
14672
+ * > 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.
14240
14673
  */
14241
14674
  backupIntranetDownloadURL?: string;
14242
14675
  /**
@@ -14263,14 +14696,28 @@ export declare class DescribeBackupsResponseBodyBackupsBackup extends $tea.Model
14263
14696
  * @remarks
14264
14697
  * The backup mode of the backup set. Valid values:
14265
14698
  *
14266
- * * **Automated**:
14699
+ * * **Automated**
14267
14700
  * * **Manual**
14268
14701
  *
14269
14702
  * @example
14270
14703
  * Automated
14271
14704
  */
14272
14705
  backupMode?: string;
14706
+ /**
14707
+ * @remarks
14708
+ * The name of the backup set (invalid now).
14709
+ *
14710
+ * @example
14711
+ * 12345678.tar.gz
14712
+ */
14273
14713
  backupName?: string;
14714
+ /**
14715
+ * @remarks
14716
+ * The scale of the backup set (invalid now).
14717
+ *
14718
+ * @example
14719
+ * DBInstance
14720
+ */
14274
14721
  backupScale?: string;
14275
14722
  /**
14276
14723
  * @remarks
@@ -14310,6 +14757,16 @@ export declare class DescribeBackupsResponseBodyBackupsBackup extends $tea.Model
14310
14757
  * FullBackup
14311
14758
  */
14312
14759
  backupType?: string;
14760
+ engineVersion?: string;
14761
+ /**
14762
+ * @remarks
14763
+ * Availability of the backup set.
14764
+ * - 0: unavailable
14765
+ * - 1: available
14766
+ *
14767
+ * @example
14768
+ * 1
14769
+ */
14313
14770
  isAvail?: boolean;
14314
14771
  static names(): {
14315
14772
  [key: string]: string;
@@ -14567,6 +15024,7 @@ export declare class DescribeClusterBackupsResponseBodyClusterBackups extends $t
14567
15024
  * OK
14568
15025
  */
14569
15026
  clusterBackupStatus?: string;
15027
+ engineVersion?: string;
14570
15028
  /**
14571
15029
  * @remarks
14572
15030
  * The additional information in the JSON format.
@@ -14647,6 +15105,27 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
14647
15105
  * dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com
14648
15106
  */
14649
15107
  connectString?: string;
15108
+ /**
15109
+ * @remarks
15110
+ * The minor version of the current MongoDB kernel.
15111
+ *
15112
+ * @example
15113
+ * mongodb_20230613_4.0.25
15114
+ */
15115
+ currentKernelVersion?: string;
15116
+ /**
15117
+ * @remarks
15118
+ * The lock status of the Configserver node. Valid values:
15119
+ *
15120
+ * * **Unlock**: The instance is not locked.
15121
+ * * **ManualLock**: The instance is manually locked.
15122
+ * * **LockByExpiration**: The instance is automatically locked due to instance expiration.
15123
+ * * **LockByRestoration**: The instance is automatically locked before a rollback.
15124
+ * * **LockByDiskQuota**: The instance is automatically locked because its storage capacity is exhausted and the instance is inaccessible.
15125
+ *
15126
+ * @example
15127
+ * Unlock
15128
+ */
14650
15129
  lockMode?: string;
14651
15130
  /**
14652
15131
  * @remarks
@@ -14743,6 +15222,27 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
14743
15222
  * s-bp1d8c262a15****.mongodb.rds.aliyuncs.com
14744
15223
  */
14745
15224
  connectSting?: string;
15225
+ /**
15226
+ * @remarks
15227
+ * The minor version of the current MongoDB kernel.
15228
+ *
15229
+ * @example
15230
+ * mongodb_20220518_4.0.21
15231
+ */
15232
+ currentKernelVersion?: string;
15233
+ /**
15234
+ * @remarks
15235
+ * The lock status of the instance. Valid values:
15236
+ *
15237
+ * * **Unlock**: The instance is not locked.
15238
+ * * **ManualLock**: The instance is manually locked.
15239
+ * * **LockByExpiration**: The instance is automatically locked due to instance expiration.
15240
+ * * **LockByRestoration**: The instance is automatically locked before a rollback.
15241
+ * * **LockByDiskQuota**: The instance is automatically locked because its storage capacity is exhausted and the instance is inaccessible.
15242
+ *
15243
+ * @example
15244
+ * Unlock
15245
+ */
14746
15246
  lockMode?: string;
14747
15247
  /**
14748
15248
  * @remarks
@@ -14950,6 +15450,27 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
14950
15450
  * d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****
14951
15451
  */
14952
15452
  connectString?: string;
15453
+ /**
15454
+ * @remarks
15455
+ * The minor version of the current MongoDB kernel.
15456
+ *
15457
+ * @example
15458
+ * mongodb_20230613_4.0.25
15459
+ */
15460
+ currentKernelVersion?: string;
15461
+ /**
15462
+ * @remarks
15463
+ * The lock status of the shard node. Valid values:
15464
+ *
15465
+ * * **Unlock**: The instance is not locked.
15466
+ * * **ManualLock**: The instance is manually locked.
15467
+ * * **LockByExpiration**: The instance is automatically locked due to instance expiration.
15468
+ * * **LockByRestoration**: The instance is automatically locked before a rollback.
15469
+ * * **LockByDiskQuota**: The instance is automatically locked because its storage capacity is exhausted and the instance is inaccessible.
15470
+ *
15471
+ * @example
15472
+ * Unlock
15473
+ */
14953
15474
  lockMode?: string;
14954
15475
  /**
14955
15476
  * @remarks
@@ -14961,7 +15482,7 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
14961
15482
  maxConnections?: number;
14962
15483
  /**
14963
15484
  * @remarks
14964
- * shard节点的最大云盘吞吐量。
15485
+ * The maximum MBPS of the shard node.
14965
15486
  *
14966
15487
  * @example
14967
15488
  * 350
@@ -15122,7 +15643,7 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
15122
15643
  chargeType?: string;
15123
15644
  /**
15124
15645
  * @remarks
15125
- * The information of the Configserver nodes.
15646
+ * The details of the ConfigServer node.
15126
15647
  *
15127
15648
  * > This parameter is returned if the instance is a sharded cluster instance.
15128
15649
  */
@@ -15381,7 +15902,7 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
15381
15902
  maxIOPS?: number;
15382
15903
  /**
15383
15904
  * @remarks
15384
- * 实例的最大云盘吞吐量,单位MB/s。
15905
+ * The maximum MBPS of the instance.
15385
15906
  *
15386
15907
  * @example
15387
15908
  * 350
@@ -15389,7 +15910,7 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
15389
15910
  maxMBPS?: number;
15390
15911
  /**
15391
15912
  * @remarks
15392
- * The information of the mongos nodes.
15913
+ * The details of the mongos node.
15393
15914
  *
15394
15915
  * > This parameter is returned if the instance is a sharded cluster instance.
15395
15916
  */
@@ -15524,7 +16045,7 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
15524
16045
  secondaryZoneId?: string;
15525
16046
  /**
15526
16047
  * @remarks
15527
- * The information of the shard nodes.
16048
+ * The details of the shard node.
15528
16049
  *
15529
16050
  * > This parameter is returned if the instance is a sharded cluster instance.
15530
16051
  */
@@ -19300,6 +19821,14 @@ export declare class DescribeReplicaSetRoleResponseBodyReplicaSetsReplicaSet ext
19300
19821
  * 3717
19301
19822
  */
19302
19823
  connectionPort?: string;
19824
+ /**
19825
+ * @remarks
19826
+ * The connection type of the node.
19827
+ *
19828
+ * @example
19829
+ * SRV
19830
+ */
19831
+ connectionType?: string;
19303
19832
  /**
19304
19833
  * @remarks
19305
19834
  * The remaining duration of the classic network endpoint. Unit: seconds.
@@ -19361,6 +19890,85 @@ export declare class DescribeReplicaSetRoleResponseBodyReplicaSets extends $tea.
19361
19890
  [key: string]: any;
19362
19891
  });
19363
19892
  }
19893
+ export declare class DescribeRestoreDBInstanceListResponseBodyDBInstancesDBInstance extends $tea.Model {
19894
+ /**
19895
+ * @example
19896
+ * 2022-01-02T07:43:59Z
19897
+ */
19898
+ creationTime?: string;
19899
+ DBInstanceDescription?: string;
19900
+ /**
19901
+ * @example
19902
+ * dds-bp12c5b040dc****
19903
+ */
19904
+ DBInstanceId?: string;
19905
+ /**
19906
+ * @example
19907
+ * Running
19908
+ */
19909
+ DBInstanceStatus?: string;
19910
+ /**
19911
+ * @example
19912
+ * replicate
19913
+ */
19914
+ DBInstanceType?: string;
19915
+ /**
19916
+ * @example
19917
+ * 4.2
19918
+ */
19919
+ engineVersion?: string;
19920
+ /**
19921
+ * @example
19922
+ * cn-hangzhou-h
19923
+ */
19924
+ hiddenZoneId?: string;
19925
+ /**
19926
+ * @example
19927
+ * 0
19928
+ */
19929
+ isDeleted?: number;
19930
+ /**
19931
+ * @example
19932
+ * Unlock
19933
+ */
19934
+ lockMode?: string;
19935
+ /**
19936
+ * @example
19937
+ * cn-hangzhou
19938
+ */
19939
+ regionId?: string;
19940
+ /**
19941
+ * @example
19942
+ * cn-hangzhou-i
19943
+ */
19944
+ secondaryZoneId?: string;
19945
+ /**
19946
+ * @example
19947
+ * cn-hangzhou-g
19948
+ */
19949
+ zoneId?: string;
19950
+ static names(): {
19951
+ [key: string]: string;
19952
+ };
19953
+ static types(): {
19954
+ [key: string]: any;
19955
+ };
19956
+ constructor(map?: {
19957
+ [key: string]: any;
19958
+ });
19959
+ }
19960
+ export declare class DescribeRestoreDBInstanceListResponseBodyDBInstances extends $tea.Model {
19961
+ DBInstance?: DescribeRestoreDBInstanceListResponseBodyDBInstancesDBInstance[];
19962
+ static names(): {
19963
+ [key: string]: string;
19964
+ };
19965
+ static types(): {
19966
+ [key: string]: any;
19967
+ };
19968
+ constructor(map?: {
19969
+ [key: string]: any;
19970
+ });
19971
+ }
19364
19972
  export declare class DescribeRoleZoneInfoResponseBodyZoneInfosZoneInfo extends $tea.Model {
19365
19973
  /**
19366
19974
  * @remarks
@@ -19675,6 +20283,7 @@ export declare class DescribeShardingNetworkAddressResponseBodyCompatibleConnect
19675
20283
  });
19676
20284
  }
19677
20285
  export declare class DescribeShardingNetworkAddressResponseBodyNetworkAddressesNetworkAddress extends $tea.Model {
20286
+ connectionType?: string;
19678
20287
  /**
19679
20288
  * @remarks
19680
20289
  * The remaining duration of the classic network endpoint. Unit: seconds.
@@ -19750,6 +20359,7 @@ export declare class DescribeShardingNetworkAddressResponseBodyNetworkAddressesN
19750
20359
  * Primary
19751
20360
  */
19752
20361
  role?: string;
20362
+ txtRecord?: string;
19753
20363
  /**
19754
20364
  * @remarks
19755
20365
  * The VPC ID of the instance.
@@ -20234,7 +20844,7 @@ export default class Client extends OpenApi {
20234
20844
  * Creates or clones an ApsaraDB for MongoDB replica set instance.
20235
20845
  *
20236
20846
  * @remarks
20237
- * 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.
20847
+ * 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.
20238
20848
  * 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).
20239
20849
  * To create sharded cluster instances, you can call the [CreateShardingDBInstance](~~CreateShardingDBInstance~~) operation.
20240
20850
  *
@@ -20247,7 +20857,7 @@ export default class Client extends OpenApi {
20247
20857
  * Creates or clones an ApsaraDB for MongoDB replica set instance.
20248
20858
  *
20249
20859
  * @remarks
20250
- * 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.
20860
+ * 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.
20251
20861
  * 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).
20252
20862
  * To create sharded cluster instances, you can call the [CreateShardingDBInstance](~~CreateShardingDBInstance~~) operation.
20253
20863
  *
@@ -20320,7 +20930,7 @@ export default class Client extends OpenApi {
20320
20930
  * Creates or clones an ApsaraDB for MongoDB sharded cluster instance.
20321
20931
  *
20322
20932
  * @remarks
20323
- * 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.
20933
+ * 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.
20324
20934
  * * For more information about the instance types of ApsaraDB for MongoDB, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
20325
20935
  * * To create standalone instances and replica set instances, you can call the [CreateDBInstance](https://help.aliyun.com/document_detail/61763.html) operation.
20326
20936
  *
@@ -20333,7 +20943,7 @@ export default class Client extends OpenApi {
20333
20943
  * Creates or clones an ApsaraDB for MongoDB sharded cluster instance.
20334
20944
  *
20335
20945
  * @remarks
20336
- * 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.
20946
+ * 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.
20337
20947
  * * For more information about the instance types of ApsaraDB for MongoDB, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
20338
20948
  * * To create standalone instances and replica set instances, you can call the [CreateDBInstance](https://help.aliyun.com/document_detail/61763.html) operation.
20339
20949
  *
@@ -21245,6 +21855,17 @@ export default class Client extends OpenApi {
21245
21855
  * @returns DescribeReplicaSetRoleResponse
21246
21856
  */
21247
21857
  describeReplicaSetRole(request: DescribeReplicaSetRoleRequest): Promise<DescribeReplicaSetRoleResponse>;
21858
+ /**
21859
+ * @param request - DescribeRestoreDBInstanceListRequest
21860
+ * @param runtime - runtime options for this request RuntimeOptions
21861
+ * @returns DescribeRestoreDBInstanceListResponse
21862
+ */
21863
+ describeRestoreDBInstanceListWithOptions(request: DescribeRestoreDBInstanceListRequest, runtime: $Util.RuntimeOptions): Promise<DescribeRestoreDBInstanceListResponse>;
21864
+ /**
21865
+ * @param request - DescribeRestoreDBInstanceListRequest
21866
+ * @returns DescribeRestoreDBInstanceListResponse
21867
+ */
21868
+ describeRestoreDBInstanceList(request: DescribeRestoreDBInstanceListRequest): Promise<DescribeRestoreDBInstanceListResponse>;
21248
21869
  /**
21249
21870
  * Queries the role and zone of each node in an ApsaraDB for MongoDB instance.
21250
21871
  *
@@ -21603,6 +22224,9 @@ export default class Client extends OpenApi {
21603
22224
  /**
21604
22225
  * Modifies a backup policy for an ApsaraDB for MongoDB instance.
21605
22226
  *
22227
+ * @remarks
22228
+ * Cross-regional backup only supports MongoDB sharded cluster instance and MongoDB replica set.
22229
+ *
21606
22230
  * @param request - ModifyBackupPolicyRequest
21607
22231
  * @param runtime - runtime options for this request RuntimeOptions
21608
22232
  * @returns ModifyBackupPolicyResponse
@@ -21611,6 +22235,9 @@ export default class Client extends OpenApi {
21611
22235
  /**
21612
22236
  * Modifies a backup policy for an ApsaraDB for MongoDB instance.
21613
22237
  *
22238
+ * @remarks
22239
+ * Cross-regional backup only supports MongoDB sharded cluster instance and MongoDB replica set.
22240
+ *
21614
22241
  * @param request - ModifyBackupPolicyRequest
21615
22242
  * @returns ModifyBackupPolicyResponse
21616
22243
  */
@@ -22199,7 +22826,13 @@ export default class Client extends OpenApi {
22199
22826
  */
22200
22827
  restartDBInstance(request: RestartDBInstanceRequest): Promise<RestartDBInstanceResponse>;
22201
22828
  /**
22202
- * 重启副本集单个节点
22829
+ * Restarts a node in an ApsaraDB for MongoDB instance.
22830
+ *
22831
+ * @remarks
22832
+ * You can call this operation to restart a node in a replica set instance or a child instance in a sharded cluster instance.
22833
+ * > When you call this operation, the instance must meet the following requirements:
22834
+ * * The instance is in the Running state.
22835
+ * * The instance is a replica set or sharded cluster instance of the standard edition.
22203
22836
  *
22204
22837
  * @param request - RestartNodeRequest
22205
22838
  * @param runtime - runtime options for this request RuntimeOptions
@@ -22207,7 +22840,13 @@ export default class Client extends OpenApi {
22207
22840
  */
22208
22841
  restartNodeWithOptions(request: RestartNodeRequest, runtime: $Util.RuntimeOptions): Promise<RestartNodeResponse>;
22209
22842
  /**
22210
- * 重启副本集单个节点
22843
+ * Restarts a node in an ApsaraDB for MongoDB instance.
22844
+ *
22845
+ * @remarks
22846
+ * You can call this operation to restart a node in a replica set instance or a child instance in a sharded cluster instance.
22847
+ * > When you call this operation, the instance must meet the following requirements:
22848
+ * * The instance is in the Running state.
22849
+ * * The instance is a replica set or sharded cluster instance of the standard edition.
22211
22850
  *
22212
22851
  * @param request - RestartNodeRequest
22213
22852
  * @returns RestartNodeResponse
@@ -22298,12 +22937,12 @@ export default class Client extends OpenApi {
22298
22937
  * Changes the billing method of an instance from pay-as-you-go to subscription or from subscription to pay-as-you-go.
22299
22938
  *
22300
22939
  * @remarks
22301
- * 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.
22940
+ * 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
22302
22941
  * Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
22303
22942
  * * The instance is in the Running state.
22304
22943
  * * Your instance has no unpaid billing method change orders.
22305
22944
  * * 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).
22306
- * > 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.
22945
+ * > 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.
22307
22946
  *
22308
22947
  * @param request - TransformInstanceChargeTypeRequest
22309
22948
  * @param runtime - runtime options for this request RuntimeOptions
@@ -22314,12 +22953,12 @@ export default class Client extends OpenApi {
22314
22953
  * Changes the billing method of an instance from pay-as-you-go to subscription or from subscription to pay-as-you-go.
22315
22954
  *
22316
22955
  * @remarks
22317
- * 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.
22956
+ * 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
22318
22957
  * Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
22319
22958
  * * The instance is in the Running state.
22320
22959
  * * Your instance has no unpaid billing method change orders.
22321
22960
  * * 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).
22322
- * > 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.
22961
+ * > 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.
22323
22962
  *
22324
22963
  * @param request - TransformInstanceChargeTypeRequest
22325
22964
  * @returns TransformInstanceChargeTypeResponse