@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/dist/client.d.ts +823 -74
- package/dist/client.js +254 -17
- package/dist/client.js.map +1 -1
- package/package.json +2 -2
- package/src/client.ts +993 -74
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.
|
|
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
|
|
965
|
+
* The region ID of the instance.
|
|
955
966
|
*
|
|
956
|
-
*
|
|
957
|
-
* * **RocksDB**
|
|
958
|
-
* * **TerarkDB**
|
|
967
|
+
* > - This parameter is required when restore type is set to 2 or 3.
|
|
959
968
|
*
|
|
960
|
-
*
|
|
961
|
-
*
|
|
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
|
|
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
|
-
*
|
|
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
|
|
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
|
-
* > *
|
|
1644
|
-
* > *
|
|
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.
|
|
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
|
|
1725
|
-
* * **dynamodb
|
|
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
|
-
* > *
|
|
1839
|
-
* > *
|
|
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
|
|
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
|
|
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
|
|
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
|
|
4444
|
+
* Specifies whether to query instances that are deleted. Valid values:
|
|
4260
4445
|
*
|
|
4261
|
-
*
|
|
4262
|
-
*
|
|
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
|
|
4481
|
+
* The instance details.
|
|
4297
4482
|
*/
|
|
4298
4483
|
DBInstances?: DescribeDBInstanceAttributeResponseBodyDBInstances;
|
|
4299
4484
|
/**
|
|
@@ -7466,6 +7651,125 @@ 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
|
+
* Find instances created after the specified time, formatted as <i>yyyy-MM-dd</i>T<i>HH:00:00</i>Z (UTC time).
|
|
7658
|
+
*
|
|
7659
|
+
* >
|
|
7660
|
+
* > - The time must be on the hour.
|
|
7661
|
+
* > - The time cannot be earlier than 7 days before the current time.
|
|
7662
|
+
*
|
|
7663
|
+
* This parameter is required.
|
|
7664
|
+
*
|
|
7665
|
+
* @example
|
|
7666
|
+
* 2024-07-24T14:00:00Z
|
|
7667
|
+
*/
|
|
7668
|
+
creationTimeAfter?: string;
|
|
7669
|
+
/**
|
|
7670
|
+
* @remarks
|
|
7671
|
+
* The instance ID.
|
|
7672
|
+
*
|
|
7673
|
+
* This parameter is required.
|
|
7674
|
+
*
|
|
7675
|
+
* @example
|
|
7676
|
+
* dds-bp114f14849d****
|
|
7677
|
+
*/
|
|
7678
|
+
DBInstanceId?: string;
|
|
7679
|
+
ownerAccount?: string;
|
|
7680
|
+
ownerId?: number;
|
|
7681
|
+
/**
|
|
7682
|
+
* @remarks
|
|
7683
|
+
* The page number.
|
|
7684
|
+
*
|
|
7685
|
+
* @example
|
|
7686
|
+
* 1
|
|
7687
|
+
*/
|
|
7688
|
+
pageNumber?: number;
|
|
7689
|
+
/**
|
|
7690
|
+
* @remarks
|
|
7691
|
+
* The number of entries returned per page.
|
|
7692
|
+
*
|
|
7693
|
+
* @example
|
|
7694
|
+
* 30
|
|
7695
|
+
*/
|
|
7696
|
+
pageSize?: number;
|
|
7697
|
+
resourceOwnerAccount?: string;
|
|
7698
|
+
resourceOwnerId?: number;
|
|
7699
|
+
static names(): {
|
|
7700
|
+
[key: string]: string;
|
|
7701
|
+
};
|
|
7702
|
+
static types(): {
|
|
7703
|
+
[key: string]: any;
|
|
7704
|
+
};
|
|
7705
|
+
constructor(map?: {
|
|
7706
|
+
[key: string]: any;
|
|
7707
|
+
});
|
|
7708
|
+
}
|
|
7709
|
+
export declare class DescribeRestoreDBInstanceListResponseBody extends $tea.Model {
|
|
7710
|
+
/**
|
|
7711
|
+
* @remarks
|
|
7712
|
+
* DB instances list.
|
|
7713
|
+
*/
|
|
7714
|
+
DBInstances?: DescribeRestoreDBInstanceListResponseBodyDBInstances;
|
|
7715
|
+
/**
|
|
7716
|
+
* @remarks
|
|
7717
|
+
* The page number.
|
|
7718
|
+
*
|
|
7719
|
+
* @example
|
|
7720
|
+
* 1
|
|
7721
|
+
*/
|
|
7722
|
+
pageNumber?: number;
|
|
7723
|
+
/**
|
|
7724
|
+
* @remarks
|
|
7725
|
+
* The number of entries returned per page.
|
|
7726
|
+
*
|
|
7727
|
+
* @example
|
|
7728
|
+
* 30
|
|
7729
|
+
*/
|
|
7730
|
+
pageSize?: number;
|
|
7731
|
+
/**
|
|
7732
|
+
* @remarks
|
|
7733
|
+
* The request ID.
|
|
7734
|
+
*
|
|
7735
|
+
* @example
|
|
7736
|
+
* 1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx
|
|
7737
|
+
*/
|
|
7738
|
+
requestId?: string;
|
|
7739
|
+
/**
|
|
7740
|
+
* @remarks
|
|
7741
|
+
* The number of instances in the query results.
|
|
7742
|
+
*
|
|
7743
|
+
* @example
|
|
7744
|
+
* 5
|
|
7745
|
+
*/
|
|
7746
|
+
totalCount?: number;
|
|
7747
|
+
static names(): {
|
|
7748
|
+
[key: string]: string;
|
|
7749
|
+
};
|
|
7750
|
+
static types(): {
|
|
7751
|
+
[key: string]: any;
|
|
7752
|
+
};
|
|
7753
|
+
constructor(map?: {
|
|
7754
|
+
[key: string]: any;
|
|
7755
|
+
});
|
|
7756
|
+
}
|
|
7757
|
+
export declare class DescribeRestoreDBInstanceListResponse extends $tea.Model {
|
|
7758
|
+
headers?: {
|
|
7759
|
+
[key: string]: string;
|
|
7760
|
+
};
|
|
7761
|
+
statusCode?: number;
|
|
7762
|
+
body?: DescribeRestoreDBInstanceListResponseBody;
|
|
7763
|
+
static names(): {
|
|
7764
|
+
[key: string]: string;
|
|
7765
|
+
};
|
|
7766
|
+
static types(): {
|
|
7767
|
+
[key: string]: any;
|
|
7768
|
+
};
|
|
7769
|
+
constructor(map?: {
|
|
7770
|
+
[key: string]: any;
|
|
7771
|
+
});
|
|
7772
|
+
}
|
|
7469
7773
|
export declare class DescribeRoleZoneInfoRequest extends $tea.Model {
|
|
7470
7774
|
/**
|
|
7471
7775
|
* @remarks
|
|
@@ -7934,7 +8238,7 @@ export declare class DescribeShardingNetworkAddressResponseBody extends $tea.Mod
|
|
|
7934
8238
|
compatibleConnections?: DescribeShardingNetworkAddressResponseBodyCompatibleConnections;
|
|
7935
8239
|
/**
|
|
7936
8240
|
* @remarks
|
|
7937
|
-
* The endpoints of ApsaraDB for MongoDB
|
|
8241
|
+
* The endpoints of the ApsaraDB for MongoDB sharded cluster instance.
|
|
7938
8242
|
*/
|
|
7939
8243
|
networkAddresses?: DescribeShardingNetworkAddressResponseBodyNetworkAddresses;
|
|
7940
8244
|
/**
|
|
@@ -8766,11 +9070,25 @@ export declare class MigrateAvailableZoneRequest extends $tea.Model {
|
|
|
8766
9070
|
* Immediately
|
|
8767
9071
|
*/
|
|
8768
9072
|
effectiveTime?: string;
|
|
9073
|
+
/**
|
|
9074
|
+
* @remarks
|
|
9075
|
+
* The ID of the destination hidden zone.
|
|
9076
|
+
*
|
|
9077
|
+
* @example
|
|
9078
|
+
* cn-shanghai-n
|
|
9079
|
+
*/
|
|
8769
9080
|
hiddenZoneId?: string;
|
|
8770
9081
|
ownerAccount?: string;
|
|
8771
9082
|
ownerId?: number;
|
|
8772
9083
|
resourceOwnerAccount?: string;
|
|
8773
9084
|
resourceOwnerId?: number;
|
|
9085
|
+
/**
|
|
9086
|
+
* @remarks
|
|
9087
|
+
* The ID of the destination secondary zone.
|
|
9088
|
+
*
|
|
9089
|
+
* @example
|
|
9090
|
+
* cn-hangzhou-h
|
|
9091
|
+
*/
|
|
8774
9092
|
secondaryZoneId?: string;
|
|
8775
9093
|
/**
|
|
8776
9094
|
* @remarks
|
|
@@ -9314,7 +9632,7 @@ export declare class ModifyAuditPolicyResponse extends $tea.Model {
|
|
|
9314
9632
|
export declare class ModifyBackupPolicyRequest extends $tea.Model {
|
|
9315
9633
|
/**
|
|
9316
9634
|
* @remarks
|
|
9317
|
-
* The frequency at which high-frequency
|
|
9635
|
+
* The frequency at which high-frequency backups are generated. Valid values:
|
|
9318
9636
|
*
|
|
9319
9637
|
* * **-1**: High-frequency backup is disabled.
|
|
9320
9638
|
* * **30**: High-frequency backups are generated every 30 minutes.
|
|
@@ -9328,9 +9646,9 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
|
|
|
9328
9646
|
*
|
|
9329
9647
|
* >
|
|
9330
9648
|
*
|
|
9331
|
-
* * If the **SnapshotBackupType** parameter
|
|
9649
|
+
* * If you set the **SnapshotBackupType** parameter to **Standard**, you must fix the value of this parameter to -1.
|
|
9332
9650
|
*
|
|
9333
|
-
* * High-frequency backup takes effect only when the **SnapshotBackupType** parameter
|
|
9651
|
+
* * High-frequency backup takes effect only when you set the **SnapshotBackupType** parameter to **Flash** and this parameter to a value greater than 0.
|
|
9334
9652
|
*
|
|
9335
9653
|
* @example
|
|
9336
9654
|
* -1
|
|
@@ -9350,12 +9668,95 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
|
|
|
9350
9668
|
* 30
|
|
9351
9669
|
*/
|
|
9352
9670
|
backupRetentionPeriod?: number;
|
|
9671
|
+
/**
|
|
9672
|
+
* @remarks
|
|
9673
|
+
* The backup retention policy configured for the instance. Valid values:
|
|
9674
|
+
*
|
|
9675
|
+
* 1. 0: All backup sets are immediately deleted when the instance is released.
|
|
9676
|
+
* 2. 1: Automatic backup is performed and the backup set is retained for a long period of time when the instance is released.
|
|
9677
|
+
* 3. 2: Automatic backup is performed and all backup sets are retained for a long period of time when the instance is released.
|
|
9678
|
+
*
|
|
9679
|
+
* 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).
|
|
9680
|
+
*
|
|
9681
|
+
* @example
|
|
9682
|
+
* 2
|
|
9683
|
+
*/
|
|
9353
9684
|
backupRetentionPolicyOnClusterDeletion?: number;
|
|
9685
|
+
/**
|
|
9686
|
+
* @remarks
|
|
9687
|
+
* The retention period of Cross-regional backup.
|
|
9688
|
+
* Valid values:
|
|
9689
|
+
*
|
|
9690
|
+
* * **Monday**
|
|
9691
|
+
* * **Tuesday**
|
|
9692
|
+
* * **Wednesday**
|
|
9693
|
+
* * **Thursday**
|
|
9694
|
+
* * **Friday**
|
|
9695
|
+
* * **Saturday**
|
|
9696
|
+
* * **Sunday**
|
|
9697
|
+
*
|
|
9698
|
+
* **
|
|
9699
|
+
*
|
|
9700
|
+
*
|
|
9701
|
+
*
|
|
9702
|
+
*
|
|
9703
|
+
*
|
|
9704
|
+
* >- Separate multiple values with commas (,).
|
|
9705
|
+
* >- When SnapshotBackupType is set to standard, this value needs to be a subset of the PreferredBackupPeriod.
|
|
9706
|
+
*
|
|
9707
|
+
* @example
|
|
9708
|
+
* Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
|
|
9709
|
+
*/
|
|
9354
9710
|
crossBackupPeriod?: string;
|
|
9711
|
+
/**
|
|
9712
|
+
* @remarks
|
|
9713
|
+
* The operation strategy of Cross-regional backup.
|
|
9714
|
+
* - update
|
|
9715
|
+
* - delete
|
|
9716
|
+
*
|
|
9717
|
+
* @example
|
|
9718
|
+
* update
|
|
9719
|
+
*/
|
|
9355
9720
|
crossBackupType?: string;
|
|
9721
|
+
/**
|
|
9722
|
+
* @remarks
|
|
9723
|
+
* The retention type of Cross-regional log backup.
|
|
9724
|
+
*
|
|
9725
|
+
* - delay : retain the backup for a period of time.
|
|
9726
|
+
* - never : retain the backup permanently.
|
|
9727
|
+
*
|
|
9728
|
+
* @example
|
|
9729
|
+
* delay
|
|
9730
|
+
*/
|
|
9356
9731
|
crossLogRetentionType?: string;
|
|
9732
|
+
/**
|
|
9733
|
+
* @remarks
|
|
9734
|
+
* The retention time of Cross-regional log backup, 3 - 1825 days.
|
|
9735
|
+
*
|
|
9736
|
+
* @example
|
|
9737
|
+
* 3
|
|
9738
|
+
*/
|
|
9357
9739
|
crossLogRetentionValue?: number;
|
|
9740
|
+
/**
|
|
9741
|
+
* @remarks
|
|
9742
|
+
* The retention type of Cross-regional backup.
|
|
9743
|
+
*
|
|
9744
|
+
* - delay : retain the backup for a period of time.
|
|
9745
|
+
* - never : retain the backup permanently.
|
|
9746
|
+
*
|
|
9747
|
+
* @example
|
|
9748
|
+
* delay
|
|
9749
|
+
*/
|
|
9358
9750
|
crossRetentionType?: string;
|
|
9751
|
+
/**
|
|
9752
|
+
* @remarks
|
|
9753
|
+
* The retention time of Cross-regional backup, 3 - 1825 days.
|
|
9754
|
+
* >
|
|
9755
|
+
* > - Used and must be used when CrossRetentionType is delay.
|
|
9756
|
+
*
|
|
9757
|
+
* @example
|
|
9758
|
+
* 7
|
|
9759
|
+
*/
|
|
9359
9760
|
crossRetentionValue?: number;
|
|
9360
9761
|
/**
|
|
9361
9762
|
* @remarks
|
|
@@ -9367,6 +9768,15 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
|
|
|
9367
9768
|
* dds-bp16cb162771****
|
|
9368
9769
|
*/
|
|
9369
9770
|
DBInstanceId?: string;
|
|
9771
|
+
/**
|
|
9772
|
+
* @remarks
|
|
9773
|
+
* The region id of Cross-regional backup.
|
|
9774
|
+
* >
|
|
9775
|
+
* > - Required for Cross-regional backup.
|
|
9776
|
+
*
|
|
9777
|
+
* @example
|
|
9778
|
+
* cn-hangzhou
|
|
9779
|
+
*/
|
|
9370
9780
|
destRegion?: string;
|
|
9371
9781
|
/**
|
|
9372
9782
|
* @remarks
|
|
@@ -9379,12 +9789,37 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
|
|
|
9379
9789
|
* 0
|
|
9380
9790
|
*/
|
|
9381
9791
|
enableBackupLog?: number;
|
|
9792
|
+
/**
|
|
9793
|
+
* @remarks
|
|
9794
|
+
* Whether to turn on cross-regional log backup.
|
|
9795
|
+
* - 1:turn on . Used for sharded cluster.
|
|
9796
|
+
* - 0: turn off. Used for replicate set.
|
|
9797
|
+
*
|
|
9798
|
+
* @example
|
|
9799
|
+
* 1
|
|
9800
|
+
*/
|
|
9382
9801
|
enableCrossLogBackup?: number;
|
|
9383
9802
|
/**
|
|
9384
9803
|
* @remarks
|
|
9385
9804
|
* 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.
|
|
9805
|
+
*
|
|
9806
|
+
* @example
|
|
9807
|
+
* 1
|
|
9386
9808
|
*/
|
|
9387
9809
|
highFrequencyBackupRetention?: number;
|
|
9810
|
+
/**
|
|
9811
|
+
* @remarks
|
|
9812
|
+
* The instance architecture. Valid values:
|
|
9813
|
+
*
|
|
9814
|
+
* * replicate
|
|
9815
|
+
* * sharding
|
|
9816
|
+
*
|
|
9817
|
+
* > * This parameter is required for Cross-regional backup.
|
|
9818
|
+
* > * This parameter is required for backup recovery of deleted instances.
|
|
9819
|
+
*
|
|
9820
|
+
* @example
|
|
9821
|
+
* replicate
|
|
9822
|
+
*/
|
|
9388
9823
|
instanceType?: string;
|
|
9389
9824
|
/**
|
|
9390
9825
|
* @remarks
|
|
@@ -9410,6 +9845,10 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
|
|
|
9410
9845
|
* * **Saturday**
|
|
9411
9846
|
* * **Sunday**
|
|
9412
9847
|
*
|
|
9848
|
+
* **
|
|
9849
|
+
*
|
|
9850
|
+
* **Notice**: To ensure data security, make sure that the system backs up data at least twice a week.
|
|
9851
|
+
*
|
|
9413
9852
|
* > Separate multiple values with commas (,).
|
|
9414
9853
|
*
|
|
9415
9854
|
* @example
|
|
@@ -9439,6 +9878,17 @@ export declare class ModifyBackupPolicyRequest extends $tea.Model {
|
|
|
9439
9878
|
* Standard
|
|
9440
9879
|
*/
|
|
9441
9880
|
snapshotBackupType?: string;
|
|
9881
|
+
/**
|
|
9882
|
+
* @remarks
|
|
9883
|
+
* The region ID of the instance.
|
|
9884
|
+
*
|
|
9885
|
+
* >
|
|
9886
|
+
* > - Required for Cross-regional backup.
|
|
9887
|
+
* > - Required for backup recovery of deleted instances.
|
|
9888
|
+
*
|
|
9889
|
+
* @example
|
|
9890
|
+
* cn-beijing
|
|
9891
|
+
*/
|
|
9442
9892
|
srcRegion?: string;
|
|
9443
9893
|
static names(): {
|
|
9444
9894
|
[key: string]: string;
|
|
@@ -12295,6 +12745,10 @@ export declare class RestartDBInstanceResponse extends $tea.Model {
|
|
|
12295
12745
|
export declare class RestartNodeRequest extends $tea.Model {
|
|
12296
12746
|
/**
|
|
12297
12747
|
* @remarks
|
|
12748
|
+
* The instance ID.
|
|
12749
|
+
*
|
|
12750
|
+
* > If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.
|
|
12751
|
+
*
|
|
12298
12752
|
* This parameter is required.
|
|
12299
12753
|
*
|
|
12300
12754
|
* @example
|
|
@@ -12302,6 +12756,11 @@ export declare class RestartNodeRequest extends $tea.Model {
|
|
|
12302
12756
|
*/
|
|
12303
12757
|
DBInstanceId?: string;
|
|
12304
12758
|
/**
|
|
12759
|
+
* @remarks
|
|
12760
|
+
* The ID of the shard, mongos, or ConfigServer node in a child instance of the sharded cluster instance.
|
|
12761
|
+
*
|
|
12762
|
+
* > If you set the **DBInstanceId** parameter to the ID of a sharded cluster instance, you must specify this parameter.
|
|
12763
|
+
*
|
|
12305
12764
|
* @example
|
|
12306
12765
|
* d-bp128a003436****
|
|
12307
12766
|
*/
|
|
@@ -12312,6 +12771,11 @@ export declare class RestartNodeRequest extends $tea.Model {
|
|
|
12312
12771
|
resourceOwnerId?: number;
|
|
12313
12772
|
/**
|
|
12314
12773
|
* @remarks
|
|
12774
|
+
* The role ID of the node.
|
|
12775
|
+
*
|
|
12776
|
+
* 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.
|
|
12777
|
+
* 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.
|
|
12778
|
+
*
|
|
12315
12779
|
* This parameter is required.
|
|
12316
12780
|
*
|
|
12317
12781
|
* @example
|
|
@@ -12330,6 +12794,9 @@ export declare class RestartNodeRequest extends $tea.Model {
|
|
|
12330
12794
|
}
|
|
12331
12795
|
export declare class RestartNodeResponseBody extends $tea.Model {
|
|
12332
12796
|
/**
|
|
12797
|
+
* @remarks
|
|
12798
|
+
* The request ID.
|
|
12799
|
+
*
|
|
12333
12800
|
* @example
|
|
12334
12801
|
* ECBCA991-XXXX-XXXX-834C-B3E8007F33AA
|
|
12335
12802
|
*/
|
|
@@ -12626,7 +13093,7 @@ export declare class TransformInstanceChargeTypeRequest extends $tea.Model {
|
|
|
12626
13093
|
* * **true**
|
|
12627
13094
|
* * **false**
|
|
12628
13095
|
*
|
|
12629
|
-
* >
|
|
13096
|
+
* > Default value: **true**.
|
|
12630
13097
|
*
|
|
12631
13098
|
* @example
|
|
12632
13099
|
* true
|
|
@@ -12657,8 +13124,8 @@ export declare class TransformInstanceChargeTypeRequest extends $tea.Model {
|
|
|
12657
13124
|
* @remarks
|
|
12658
13125
|
* The billing method of the instance. Valid values:
|
|
12659
13126
|
*
|
|
12660
|
-
* * **PrePaid
|
|
12661
|
-
* * **PostPaid
|
|
13127
|
+
* * **PrePaid:** subscription.
|
|
13128
|
+
* * **PostPaid:** pay-as-you-go.
|
|
12662
13129
|
*
|
|
12663
13130
|
* This parameter is required.
|
|
12664
13131
|
*
|
|
@@ -12668,10 +13135,7 @@ export declare class TransformInstanceChargeTypeRequest extends $tea.Model {
|
|
|
12668
13135
|
chargeType?: string;
|
|
12669
13136
|
/**
|
|
12670
13137
|
* @remarks
|
|
12671
|
-
*
|
|
12672
|
-
*
|
|
12673
|
-
* * **default** or **null**: uses coupons.
|
|
12674
|
-
* * **youhuiquan_promotion_option_id_for_blank**: does not use coupons.
|
|
13138
|
+
* The coupon code. Default value: `youhuiquan_promotion_option_id_for_blank`.
|
|
12675
13139
|
*
|
|
12676
13140
|
* @example
|
|
12677
13141
|
* youhuiquan_promotion_option_id_for_blank
|
|
@@ -12679,7 +13143,7 @@ export declare class TransformInstanceChargeTypeRequest extends $tea.Model {
|
|
|
12679
13143
|
couponNo?: string;
|
|
12680
13144
|
/**
|
|
12681
13145
|
* @remarks
|
|
12682
|
-
* The ID of the instance
|
|
13146
|
+
* The ID of the instance.
|
|
12683
13147
|
*
|
|
12684
13148
|
* This parameter is required.
|
|
12685
13149
|
*
|
|
@@ -12691,10 +13155,7 @@ export declare class TransformInstanceChargeTypeRequest extends $tea.Model {
|
|
|
12691
13155
|
ownerId?: number;
|
|
12692
13156
|
/**
|
|
12693
13157
|
* @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**.
|
|
13158
|
+
* The subscription duration of the instance. Unit: months. Valid values: **1, 2, 3, 4, 5, 6, 7, 8, 9******, **12**, **24**, and **36**.
|
|
12698
13159
|
*
|
|
12699
13160
|
* @example
|
|
12700
13161
|
* 1
|
|
@@ -12702,12 +13163,12 @@ export declare class TransformInstanceChargeTypeRequest extends $tea.Model {
|
|
|
12702
13163
|
period?: number;
|
|
12703
13164
|
/**
|
|
12704
13165
|
* @remarks
|
|
12705
|
-
*
|
|
13166
|
+
* 实例付费时长单位
|
|
13167
|
+
* 取值说明:
|
|
13168
|
+
* - **Month:** 月
|
|
13169
|
+
* - **Year:** 年
|
|
12706
13170
|
*
|
|
12707
|
-
*
|
|
12708
|
-
* * **Year**
|
|
12709
|
-
*
|
|
12710
|
-
* Default value: Month.
|
|
13171
|
+
* 默认值:Month
|
|
12711
13172
|
*
|
|
12712
13173
|
* @example
|
|
12713
13174
|
* Month
|
|
@@ -12728,7 +13189,7 @@ export declare class TransformInstanceChargeTypeRequest extends $tea.Model {
|
|
|
12728
13189
|
export declare class TransformInstanceChargeTypeResponseBody extends $tea.Model {
|
|
12729
13190
|
/**
|
|
12730
13191
|
* @remarks
|
|
12731
|
-
* The ID
|
|
13192
|
+
* The order ID.
|
|
12732
13193
|
*
|
|
12733
13194
|
* @example
|
|
12734
13195
|
* 21084641369****
|
|
@@ -12736,7 +13197,7 @@ export declare class TransformInstanceChargeTypeResponseBody extends $tea.Model
|
|
|
12736
13197
|
orderId?: string;
|
|
12737
13198
|
/**
|
|
12738
13199
|
* @remarks
|
|
12739
|
-
* The ID
|
|
13200
|
+
* The request ID.
|
|
12740
13201
|
*
|
|
12741
13202
|
* @example
|
|
12742
13203
|
* D8F1D721-6439-4257-A89C-F1E8E9C9****
|
|
@@ -13025,6 +13486,7 @@ export declare class UpgradeDBInstanceEngineVersionRequest extends $tea.Model {
|
|
|
13025
13486
|
ownerId?: number;
|
|
13026
13487
|
resourceOwnerAccount?: string;
|
|
13027
13488
|
resourceOwnerId?: number;
|
|
13489
|
+
switchMode?: number;
|
|
13028
13490
|
static names(): {
|
|
13029
13491
|
[key: string]: string;
|
|
13030
13492
|
};
|
|
@@ -13085,6 +13547,7 @@ export declare class UpgradeDBInstanceKernelVersionRequest extends $tea.Model {
|
|
|
13085
13547
|
ownerId?: number;
|
|
13086
13548
|
resourceOwnerAccount?: string;
|
|
13087
13549
|
resourceOwnerId?: number;
|
|
13550
|
+
switchMode?: string;
|
|
13088
13551
|
static names(): {
|
|
13089
13552
|
[key: string]: string;
|
|
13090
13553
|
};
|
|
@@ -13275,8 +13738,8 @@ export declare class CreateShardingDBInstanceRequestReplicaSet extends $tea.Mode
|
|
|
13275
13738
|
* @remarks
|
|
13276
13739
|
* The instance type of the shard node. For more information, see [Sharded cluster instance types](https://help.aliyun.com/document_detail/311414.html).
|
|
13277
13740
|
*
|
|
13278
|
-
* > *
|
|
13279
|
-
* > *
|
|
13741
|
+
* > * **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.
|
|
13742
|
+
* > * Valid values of **N**: **2** to **32**.
|
|
13280
13743
|
*
|
|
13281
13744
|
* This parameter is required.
|
|
13282
13745
|
*
|
|
@@ -13286,11 +13749,11 @@ export declare class CreateShardingDBInstanceRequestReplicaSet extends $tea.Mode
|
|
|
13286
13749
|
class?: string;
|
|
13287
13750
|
/**
|
|
13288
13751
|
* @remarks
|
|
13289
|
-
* The number of read-only nodes in shard node
|
|
13752
|
+
* The number of read-only nodes in the shard node.
|
|
13290
13753
|
*
|
|
13291
|
-
* Valid values: **0**, 1, 2, 3, 4, and
|
|
13754
|
+
* Valid values: **0**, **1, 2, 3, 4, and 5**. Default value: **0**.
|
|
13292
13755
|
*
|
|
13293
|
-
* > **N** specifies the serial number of the shard node for which you want to set the number of read-only nodes.
|
|
13756
|
+
* > **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
13757
|
*
|
|
13295
13758
|
* @example
|
|
13296
13759
|
* 0
|
|
@@ -13298,10 +13761,10 @@ export declare class CreateShardingDBInstanceRequestReplicaSet extends $tea.Mode
|
|
|
13298
13761
|
readonlyReplicas?: number;
|
|
13299
13762
|
/**
|
|
13300
13763
|
* @remarks
|
|
13301
|
-
* The storage
|
|
13764
|
+
* The storage capacity of the shard node. Unit: GB.
|
|
13302
13765
|
*
|
|
13303
|
-
* > *
|
|
13304
|
-
* > *
|
|
13766
|
+
* > * 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).
|
|
13767
|
+
* > * **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
13768
|
*
|
|
13306
13769
|
* This parameter is required.
|
|
13307
13770
|
*
|
|
@@ -14236,7 +14699,7 @@ export declare class DescribeBackupsResponseBodyBackupsBackup extends $tea.Model
|
|
|
14236
14699
|
* @remarks
|
|
14237
14700
|
* The internal download URL of the backup set.
|
|
14238
14701
|
*
|
|
14239
|
-
* > You can use the URL to download the specified backup set on an Elastic Compute Service (ECS) instance that is in the same
|
|
14702
|
+
* > 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
14703
|
*/
|
|
14241
14704
|
backupIntranetDownloadURL?: string;
|
|
14242
14705
|
/**
|
|
@@ -14263,14 +14726,28 @@ export declare class DescribeBackupsResponseBodyBackupsBackup extends $tea.Model
|
|
|
14263
14726
|
* @remarks
|
|
14264
14727
|
* The backup mode of the backup set. Valid values:
|
|
14265
14728
|
*
|
|
14266
|
-
* * **Automated
|
|
14729
|
+
* * **Automated**
|
|
14267
14730
|
* * **Manual**
|
|
14268
14731
|
*
|
|
14269
14732
|
* @example
|
|
14270
14733
|
* Automated
|
|
14271
14734
|
*/
|
|
14272
14735
|
backupMode?: string;
|
|
14736
|
+
/**
|
|
14737
|
+
* @remarks
|
|
14738
|
+
* The name of the backup set (invalid now).
|
|
14739
|
+
*
|
|
14740
|
+
* @example
|
|
14741
|
+
* 12345678.tar.gz
|
|
14742
|
+
*/
|
|
14273
14743
|
backupName?: string;
|
|
14744
|
+
/**
|
|
14745
|
+
* @remarks
|
|
14746
|
+
* The scale of the backup set (invalid now).
|
|
14747
|
+
*
|
|
14748
|
+
* @example
|
|
14749
|
+
* DBInstance
|
|
14750
|
+
*/
|
|
14274
14751
|
backupScale?: string;
|
|
14275
14752
|
/**
|
|
14276
14753
|
* @remarks
|
|
@@ -14310,6 +14787,16 @@ export declare class DescribeBackupsResponseBodyBackupsBackup extends $tea.Model
|
|
|
14310
14787
|
* FullBackup
|
|
14311
14788
|
*/
|
|
14312
14789
|
backupType?: string;
|
|
14790
|
+
engineVersion?: string;
|
|
14791
|
+
/**
|
|
14792
|
+
* @remarks
|
|
14793
|
+
* Availability of the backup set.
|
|
14794
|
+
* - 0: unavailable
|
|
14795
|
+
* - 1: available
|
|
14796
|
+
*
|
|
14797
|
+
* @example
|
|
14798
|
+
* 1
|
|
14799
|
+
*/
|
|
14313
14800
|
isAvail?: boolean;
|
|
14314
14801
|
static names(): {
|
|
14315
14802
|
[key: string]: string;
|
|
@@ -14567,6 +15054,7 @@ export declare class DescribeClusterBackupsResponseBodyClusterBackups extends $t
|
|
|
14567
15054
|
* OK
|
|
14568
15055
|
*/
|
|
14569
15056
|
clusterBackupStatus?: string;
|
|
15057
|
+
engineVersion?: string;
|
|
14570
15058
|
/**
|
|
14571
15059
|
* @remarks
|
|
14572
15060
|
* The additional information in the JSON format.
|
|
@@ -14647,6 +15135,27 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
|
|
|
14647
15135
|
* dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com
|
|
14648
15136
|
*/
|
|
14649
15137
|
connectString?: string;
|
|
15138
|
+
/**
|
|
15139
|
+
* @remarks
|
|
15140
|
+
* The minor version of the current MongoDB kernel.
|
|
15141
|
+
*
|
|
15142
|
+
* @example
|
|
15143
|
+
* mongodb_20230613_4.0.25
|
|
15144
|
+
*/
|
|
15145
|
+
currentKernelVersion?: string;
|
|
15146
|
+
/**
|
|
15147
|
+
* @remarks
|
|
15148
|
+
* The lock status of the Configserver node. Valid values:
|
|
15149
|
+
*
|
|
15150
|
+
* * **Unlock**: The instance is not locked.
|
|
15151
|
+
* * **ManualLock**: The instance is manually locked.
|
|
15152
|
+
* * **LockByExpiration**: The instance is automatically locked due to instance expiration.
|
|
15153
|
+
* * **LockByRestoration**: The instance is automatically locked before a rollback.
|
|
15154
|
+
* * **LockByDiskQuota**: The instance is automatically locked because its storage capacity is exhausted and the instance is inaccessible.
|
|
15155
|
+
*
|
|
15156
|
+
* @example
|
|
15157
|
+
* Unlock
|
|
15158
|
+
*/
|
|
14650
15159
|
lockMode?: string;
|
|
14651
15160
|
/**
|
|
14652
15161
|
* @remarks
|
|
@@ -14743,6 +15252,27 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
|
|
|
14743
15252
|
* s-bp1d8c262a15****.mongodb.rds.aliyuncs.com
|
|
14744
15253
|
*/
|
|
14745
15254
|
connectSting?: string;
|
|
15255
|
+
/**
|
|
15256
|
+
* @remarks
|
|
15257
|
+
* The minor version of the current MongoDB kernel.
|
|
15258
|
+
*
|
|
15259
|
+
* @example
|
|
15260
|
+
* mongodb_20220518_4.0.21
|
|
15261
|
+
*/
|
|
15262
|
+
currentKernelVersion?: string;
|
|
15263
|
+
/**
|
|
15264
|
+
* @remarks
|
|
15265
|
+
* The lock status of the instance. Valid values:
|
|
15266
|
+
*
|
|
15267
|
+
* * **Unlock**: The instance is not locked.
|
|
15268
|
+
* * **ManualLock**: The instance is manually locked.
|
|
15269
|
+
* * **LockByExpiration**: The instance is automatically locked due to instance expiration.
|
|
15270
|
+
* * **LockByRestoration**: The instance is automatically locked before a rollback.
|
|
15271
|
+
* * **LockByDiskQuota**: The instance is automatically locked because its storage capacity is exhausted and the instance is inaccessible.
|
|
15272
|
+
*
|
|
15273
|
+
* @example
|
|
15274
|
+
* Unlock
|
|
15275
|
+
*/
|
|
14746
15276
|
lockMode?: string;
|
|
14747
15277
|
/**
|
|
14748
15278
|
* @remarks
|
|
@@ -14950,6 +15480,27 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
|
|
|
14950
15480
|
* d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****
|
|
14951
15481
|
*/
|
|
14952
15482
|
connectString?: string;
|
|
15483
|
+
/**
|
|
15484
|
+
* @remarks
|
|
15485
|
+
* The minor version of the current MongoDB kernel.
|
|
15486
|
+
*
|
|
15487
|
+
* @example
|
|
15488
|
+
* mongodb_20230613_4.0.25
|
|
15489
|
+
*/
|
|
15490
|
+
currentKernelVersion?: string;
|
|
15491
|
+
/**
|
|
15492
|
+
* @remarks
|
|
15493
|
+
* The lock status of the shard node. Valid values:
|
|
15494
|
+
*
|
|
15495
|
+
* * **Unlock**: The instance is not locked.
|
|
15496
|
+
* * **ManualLock**: The instance is manually locked.
|
|
15497
|
+
* * **LockByExpiration**: The instance is automatically locked due to instance expiration.
|
|
15498
|
+
* * **LockByRestoration**: The instance is automatically locked before a rollback.
|
|
15499
|
+
* * **LockByDiskQuota**: The instance is automatically locked because its storage capacity is exhausted and the instance is inaccessible.
|
|
15500
|
+
*
|
|
15501
|
+
* @example
|
|
15502
|
+
* Unlock
|
|
15503
|
+
*/
|
|
14953
15504
|
lockMode?: string;
|
|
14954
15505
|
/**
|
|
14955
15506
|
* @remarks
|
|
@@ -14961,7 +15512,7 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
|
|
|
14961
15512
|
maxConnections?: number;
|
|
14962
15513
|
/**
|
|
14963
15514
|
* @remarks
|
|
14964
|
-
* shard
|
|
15515
|
+
* The maximum MBPS of the shard node.
|
|
14965
15516
|
*
|
|
14966
15517
|
* @example
|
|
14967
15518
|
* 350
|
|
@@ -15122,7 +15673,7 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
|
|
|
15122
15673
|
chargeType?: string;
|
|
15123
15674
|
/**
|
|
15124
15675
|
* @remarks
|
|
15125
|
-
* The
|
|
15676
|
+
* The details of the ConfigServer node.
|
|
15126
15677
|
*
|
|
15127
15678
|
* > This parameter is returned if the instance is a sharded cluster instance.
|
|
15128
15679
|
*/
|
|
@@ -15381,7 +15932,7 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
|
|
|
15381
15932
|
maxIOPS?: number;
|
|
15382
15933
|
/**
|
|
15383
15934
|
* @remarks
|
|
15384
|
-
*
|
|
15935
|
+
* The maximum MBPS of the instance.
|
|
15385
15936
|
*
|
|
15386
15937
|
* @example
|
|
15387
15938
|
* 350
|
|
@@ -15389,7 +15940,7 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
|
|
|
15389
15940
|
maxMBPS?: number;
|
|
15390
15941
|
/**
|
|
15391
15942
|
* @remarks
|
|
15392
|
-
* The
|
|
15943
|
+
* The details of the mongos node.
|
|
15393
15944
|
*
|
|
15394
15945
|
* > This parameter is returned if the instance is a sharded cluster instance.
|
|
15395
15946
|
*/
|
|
@@ -15524,7 +16075,7 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
|
|
|
15524
16075
|
secondaryZoneId?: string;
|
|
15525
16076
|
/**
|
|
15526
16077
|
* @remarks
|
|
15527
|
-
* The
|
|
16078
|
+
* The details of the shard node.
|
|
15528
16079
|
*
|
|
15529
16080
|
* > This parameter is returned if the instance is a sharded cluster instance.
|
|
15530
16081
|
*/
|
|
@@ -19300,6 +19851,14 @@ export declare class DescribeReplicaSetRoleResponseBodyReplicaSetsReplicaSet ext
|
|
|
19300
19851
|
* 3717
|
|
19301
19852
|
*/
|
|
19302
19853
|
connectionPort?: string;
|
|
19854
|
+
/**
|
|
19855
|
+
* @remarks
|
|
19856
|
+
* The connection type of the node.
|
|
19857
|
+
*
|
|
19858
|
+
* @example
|
|
19859
|
+
* SRV
|
|
19860
|
+
*/
|
|
19861
|
+
connectionType?: string;
|
|
19303
19862
|
/**
|
|
19304
19863
|
* @remarks
|
|
19305
19864
|
* The remaining duration of the classic network endpoint. Unit: seconds.
|
|
@@ -19361,6 +19920,144 @@ export declare class DescribeReplicaSetRoleResponseBodyReplicaSets extends $tea.
|
|
|
19361
19920
|
[key: string]: any;
|
|
19362
19921
|
});
|
|
19363
19922
|
}
|
|
19923
|
+
export declare class DescribeRestoreDBInstanceListResponseBodyDBInstancesDBInstance extends $tea.Model {
|
|
19924
|
+
/**
|
|
19925
|
+
* @remarks
|
|
19926
|
+
* The time of instance creation, formatted as <i>yyyy-MM-dd</i>T<i>HH:00:00</i>Z (UTC time).
|
|
19927
|
+
*
|
|
19928
|
+
* @example
|
|
19929
|
+
* 2022-01-02T07:43:59Z
|
|
19930
|
+
*/
|
|
19931
|
+
creationTime?: string;
|
|
19932
|
+
/**
|
|
19933
|
+
* @remarks
|
|
19934
|
+
* The description of the instance.
|
|
19935
|
+
*
|
|
19936
|
+
* @example
|
|
19937
|
+
* test-database
|
|
19938
|
+
*/
|
|
19939
|
+
DBInstanceDescription?: string;
|
|
19940
|
+
/**
|
|
19941
|
+
* @remarks
|
|
19942
|
+
* The instance ID.
|
|
19943
|
+
*
|
|
19944
|
+
* @example
|
|
19945
|
+
* dds-bp12c5b040dc****
|
|
19946
|
+
*/
|
|
19947
|
+
DBInstanceId?: string;
|
|
19948
|
+
/**
|
|
19949
|
+
* @remarks
|
|
19950
|
+
* The status of the instance. For more information, see [Instance states](https://help.aliyun.com/document_detail/63870.html).
|
|
19951
|
+
*
|
|
19952
|
+
* @example
|
|
19953
|
+
* Running
|
|
19954
|
+
*/
|
|
19955
|
+
DBInstanceStatus?: string;
|
|
19956
|
+
/**
|
|
19957
|
+
* @remarks
|
|
19958
|
+
* The architecture of the instance. Valid values:
|
|
19959
|
+
*
|
|
19960
|
+
* * **sharding**: sharded cluster instance
|
|
19961
|
+
* * **replicate**: replica set or standalone instance
|
|
19962
|
+
*
|
|
19963
|
+
* @example
|
|
19964
|
+
* replicate
|
|
19965
|
+
*/
|
|
19966
|
+
DBInstanceType?: string;
|
|
19967
|
+
/**
|
|
19968
|
+
* @remarks
|
|
19969
|
+
* The database engine version of the instance. Valid values:
|
|
19970
|
+
*
|
|
19971
|
+
* * **7.0**
|
|
19972
|
+
* * **6.0**
|
|
19973
|
+
* * **5.0**
|
|
19974
|
+
* * **4.4**
|
|
19975
|
+
* * **4.2**
|
|
19976
|
+
* * **4.0**
|
|
19977
|
+
* * **3.4**
|
|
19978
|
+
*
|
|
19979
|
+
* @example
|
|
19980
|
+
* 4.2
|
|
19981
|
+
*/
|
|
19982
|
+
engineVersion?: string;
|
|
19983
|
+
/**
|
|
19984
|
+
* @remarks
|
|
19985
|
+
* The secondary availability zone 2 for the instance when implementing multi-AZ deployment.
|
|
19986
|
+
*
|
|
19987
|
+
* @example
|
|
19988
|
+
* cn-hangzhou-h
|
|
19989
|
+
*/
|
|
19990
|
+
hiddenZoneId?: string;
|
|
19991
|
+
/**
|
|
19992
|
+
* @remarks
|
|
19993
|
+
* Specifies whether the instance is deleted. Valid values:
|
|
19994
|
+
*
|
|
19995
|
+
* * **0**: not deleted
|
|
19996
|
+
* * **1**: deleted
|
|
19997
|
+
*
|
|
19998
|
+
* @example
|
|
19999
|
+
* 0
|
|
20000
|
+
*/
|
|
20001
|
+
isDeleted?: number;
|
|
20002
|
+
/**
|
|
20003
|
+
* @remarks
|
|
20004
|
+
* The locked state of the instance, value description:
|
|
20005
|
+
* - Unlock: Normal.
|
|
20006
|
+
* - ManualLock: Manually triggered lock.
|
|
20007
|
+
* - LockByExpiration: Automatically locked due to expiration.
|
|
20008
|
+
* - LockByRestoration: Automatically locked before restoration.
|
|
20009
|
+
* - LockByDiskQuota: Automatically locked due to disk quota exceeded.
|
|
20010
|
+
*
|
|
20011
|
+
* @example
|
|
20012
|
+
* Unlock
|
|
20013
|
+
*/
|
|
20014
|
+
lockMode?: string;
|
|
20015
|
+
/**
|
|
20016
|
+
* @remarks
|
|
20017
|
+
* The region ID of the instance.
|
|
20018
|
+
*
|
|
20019
|
+
* @example
|
|
20020
|
+
* cn-hangzhou
|
|
20021
|
+
*/
|
|
20022
|
+
regionId?: string;
|
|
20023
|
+
/**
|
|
20024
|
+
* @remarks
|
|
20025
|
+
* The secondary availability zone 1 for the instance when implementing multi-AZ deployment.
|
|
20026
|
+
*
|
|
20027
|
+
* @example
|
|
20028
|
+
* cn-hangzhou-i
|
|
20029
|
+
*/
|
|
20030
|
+
secondaryZoneId?: string;
|
|
20031
|
+
/**
|
|
20032
|
+
* @remarks
|
|
20033
|
+
* The zone ID of the instance.
|
|
20034
|
+
*
|
|
20035
|
+
* @example
|
|
20036
|
+
* cn-hangzhou-g
|
|
20037
|
+
*/
|
|
20038
|
+
zoneId?: string;
|
|
20039
|
+
static names(): {
|
|
20040
|
+
[key: string]: string;
|
|
20041
|
+
};
|
|
20042
|
+
static types(): {
|
|
20043
|
+
[key: string]: any;
|
|
20044
|
+
};
|
|
20045
|
+
constructor(map?: {
|
|
20046
|
+
[key: string]: any;
|
|
20047
|
+
});
|
|
20048
|
+
}
|
|
20049
|
+
export declare class DescribeRestoreDBInstanceListResponseBodyDBInstances extends $tea.Model {
|
|
20050
|
+
DBInstance?: DescribeRestoreDBInstanceListResponseBodyDBInstancesDBInstance[];
|
|
20051
|
+
static names(): {
|
|
20052
|
+
[key: string]: string;
|
|
20053
|
+
};
|
|
20054
|
+
static types(): {
|
|
20055
|
+
[key: string]: any;
|
|
20056
|
+
};
|
|
20057
|
+
constructor(map?: {
|
|
20058
|
+
[key: string]: any;
|
|
20059
|
+
});
|
|
20060
|
+
}
|
|
19364
20061
|
export declare class DescribeRoleZoneInfoResponseBodyZoneInfosZoneInfo extends $tea.Model {
|
|
19365
20062
|
/**
|
|
19366
20063
|
* @remarks
|
|
@@ -19675,6 +20372,17 @@ export declare class DescribeShardingNetworkAddressResponseBodyCompatibleConnect
|
|
|
19675
20372
|
});
|
|
19676
20373
|
}
|
|
19677
20374
|
export declare class DescribeShardingNetworkAddressResponseBodyNetworkAddressesNetworkAddress extends $tea.Model {
|
|
20375
|
+
/**
|
|
20376
|
+
* @remarks
|
|
20377
|
+
* The public endpoint type. Valid values:
|
|
20378
|
+
*
|
|
20379
|
+
* * **SRV**
|
|
20380
|
+
* * **Normal**
|
|
20381
|
+
*
|
|
20382
|
+
* @example
|
|
20383
|
+
* SRV
|
|
20384
|
+
*/
|
|
20385
|
+
connectionType?: string;
|
|
19678
20386
|
/**
|
|
19679
20387
|
* @remarks
|
|
19680
20388
|
* The remaining duration of the classic network endpoint. Unit: seconds.
|
|
@@ -19750,6 +20458,14 @@ export declare class DescribeShardingNetworkAddressResponseBodyNetworkAddressesN
|
|
|
19750
20458
|
* Primary
|
|
19751
20459
|
*/
|
|
19752
20460
|
role?: string;
|
|
20461
|
+
/**
|
|
20462
|
+
* @remarks
|
|
20463
|
+
* 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.
|
|
20464
|
+
*
|
|
20465
|
+
* @example
|
|
20466
|
+
* mongo.example.com. IN TXT "config=replicaSet=myReplicaSet"
|
|
20467
|
+
*/
|
|
20468
|
+
txtRecord?: string;
|
|
19753
20469
|
/**
|
|
19754
20470
|
* @remarks
|
|
19755
20471
|
* The VPC ID of the instance.
|
|
@@ -20234,7 +20950,7 @@ export default class Client extends OpenApi {
|
|
|
20234
20950
|
* Creates or clones an ApsaraDB for MongoDB replica set instance.
|
|
20235
20951
|
*
|
|
20236
20952
|
* @remarks
|
|
20237
|
-
* Make sure that you fully understand the billing methods and [pricing](https://www.
|
|
20953
|
+
* 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
20954
|
* 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
20955
|
* To create sharded cluster instances, you can call the [CreateShardingDBInstance](~~CreateShardingDBInstance~~) operation.
|
|
20240
20956
|
*
|
|
@@ -20247,7 +20963,7 @@ export default class Client extends OpenApi {
|
|
|
20247
20963
|
* Creates or clones an ApsaraDB for MongoDB replica set instance.
|
|
20248
20964
|
*
|
|
20249
20965
|
* @remarks
|
|
20250
|
-
* Make sure that you fully understand the billing methods and [pricing](https://www.
|
|
20966
|
+
* 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
20967
|
* 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
20968
|
* To create sharded cluster instances, you can call the [CreateShardingDBInstance](~~CreateShardingDBInstance~~) operation.
|
|
20253
20969
|
*
|
|
@@ -20320,7 +21036,7 @@ export default class Client extends OpenApi {
|
|
|
20320
21036
|
* Creates or clones an ApsaraDB for MongoDB sharded cluster instance.
|
|
20321
21037
|
*
|
|
20322
21038
|
* @remarks
|
|
20323
|
-
* Make sure that you fully understand the billing methods and [pricing](https://www.
|
|
21039
|
+
* 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
21040
|
* * For more information about the instance types of ApsaraDB for MongoDB, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
|
|
20325
21041
|
* * To create standalone instances and replica set instances, you can call the [CreateDBInstance](https://help.aliyun.com/document_detail/61763.html) operation.
|
|
20326
21042
|
*
|
|
@@ -20333,7 +21049,7 @@ export default class Client extends OpenApi {
|
|
|
20333
21049
|
* Creates or clones an ApsaraDB for MongoDB sharded cluster instance.
|
|
20334
21050
|
*
|
|
20335
21051
|
* @remarks
|
|
20336
|
-
* Make sure that you fully understand the billing methods and [pricing](https://www.
|
|
21052
|
+
* 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
21053
|
* * For more information about the instance types of ApsaraDB for MongoDB, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
|
|
20338
21054
|
* * To create standalone instances and replica set instances, you can call the [CreateDBInstance](https://help.aliyun.com/document_detail/61763.html) operation.
|
|
20339
21055
|
*
|
|
@@ -21245,6 +21961,21 @@ export default class Client extends OpenApi {
|
|
|
21245
21961
|
* @returns DescribeReplicaSetRoleResponse
|
|
21246
21962
|
*/
|
|
21247
21963
|
describeReplicaSetRole(request: DescribeReplicaSetRoleRequest): Promise<DescribeReplicaSetRoleResponse>;
|
|
21964
|
+
/**
|
|
21965
|
+
* Queries ApsaraDB for MongoDB instances whose backups are restored within seven days.
|
|
21966
|
+
*
|
|
21967
|
+
* @param request - DescribeRestoreDBInstanceListRequest
|
|
21968
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
21969
|
+
* @returns DescribeRestoreDBInstanceListResponse
|
|
21970
|
+
*/
|
|
21971
|
+
describeRestoreDBInstanceListWithOptions(request: DescribeRestoreDBInstanceListRequest, runtime: $Util.RuntimeOptions): Promise<DescribeRestoreDBInstanceListResponse>;
|
|
21972
|
+
/**
|
|
21973
|
+
* Queries ApsaraDB for MongoDB instances whose backups are restored within seven days.
|
|
21974
|
+
*
|
|
21975
|
+
* @param request - DescribeRestoreDBInstanceListRequest
|
|
21976
|
+
* @returns DescribeRestoreDBInstanceListResponse
|
|
21977
|
+
*/
|
|
21978
|
+
describeRestoreDBInstanceList(request: DescribeRestoreDBInstanceListRequest): Promise<DescribeRestoreDBInstanceListResponse>;
|
|
21248
21979
|
/**
|
|
21249
21980
|
* Queries the role and zone of each node in an ApsaraDB for MongoDB instance.
|
|
21250
21981
|
*
|
|
@@ -21603,6 +22334,9 @@ export default class Client extends OpenApi {
|
|
|
21603
22334
|
/**
|
|
21604
22335
|
* Modifies a backup policy for an ApsaraDB for MongoDB instance.
|
|
21605
22336
|
*
|
|
22337
|
+
* @remarks
|
|
22338
|
+
* Cross-regional backup only supports MongoDB sharded cluster instance and MongoDB replica set.
|
|
22339
|
+
*
|
|
21606
22340
|
* @param request - ModifyBackupPolicyRequest
|
|
21607
22341
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
21608
22342
|
* @returns ModifyBackupPolicyResponse
|
|
@@ -21611,6 +22345,9 @@ export default class Client extends OpenApi {
|
|
|
21611
22345
|
/**
|
|
21612
22346
|
* Modifies a backup policy for an ApsaraDB for MongoDB instance.
|
|
21613
22347
|
*
|
|
22348
|
+
* @remarks
|
|
22349
|
+
* Cross-regional backup only supports MongoDB sharded cluster instance and MongoDB replica set.
|
|
22350
|
+
*
|
|
21614
22351
|
* @param request - ModifyBackupPolicyRequest
|
|
21615
22352
|
* @returns ModifyBackupPolicyResponse
|
|
21616
22353
|
*/
|
|
@@ -22199,7 +22936,13 @@ export default class Client extends OpenApi {
|
|
|
22199
22936
|
*/
|
|
22200
22937
|
restartDBInstance(request: RestartDBInstanceRequest): Promise<RestartDBInstanceResponse>;
|
|
22201
22938
|
/**
|
|
22202
|
-
*
|
|
22939
|
+
* Restarts a node in an ApsaraDB for MongoDB instance.
|
|
22940
|
+
*
|
|
22941
|
+
* @remarks
|
|
22942
|
+
* You can call this operation to restart a node in a replica set instance or a child instance in a sharded cluster instance.
|
|
22943
|
+
* > When you call this operation, the instance must meet the following requirements:
|
|
22944
|
+
* * The instance is in the Running state.
|
|
22945
|
+
* * The instance is a replica set or sharded cluster instance of the standard edition.
|
|
22203
22946
|
*
|
|
22204
22947
|
* @param request - RestartNodeRequest
|
|
22205
22948
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -22207,7 +22950,13 @@ export default class Client extends OpenApi {
|
|
|
22207
22950
|
*/
|
|
22208
22951
|
restartNodeWithOptions(request: RestartNodeRequest, runtime: $Util.RuntimeOptions): Promise<RestartNodeResponse>;
|
|
22209
22952
|
/**
|
|
22210
|
-
*
|
|
22953
|
+
* Restarts a node in an ApsaraDB for MongoDB instance.
|
|
22954
|
+
*
|
|
22955
|
+
* @remarks
|
|
22956
|
+
* You can call this operation to restart a node in a replica set instance or a child instance in a sharded cluster instance.
|
|
22957
|
+
* > When you call this operation, the instance must meet the following requirements:
|
|
22958
|
+
* * The instance is in the Running state.
|
|
22959
|
+
* * The instance is a replica set or sharded cluster instance of the standard edition.
|
|
22211
22960
|
*
|
|
22212
22961
|
* @param request - RestartNodeRequest
|
|
22213
22962
|
* @returns RestartNodeResponse
|
|
@@ -22298,12 +23047,12 @@ export default class Client extends OpenApi {
|
|
|
22298
23047
|
* Changes the billing method of an instance from pay-as-you-go to subscription or from subscription to pay-as-you-go.
|
|
22299
23048
|
*
|
|
22300
23049
|
* @remarks
|
|
22301
|
-
* Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.
|
|
23050
|
+
* 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
23051
|
* Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
22303
23052
|
* * The instance is in the Running state.
|
|
22304
23053
|
* * Your instance has no unpaid billing method change orders.
|
|
22305
23054
|
* * 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
|
|
23055
|
+
* > 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
23056
|
*
|
|
22308
23057
|
* @param request - TransformInstanceChargeTypeRequest
|
|
22309
23058
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -22314,12 +23063,12 @@ export default class Client extends OpenApi {
|
|
|
22314
23063
|
* Changes the billing method of an instance from pay-as-you-go to subscription or from subscription to pay-as-you-go.
|
|
22315
23064
|
*
|
|
22316
23065
|
* @remarks
|
|
22317
|
-
* Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.
|
|
23066
|
+
* 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
23067
|
* Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
22319
23068
|
* * The instance is in the Running state.
|
|
22320
23069
|
* * Your instance has no unpaid billing method change orders.
|
|
22321
23070
|
* * 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
|
|
23071
|
+
* > 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
23072
|
*
|
|
22324
23073
|
* @param request - TransformInstanceChargeTypeRequest
|
|
22325
23074
|
* @returns TransformInstanceChargeTypeResponse
|