@alicloud/rds20140815 2.7.0 → 2.7.2

package/dist/client.d.ts

@@ -20626,7 +20626,7 @@ export default class Client extends OpenApi {
       * *   MySQL
       * ### [](#)Description
       * *   A full backup file contains the data of a self-managed MySQL instance. You can restore the data of a self-managed MySQL instance from a full backup file to an ApsaraDB RDS for MySQL instance. For more information, see [Migrate the data of a self-managed MySQL 5.7 instance to the cloud](~~251779~~).
-      * *   This operation deletes full backup files only from the ApsaraDB RDS console. This operation does not affect the full backup files that are stored as objects in Object Storage Service (OSS) buckets. After you call this operation to delete a full backup file, you can call the [ImportUserBackupFile](~~260266~~)operation to import the full backup file again.
+      * *   This operation deletes full backup files only from the ApsaraDB RDS console. This operation does not affect the full backup files that are stored as objects in Object Storage Service (OSS) buckets. After you call this operation to delete a full backup file, you can call the [ImportUserBackupFile](~~260266~~) operation to import the full backup file again.
       *
       * @param request DeleteUserBackupFileRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -20638,7 +20638,7 @@ export default class Client extends OpenApi {
       * *   MySQL
       * ### [](#)Description
       * *   A full backup file contains the data of a self-managed MySQL instance. You can restore the data of a self-managed MySQL instance from a full backup file to an ApsaraDB RDS for MySQL instance. For more information, see [Migrate the data of a self-managed MySQL 5.7 instance to the cloud](~~251779~~).
-      * *   This operation deletes full backup files only from the ApsaraDB RDS console. This operation does not affect the full backup files that are stored as objects in Object Storage Service (OSS) buckets. After you call this operation to delete a full backup file, you can call the [ImportUserBackupFile](~~260266~~)operation to import the full backup file again.
+      * *   This operation deletes full backup files only from the ApsaraDB RDS console. This operation does not affect the full backup files that are stored as objects in Object Storage Service (OSS) buckets. After you call this operation to delete a full backup file, you can call the [ImportUserBackupFile](~~260266~~) operation to import the full backup file again.
       *
       * @param request DeleteUserBackupFileRequest
       * @return DeleteUserBackupFileResponse
@@ -20774,7 +20774,28 @@ export default class Client extends OpenApi {
     describeAllWhitelistTemplate(request: DescribeAllWhitelistTemplateRequest): Promise<DescribeAllWhitelistTemplateResponse>;
     describeAnalyticdbByPrimaryDBInstanceWithOptions(request: DescribeAnalyticdbByPrimaryDBInstanceRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAnalyticdbByPrimaryDBInstanceResponse>;
     describeAnalyticdbByPrimaryDBInstance(request: DescribeAnalyticdbByPrimaryDBInstanceRequest): Promise<DescribeAnalyticdbByPrimaryDBInstanceResponse>;
+    /**
+      * ### [](#)Supported database engines
+      * *   MySQL
+      * *   PostgreSQL
+      * *   SQL Server
+      * *   MariaDB
+      *
+      * @param request DescribeAvailableClassesRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return DescribeAvailableClassesResponse
+     */
     describeAvailableClassesWithOptions(request: DescribeAvailableClassesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAvailableClassesResponse>;
+    /**
+      * ### [](#)Supported database engines
+      * *   MySQL
+      * *   PostgreSQL
+      * *   SQL Server
+      * *   MariaDB
+      *
+      * @param request DescribeAvailableClassesRequest
+      * @return DescribeAvailableClassesResponse
+     */
     describeAvailableClasses(request: DescribeAvailableClassesRequest): Promise<DescribeAvailableClassesResponse>;
     /**
       * ### [](#)Supported database engines
@@ -22377,7 +22398,28 @@ export default class Client extends OpenApi {
       * @return DescribeReadDBInstanceDelayResponse
      */
     describeReadDBInstanceDelay(request: DescribeReadDBInstanceDelayRequest): Promise<DescribeReadDBInstanceDelayResponse>;
+    /**
+      * ### [](#)Supported database engines
+      * *   MySQL
+      * *   PostgreSQL
+      * *   SQL Server
+      * *   MariaDB
+      *
+      * @param request DescribeRegionInfosRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return DescribeRegionInfosResponse
+     */
     describeRegionInfosWithOptions(request: DescribeRegionInfosRequest, runtime: $Util.RuntimeOptions): Promise<DescribeRegionInfosResponse>;
+    /**
+      * ### [](#)Supported database engines
+      * *   MySQL
+      * *   PostgreSQL
+      * *   SQL Server
+      * *   MariaDB
+      *
+      * @param request DescribeRegionInfosRequest
+      * @return DescribeRegionInfosResponse
+     */
     describeRegionInfos(request: DescribeRegionInfosRequest): Promise<DescribeRegionInfosResponse>;
     /**
       * Before you call the [CreateDBInstance](~~26228~~) operation to create an RDS instance, you can call the DescribeRegions operation to query the available regions and zones.
@@ -22936,14 +22978,18 @@ export default class Client extends OpenApi {
      */
     grantOperatorPermission(request: GrantOperatorPermissionRequest): Promise<GrantOperatorPermissionResponse>;
     /**
+      * ### [](#)Supported database engine
+      * *   SQL Server
+      * ### [](#)Description
       * We recommend that you use Data Transmission Service (DTS). DTS provides data migration, subscription, and synchronization features that allow you to establish stable, secure transmission links. For more information, see [DTS API overview](~~49456~~).
-      * During the migration, the source instance is in the **Migrating** state, and the destination instance is in the **Importing** state.
-      * Before you call this operation, make sure that the following requirements are met:
-      * *   The source and destination instances must run SQL Server and belong to the dedicated or dedicated host instance family. For more information about the supported instance types, see [Primary instance types](~~26312~~).
-      * *   The source and destination instances must be created by using the same user credentials.
-      * *   The instance is in the Running state.
-      * *   The source and destination databases must be in the Running state.
-      * *   The remaining storage of the destination instance must be greater than the storage capacity of the source instance.
+      * ### [](#)Precautions
+      * *   During the migration, the source instance is in the **Migrating** state, and the destination instance is in the **Importing** state.
+      * *   Before you call this operation, make sure that the following requirements are met:
+      *     *   The source and destination instances must run SQL Server and belong to the dedicated or dedicated host instance family. For more information about the supported instance types, see [Primary instance types](~~26312~~).
+      *     *   The source and destination instances must be created by using the same user credentials.
+      *     *   The instance is in the Running state.
+      *     *   The source and destination databases must be in the Running state.
+      *     *   The remaining storage of the destination instance must be greater than the storage capacity of the source instance.
       * >
       * *   This operation is not supported for instances that run SQL Server 2017 on RDS Cluster Edition.
       * *   You can migrate the data of multiple databases at a time.
@@ -22954,14 +23000,18 @@ export default class Client extends OpenApi {
      */
     importDatabaseBetweenInstancesWithOptions(request: ImportDatabaseBetweenInstancesRequest, runtime: $Util.RuntimeOptions): Promise<ImportDatabaseBetweenInstancesResponse>;
     /**
+      * ### [](#)Supported database engine
+      * *   SQL Server
+      * ### [](#)Description
       * We recommend that you use Data Transmission Service (DTS). DTS provides data migration, subscription, and synchronization features that allow you to establish stable, secure transmission links. For more information, see [DTS API overview](~~49456~~).
-      * During the migration, the source instance is in the **Migrating** state, and the destination instance is in the **Importing** state.
-      * Before you call this operation, make sure that the following requirements are met:
-      * *   The source and destination instances must run SQL Server and belong to the dedicated or dedicated host instance family. For more information about the supported instance types, see [Primary instance types](~~26312~~).
-      * *   The source and destination instances must be created by using the same user credentials.
-      * *   The instance is in the Running state.
-      * *   The source and destination databases must be in the Running state.
-      * *   The remaining storage of the destination instance must be greater than the storage capacity of the source instance.
+      * ### [](#)Precautions
+      * *   During the migration, the source instance is in the **Migrating** state, and the destination instance is in the **Importing** state.
+      * *   Before you call this operation, make sure that the following requirements are met:
+      *     *   The source and destination instances must run SQL Server and belong to the dedicated or dedicated host instance family. For more information about the supported instance types, see [Primary instance types](~~26312~~).
+      *     *   The source and destination instances must be created by using the same user credentials.
+      *     *   The instance is in the Running state.
+      *     *   The source and destination databases must be in the Running state.
+      *     *   The remaining storage of the destination instance must be greater than the storage capacity of the source instance.
       * >
       * *   This operation is not supported for instances that run SQL Server 2017 on RDS Cluster Edition.
       * *   You can migrate the data of multiple databases at a time.
@@ -23761,7 +23811,28 @@ export default class Client extends OpenApi {
       * @return ModifyDBInstanceTDEResponse
      */
     modifyDBInstanceTDE(request: ModifyDBInstanceTDERequest): Promise<ModifyDBInstanceTDEResponse>;
+    /**
+      * ### [](#)Supported database engines
+      * *   MySQL
+      * ### [](#)References
+      * > Fees are generated if the call is successful. Before you call this operation, carefully read the following topics:
+      * *   [Change the specifications of an ApsaraDB RDS for MySQL instance](~~96061~~)
+      *
+      * @param tmpReq ModifyDBNodeRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return ModifyDBNodeResponse
+     */
     modifyDBNodeWithOptions(tmpReq: ModifyDBNodeRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBNodeResponse>;
+    /**
+      * ### [](#)Supported database engines
+      * *   MySQL
+      * ### [](#)References
+      * > Fees are generated if the call is successful. Before you call this operation, carefully read the following topics:
+      * *   [Change the specifications of an ApsaraDB RDS for MySQL instance](~~96061~~)
+      *
+      * @param request ModifyDBNodeRequest
+      * @return ModifyDBNodeResponse
+     */
     modifyDBNode(request: ModifyDBNodeRequest): Promise<ModifyDBNodeResponse>;
     /**
       * ### [](#)Supported database engines
@@ -24410,8 +24481,7 @@ export default class Client extends OpenApi {
      */
     rebuildDBInstance(request: RebuildDBInstanceRequest): Promise<RebuildDBInstanceResponse>;
     /**
-      * ## Prerequisites
-      * A disaster recovery instance is created.
+      * The operation is phased out.
       *
       * @param request ReceiveDBInstanceRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -24419,8 +24489,7 @@ export default class Client extends OpenApi {
      */
     receiveDBInstanceWithOptions(request: ReceiveDBInstanceRequest, runtime: $Util.RuntimeOptions): Promise<ReceiveDBInstanceResponse>;
     /**
-      * ## Prerequisites
-      * A disaster recovery instance is created.
+      * The operation is phased out.
       *
       * @param request ReceiveDBInstanceRequest
       * @return ReceiveDBInstanceResponse
@@ -24945,7 +25014,20 @@ export default class Client extends OpenApi {
       * @return SwitchDBInstanceVpcResponse
      */
     switchDBInstanceVpc(request: SwitchDBInstanceVpcRequest): Promise<SwitchDBInstanceVpcResponse>;
+    /**
+      * This operation is phased out.
+      *
+      * @param request SwitchGuardToMasterInstanceRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return SwitchGuardToMasterInstanceResponse
+     */
     switchGuardToMasterInstanceWithOptions(request: SwitchGuardToMasterInstanceRequest, runtime: $Util.RuntimeOptions): Promise<SwitchGuardToMasterInstanceResponse>;
+    /**
+      * This operation is phased out.
+      *
+      * @param request SwitchGuardToMasterInstanceRequest
+      * @return SwitchGuardToMasterInstanceResponse
+     */
     switchGuardToMasterInstance(request: SwitchGuardToMasterInstanceRequest): Promise<SwitchGuardToMasterInstanceResponse>;
     /**
       * ### [](#)Supported database engines

package/dist/client.js

@@ -32533,7 +32533,7 @@ class Client extends openapi_client_1.default {
       * *   MySQL
       * ### [](#)Description
       * *   A full backup file contains the data of a self-managed MySQL instance. You can restore the data of a self-managed MySQL instance from a full backup file to an ApsaraDB RDS for MySQL instance. For more information, see [Migrate the data of a self-managed MySQL 5.7 instance to the cloud](~~251779~~).
-      * *   This operation deletes full backup files only from the ApsaraDB RDS console. This operation does not affect the full backup files that are stored as objects in Object Storage Service (OSS) buckets. After you call this operation to delete a full backup file, you can call the [ImportUserBackupFile](~~260266~~)operation to import the full backup file again.
+      * *   This operation deletes full backup files only from the ApsaraDB RDS console. This operation does not affect the full backup files that are stored as objects in Object Storage Service (OSS) buckets. After you call this operation to delete a full backup file, you can call the [ImportUserBackupFile](~~260266~~) operation to import the full backup file again.
       *
       * @param request DeleteUserBackupFileRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -32581,7 +32581,7 @@ class Client extends openapi_client_1.default {
       * *   MySQL
       * ### [](#)Description
       * *   A full backup file contains the data of a self-managed MySQL instance. You can restore the data of a self-managed MySQL instance from a full backup file to an ApsaraDB RDS for MySQL instance. For more information, see [Migrate the data of a self-managed MySQL 5.7 instance to the cloud](~~251779~~).
-      * *   This operation deletes full backup files only from the ApsaraDB RDS console. This operation does not affect the full backup files that are stored as objects in Object Storage Service (OSS) buckets. After you call this operation to delete a full backup file, you can call the [ImportUserBackupFile](~~260266~~)operation to import the full backup file again.
+      * *   This operation deletes full backup files only from the ApsaraDB RDS console. This operation does not affect the full backup files that are stored as objects in Object Storage Service (OSS) buckets. After you call this operation to delete a full backup file, you can call the [ImportUserBackupFile](~~260266~~) operation to import the full backup file again.
       *
       * @param request DeleteUserBackupFileRequest
       * @return DeleteUserBackupFileResponse
@@ -33041,6 +33041,17 @@ class Client extends openapi_client_1.default {
         let runtime = new $Util.RuntimeOptions({});
         return await this.describeAnalyticdbByPrimaryDBInstanceWithOptions(request, runtime);
     }
+    /**
+      * ### [](#)Supported database engines
+      * *   MySQL
+      * *   PostgreSQL
+      * *   SQL Server
+      * *   MariaDB
+      *
+      * @param request DescribeAvailableClassesRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return DescribeAvailableClassesResponse
+     */
     async describeAvailableClassesWithOptions(request, runtime) {
         tea_util_1.default.validateModel(request);
         let query = {};
@@ -33093,6 +33104,16 @@ class Client extends openapi_client_1.default {
         });
         return $tea.cast(await this.callApi(params, req, runtime), new DescribeAvailableClassesResponse({}));
     }
+    /**
+      * ### [](#)Supported database engines
+      * *   MySQL
+      * *   PostgreSQL
+      * *   SQL Server
+      * *   MariaDB
+      *
+      * @param request DescribeAvailableClassesRequest
+      * @return DescribeAvailableClassesResponse
+     */
     async describeAvailableClasses(request) {
         let runtime = new $Util.RuntimeOptions({});
         return await this.describeAvailableClassesWithOptions(request, runtime);
@@ -38491,6 +38512,17 @@ class Client extends openapi_client_1.default {
         let runtime = new $Util.RuntimeOptions({});
         return await this.describeReadDBInstanceDelayWithOptions(request, runtime);
     }
+    /**
+      * ### [](#)Supported database engines
+      * *   MySQL
+      * *   PostgreSQL
+      * *   SQL Server
+      * *   MariaDB
+      *
+      * @param request DescribeRegionInfosRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return DescribeRegionInfosResponse
+     */
     async describeRegionInfosWithOptions(request, runtime) {
         tea_util_1.default.validateModel(request);
         let query = {};
@@ -38525,6 +38557,16 @@ class Client extends openapi_client_1.default {
         });
         return $tea.cast(await this.callApi(params, req, runtime), new DescribeRegionInfosResponse({}));
     }
+    /**
+      * ### [](#)Supported database engines
+      * *   MySQL
+      * *   PostgreSQL
+      * *   SQL Server
+      * *   MariaDB
+      *
+      * @param request DescribeRegionInfosRequest
+      * @return DescribeRegionInfosResponse
+     */
     async describeRegionInfos(request) {
         let runtime = new $Util.RuntimeOptions({});
         return await this.describeRegionInfosWithOptions(request, runtime);
@@ -40387,14 +40429,18 @@ class Client extends openapi_client_1.default {
         return await this.grantOperatorPermissionWithOptions(request, runtime);
     }
     /**
+      * ### [](#)Supported database engine
+      * *   SQL Server
+      * ### [](#)Description
       * We recommend that you use Data Transmission Service (DTS). DTS provides data migration, subscription, and synchronization features that allow you to establish stable, secure transmission links. For more information, see [DTS API overview](~~49456~~).
-      * During the migration, the source instance is in the **Migrating** state, and the destination instance is in the **Importing** state.
-      * Before you call this operation, make sure that the following requirements are met:
-      * *   The source and destination instances must run SQL Server and belong to the dedicated or dedicated host instance family. For more information about the supported instance types, see [Primary instance types](~~26312~~).
-      * *   The source and destination instances must be created by using the same user credentials.
-      * *   The instance is in the Running state.
-      * *   The source and destination databases must be in the Running state.
-      * *   The remaining storage of the destination instance must be greater than the storage capacity of the source instance.
+      * ### [](#)Precautions
+      * *   During the migration, the source instance is in the **Migrating** state, and the destination instance is in the **Importing** state.
+      * *   Before you call this operation, make sure that the following requirements are met:
+      *     *   The source and destination instances must run SQL Server and belong to the dedicated or dedicated host instance family. For more information about the supported instance types, see [Primary instance types](~~26312~~).
+      *     *   The source and destination instances must be created by using the same user credentials.
+      *     *   The instance is in the Running state.
+      *     *   The source and destination databases must be in the Running state.
+      *     *   The remaining storage of the destination instance must be greater than the storage capacity of the source instance.
       * >
       * *   This operation is not supported for instances that run SQL Server 2017 on RDS Cluster Edition.
       * *   You can migrate the data of multiple databases at a time.
@@ -40444,14 +40490,18 @@ class Client extends openapi_client_1.default {
         return $tea.cast(await this.callApi(params, req, runtime), new ImportDatabaseBetweenInstancesResponse({}));
     }
     /**
+      * ### [](#)Supported database engine
+      * *   SQL Server
+      * ### [](#)Description
       * We recommend that you use Data Transmission Service (DTS). DTS provides data migration, subscription, and synchronization features that allow you to establish stable, secure transmission links. For more information, see [DTS API overview](~~49456~~).
-      * During the migration, the source instance is in the **Migrating** state, and the destination instance is in the **Importing** state.
-      * Before you call this operation, make sure that the following requirements are met:
-      * *   The source and destination instances must run SQL Server and belong to the dedicated or dedicated host instance family. For more information about the supported instance types, see [Primary instance types](~~26312~~).
-      * *   The source and destination instances must be created by using the same user credentials.
-      * *   The instance is in the Running state.
-      * *   The source and destination databases must be in the Running state.
-      * *   The remaining storage of the destination instance must be greater than the storage capacity of the source instance.
+      * ### [](#)Precautions
+      * *   During the migration, the source instance is in the **Migrating** state, and the destination instance is in the **Importing** state.
+      * *   Before you call this operation, make sure that the following requirements are met:
+      *     *   The source and destination instances must run SQL Server and belong to the dedicated or dedicated host instance family. For more information about the supported instance types, see [Primary instance types](~~26312~~).
+      *     *   The source and destination instances must be created by using the same user credentials.
+      *     *   The instance is in the Running state.
+      *     *   The source and destination databases must be in the Running state.
+      *     *   The remaining storage of the destination instance must be greater than the storage capacity of the source instance.
       * >
       * *   This operation is not supported for instances that run SQL Server 2017 on RDS Cluster Edition.
       * *   You can migrate the data of multiple databases at a time.
@@ -43034,6 +43084,17 @@ class Client extends openapi_client_1.default {
         let runtime = new $Util.RuntimeOptions({});
         return await this.modifyDBInstanceTDEWithOptions(request, runtime);
     }
+    /**
+      * ### [](#)Supported database engines
+      * *   MySQL
+      * ### [](#)References
+      * > Fees are generated if the call is successful. Before you call this operation, carefully read the following topics:
+      * *   [Change the specifications of an ApsaraDB RDS for MySQL instance](~~96061~~)
+      *
+      * @param tmpReq ModifyDBNodeRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return ModifyDBNodeResponse
+     */
     async modifyDBNodeWithOptions(tmpReq, runtime) {
         tea_util_1.default.validateModel(tmpReq);
         let request = new ModifyDBNodeShrinkRequest({});
@@ -43094,6 +43155,16 @@ class Client extends openapi_client_1.default {
         });
         return $tea.cast(await this.callApi(params, req, runtime), new ModifyDBNodeResponse({}));
     }
+    /**
+      * ### [](#)Supported database engines
+      * *   MySQL
+      * ### [](#)References
+      * > Fees are generated if the call is successful. Before you call this operation, carefully read the following topics:
+      * *   [Change the specifications of an ApsaraDB RDS for MySQL instance](~~96061~~)
+      *
+      * @param request ModifyDBNodeRequest
+      * @return ModifyDBNodeResponse
+     */
     async modifyDBNode(request) {
         let runtime = new $Util.RuntimeOptions({});
         return await this.modifyDBNodeWithOptions(request, runtime);
@@ -45132,8 +45203,7 @@ class Client extends openapi_client_1.default {
         return await this.rebuildDBInstanceWithOptions(request, runtime);
     }
     /**
-      * ## Prerequisites
-      * A disaster recovery instance is created.
+      * The operation is phased out.
       *
       * @param request ReceiveDBInstanceRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -45177,8 +45247,7 @@ class Client extends openapi_client_1.default {
         return $tea.cast(await this.callApi(params, req, runtime), new ReceiveDBInstanceResponse({}));
     }
     /**
-      * ## Prerequisites
-      * A disaster recovery instance is created.
+      * The operation is phased out.
       *
       * @param request ReceiveDBInstanceRequest
       * @return ReceiveDBInstanceResponse
@@ -46543,6 +46612,13 @@ class Client extends openapi_client_1.default {
         let runtime = new $Util.RuntimeOptions({});
         return await this.switchDBInstanceVpcWithOptions(request, runtime);
     }
+    /**
+      * This operation is phased out.
+      *
+      * @param request SwitchGuardToMasterInstanceRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return SwitchGuardToMasterInstanceResponse
+     */
     async switchGuardToMasterInstanceWithOptions(request, runtime) {
         tea_util_1.default.validateModel(request);
         let query = {};
@@ -46580,6 +46656,12 @@ class Client extends openapi_client_1.default {
         });
         return $tea.cast(await this.callApi(params, req, runtime), new SwitchGuardToMasterInstanceResponse({}));
     }
+    /**
+      * This operation is phased out.
+      *
+      * @param request SwitchGuardToMasterInstanceRequest
+      * @return SwitchGuardToMasterInstanceResponse
+     */
     async switchGuardToMasterInstance(request) {
         let runtime = new $Util.RuntimeOptions({});
         return await this.switchGuardToMasterInstanceWithOptions(request, runtime);