@alicloud/rds20140815 16.0.1 → 16.1.1

package/dist/client.d.ts

@@ -53,10 +53,10 @@ export default class Client extends OpenApi {
      */
     activateMigrationTargetInstance(request: $_model.ActivateMigrationTargetInstanceRequest): Promise<$_model.ActivateMigrationTargetInstanceResponse>;
     /**
-     * Adds instances to a deployment set.
+     * Adds an instance to a deployment set.
      *
      * @remarks
-     * By default, instances with local disks are not allowed to be added to a deployment set, and the UNSUPPORTED_DBINSTANCE_OPERATEION error is returned. To add such an instance, contact the administrator to add your UID to the whitelist. This restriction does not apply to cloud disk instances. Forcibly adding an instance to a deployment set may cause the instance to restart. Proceed with caution.
+     * By default, instances with local disks cannot be added to a deployment set, and the UNSUPPORTED_DBINSTANCE_OPERATEION error is returned. To add such an instance, contact the development team and ask the administrator to add the UID to the whitelist. This restriction does not apply to cloud disk instances. Forcibly adding an instance to a deployment set may cause the instance to restart. Proceed with caution.
      *
      * @param request - AddRCInstancesToDeploymentSetRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -64,10 +64,10 @@ export default class Client extends OpenApi {
      */
     addRCInstancesToDeploymentSetWithOptions(request: $_model.AddRCInstancesToDeploymentSetRequest, runtime: $dara.RuntimeOptions): Promise<$_model.AddRCInstancesToDeploymentSetResponse>;
     /**
-     * Adds instances to a deployment set.
+     * Adds an instance to a deployment set.
      *
      * @remarks
-     * By default, instances with local disks are not allowed to be added to a deployment set, and the UNSUPPORTED_DBINSTANCE_OPERATEION error is returned. To add such an instance, contact the administrator to add your UID to the whitelist. This restriction does not apply to cloud disk instances. Forcibly adding an instance to a deployment set may cause the instance to restart. Proceed with caution.
+     * By default, instances with local disks cannot be added to a deployment set, and the UNSUPPORTED_DBINSTANCE_OPERATEION error is returned. To add such an instance, contact the development team and ask the administrator to add the UID to the whitelist. This restriction does not apply to cloud disk instances. Forcibly adding an instance to a deployment set may cause the instance to restart. Proceed with caution.
      *
      * @param request - AddRCInstancesToDeploymentSetRequest
      * @returns AddRCInstancesToDeploymentSetResponse
@@ -1277,16 +1277,16 @@ export default class Client extends OpenApi {
      */
     createDBProxyEndpointAddress(request: $_model.CreateDBProxyEndpointAddressRequest): Promise<$_model.CreateDBProxyEndpointAddressResponse>;
     /**
-     * Creates a database in an ApsaraDB RDS instance.
+     * Creates a database on an ApsaraDB RDS instance.
      *
      * @remarks
-     * ### Supported engines
+     * ### Supported database engines
      * - ApsaraDB RDS for MySQL
      * - ApsaraDB RDS for PostgreSQL
      * - ApsaraDB RDS for SQL Server
      * - ApsaraDB RDS for MariaDB
      * ### Related documentation
-     * >Notice: Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.
+     * >Notice: Before you call this operation, read the documentation carefully to fully understand the prerequisites and impacts.
      * - [Create a database on an ApsaraDB RDS for MySQL instance](https://help.aliyun.com/document_detail/96105.html)
      * - [Create a database on an ApsaraDB RDS for PostgreSQL instance](https://help.aliyun.com/document_detail/96758.html)
      * - [Create a database on an ApsaraDB RDS for SQL Server instance](https://help.aliyun.com/document_detail/95698.html)
@@ -1298,16 +1298,16 @@ export default class Client extends OpenApi {
      */
     createDatabaseWithOptions(request: $_model.CreateDatabaseRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateDatabaseResponse>;
     /**
-     * Creates a database in an ApsaraDB RDS instance.
+     * Creates a database on an ApsaraDB RDS instance.
      *
      * @remarks
-     * ### Supported engines
+     * ### Supported database engines
      * - ApsaraDB RDS for MySQL
      * - ApsaraDB RDS for PostgreSQL
      * - ApsaraDB RDS for SQL Server
      * - ApsaraDB RDS for MariaDB
      * ### Related documentation
-     * >Notice: Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.
+     * >Notice: Before you call this operation, read the documentation carefully to fully understand the prerequisites and impacts.
      * - [Create a database on an ApsaraDB RDS for MySQL instance](https://help.aliyun.com/document_detail/96105.html)
      * - [Create a database on an ApsaraDB RDS for PostgreSQL instance](https://help.aliyun.com/document_detail/96758.html)
      * - [Create a database on an ApsaraDB RDS for SQL Server instance](https://help.aliyun.com/document_detail/95698.html)
@@ -1659,9 +1659,9 @@ export default class Client extends OpenApi {
      *
      * @remarks
      * - Supported cloud disk types: ultra disk, standard SSD, ESSD, and premium performance disk (default).
-     * - When the billing method of the cloud disk is subscription (**Prepaid**), you must specify the instance ID of a subscription instance (**InstanceId**) to which the cloud disk is mounted. The expiration time of the cloud disk is the same as that of the mounted instance.
-     * - You can create a pay-as-you-go (**Postpaid**) cloud disk separately without mounting it to an instance. You can also mount it to an instance of any billing method when you create it as needed.
-     * - The types and number of cloud disks that can be mounted vary based on the instance type.
+     * - When the billing method of the cloud disk is subscription (**Prepaid**), you must specify the instance ID (**InstanceId**) of a subscription instance to which this cloud disk is mounted. The expiration time of the cloud disk is the same as that of the mounted instance.
+     * - You can create a pay-as-you-go (**Postpaid**) cloud disk separately without mounting it to an instance. You can also mount it to an instance of any billing method during creation as needed.
+     * - The supported cloud disk types and the maximum number of cloud disks that can be mounted vary based on the instance type.
      *
      * @param request - CreateRCDiskRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1673,9 +1673,9 @@ export default class Client extends OpenApi {
      *
      * @remarks
      * - Supported cloud disk types: ultra disk, standard SSD, ESSD, and premium performance disk (default).
-     * - When the billing method of the cloud disk is subscription (**Prepaid**), you must specify the instance ID of a subscription instance (**InstanceId**) to which the cloud disk is mounted. The expiration time of the cloud disk is the same as that of the mounted instance.
-     * - You can create a pay-as-you-go (**Postpaid**) cloud disk separately without mounting it to an instance. You can also mount it to an instance of any billing method when you create it as needed.
-     * - The types and number of cloud disks that can be mounted vary based on the instance type.
+     * - When the billing method of the cloud disk is subscription (**Prepaid**), you must specify the instance ID (**InstanceId**) of a subscription instance to which this cloud disk is mounted. The expiration time of the cloud disk is the same as that of the mounted instance.
+     * - You can create a pay-as-you-go (**Postpaid**) cloud disk separately without mounting it to an instance. You can also mount it to an instance of any billing method during creation as needed.
+     * - The supported cloud disk types and the maximum number of cloud disks that can be mounted vary based on the instance type.
      *
      * @param request - CreateRCDiskRequest
      * @returns CreateRCDiskResponse
@@ -5305,6 +5305,43 @@ export default class Client extends OpenApi {
      * @returns DescribeModifyParameterLogResponse
      */
     describeModifyParameterLog(request: $_model.DescribeModifyParameterLogRequest): Promise<$_model.DescribeModifyParameterLogResponse>;
+    /**
+     * Queries the authorization information of a service account.
+     *
+     * @remarks
+     * ### Supported engines
+     * - ApsaraDB RDS for MySQL
+     * - ApsaraDB RDS for PostgreSQL
+     * - ApsaraDB RDS for SQL Server
+     * ### Related documentation
+     * >Notice: Before you call this operation, read the related documentation carefully to fully understand the prerequisites and impacts of this operation.
+     * - [Grant permissions to a service account for ApsaraDB RDS for MySQL](https://help.aliyun.com/document_detail/96102.html)
+     * - [Grant permissions to a service account for ApsaraDB RDS for PostgreSQL](https://help.aliyun.com/document_detail/146887.html)
+     * - [Grant permissions to a service account for ApsaraDB RDS for SQL Server](https://help.aliyun.com/document_detail/95693.html)
+     *
+     * @param request - DescribeOperatorPermissionRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribeOperatorPermissionResponse
+     */
+    describeOperatorPermissionWithOptions(request: $_model.DescribeOperatorPermissionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeOperatorPermissionResponse>;
+    /**
+     * Queries the authorization information of a service account.
+     *
+     * @remarks
+     * ### Supported engines
+     * - ApsaraDB RDS for MySQL
+     * - ApsaraDB RDS for PostgreSQL
+     * - ApsaraDB RDS for SQL Server
+     * ### Related documentation
+     * >Notice: Before you call this operation, read the related documentation carefully to fully understand the prerequisites and impacts of this operation.
+     * - [Grant permissions to a service account for ApsaraDB RDS for MySQL](https://help.aliyun.com/document_detail/96102.html)
+     * - [Grant permissions to a service account for ApsaraDB RDS for PostgreSQL](https://help.aliyun.com/document_detail/146887.html)
+     * - [Grant permissions to a service account for ApsaraDB RDS for SQL Server](https://help.aliyun.com/document_detail/95693.html)
+     *
+     * @param request - DescribeOperatorPermissionRequest
+     * @returns DescribeOperatorPermissionResponse
+     */
+    describeOperatorPermission(request: $_model.DescribeOperatorPermissionRequest): Promise<$_model.DescribeOperatorPermissionResponse>;
     /**
      * Queries the file details of a backup data migration task for an ApsaraDB RDS for SQL Server instance.
      *
@@ -5721,7 +5758,7 @@ export default class Client extends OpenApi {
      */
     describeRCImageList(request: $_model.DescribeRCImageListRequest): Promise<$_model.DescribeRCImageListResponse>;
     /**
-     * Queries the details of a single RDS Custom instance by calling the DescribeRCInstanceAttribute operation.
+     * Queries the details of a single RDS Custom instance.
      *
      * @param request - DescribeRCInstanceAttributeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -5729,7 +5766,7 @@ export default class Client extends OpenApi {
      */
     describeRCInstanceAttributeWithOptions(request: $_model.DescribeRCInstanceAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeRCInstanceAttributeResponse>;
     /**
-     * Queries the details of a single RDS Custom instance by calling the DescribeRCInstanceAttribute operation.
+     * Queries the details of a single RDS Custom instance.
      *
      * @param request - DescribeRCInstanceAttributeRequest
      * @returns DescribeRCInstanceAttributeResponse
@@ -7603,8 +7640,8 @@ export default class Client extends OpenApi {
      * - ApsaraDB RDS for PostgreSQL
      * - ApsaraDB RDS for SQL Server
      * - ApsaraDB RDS for MariaDB
-     * ### Related documentation
-     * >Notice: Before you call this operation, read the documentation to understand the prerequisites and impacts.</notice>
+     * ### Related feature documentation
+     * >Notice: Before you call this operation, read the feature documentation to fully understand the prerequisites and impacts.
      * - [Configure an automatic backup policy for an ApsaraDB RDS for MySQL instance](https://help.aliyun.com/document_detail/98818.html)
      * - [Configure an automatic backup policy for an ApsaraDB RDS for PostgreSQL instance](https://help.aliyun.com/document_detail/96772.html)
      * - [Configure an automatic backup policy for an ApsaraDB RDS for SQL Server instance](https://help.aliyun.com/document_detail/95717.html)
@@ -7624,8 +7661,8 @@ export default class Client extends OpenApi {
      * - ApsaraDB RDS for PostgreSQL
      * - ApsaraDB RDS for SQL Server
      * - ApsaraDB RDS for MariaDB
-     * ### Related documentation
-     * >Notice: Before you call this operation, read the documentation to understand the prerequisites and impacts.</notice>
+     * ### Related feature documentation
+     * >Notice: Before you call this operation, read the feature documentation to fully understand the prerequisites and impacts.
      * - [Configure an automatic backup policy for an ApsaraDB RDS for MySQL instance](https://help.aliyun.com/document_detail/98818.html)
      * - [Configure an automatic backup policy for an ApsaraDB RDS for PostgreSQL instance](https://help.aliyun.com/document_detail/96772.html)
      * - [Configure an automatic backup policy for an ApsaraDB RDS for SQL Server instance](https://help.aliyun.com/document_detail/95717.html)
@@ -7780,16 +7817,18 @@ export default class Client extends OpenApi {
      */
     modifyDBInstance(request: $_model.ModifyDBInstanceRequest): Promise<$_model.ModifyDBInstanceResponse>;
     /**
-     * Modifies the minor version update policy for an ApsaraDB RDS for MySQL or ApsaraDB RDS for PostgreSQL instance.
+     * Modifies the minor version upgrade method for ApsaraDB RDS for MySQL, ApsaraDB RDS for PostgreSQL, and ApsaraDB RDS for SQL Server instances.
      *
      * @remarks
-     * ### Applicable engines
-     * - RDS MySQL
-     * - RDS PostgreSQL
-     * ### Related documentation
-     * >Notice: Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.
-     * - [Modify the automatic upgrade settings for an ApsaraDB RDS for MySQL instance](https://help.aliyun.com/document_detail/96059.html)
-     * - [Modify the automatic upgrade settings for an ApsaraDB RDS for PostgreSQL instance](https://help.aliyun.com/document_detail/146895.html)
+     * ### Supported engines
+     * - ApsaraDB RDS for MySQL
+     * - ApsaraDB RDS for PostgreSQL
+     * - ApsaraDB RDS for SQL Server
+     * ### Related feature documentation
+     * >Notice: Before you call this operation, carefully read the feature documentation to ensure that you fully understand the prerequisites and the impacts of this operation.</notice>
+     * - [Modify the automatic upgrade settings for ApsaraDB RDS for MySQL](https://help.aliyun.com/document_detail/96059.html)
+     * - [Modify the automatic upgrade settings for ApsaraDB RDS for PostgreSQL](https://help.aliyun.com/document_detail/146895.html)
+     * - [Modify the automatic upgrade settings for ApsaraDB RDS for SQL Server](https://help.aliyun.com/document_detail/213582.html)
      *
      * @param request - ModifyDBInstanceAutoUpgradeMinorVersionRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -7797,16 +7836,18 @@ export default class Client extends OpenApi {
      */
     modifyDBInstanceAutoUpgradeMinorVersionWithOptions(request: $_model.ModifyDBInstanceAutoUpgradeMinorVersionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyDBInstanceAutoUpgradeMinorVersionResponse>;
     /**
-     * Modifies the minor version update policy for an ApsaraDB RDS for MySQL or ApsaraDB RDS for PostgreSQL instance.
+     * Modifies the minor version upgrade method for ApsaraDB RDS for MySQL, ApsaraDB RDS for PostgreSQL, and ApsaraDB RDS for SQL Server instances.
      *
      * @remarks
-     * ### Applicable engines
-     * - RDS MySQL
-     * - RDS PostgreSQL
-     * ### Related documentation
-     * >Notice: Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.
-     * - [Modify the automatic upgrade settings for an ApsaraDB RDS for MySQL instance](https://help.aliyun.com/document_detail/96059.html)
-     * - [Modify the automatic upgrade settings for an ApsaraDB RDS for PostgreSQL instance](https://help.aliyun.com/document_detail/146895.html)
+     * ### Supported engines
+     * - ApsaraDB RDS for MySQL
+     * - ApsaraDB RDS for PostgreSQL
+     * - ApsaraDB RDS for SQL Server
+     * ### Related feature documentation
+     * >Notice: Before you call this operation, carefully read the feature documentation to ensure that you fully understand the prerequisites and the impacts of this operation.</notice>
+     * - [Modify the automatic upgrade settings for ApsaraDB RDS for MySQL](https://help.aliyun.com/document_detail/96059.html)
+     * - [Modify the automatic upgrade settings for ApsaraDB RDS for PostgreSQL](https://help.aliyun.com/document_detail/146895.html)
+     * - [Modify the automatic upgrade settings for ApsaraDB RDS for SQL Server](https://help.aliyun.com/document_detail/213582.html)
      *
      * @param request - ModifyDBInstanceAutoUpgradeMinorVersionRequest
      * @returns ModifyDBInstanceAutoUpgradeMinorVersionResponse
@@ -8318,15 +8359,15 @@ export default class Client extends OpenApi {
      */
     modifyDBInstancePayType(request: $_model.ModifyDBInstancePayTypeRequest): Promise<$_model.ModifyDBInstancePayTypeResponse>;
     /**
-     * Enables or disables native replication mode for an ApsaraDB RDS instance by calling the ModifyDBInstanceReplicationSwitch operation.
+     * Enables or disables the native replication mode for an ApsaraDB RDS instance.
      *
      * @remarks
-     * ApsaraDB RDS for MySQL instances with native replication enabled must meet the following requirements:
-     * - Database engine version: MySQL 5.7
-     * - Instance edition: Basic Edition
+     * To enable the native replication feature for an ApsaraDB RDS for MySQL instance, the following requirements must be met:
+     * - DPI engine version: MySQL 5.7
+     * - Edition: Basic Edition
      * - Billing method: pay-as-you-go or subscription
-     * - Minor engine version: 20240930 or later
-     * For more information about native replication, see [RDS native replication](https://help.aliyun.com/document_detail/2856530.html).
+     * - Milvus version: 20240930 or later
+     * For more information about native replication, see [Native replication for ApsaraDB RDS](https://help.aliyun.com/document_detail/2856530.html).
      *
      * @param request - ModifyDBInstanceReplicationSwitchRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -8334,15 +8375,15 @@ export default class Client extends OpenApi {
      */
     modifyDBInstanceReplicationSwitchWithOptions(request: $_model.ModifyDBInstanceReplicationSwitchRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyDBInstanceReplicationSwitchResponse>;
     /**
-     * Enables or disables native replication mode for an ApsaraDB RDS instance by calling the ModifyDBInstanceReplicationSwitch operation.
+     * Enables or disables the native replication mode for an ApsaraDB RDS instance.
      *
      * @remarks
-     * ApsaraDB RDS for MySQL instances with native replication enabled must meet the following requirements:
-     * - Database engine version: MySQL 5.7
-     * - Instance edition: Basic Edition
+     * To enable the native replication feature for an ApsaraDB RDS for MySQL instance, the following requirements must be met:
+     * - DPI engine version: MySQL 5.7
+     * - Edition: Basic Edition
      * - Billing method: pay-as-you-go or subscription
-     * - Minor engine version: 20240930 or later
-     * For more information about native replication, see [RDS native replication](https://help.aliyun.com/document_detail/2856530.html).
+     * - Milvus version: 20240930 or later
+     * For more information about native replication, see [Native replication for ApsaraDB RDS](https://help.aliyun.com/document_detail/2856530.html).
      *
      * @param request - ModifyDBInstanceReplicationSwitchRequest
      * @returns ModifyDBInstanceReplicationSwitchResponse
@@ -10105,10 +10146,10 @@ export default class Client extends OpenApi {
      */
     releaseReadWriteSplittingConnection(request: $_model.ReleaseReadWriteSplittingConnectionRequest): Promise<$_model.ReleaseReadWriteSplittingConnectionResponse>;
     /**
-     * Removes an RDS custom instance from a deployment set.
+     * Removes ApsaraDB RDS Custom instances from a deployment set.
      *
      * @remarks
-     * Removing an RDS custom instance from a deployment set is a non-disruptive operation and does not cause the instance to restart.
+     * Removing an instance from a deployment set is a lossless operation and does not cause the instance to restart.
      *
      * @param request - RemoveRCInstancesFromDeploymentSetRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -10116,10 +10157,10 @@ export default class Client extends OpenApi {
      */
     removeRCInstancesFromDeploymentSetWithOptions(request: $_model.RemoveRCInstancesFromDeploymentSetRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RemoveRCInstancesFromDeploymentSetResponse>;
     /**
-     * Removes an RDS custom instance from a deployment set.
+     * Removes ApsaraDB RDS Custom instances from a deployment set.
      *
      * @remarks
-     * Removing an RDS custom instance from a deployment set is a non-disruptive operation and does not cause the instance to restart.
+     * Removing an instance from a deployment set is a lossless operation and does not cause the instance to restart.
      *
      * @param request - RemoveRCInstancesFromDeploymentSetRequest
      * @returns RemoveRCInstancesFromDeploymentSetResponse
@@ -10552,12 +10593,12 @@ export default class Client extends OpenApi {
      */
     runRCCommand(request: $_model.RunRCCommandRequest): Promise<$_model.RunRCCommandResponse>;
     /**
-     * Creates one or more RDS Custom instances by calling the RunRCInstances operation. You can specify parameters such as ImageId, InstanceType, VSwitchId, and SecurityGroupId.
+     * Creates one or more RDS Custom instances by specifying parameters such as ImageId, InstanceType, VSwitchId, and SecurityGroupId.
      *
      * @remarks
-     * - Before creating an RDS Custom instance, submit a ticket to request that your Alibaba Cloud account be added to the whitelist.
-     * - Only subscription RDS Custom instances can be created.
-     * - Supported regions are Beijing, Shanghai, Shenzhen, and Hangzhou.
+     * - Before you create an RDS Custom instance, submit a ticket to apply for adding your Alibaba Cloud account to the whitelist.
+     * - Only subscription RDS Custom instances are supported.
+     * - Supported regions include Beijing, Shanghai, Shenzhen, and Hangzhou.
      *
      * @param tmpReq - RunRCInstancesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -10565,12 +10606,12 @@ export default class Client extends OpenApi {
      */
     runRCInstancesWithOptions(tmpReq: $_model.RunRCInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RunRCInstancesResponse>;
     /**
-     * Creates one or more RDS Custom instances by calling the RunRCInstances operation. You can specify parameters such as ImageId, InstanceType, VSwitchId, and SecurityGroupId.
+     * Creates one or more RDS Custom instances by specifying parameters such as ImageId, InstanceType, VSwitchId, and SecurityGroupId.
      *
      * @remarks
-     * - Before creating an RDS Custom instance, submit a ticket to request that your Alibaba Cloud account be added to the whitelist.
-     * - Only subscription RDS Custom instances can be created.
-     * - Supported regions are Beijing, Shanghai, Shenzhen, and Hangzhou.
+     * - Before you create an RDS Custom instance, submit a ticket to apply for adding your Alibaba Cloud account to the whitelist.
+     * - Only subscription RDS Custom instances are supported.
+     * - Supported regions include Beijing, Shanghai, Shenzhen, and Hangzhou.
      *
      * @param request - RunRCInstancesRequest
      * @returns RunRCInstancesResponse