@alicloud/dds20151201 7.2.0 → 8.0.0

package/dist/client.d.ts

@@ -150,10 +150,13 @@ export declare class CreateShardingDBInstanceRequestMongos extends $dara.Model {
 export declare class CreateShardingDBInstanceRequestReplicaSet extends $dara.Model {
     /**
      * @remarks
-     * The instance type of the shard node. For more information, see [Sharded cluster instance types](https://help.aliyun.com/document_detail/311414.html).
+     * The instance type of the shard component. For more information, see [Sharded cluster instance types](https://help.aliyun.com/document_detail/311414.html).
      *
-     * > * **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.
-     * > * Valid values of **N**: **2** to **32**.
+     * >
+     *
+     * *   **N** specifies the serial number of the shard component for which the instance type is specified. For example, **ReplicaSet.2.Class** specifies the instance type of the second shard component.
+     *
+     * *   Valid values of **N**: **2** to **32**.
      *
      * This parameter is required.
      *
@@ -163,11 +166,11 @@ export declare class CreateShardingDBInstanceRequestReplicaSet extends $dara.Mod
     class?: string;
     /**
      * @remarks
-     * The number of read-only nodes in the shard node.
+     * The number of read-only nodes in the shard component.
      *
      * Valid values: **0**, **1, 2, 3, 4, and 5**. Default value: **0**.
      *
-     * >  **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.
+     * >  **N** specifies the serial number of the shard component 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 component.
      *
      * @example
      * 0
@@ -175,10 +178,13 @@ export declare class CreateShardingDBInstanceRequestReplicaSet extends $dara.Mod
     readonlyReplicas?: number;
     /**
      * @remarks
-     * The storage capacity of the shard node. Unit: GB.
+     * The storage capacity of the shard component. Unit: GB.
+     *
+     * >
      *
-     * > * 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).
-     * > * **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.
+     * *   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).
+     *
+     * *   **N** specifies the serial number of the shard component for which the storage capacity is specified. For example, **ReplicaSet.2.Storage** specifies the storage capacity of the second shard component.
      *
      * This parameter is required.
      *
@@ -1961,6 +1967,13 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
      * s-bp1d8c262a15****.mongodb.rds.aliyuncs.com
      */
     connectSting?: string;
+    /**
+     * @remarks
+     * The endpoint of the mongos node.
+     *
+     * @example
+     * s-bp1d8c262a15****.mongodb.rds.aliyuncs.com
+     */
     connectString?: string;
     /**
      * @remarks
@@ -4305,7 +4318,7 @@ export declare class DescribeHistoryTasksResponseBodyItems extends $dara.Model {
      * @example
      * Succeed
      */
-    status?: number;
+    status?: string;
     /**
      * @remarks
      * The details of the task. The task details vary based on the value of the taskType parameter.
@@ -5860,7 +5873,7 @@ export declare class DescribePriceResponseBodySubOrdersSubOrderModuleInstanceMod
     promDetailList?: DescribePriceResponseBodySubOrdersSubOrderModuleInstanceModuleInstancePromDetailList;
     /**
      * @remarks
-     * The discount.
+     * The discounted price.
      *
      * @example
      * 451.00
@@ -5882,7 +5895,21 @@ export declare class DescribePriceResponseBodySubOrdersSubOrderModuleInstanceMod
      * 0.0
      */
     totalProductFee?: number;
+    /**
+     * @remarks
+     * The price type.
+     *
+     * @example
+     * monthPrice
+     */
     priceType?: string;
+    /**
+     * @remarks
+     * The unit of the price.
+     *
+     * @example
+     * xxxx
+     */
     priceUnit?: string;
     static names(): {
         [key: string]: string;
@@ -5989,7 +6016,7 @@ export declare class DescribePriceResponseBodySubOrdersSubOrderOptionalPromotion
     promotionOptionNo?: string;
     /**
      * @remarks
-     * The IDs of the rules that correspond to the coupon.
+     * The promotion IDs.
      */
     promotionRuleIdList?: DescribePriceResponseBodySubOrdersSubOrderOptionalPromotionsOptionalPromotionPromotionRuleIdList;
     /**
@@ -8189,6 +8216,19 @@ export declare class CreateAccountRequest extends $dara.Model {
      * Test123456!
      */
     accountPassword?: string;
+    /**
+     * @remarks
+     * The type of the account that you want to create. Valid values:
+     *
+     * *   **db** (default): shard account (available)
+     * *   **cs**: ConfigServer account
+     * *   **normal**: replica set account
+     *
+     * >  You can set this parameter only to **db**.
+     *
+     * @example
+     * db
+     */
     characterType?: string;
     /**
      * @remarks
@@ -9301,9 +9341,11 @@ export declare class CreateShardingDBInstanceRequest extends $dara.Model {
      * @remarks
      * The password of the root account. The password must meet the following requirements:
      *
-     * *   The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
-     * *   The special characters include ! # $ % ^ & \\* ( ) _ + - =
-     * *   The password of the account must be 8 to 32 characters in length.
+     * *   The password contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
+     * *   The following special characters are supported: ! @ # $ % ^ & \\* ( ) _ + - =.
+     * *   The password must be 8 to 32 characters in length.
+     *
+     * >  For more information about how to resolve failed database connections due to special characters, see [What do I do if my instance is not connected due to special characters in the password in the connection string of the instance?](https://help.aliyun.com/document_detail/471568.html)
      *
      * @example
      * 123456Aa
@@ -9339,7 +9381,7 @@ export declare class CreateShardingDBInstanceRequest extends $dara.Model {
      * *   **PostPaid** (default): pay-as-you-go
      * *   **PrePaid**: subscription
      *
-     * >  If this parameter is set to **PrePaid**, you must also configure the **Period** parameter.
+     * >  If you set this parameter to **PrePaid**, you must also configure the **Period** parameter.
      *
      * @example
      * PrePaid
@@ -9384,7 +9426,7 @@ export declare class CreateShardingDBInstanceRequest extends $dara.Model {
     destRegion?: string;
     /**
      * @remarks
-     * Indicates whether disk encryption is enabled.
+     * Specifies whether to enable disk encryption.
      *
      * @example
      * true
@@ -9419,8 +9461,11 @@ export declare class CreateShardingDBInstanceRequest extends $dara.Model {
      * *   **4.2**
      * *   **4.0**
      *
-     * > * 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).
-     * > * If you call this operation to clone an instance, set the value of this parameter to the database engine version of the source instance.
+     * >
+     *
+     * *   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).
+     *
+     * *   If you call this operation to clone an instance, set the value of this parameter to the database engine version of the source instance.
      *
      * This parameter is required.
      *
@@ -9476,9 +9521,9 @@ export declare class CreateShardingDBInstanceRequest extends $dara.Model {
     mongos?: CreateShardingDBInstanceRequestMongos[];
     /**
      * @remarks
-     * The network type of the instance.
+     * The network type of the instance. Set the value to VPC.
      *
-     * Set the value to **VPC**.
+     * ****
      *
      * @example
      * VPC
@@ -9529,7 +9574,7 @@ export declare class CreateShardingDBInstanceRequest extends $dara.Model {
     regionId?: string;
     /**
      * @remarks
-     * The information of the shard node.
+     * The information of the shard component.
      *
      * This parameter is required.
      */
@@ -9556,10 +9601,11 @@ export declare class CreateShardingDBInstanceRequest extends $dara.Model {
     restoreTime?: string;
     /**
      * @remarks
-     * The backup restore type of the instance.
-     * - 1:  restore an instance to the specified time.
-     * - 2: restore an  released instance to the specified backup set.
-     * - 3：restore an instance to the specified cross-regional backup set.
+     * The restoration type of the instance. Valid values:
+     *
+     * *   1: restores the instance data to the specified point in time.
+     * *   2: restores the data of the released instance to the specified backup set.
+     * *   3: restores the instance data to the specified cross-region backup set.
      *
      * @example
      * 1
@@ -9635,8 +9681,11 @@ export declare class CreateShardingDBInstanceRequest extends $dara.Model {
      * @remarks
      * The storage engine of the instance. Set the value to **WiredTiger**.
      *
-     * > * If you call this operation to clone an instance, set the value of this parameter to the storage engine of the source instance.
-     * > * 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).
+     * >
+     *
+     * *   If you call this operation to clone an instance, set the value of this parameter to the storage engine of the source instance.
+     *
+     * *   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).
      *
      * @example
      * WiredTiger
@@ -10591,7 +10640,7 @@ export declare class DescribeActiveOperationTasksRequest extends $dara.Model {
     ownerId?: number;
     /**
      * @remarks
-     * The page number of the page to return.
+     * The number of the page to return. Specify the parameter to a positive integer that is greater than **0**. Default value: **1**.
      *
      * @example
      * 1
@@ -10599,7 +10648,7 @@ export declare class DescribeActiveOperationTasksRequest extends $dara.Model {
     pageNumber?: number;
     /**
      * @remarks
-     * The number of entries to return on each page. Valid values: **30, 50, and 100**. Default value: **30**.
+     * The number of entries to return on each page. Valid values: **30**, **50**, and **100**. Default value: **30**.
      *
      * @example
      * 30
@@ -10623,6 +10672,14 @@ export declare class DescribeActiveOperationTasksRequest extends $dara.Model {
      * cn-beijing
      */
     region?: string;
+    /**
+     * @remarks
+     * The ID of the resource group.
+     *
+     * @example
+     * rg-acfmyiu4ekp****
+     */
+    resourceGroupId?: string;
     resourceOwnerAccount?: string;
     resourceOwnerId?: number;
     /**
@@ -11100,7 +11157,7 @@ export declare class DescribeAuditRecordsResponse extends $dara.Model {
 export declare class DescribeAvailabilityZonesRequest extends $dara.Model {
     /**
      * @remarks
-     * The language of the values of the returned **RegionName** and **ZoneName** parameters. Valid values:
+     * The language of the returned **RegionName** and **ZoneName** parameter values. Valid values:
      *
      * *   **zh** (default): Chinese
      * *   **en**: English
@@ -11154,15 +11211,26 @@ export declare class DescribeAvailabilityZonesRequest extends $dara.Model {
     excludeZoneId?: string;
     /**
      * @remarks
-     * The billing method. Valid values:
+     * The billing method of the product. Valid values:
      *
-     * *   **PrePaid** (default): subscription
-     * *   **PostPaid**: pay-as-you-go
+     * *   **PrePaid**: subscription
+     * *   **PostPaid:** pay-as-you-go
      *
      * @example
      * PrePaid
      */
     instanceChargeType?: string;
+    /**
+     * @remarks
+     * The architecture of the instance. Valid values:
+     *
+     * *   **sharding**: sharded cluster instance
+     * *   **replicate**: replica set or standalone instance
+     *
+     * @example
+     * replicate
+     */
+    instanceType?: string;
     /**
      * @remarks
      * The edition of the instance. High-Available Edition and Preview Edition (dbfs) are supported.
@@ -11185,7 +11253,16 @@ export declare class DescribeAvailabilityZonesRequest extends $dara.Model {
     regionId?: string;
     /**
      * @remarks
-     * The number of nodes. This parameter is available only for replica set instances.
+     * The number of nodes in the instance.
+     *
+     * >  This parameter is available only for replica set instances.
+     *
+     * Valid values:
+     *
+     * *   1
+     * *   3
+     * *   5
+     * *   7
      *
      * @example
      * 3
@@ -11203,10 +11280,11 @@ export declare class DescribeAvailabilityZonesRequest extends $dara.Model {
     resourceOwnerId?: number;
     /**
      * @remarks
-     * The storage type of the instance.
-     * - **cloud**: The system displays only zones in which cloud disk-based instances can be deployed.
-     * - **local**: The system displays only zones in which local disk-based instances can be deployed.
-     * - **default** or null: The system displays only zones in which cloud disk-based and local disk-based instances can be deployed.
+     * The storage type. Valid values:
+     *
+     * *   **cloud**: displays only zones available for instances that use cloud disks.
+     * *   **local**: only displays zones available for instances that use local disks instances.
+     * *   **default** or unspecified: displays zones available for instances that use cloud disks and those that use local disks.
      *
      * @example
      * local
@@ -11214,15 +11292,18 @@ export declare class DescribeAvailabilityZonesRequest extends $dara.Model {
     storageSupport?: string;
     /**
      * @remarks
-     * The storage type of the instance. Valid values:
+     * The disk type. Valid values:
      *
-     * *   **cloud_essd1**: PL1 enhanced SSD (ESSD)
+     * *   **cloud_essd**: PL1 Enterprise SSD (ESSD)
      * *   **cloud_essd2**: PL2 ESSD
      * *   **cloud_essd3**: PL3 ESSD
-     * *   **local_ssd**: Local SSD
+     * *   **dhg_local_ssd**: local SSD
      *
-     * > *   Instances that run MongoDB 4.4 or later support only cloud disks. **cloud_essd1** is selected if you leave this parameter empty.
-     * > *   Instances that run MongoDB 4.2 and earlier support only local disks. **local_ssd** is selected if you leave this parameter empty.
+     * >
+     *
+     * *   Instances that run MongoDB 4.4 or later only use cloud disks to store data. If you do not specify this parameter, the value **cloud_essd1** is used by default.
+     *
+     * *   Instances that run MongoDB 4.2 and earlier only use local disks to store data. If you do not specify this parameter, the value **local_ssd** is used by default.
      *
      * @example
      * local_ssd
@@ -12037,7 +12118,7 @@ export declare class DescribeBackupTasksRequest extends $dara.Model {
      * @remarks
      * The ID of the backup task.
      *
-     * >  If you call the [CreateBackup](https://help.aliyun.com/document_detail/61075.html) operation to perform a manual backup task, you can set this parameter to the returned backup ID to query the backup progress of the task.
+     * >  If you call the [CreateBackup](https://help.aliyun.com/document_detail/468439.html) operation to perform a manual backup task, you can set this parameter to the returned backup ID to query the backup progress of the task.
      *
      * @example
      * 170034
@@ -12166,7 +12247,7 @@ export declare class DescribeBackupsRequest extends $dara.Model {
     ownerId?: number;
     /**
      * @remarks
-     * 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**.
+     * The page number. Pages start from page 1. Default value: **1**.
      *
      * @example
      * 1
@@ -13082,6 +13163,76 @@ export declare class DescribeDBInstanceSSLResponse extends $dara.Model {
         [key: string]: any;
     });
 }
+export declare class DescribeDBInstanceSpecInfoRequest extends $dara.Model {
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * mdb.shard.4x.large.d
+     */
+    instanceClass?: string;
+    ownerAccount?: string;
+    ownerId?: number;
+    resourceOwnerAccount?: string;
+    resourceOwnerId?: number;
+    securityToken?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DescribeDBInstanceSpecInfoResponseBody extends $dara.Model {
+    /**
+     * @example
+     * 2
+     */
+    CPU?: string;
+    description?: string;
+    /**
+     * @example
+     * 8
+     */
+    memory?: string;
+    /**
+     * @example
+     * 6B82A9EF-9961-5A31-A19F-009B709xxxxx
+     */
+    requestId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DescribeDBInstanceSpecInfoResponse extends $dara.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: DescribeDBInstanceSpecInfoResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class DescribeDBInstanceSwitchLogRequest extends $dara.Model {
     /**
      * @remarks
@@ -13712,6 +13863,13 @@ export declare class DescribeDBInstancesOverviewRequest extends $dara.Model {
     resourceGroupId?: string;
     resourceOwnerAccount?: string;
     resourceOwnerId?: number;
+    /**
+     * @remarks
+     * Specifies whether to display instance tags. Default value: False.
+     *
+     * @example
+     * false
+     */
     showTags?: boolean;
     /**
      * @remarks
@@ -14193,7 +14351,7 @@ export declare class DescribeHistoryTasksRequest extends $dara.Model {
     instanceType?: string;
     /**
      * @remarks
-     * The number of the page to return. The value must be a positive integer. Default value: 1
+     * The number of the page to return. The value must be a positive integer. Default value: 1.
      *
      * @example
      * 1
@@ -14201,7 +14359,7 @@ export declare class DescribeHistoryTasksRequest extends $dara.Model {
     pageNumber?: number;
     /**
      * @remarks
-     * The number of entries per page. Valid values: 10 to 100. Default value: 10
+     * The number of entries per page. Valid values: 10 to 100. Default value: 10.
      *
      * @example
      * 10
@@ -14215,6 +14373,14 @@ export declare class DescribeHistoryTasksRequest extends $dara.Model {
      * cn-beijing
      */
     regionId?: string;
+    /**
+     * @remarks
+     * The ID of the resource group.
+     *
+     * @example
+     * rg-aek2inrfrnw3xby
+     */
+    resourceGroupId?: string;
     resourceOwnerAccount?: string;
     resourceOwnerId?: number;
     /**
@@ -14407,6 +14573,14 @@ export declare class DescribeHistoryTasksStatRequest extends $dara.Model {
      * cn-beijing
      */
     regionId?: string;
+    /**
+     * @remarks
+     * The ID of the resource group.
+     *
+     * @example
+     * rg-acfmyiu4ekp****
+     */
+    resourceGroupId?: string;
     resourceOwnerAccount?: string;
     resourceOwnerId?: number;
     /**
@@ -17389,10 +17563,8 @@ export declare class MigrateToOtherZoneRequest extends $dara.Model {
      * @remarks
      * The time when the instance is migrated to the destination zone. Valid values:
      *
-     * *   **Immediately**: The instance is immediately migrated to the destination zone.
-     * *   **MaintainTime**: The instance is migrated during the maintenance period of the instance.
-     *
-     * Default value: **Immediately**.
+     * *   **Immediately** (default): The instance is migrated immediately.
+     * *   **MaintainTime**: The instance is migrated during its maintenance window.
      *
      * @example
      * Immediately
@@ -17509,6 +17681,19 @@ export declare class ModifyAccountDescriptionRequest extends $dara.Model {
      * root
      */
     accountName?: string;
+    /**
+     * @remarks
+     * The type of the account whose description you can modify. Valid values:
+     *
+     * *   **db**: shard account
+     * *   **cs**: ConfigServer account
+     * *   **normal** (default): replica set account (available)
+     *
+     * >  You can set this parameter only to **normal**.
+     *
+     * @example
+     * normal
+     */
     characterType?: string;
     /**
      * @remarks
@@ -17601,6 +17786,14 @@ export declare class ModifyActiveOperationTasksRequest extends $dara.Model {
     immediateStart?: number;
     ownerAccount?: string;
     ownerId?: number;
+    /**
+     * @remarks
+     * The ID of the resource group.
+     *
+     * @example
+     * rg-acfmyiu4ekp****
+     */
+    resourceGroupId?: string;
     resourceOwnerAccount?: string;
     resourceOwnerId?: number;
     /**
@@ -22850,6 +23043,21 @@ export default class Client extends OpenApi {
      * @returns DescribeDBInstanceSSLResponse
      */
     describeDBInstanceSSL(request: DescribeDBInstanceSSLRequest): Promise<DescribeDBInstanceSSLResponse>;
+    /**
+     * 查看规格信息详情
+     *
+     * @param request - DescribeDBInstanceSpecInfoRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribeDBInstanceSpecInfoResponse
+     */
+    describeDBInstanceSpecInfoWithOptions(request: DescribeDBInstanceSpecInfoRequest, runtime: $dara.RuntimeOptions): Promise<DescribeDBInstanceSpecInfoResponse>;
+    /**
+     * 查看规格信息详情
+     *
+     * @param request - DescribeDBInstanceSpecInfoRequest
+     * @returns DescribeDBInstanceSpecInfoResponse
+     */
+    describeDBInstanceSpecInfo(request: DescribeDBInstanceSpecInfoRequest): Promise<DescribeDBInstanceSpecInfoResponse>;
     /**
      * Queries the primary/secondary switching logs of an ApsaraDB for MongoDB instance.
      *
@@ -23176,7 +23384,7 @@ export default class Client extends OpenApi {
      */
     describeParameters(request: DescribeParametersRequest): Promise<DescribeParametersResponse>;
     /**
-     * Queries the fees incurred when you create, upgrade, or renew an ApsaraDB for MongoDB instance.
+     * Queries the pricing information of an ApsaraDB for MongoDB instance.
      *
      * @param request - DescribePriceRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -23184,7 +23392,7 @@ export default class Client extends OpenApi {
      */
     describePriceWithOptions(request: DescribePriceRequest, runtime: $dara.RuntimeOptions): Promise<DescribePriceResponse>;
     /**
-     * Queries the fees incurred when you create, upgrade, or renew an ApsaraDB for MongoDB instance.
+     * Queries the pricing information of an ApsaraDB for MongoDB instance.
      *
      * @param request - DescribePriceRequest
      * @returns DescribePriceResponse