@alicloud/dds20151201 5.0.1 → 5.0.3

package/dist/client.js

@@ -1614,6 +1614,7 @@ class DescribeAvailabilityZonesRequest extends $tea.Model {
             ownerAccount: 'OwnerAccount',
             ownerId: 'OwnerId',
             regionId: 'RegionId',
+            replicationFactor: 'ReplicationFactor',
             resourceGroupId: 'ResourceGroupId',
             resourceOwnerAccount: 'ResourceOwnerAccount',
             resourceOwnerId: 'ResourceOwnerId',
@@ -1635,6 +1636,7 @@ class DescribeAvailabilityZonesRequest extends $tea.Model {
             ownerAccount: 'string',
             ownerId: 'number',
             regionId: 'string',
+            replicationFactor: 'string',
             resourceGroupId: 'string',
             resourceOwnerAccount: 'string',
             resourceOwnerId: 'number',
@@ -1758,6 +1760,7 @@ class DescribeAvailableResourceRequest extends $tea.Model {
             ownerAccount: 'OwnerAccount',
             ownerId: 'OwnerId',
             regionId: 'RegionId',
+            replicationFactor: 'ReplicationFactor',
             resourceGroupId: 'ResourceGroupId',
             resourceOwnerAccount: 'ResourceOwnerAccount',
             resourceOwnerId: 'ResourceOwnerId',
@@ -1774,6 +1777,7 @@ class DescribeAvailableResourceRequest extends $tea.Model {
             ownerAccount: 'string',
             ownerId: 'number',
             regionId: 'string',
+            replicationFactor: 'string',
             resourceGroupId: 'string',
             resourceOwnerAccount: 'string',
             resourceOwnerId: 'number',
@@ -3626,6 +3630,7 @@ class DescribeParameterTemplatesRequest extends $tea.Model {
             regionId: 'RegionId',
             resourceOwnerAccount: 'ResourceOwnerAccount',
             resourceOwnerId: 'ResourceOwnerId',
+            role: 'Role',
         };
     }
     static types() {
@@ -3637,6 +3642,7 @@ class DescribeParameterTemplatesRequest extends $tea.Model {
             regionId: 'string',
             resourceOwnerAccount: 'string',
             resourceOwnerId: 'number',
+            role: 'string',
         };
     }
 }
@@ -8481,6 +8487,7 @@ class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceShardListShard
         return {
             connectString: 'ConnectString',
             maxConnections: 'MaxConnections',
+            maxDiskMbps: 'MaxDiskMbps',
             maxIOPS: 'MaxIOPS',
             nodeClass: 'NodeClass',
             nodeDescription: 'NodeDescription',
@@ -8495,6 +8502,7 @@ class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceShardListShard
         return {
             connectString: 'string',
             maxConnections: 'number',
+            maxDiskMbps: 'string',
             maxIOPS: 'number',
             nodeClass: 'string',
             nodeDescription: 'string',
@@ -8591,6 +8599,7 @@ class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstance extends $tea.
             maintainStartTime: 'MaintainStartTime',
             maxConnections: 'MaxConnections',
             maxIOPS: 'MaxIOPS',
+            maxMBPS: 'MaxMBPS',
             mongosList: 'MongosList',
             networkType: 'NetworkType',
             protocolType: 'ProtocolType',
@@ -8646,6 +8655,7 @@ class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstance extends $tea.
             maintainStartTime: 'string',
             maxConnections: 'number',
             maxIOPS: 'number',
+            maxMBPS: 'number',
             mongosList: DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceMongosList,
             networkType: 'string',
             protocolType: 'string',
@@ -10527,8 +10537,8 @@ class Client extends openapi_client_1.default {
         return endpoint_util_1.default.getEndpointRules(productId, regionId, endpointRule, network, suffix);
     }
     /**
-      * This operation applies only to sharded cluster instances. For more information, see [Apply for an endpoint for a shard or Configserver node](~~134037~~).
-      * >  The requested endpoint can only be accessed over the internal network. If you want to access the endpoint over the Internet, call the [AllocatePublicNetworkAddress](~~67602~~) operation to apply for a public endpoint.
+      * This operation is applicable only to sharded cluster instances. For more information, see [Apply for an endpoint for a shard or Configserver node](~~134037~~).
+      * >  The allocated endpoints can be used only for internal access. To gain Internet access, you must call the [AllocatePublicNetworkAddress](~~67602~~) operation to apply for public endpoints.
       *
       * @param request AllocateNodePrivateNetworkAddressRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -10581,8 +10591,8 @@ class Client extends openapi_client_1.default {
         return $tea.cast(await this.callApi(params, req, runtime), new AllocateNodePrivateNetworkAddressResponse({}));
     }
     /**
-      * This operation applies only to sharded cluster instances. For more information, see [Apply for an endpoint for a shard or Configserver node](~~134037~~).
-      * >  The requested endpoint can only be accessed over the internal network. If you want to access the endpoint over the Internet, call the [AllocatePublicNetworkAddress](~~67602~~) operation to apply for a public endpoint.
+      * This operation is applicable only to sharded cluster instances. For more information, see [Apply for an endpoint for a shard or Configserver node](~~134037~~).
+      * >  The allocated endpoints can be used only for internal access. To gain Internet access, you must call the [AllocatePublicNetworkAddress](~~67602~~) operation to apply for public endpoints.
       *
       * @param request AllocateNodePrivateNetworkAddressRequest
       * @return AllocateNodePrivateNetworkAddressResponse
@@ -10687,8 +10697,8 @@ class Client extends openapi_client_1.default {
         return await this.checkCloudResourceAuthorizedWithOptions(request, runtime);
     }
     /**
-      * This operation is applicable to replica set instances or sharded cluster instances.
-      * >  After you confirm that the data recovery conditions are met by calling this operation, you can call the [CreateDBInstance](~~61763~~) operation to restore data to a new instance.
+      * This operation is applicable to replica set instances and sharded cluster instances.
+      * >  After you call this operation to confirm that the data of the instance can be restored, you can call the [CreateDBInstance](~~61763~~) operation to restore data to a new instance.
       *
       * @param request CheckRecoveryConditionRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -10744,8 +10754,8 @@ class Client extends openapi_client_1.default {
         return $tea.cast(await this.callApi(params, req, runtime), new CheckRecoveryConditionResponse({}));
     }
     /**
-      * This operation is applicable to replica set instances or sharded cluster instances.
-      * >  After you confirm that the data recovery conditions are met by calling this operation, you can call the [CreateDBInstance](~~61763~~) operation to restore data to a new instance.
+      * This operation is applicable to replica set instances and sharded cluster instances.
+      * >  After you call this operation to confirm that the data of the instance can be restored, you can call the [CreateDBInstance](~~61763~~) operation to restore data to a new instance.
       *
       * @param request CheckRecoveryConditionRequest
       * @return CheckRecoveryConditionResponse
@@ -11637,6 +11647,13 @@ class Client extends openapi_client_1.default {
         let runtime = new $Util.RuntimeOptions({});
         return await this.describeActiveOperationTaskCountWithOptions(request, runtime);
     }
+    /**
+      * This operation is no longer updated and will be unavailable.
+      *
+      * @param request DescribeActiveOperationTaskTypeRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return DescribeActiveOperationTaskTypeResponse
+     */
     async describeActiveOperationTaskTypeWithOptions(request, runtime) {
         tea_util_1.default.validateModel(request);
         let query = {};
@@ -11674,6 +11691,12 @@ class Client extends openapi_client_1.default {
         });
         return $tea.cast(await this.callApi(params, req, runtime), new DescribeActiveOperationTaskTypeResponse({}));
     }
+    /**
+      * This operation is no longer updated and will be unavailable.
+      *
+      * @param request DescribeActiveOperationTaskTypeRequest
+      * @return DescribeActiveOperationTaskTypeResponse
+     */
     async describeActiveOperationTaskType(request) {
         let runtime = new $Util.RuntimeOptions({});
         return await this.describeActiveOperationTaskTypeWithOptions(request, runtime);
@@ -11945,7 +11968,7 @@ class Client extends openapi_client_1.default {
         return await this.describeAuditRecordsWithOptions(request, runtime);
     }
     /**
-      * You can call this operation to query zones in which you can create an ApsaraDB for MongoDB instance.
+      * Queries the zones in which an ApsaraDB for MongoDB instance can be deployed under specified purchase conditions. The region ID is required in the purchase condition.
       *
       * @param request DescribeAvailabilityZonesRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -11987,6 +12010,9 @@ class Client extends openapi_client_1.default {
         if (!tea_util_1.default.isUnset(request.regionId)) {
             query["RegionId"] = request.regionId;
         }
+        if (!tea_util_1.default.isUnset(request.replicationFactor)) {
+            query["ReplicationFactor"] = request.replicationFactor;
+        }
         if (!tea_util_1.default.isUnset(request.resourceGroupId)) {
             query["ResourceGroupId"] = request.resourceGroupId;
         }
@@ -12022,7 +12048,7 @@ class Client extends openapi_client_1.default {
         return $tea.cast(await this.callApi(params, req, runtime), new DescribeAvailabilityZonesResponse({}));
     }
     /**
-      * You can call this operation to query zones in which you can create an ApsaraDB for MongoDB instance.
+      * Queries the zones in which an ApsaraDB for MongoDB instance can be deployed under specified purchase conditions. The region ID is required in the purchase condition.
       *
       * @param request DescribeAvailabilityZonesRequest
       * @return DescribeAvailabilityZonesResponse
@@ -12093,6 +12119,9 @@ class Client extends openapi_client_1.default {
         if (!tea_util_1.default.isUnset(request.regionId)) {
             query["RegionId"] = request.regionId;
         }
+        if (!tea_util_1.default.isUnset(request.replicationFactor)) {
+            query["ReplicationFactor"] = request.replicationFactor;
+        }
         if (!tea_util_1.default.isUnset(request.resourceGroupId)) {
             query["ResourceGroupId"] = request.resourceGroupId;
         }
@@ -13386,9 +13415,9 @@ class Client extends openapi_client_1.default {
     }
     /**
       * This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
-      * This operation depends on the audit log feature of ApsaraDB for MongoDB. You can enable the audit log feature based on your business needs. For more information, see [Enable the audit log feature](~~59903~~)
+      * This operation depends on the audit log feature of ApsaraDB for MongoDB. You can enable the audit log feature based on your business requirements. For more information, see [Enable the audit log feature](~~59903~~).
       * *   Starting from January 6, 2022, the official edition of the audit log feature has been launched in all regions, and new applications for the free trial edition have ended. For more information, see [Notice on official launch of the pay-as-you-go audit log feature and no more application for the free trial edition](~~377480~~)
-      * *   The official edition is charged based on the storage usage and retention period. For more information, see the [Pricing](https://www.alibabacloud.com/product/apsaradb-for-mongodb/pricing) tab of the ApsaraDB for MongoDB product page.
+      * *   You are charged for the official edition of the audit log feature based on the storage capacity that is consumed by audit logs and the retention period of the audit logs. For more information, see [Pricing of ApsaraDB for MongoDB instances](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing).
       *
       * @param request DescribeMongoDBLogConfigRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -13430,9 +13459,9 @@ class Client extends openapi_client_1.default {
     }
     /**
       * This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
-      * This operation depends on the audit log feature of ApsaraDB for MongoDB. You can enable the audit log feature based on your business needs. For more information, see [Enable the audit log feature](~~59903~~)
+      * This operation depends on the audit log feature of ApsaraDB for MongoDB. You can enable the audit log feature based on your business requirements. For more information, see [Enable the audit log feature](~~59903~~).
       * *   Starting from January 6, 2022, the official edition of the audit log feature has been launched in all regions, and new applications for the free trial edition have ended. For more information, see [Notice on official launch of the pay-as-you-go audit log feature and no more application for the free trial edition](~~377480~~)
-      * *   The official edition is charged based on the storage usage and retention period. For more information, see the [Pricing](https://www.alibabacloud.com/product/apsaradb-for-mongodb/pricing) tab of the ApsaraDB for MongoDB product page.
+      * *   You are charged for the official edition of the audit log feature based on the storage capacity that is consumed by audit logs and the retention period of the audit logs. For more information, see [Pricing of ApsaraDB for MongoDB instances](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing).
       *
       * @param request DescribeMongoDBLogConfigRequest
       * @return DescribeMongoDBLogConfigResponse
@@ -13515,6 +13544,9 @@ class Client extends openapi_client_1.default {
         if (!tea_util_1.default.isUnset(request.resourceOwnerId)) {
             query["ResourceOwnerId"] = request.resourceOwnerId;
         }
+        if (!tea_util_1.default.isUnset(request.role)) {
+            query["Role"] = request.role;
+        }
         let req = new $OpenApi.OpenApiRequest({
             query: openapi_util_1.default.query(query),
         });
@@ -14022,7 +14054,7 @@ class Client extends openapi_client_1.default {
         return await this.describeSecurityIpsWithOptions(request, runtime);
     }
     /**
-      * This operation supports sharded cluster instances only.
+      * This operation is applicable only to sharded cluster instances.
       *
       * @param request DescribeShardingNetworkAddressRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -14066,7 +14098,7 @@ class Client extends openapi_client_1.default {
         return $tea.cast(await this.callApi(params, req, runtime), new DescribeShardingNetworkAddressResponse({}));
     }
     /**
-      * This operation supports sharded cluster instances only.
+      * This operation is applicable only to sharded cluster instances.
       *
       * @param request DescribeShardingNetworkAddressRequest
       * @return DescribeShardingNetworkAddressResponse
@@ -15008,10 +15040,10 @@ class Client extends openapi_client_1.default {
         return await this.modifyDBInstanceMonitorWithOptions(request, runtime);
     }
     /**
-      * Before you call this operation, make sure that the following requirements are met:
-      * *   The instance is in the running state.
+      * Before you call this operation, make sure that the instance meets the following requirements:
+      * *   The instance is in the Running state.
       * *   The network of the instance is in hybrid access mode.
-      * >  This operation is applicable only to replica set and sharded cluster instances, but not to standalone instances.
+      * >  This operation is supported by replica set instances and sharded cluster instances. This operation is not supported by standalone instances.
       *
       * @param request ModifyDBInstanceNetExpireTimeRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -15058,10 +15090,10 @@ class Client extends openapi_client_1.default {
         return $tea.cast(await this.callApi(params, req, runtime), new ModifyDBInstanceNetExpireTimeResponse({}));
     }
     /**
-      * Before you call this operation, make sure that the following requirements are met:
-      * *   The instance is in the running state.
+      * Before you call this operation, make sure that the instance meets the following requirements:
+      * *   The instance is in the Running state.
       * *   The network of the instance is in hybrid access mode.
-      * >  This operation is applicable only to replica set and sharded cluster instances, but not to standalone instances.
+      * >  This operation is supported by replica set instances and sharded cluster instances. This operation is not supported by standalone instances.
       *
       * @param request ModifyDBInstanceNetExpireTimeRequest
       * @return ModifyDBInstanceNetExpireTimeResponse
@@ -15288,10 +15320,11 @@ class Client extends openapi_client_1.default {
     }
     /**
       * TDE allows you to perform real-time I/O encryption and decryption on data files. Data is encrypted before it is written to a disk and is decrypted when it is read from the disk to the memory. For more information, see [Configure TDE](~~131048~~).
-      * > You cannot disable TDE after it is enabled.
-      * Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
-      * *   The instance is a replica set or sharded cluster instance.
+      * >  TDE cannot be disabled after it is enabled.
+      * Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
+      * *   A replica set or sharded cluster instance is used.
       * *   The storage engine of the instance is WiredTiger.
+      * *   The instance uses local disks to store data.
       * *   The database engine version of the instance is 4.0 or 4.2. If the database engine version is earlier than 4.0, you can call the [UpgradeDBInstanceEngineVersion](~~67608~~) operation to upgrade the database engine.
       *
       * @param request ModifyDBInstanceTDERequest
@@ -15346,10 +15379,11 @@ class Client extends openapi_client_1.default {
     }
     /**
       * TDE allows you to perform real-time I/O encryption and decryption on data files. Data is encrypted before it is written to a disk and is decrypted when it is read from the disk to the memory. For more information, see [Configure TDE](~~131048~~).
-      * > You cannot disable TDE after it is enabled.
-      * Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
-      * *   The instance is a replica set or sharded cluster instance.
+      * >  TDE cannot be disabled after it is enabled.
+      * Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
+      * *   A replica set or sharded cluster instance is used.
       * *   The storage engine of the instance is WiredTiger.
+      * *   The instance uses local disks to store data.
       * *   The database engine version of the instance is 4.0 or 4.2. If the database engine version is earlier than 4.0, you can call the [UpgradeDBInstanceEngineVersion](~~67608~~) operation to upgrade the database engine.
       *
       * @param request ModifyDBInstanceTDERequest
@@ -15559,10 +15593,11 @@ class Client extends openapi_client_1.default {
         return await this.modifyInstanceAutoRenewalAttributeWithOptions(request, runtime);
     }
     /**
-      * Before you call this operation, make sure that the following requirements are met:
-      * *   A replica set or sharded cluster instance is used.
-      * *   The database version of the instance is 4.0 (with the minor version of mongodb\\_20190408\\_3.0.11 or later) or 4.2. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to view the database engine version of the instance. If necessary, you can call the [UpgradeDBInstanceEngineVersion](~~67608~~) operation to upgrade the database engine.
-      * *   The instance is in a VPC. If the network type is Classic Network, you can call the [ModifyDBInstanceNetworkType](~~62138~~) operation to switch the network type to VPC.
+      * Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
+      * *   The instance is a replica set or sharded cluster instance.
+      * *   The database engine version of the instance is 4.0 (with the minor version of mongodb\\_20190408\\_3.0.11 or later) or 4.2. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to view the database engine version of the instance. If necessary, you can call the [UpgradeDBInstanceEngineVersion](~~67608~~) operation to upgrade the database engine version of the instance.
+      * *   The network type of the instance must be VPC. If the network type of the instance is classic network, you must call the [ModifyDBInstanceNetworkType](~~62138~~) operation to change the network type to VPC.
+      * *   You can only disable but not enable password-free access over VPC.
       *
       * @param request ModifyInstanceVpcAuthModeRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -15609,10 +15644,11 @@ class Client extends openapi_client_1.default {
         return $tea.cast(await this.callApi(params, req, runtime), new ModifyInstanceVpcAuthModeResponse({}));
     }
     /**
-      * Before you call this operation, make sure that the following requirements are met:
-      * *   A replica set or sharded cluster instance is used.
-      * *   The database version of the instance is 4.0 (with the minor version of mongodb\\_20190408\\_3.0.11 or later) or 4.2. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to view the database engine version of the instance. If necessary, you can call the [UpgradeDBInstanceEngineVersion](~~67608~~) operation to upgrade the database engine.
-      * *   The instance is in a VPC. If the network type is Classic Network, you can call the [ModifyDBInstanceNetworkType](~~62138~~) operation to switch the network type to VPC.
+      * Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
+      * *   The instance is a replica set or sharded cluster instance.
+      * *   The database engine version of the instance is 4.0 (with the minor version of mongodb\\_20190408\\_3.0.11 or later) or 4.2. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to view the database engine version of the instance. If necessary, you can call the [UpgradeDBInstanceEngineVersion](~~67608~~) operation to upgrade the database engine version of the instance.
+      * *   The network type of the instance must be VPC. If the network type of the instance is classic network, you must call the [ModifyDBInstanceNetworkType](~~62138~~) operation to change the network type to VPC.
+      * *   You can only disable but not enable password-free access over VPC.
       *
       * @param request ModifyInstanceVpcAuthModeRequest
       * @return ModifyInstanceVpcAuthModeResponse
@@ -16355,8 +16391,9 @@ class Client extends openapi_client_1.default {
         return await this.restartDBInstanceWithOptions(request, runtime);
     }
     /**
-      * This operation is applicable to replica set instances, but cannot be called on standalone instances or sharded cluster instances. You can use the following methods to clone an instance: [Create an instance from a backup](~~55013~~) to clone a standalone instance. Call the [CreateShardingDBInstance](~~61884~~) operation to clone a sharded cluster instance.
-      * >  This operation overwrites the data of the current instance, and the data cannot be recovered. Exercise caution when performing this operation.
+      * This operation is no longer maintained and will be unavailable.
+      * This operation is applicable only to replica set instances. You can clone a standalone instance by [creating an instance from a backup set](~~55013~~). You can clone a sharded cluster instance by calling the [CreateShardingDBInstance](~~61884~~) operation.
+      * >  This operation overwrites the data of the current instance, and the data cannot be recovered. Proceed with caution.
       *
       * @param request RestoreDBInstanceRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -16400,8 +16437,9 @@ class Client extends openapi_client_1.default {
         return $tea.cast(await this.callApi(params, req, runtime), new RestoreDBInstanceResponse({}));
     }
     /**
-      * This operation is applicable to replica set instances, but cannot be called on standalone instances or sharded cluster instances. You can use the following methods to clone an instance: [Create an instance from a backup](~~55013~~) to clone a standalone instance. Call the [CreateShardingDBInstance](~~61884~~) operation to clone a sharded cluster instance.
-      * >  This operation overwrites the data of the current instance, and the data cannot be recovered. Exercise caution when performing this operation.
+      * This operation is no longer maintained and will be unavailable.
+      * This operation is applicable only to replica set instances. You can clone a standalone instance by [creating an instance from a backup set](~~55013~~). You can clone a sharded cluster instance by calling the [CreateShardingDBInstance](~~61884~~) operation.
+      * >  This operation overwrites the data of the current instance, and the data cannot be recovered. Proceed with caution.
       *
       * @param request RestoreDBInstanceRequest
       * @return RestoreDBInstanceResponse