@alicloud/rds20140815 2.5.0 → 2.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/client.d.ts CHANGED
@@ -59,6 +59,7 @@ export declare class AddTagsToResourceRequest extends $tea.Model {
59
59
  ownerAccount?: string;
60
60
  ownerId?: number;
61
61
  regionId?: string;
62
+ resourceGroupId?: string;
62
63
  resourceOwnerAccount?: string;
63
64
  resourceOwnerId?: number;
64
65
  tags?: string;
@@ -298,6 +299,7 @@ export declare class CancelImportRequest extends $tea.Model {
298
299
  importId?: number;
299
300
  ownerAccount?: string;
300
301
  ownerId?: number;
302
+ resourceGroupId?: string;
301
303
  resourceOwnerAccount?: string;
302
304
  resourceOwnerId?: number;
303
305
  static names(): {
@@ -2039,6 +2041,90 @@ export declare class CreateOrderForCreateDBNodesResponse extends $tea.Model {
2039
2041
  [key: string]: any;
2040
2042
  });
2041
2043
  }
2044
+ export declare class CreateOrderForDeleteDBNodesRequest extends $tea.Model {
2045
+ autoPay?: boolean;
2046
+ businessInfo?: string;
2047
+ clientToken?: string;
2048
+ commodityCode?: string;
2049
+ DBInstanceId?: string;
2050
+ DBNodeId?: string[];
2051
+ engineVersion?: string;
2052
+ nodeType?: string;
2053
+ ownerId?: number;
2054
+ promotionCode?: string;
2055
+ regionId?: string;
2056
+ resource?: string;
2057
+ resourceGroupId?: string;
2058
+ resourceOwnerAccount?: string;
2059
+ resourceOwnerId?: number;
2060
+ zoneId?: string;
2061
+ static names(): {
2062
+ [key: string]: string;
2063
+ };
2064
+ static types(): {
2065
+ [key: string]: any;
2066
+ };
2067
+ constructor(map?: {
2068
+ [key: string]: any;
2069
+ });
2070
+ }
2071
+ export declare class CreateOrderForDeleteDBNodesShrinkRequest extends $tea.Model {
2072
+ autoPay?: boolean;
2073
+ businessInfo?: string;
2074
+ clientToken?: string;
2075
+ commodityCode?: string;
2076
+ DBInstanceId?: string;
2077
+ DBNodeIdShrink?: string;
2078
+ engineVersion?: string;
2079
+ nodeType?: string;
2080
+ ownerId?: number;
2081
+ promotionCode?: string;
2082
+ regionId?: string;
2083
+ resource?: string;
2084
+ resourceGroupId?: string;
2085
+ resourceOwnerAccount?: string;
2086
+ resourceOwnerId?: number;
2087
+ zoneId?: string;
2088
+ static names(): {
2089
+ [key: string]: string;
2090
+ };
2091
+ static types(): {
2092
+ [key: string]: any;
2093
+ };
2094
+ constructor(map?: {
2095
+ [key: string]: any;
2096
+ });
2097
+ }
2098
+ export declare class CreateOrderForDeleteDBNodesResponseBody extends $tea.Model {
2099
+ DBInstanceId?: string;
2100
+ orderId?: number;
2101
+ requestId?: string;
2102
+ static names(): {
2103
+ [key: string]: string;
2104
+ };
2105
+ static types(): {
2106
+ [key: string]: any;
2107
+ };
2108
+ constructor(map?: {
2109
+ [key: string]: any;
2110
+ });
2111
+ }
2112
+ export declare class CreateOrderForDeleteDBNodesResponse extends $tea.Model {
2113
+ headers: {
2114
+ [key: string]: string;
2115
+ };
2116
+ statusCode: number;
2117
+ body: CreateOrderForDeleteDBNodesResponseBody;
2118
+ static names(): {
2119
+ [key: string]: string;
2120
+ };
2121
+ static types(): {
2122
+ [key: string]: any;
2123
+ };
2124
+ constructor(map?: {
2125
+ [key: string]: any;
2126
+ });
2127
+ }
2042
2128
  export declare class CreateParameterGroupRequest extends $tea.Model {
2043
2129
  engine?: string;
2044
2130
  engineVersion?: string;
@@ -10892,6 +10978,83 @@ export declare class ModifyDBInstanceTDEResponse extends $tea.Model {
10892
10978
  [key: string]: any;
10893
10979
  });
10894
10980
  }
10981
+ export declare class ModifyDBNodeRequest extends $tea.Model {
10982
+ autoPay?: boolean;
10983
+ clientToken?: string;
10984
+ DBInstanceId?: string;
10985
+ DBInstanceStorage?: string;
10986
+ DBInstanceStorageType?: string;
10987
+ DBNode?: ModifyDBNodeRequestDBNode[];
10988
+ dryRun?: boolean;
10989
+ ownerAccount?: string;
10990
+ ownerId?: number;
10991
+ produceAsync?: boolean;
10992
+ resourceOwnerAccount?: string;
10993
+ resourceOwnerId?: number;
10994
+ static names(): {
10995
+ [key: string]: string;
10996
+ };
10997
+ static types(): {
10998
+ [key: string]: any;
10999
+ };
11000
+ constructor(map?: {
11001
+ [key: string]: any;
11002
+ });
11003
+ }
11004
+ export declare class ModifyDBNodeShrinkRequest extends $tea.Model {
11005
+ autoPay?: boolean;
11006
+ clientToken?: string;
11007
+ DBInstanceId?: string;
11008
+ DBInstanceStorage?: string;
11009
+ DBInstanceStorageType?: string;
11010
+ DBNodeShrink?: string;
11011
+ dryRun?: boolean;
11012
+ ownerAccount?: string;
11013
+ ownerId?: number;
11014
+ produceAsync?: boolean;
11015
+ resourceOwnerAccount?: string;
11016
+ resourceOwnerId?: number;
11017
+ static names(): {
11018
+ [key: string]: string;
11019
+ };
11020
+ static types(): {
11021
+ [key: string]: any;
11022
+ };
11023
+ constructor(map?: {
11024
+ [key: string]: any;
11025
+ });
11026
+ }
11027
+ export declare class ModifyDBNodeResponseBody extends $tea.Model {
11028
+ DBInstanceId?: string;
11029
+ orderId?: number;
11030
+ requestId?: string;
11031
+ success?: boolean;
11032
+ static names(): {
11033
+ [key: string]: string;
11034
+ };
11035
+ static types(): {
11036
+ [key: string]: any;
11037
+ };
11038
+ constructor(map?: {
11039
+ [key: string]: any;
11040
+ });
11041
+ }
11042
+ export declare class ModifyDBNodeResponse extends $tea.Model {
11043
+ headers: {
11044
+ [key: string]: string;
11045
+ };
11046
+ statusCode: number;
11047
+ body: ModifyDBNodeResponseBody;
11048
+ static names(): {
11049
+ [key: string]: string;
11050
+ };
11051
+ static types(): {
11052
+ [key: string]: any;
11053
+ };
11054
+ constructor(map?: {
11055
+ [key: string]: any;
11056
+ });
11057
+ }
10895
11058
  export declare class ModifyDBProxyRequest extends $tea.Model {
10896
11059
  configDBProxyService?: string;
10897
11060
  DBInstanceId?: string;
@@ -14669,10 +14832,14 @@ export declare class DescribeDBInstanceAttributeResponseBodyItemsDBInstanceAttri
14669
14832
  }
14670
14833
  export declare class DescribeDBInstanceAttributeResponseBodyItemsDBInstanceAttributeDBClusterNodesDBClusterNode extends $tea.Model {
14671
14834
  classCode?: string;
14835
+ classType?: string;
14836
+ cpu?: string;
14837
+ memory?: string;
14672
14838
  nodeId?: string;
14673
14839
  nodeRegionId?: string;
14674
14840
  nodeRole?: string;
14675
14841
  nodeZoneId?: string;
14842
+ status?: string;
14676
14843
  static names(): {
14677
14844
  [key: string]: string;
14678
14845
  };
@@ -18028,6 +18195,19 @@ export declare class ModifyDBInstanceSpecRequestServerlessConfiguration extends
18028
18195
  [key: string]: any;
18029
18196
  });
18030
18197
  }
18198
+ export declare class ModifyDBNodeRequestDBNode extends $tea.Model {
18199
+ classCode?: string;
18200
+ nodeId?: string;
18201
+ static names(): {
18202
+ [key: string]: string;
18203
+ };
18204
+ static types(): {
18205
+ [key: string]: any;
18206
+ };
18207
+ constructor(map?: {
18208
+ [key: string]: any;
18209
+ });
18210
+ }
18031
18211
  export declare class ModifyPGHbaConfigRequestHbaItem extends $tea.Model {
18032
18212
  address?: string;
18033
18213
  database?: string;
@@ -18286,11 +18466,16 @@ export default class Client extends OpenApi {
18286
18466
  */
18287
18467
  attachWhitelistTemplateToInstance(request: AttachWhitelistTemplateToInstanceRequest): Promise<AttachWhitelistTemplateToInstanceResponse>;
18288
18468
  /**
18289
- * When the [read/write splitting](~~51073~~) feature is enabled, this operation is used to calculate system-assigned read weights. For more information about custom read weights, see [DescribeDBInstanceNetInfo](~~26237~~).
18469
+ * ### [](#)Supported database engines
18470
+ * * MySQL
18471
+ * * SQL Server
18472
+ * ### [](#)Feature description
18473
+ * When the [read/write splitting](~~51073~~) feature is enabled, this operation is used to calculate system-assigned read weights. For more information about custom read weights, see [DescribeDBInstanceNetInfo](~~610423~~).
18474
+ * ### [](#)Prerequisites
18290
18475
  * Before you call this operation, make sure that the following requirements are met:
18291
- * * The shared proxy feature is enabled for your ApsaraDB RDS for MySQL instance.
18292
- * * The instance must run one of the following database engine versions and RDS editions:
18293
- * * MySQL 5.7 on RDS High-availability Edition (with local SSDs)
18476
+ * * If the instance runs MySQL, the instance uses a shared proxy.
18477
+ * * The instance runs one of the following MySQL versions and RDS editions:
18478
+ * * MySQL 5.7 on RDS High-availability Edition (with local disks)
18294
18479
  * * MySQL 5.6
18295
18480
  * * SQL Server on RDS Cluster Edition
18296
18481
  *
@@ -18300,11 +18485,16 @@ export default class Client extends OpenApi {
18300
18485
  */
18301
18486
  calculateDBInstanceWeightWithOptions(request: CalculateDBInstanceWeightRequest, runtime: $Util.RuntimeOptions): Promise<CalculateDBInstanceWeightResponse>;
18302
18487
  /**
18303
- * When the [read/write splitting](~~51073~~) feature is enabled, this operation is used to calculate system-assigned read weights. For more information about custom read weights, see [DescribeDBInstanceNetInfo](~~26237~~).
18488
+ * ### [](#)Supported database engines
18489
+ * * MySQL
18490
+ * * SQL Server
18491
+ * ### [](#)Feature description
18492
+ * When the [read/write splitting](~~51073~~) feature is enabled, this operation is used to calculate system-assigned read weights. For more information about custom read weights, see [DescribeDBInstanceNetInfo](~~610423~~).
18493
+ * ### [](#)Prerequisites
18304
18494
  * Before you call this operation, make sure that the following requirements are met:
18305
- * * The shared proxy feature is enabled for your ApsaraDB RDS for MySQL instance.
18306
- * * The instance must run one of the following database engine versions and RDS editions:
18307
- * * MySQL 5.7 on RDS High-availability Edition (with local SSDs)
18495
+ * * If the instance runs MySQL, the instance uses a shared proxy.
18496
+ * * The instance runs one of the following MySQL versions and RDS editions:
18497
+ * * MySQL 5.7 on RDS High-availability Edition (with local disks)
18308
18498
  * * MySQL 5.6
18309
18499
  * * SQL Server on RDS Cluster Edition
18310
18500
  *
@@ -18356,7 +18546,28 @@ export default class Client extends OpenApi {
18356
18546
  * @return CheckCreateDdrDBInstanceResponse
18357
18547
  */
18358
18548
  checkCreateDdrDBInstance(request: CheckCreateDdrDBInstanceRequest): Promise<CheckCreateDdrDBInstanceResponse>;
18549
+ /**
18550
+ * ### [](#)Supported database engines
18551
+ * * RDS MySQL
18552
+ * * RDS PostgreSQL
18553
+ * * RDS SQL Server
18554
+ * * RDS MariaDB
18555
+ *
18556
+ * @param request CheckDBNameAvailableRequest
18557
+ * @param runtime runtime options for this request RuntimeOptions
18558
+ * @return CheckDBNameAvailableResponse
18559
+ */
18359
18560
  checkDBNameAvailableWithOptions(request: CheckDBNameAvailableRequest, runtime: $Util.RuntimeOptions): Promise<CheckDBNameAvailableResponse>;
18561
+ /**
18562
+ * ### [](#)Supported database engines
18563
+ * * RDS MySQL
18564
+ * * RDS PostgreSQL
18565
+ * * RDS SQL Server
18566
+ * * RDS MariaDB
18567
+ *
18568
+ * @param request CheckDBNameAvailableRequest
18569
+ * @return CheckDBNameAvailableResponse
18570
+ */
18360
18571
  checkDBNameAvailable(request: CheckDBNameAvailableRequest): Promise<CheckDBNameAvailableResponse>;
18361
18572
  checkInstanceExistWithOptions(request: CheckInstanceExistRequest, runtime: $Util.RuntimeOptions): Promise<CheckInstanceExistResponse>;
18362
18573
  checkInstanceExist(request: CheckInstanceExistRequest): Promise<CheckInstanceExistResponse>;
@@ -18499,9 +18710,16 @@ export default class Client extends OpenApi {
18499
18710
  */
18500
18711
  createAccount(request: CreateAccountRequest): Promise<CreateAccountResponse>;
18501
18712
  /**
18713
+ * ### [](#)Supported database engines
18714
+ * * RDS MySQL
18715
+ * * RDS PostgreSQL
18716
+ * * RDS SQL Server
18717
+ * * RDS MariaDB
18718
+ * ### [](#)Feature description:
18502
18719
  * This operation uses the backup feature of ApsaraDB RDS to create a backup set. You can also use an operation of Database Backup (DBS) to create a backup set. For more information, see [List of operations by function of DBS](~~437245~~).
18720
+ * ### [](#)Precautions
18503
18721
  * Before you call this operation, make sure that the following requirements are met:
18504
- * * The original instance is in the Running state.
18722
+ * * The instance is in the running state.
18505
18723
  * * The instance does not have ongoing backup tasks.
18506
18724
  * * The number of backup files that are created per day for an instance cannot exceed 20.
18507
18725
  *
@@ -18511,9 +18729,16 @@ export default class Client extends OpenApi {
18511
18729
  */
18512
18730
  createBackupWithOptions(request: CreateBackupRequest, runtime: $Util.RuntimeOptions): Promise<CreateBackupResponse>;
18513
18731
  /**
18732
+ * ### [](#)Supported database engines
18733
+ * * RDS MySQL
18734
+ * * RDS PostgreSQL
18735
+ * * RDS SQL Server
18736
+ * * RDS MariaDB
18737
+ * ### [](#)Feature description:
18514
18738
  * This operation uses the backup feature of ApsaraDB RDS to create a backup set. You can also use an operation of Database Backup (DBS) to create a backup set. For more information, see [List of operations by function of DBS](~~437245~~).
18739
+ * ### [](#)Precautions
18515
18740
  * Before you call this operation, make sure that the following requirements are met:
18516
- * * The original instance is in the Running state.
18741
+ * * The instance is in the running state.
18517
18742
  * * The instance does not have ongoing backup tasks.
18518
18743
  * * The number of backup files that are created per day for an instance cannot exceed 20.
18519
18744
  *
@@ -18733,10 +18958,13 @@ export default class Client extends OpenApi {
18733
18958
  */
18734
18959
  createDBNodes(request: CreateDBNodesRequest): Promise<CreateDBNodesResponse>;
18735
18960
  /**
18736
- * After you enable the dedicated proxy feature for an ApsaraDB RDS for MySQL instance or enable the database proxy feature for an ApsaraDB RDS for PostgreSQL instance, a default proxy endpoint is created. You can call this operation to create proxy endpoints of different network types. For more information, see [Activate and configure the database proxy feature for an ApsaraDB RDS for PostgreSQL instance](~~418272~~) and [What are database proxies?](~~138705~~)
18737
- * >
18738
- * * The following network types are supported for ApsaraDB RDS for MySQL instances that use local disks: virtual private cloud (VPC), Classic, and Public.
18739
- * * The following network types are supported for instances that use cloud disks: VPC and Public. If you want to create a proxy endpoint of the public network type, you must configure IP address whitelists for the instance and its read-only instances to ensure connectivity between the client and the instance. You can call the [ModifySecurityIps](~~26242~~) operation to configure an IP address whitelist for an instance.
18961
+ * ### [](#)Supported database engines
18962
+ * * RDS MySQL
18963
+ * * RDS PostgreSQL
18964
+ * ### [](#)References
18965
+ * > : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
18966
+ * * [Configure the dedicated proxy endpoint of an ApsaraDB RDS for MySQL instance](~~184921~~)
18967
+ * * [Configure the dedicated proxy endpoint of an ApsaraDB RDS for PostgreSQL instance](~~418274~~)
18740
18968
  *
18741
18969
  * @param request CreateDBProxyEndpointAddressRequest
18742
18970
  * @param runtime runtime options for this request RuntimeOptions
@@ -18744,10 +18972,13 @@ export default class Client extends OpenApi {
18744
18972
  */
18745
18973
  createDBProxyEndpointAddressWithOptions(request: CreateDBProxyEndpointAddressRequest, runtime: $Util.RuntimeOptions): Promise<CreateDBProxyEndpointAddressResponse>;
18746
18974
  /**
18747
- * After you enable the dedicated proxy feature for an ApsaraDB RDS for MySQL instance or enable the database proxy feature for an ApsaraDB RDS for PostgreSQL instance, a default proxy endpoint is created. You can call this operation to create proxy endpoints of different network types. For more information, see [Activate and configure the database proxy feature for an ApsaraDB RDS for PostgreSQL instance](~~418272~~) and [What are database proxies?](~~138705~~)
18748
- * >
18749
- * * The following network types are supported for ApsaraDB RDS for MySQL instances that use local disks: virtual private cloud (VPC), Classic, and Public.
18750
- * * The following network types are supported for instances that use cloud disks: VPC and Public. If you want to create a proxy endpoint of the public network type, you must configure IP address whitelists for the instance and its read-only instances to ensure connectivity between the client and the instance. You can call the [ModifySecurityIps](~~26242~~) operation to configure an IP address whitelist for an instance.
18975
+ * ### [](#)Supported database engines
18976
+ * * RDS MySQL
18977
+ * * RDS PostgreSQL
18978
+ * ### [](#)References
18979
+ * > : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
18980
+ * * [Configure the dedicated proxy endpoint of an ApsaraDB RDS for MySQL instance](~~184921~~)
18981
+ * * [Configure the dedicated proxy endpoint of an ApsaraDB RDS for PostgreSQL instance](~~418274~~)
18751
18982
  *
18752
18983
  * @param request CreateDBProxyEndpointAddressRequest
18753
18984
  * @return CreateDBProxyEndpointAddressResponse
@@ -18789,11 +19020,16 @@ export default class Client extends OpenApi {
18789
19020
  */
18790
19021
  createDatabase(request: CreateDatabaseRequest): Promise<CreateDatabaseResponse>;
18791
19022
  /**
18792
- * Before you call this operation, you can call the [CheckCreateDdrDBInstance](~~121721~~) operation to check whether the data of the source instance can be restored from a cross-region backup set.
18793
- * Before you call this operation, make sure that the instance runs one of the following database engines:
18794
- * * MySQL. For more information, see [Back up an ApsaraDB RDS for MySQL instance across regions](~~120824~~).
18795
- * * SQL Server. For more information, see [Back up an ApsaraDB RDS for SQL Server instance across regions](~~187923~~).
18796
- * * PostgreSQL. For more information, see [Enable cross-region backups for an ApsaraDB RDS for PostgreSQL instance](~~206671~~).
19023
+ * > Before restoration, you can call the [CheckCreateDdrDBInstance](~~121721~~) operation to check whether a cross-region backup set can be used for cross-region restoration.
19024
+ * ### [](#)Supported database engines
19025
+ * * MySQL
19026
+ * * PostgreSQL
19027
+ * * SQL Server
19028
+ * ### [](#)References
19029
+ * > Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
19030
+ * * [Use the cross-region backup feature of an ApsaraDB RDS for MySQL instance](~~120824~~)
19031
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)
19032
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)
18797
19033
  *
18798
19034
  * @param request CreateDdrInstanceRequest
18799
19035
  * @param runtime runtime options for this request RuntimeOptions
@@ -18801,11 +19037,16 @@ export default class Client extends OpenApi {
18801
19037
  */
18802
19038
  createDdrInstanceWithOptions(request: CreateDdrInstanceRequest, runtime: $Util.RuntimeOptions): Promise<CreateDdrInstanceResponse>;
18803
19039
  /**
18804
- * Before you call this operation, you can call the [CheckCreateDdrDBInstance](~~121721~~) operation to check whether the data of the source instance can be restored from a cross-region backup set.
18805
- * Before you call this operation, make sure that the instance runs one of the following database engines:
18806
- * * MySQL. For more information, see [Back up an ApsaraDB RDS for MySQL instance across regions](~~120824~~).
18807
- * * SQL Server. For more information, see [Back up an ApsaraDB RDS for SQL Server instance across regions](~~187923~~).
18808
- * * PostgreSQL. For more information, see [Enable cross-region backups for an ApsaraDB RDS for PostgreSQL instance](~~206671~~).
19040
+ * > Before restoration, you can call the [CheckCreateDdrDBInstance](~~121721~~) operation to check whether a cross-region backup set can be used for cross-region restoration.
19041
+ * ### [](#)Supported database engines
19042
+ * * MySQL
19043
+ * * PostgreSQL
19044
+ * * SQL Server
19045
+ * ### [](#)References
19046
+ * > Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
19047
+ * * [Use the cross-region backup feature of an ApsaraDB RDS for MySQL instance](~~120824~~)
19048
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)
19049
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)
18809
19050
  *
18810
19051
  * @param request CreateDdrInstanceRequest
18811
19052
  * @return CreateDdrInstanceResponse
@@ -18891,6 +19132,8 @@ export default class Client extends OpenApi {
18891
19132
  createOnlineDatabaseTask(request: CreateOnlineDatabaseTaskRequest): Promise<CreateOnlineDatabaseTaskResponse>;
18892
19133
  createOrderForCreateDBNodesWithOptions(tmpReq: CreateOrderForCreateDBNodesRequest, runtime: $Util.RuntimeOptions): Promise<CreateOrderForCreateDBNodesResponse>;
18893
19134
  createOrderForCreateDBNodes(request: CreateOrderForCreateDBNodesRequest): Promise<CreateOrderForCreateDBNodesResponse>;
19135
+ createOrderForDeleteDBNodesWithOptions(tmpReq: CreateOrderForDeleteDBNodesRequest, runtime: $Util.RuntimeOptions): Promise<CreateOrderForDeleteDBNodesResponse>;
19136
+ createOrderForDeleteDBNodes(request: CreateOrderForDeleteDBNodesRequest): Promise<CreateOrderForDeleteDBNodesResponse>;
18894
19137
  /**
18895
19138
  * You can configure a number of parameters at a time by using a parameter template and then apply the parameter template to an instance. For more information, see [Use a parameter template to configure the parameters of ApsaraDB RDS for MySQL instances](~~130565~~) and [Use a parameter template to configure the parameters of ApsaraDB RDS for PostgreSQL instances](~~457176~~).
18896
19139
  * > This operation is supported only when your instance runs MySQL or PostgreSQL.
@@ -18909,11 +19152,15 @@ export default class Client extends OpenApi {
18909
19152
  */
18910
19153
  createParameterGroup(request: CreateParameterGroupRequest): Promise<CreateParameterGroupResponse>;
18911
19154
  /**
18912
- * ### Supported database engine
18913
- * PostgreSQL
18914
- * ### References
18915
- * > Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.
19155
+ * ### [](#)Supported database engines
19156
+ * RDS PostgreSQL
19157
+ * ### [](#)References
19158
+ * > : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
18916
19159
  * [Manage extensions](~~2402409~~)
19160
+ * ### [](#)Precautions
19161
+ * Install only the plug-ins that are supported by the major engine version of the instance. Otherwise, the installation fails.
19162
+ * * For more information, see [Extensions supported by ApsaraDB RDS for PostgreSQL](~~142340~~).
19163
+ * * You can call the [DescribeDBInstanceAttribute](~~610394~~) operation to query the major engine version of an instance.
18917
19164
  *
18918
19165
  * @param request CreatePostgresExtensionsRequest
18919
19166
  * @param runtime runtime options for this request RuntimeOptions
@@ -18921,13 +19168,17 @@ export default class Client extends OpenApi {
18921
19168
  */
18922
19169
  createPostgresExtensionsWithOptions(request: CreatePostgresExtensionsRequest, runtime: $Util.RuntimeOptions): Promise<CreatePostgresExtensionsResponse>;
18923
19170
  /**
18924
- * ### Supported database engine
18925
- * PostgreSQL
18926
- * ### References
18927
- * > Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.
18928
- * [Manage extensions](~~2402409~~)
18929
- *
18930
- * @param request CreatePostgresExtensionsRequest
19171
+ * ### [](#)Supported database engines
19172
+ * RDS PostgreSQL
19173
+ * ### [](#)References
19174
+ * > : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
19175
+ * [Manage extensions](~~2402409~~)
19176
+ * ### [](#)Precautions
19177
+ * Install only the plug-ins that are supported by the major engine version of the instance. Otherwise, the installation fails.
19178
+ * * For more information, see [Extensions supported by ApsaraDB RDS for PostgreSQL](~~142340~~).
19179
+ * * You can call the [DescribeDBInstanceAttribute](~~610394~~) operation to query the major engine version of an instance.
19180
+ *
19181
+ * @param request CreatePostgresExtensionsRequest
18931
19182
  * @return CreatePostgresExtensionsResponse
18932
19183
  */
18933
19184
  createPostgresExtensions(request: CreatePostgresExtensionsRequest): Promise<CreatePostgresExtensionsResponse>;
@@ -19416,7 +19667,11 @@ export default class Client extends OpenApi {
19416
19667
  */
19417
19668
  describeADInfo(request: DescribeADInfoRequest): Promise<DescribeADInfoResponse>;
19418
19669
  /**
19419
- * > This operation is not supported for instances that run SQL Server 2017 on RDS Cluster Edition.
19670
+ * ### [](#)Supported database engines
19671
+ * * RDS MySQL
19672
+ * * RDS PostgreSQL
19673
+ * * RDS SQL Server
19674
+ * * RDS MariaDB
19420
19675
  *
19421
19676
  * @param request DescribeAccountsRequest
19422
19677
  * @param runtime runtime options for this request RuntimeOptions
@@ -19424,7 +19679,11 @@ export default class Client extends OpenApi {
19424
19679
  */
19425
19680
  describeAccountsWithOptions(request: DescribeAccountsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAccountsResponse>;
19426
19681
  /**
19427
- * > This operation is not supported for instances that run SQL Server 2017 on RDS Cluster Edition.
19682
+ * ### [](#)Supported database engines
19683
+ * * RDS MySQL
19684
+ * * RDS PostgreSQL
19685
+ * * RDS SQL Server
19686
+ * * RDS MariaDB
19428
19687
  *
19429
19688
  * @param request DescribeAccountsRequest
19430
19689
  * @return DescribeAccountsResponse
@@ -19494,10 +19753,15 @@ export default class Client extends OpenApi {
19494
19753
  describeAvailableClassesWithOptions(request: DescribeAvailableClassesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAvailableClassesResponse>;
19495
19754
  describeAvailableClasses(request: DescribeAvailableClassesRequest): Promise<DescribeAvailableClassesResponse>;
19496
19755
  /**
19497
- * Before you call this operation, make sure that the instance runs one of the following database engines:
19498
- * * MySQL. For more information, see [Back up an ApsaraDB RDS for MySQL instance across regions](~~120824~~).
19499
- * * SQL Server. For more information, see [Back up an ApsaraDB RDS for SQL Server instance across regions](~~187923~~).
19500
- * * PostgreSQL. For more information, see [Back up an ApsaraDB RDS for PostgreSQL instance across regions](~~206671~~).
19756
+ * ### [](#)Supported database engines
19757
+ * * MySQL
19758
+ * * PostgreSQL
19759
+ * * SQL Server
19760
+ * ### [](#)References
19761
+ * > Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
19762
+ * * [Use the cross-region backup feature of an ApsaraDB RDS for MySQL instance](~~120824~~)
19763
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)
19764
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)
19501
19765
  *
19502
19766
  * @param request DescribeAvailableCrossRegionRequest
19503
19767
  * @param runtime runtime options for this request RuntimeOptions
@@ -19505,10 +19769,15 @@ export default class Client extends OpenApi {
19505
19769
  */
19506
19770
  describeAvailableCrossRegionWithOptions(request: DescribeAvailableCrossRegionRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAvailableCrossRegionResponse>;
19507
19771
  /**
19508
- * Before you call this operation, make sure that the instance runs one of the following database engines:
19509
- * * MySQL. For more information, see [Back up an ApsaraDB RDS for MySQL instance across regions](~~120824~~).
19510
- * * SQL Server. For more information, see [Back up an ApsaraDB RDS for SQL Server instance across regions](~~187923~~).
19511
- * * PostgreSQL. For more information, see [Back up an ApsaraDB RDS for PostgreSQL instance across regions](~~206671~~).
19772
+ * ### [](#)Supported database engines
19773
+ * * MySQL
19774
+ * * PostgreSQL
19775
+ * * SQL Server
19776
+ * ### [](#)References
19777
+ * > Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
19778
+ * * [Use the cross-region backup feature of an ApsaraDB RDS for MySQL instance](~~120824~~)
19779
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)
19780
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)
19512
19781
  *
19513
19782
  * @param request DescribeAvailableCrossRegionRequest
19514
19783
  * @return DescribeAvailableCrossRegionResponse
@@ -19534,10 +19803,12 @@ export default class Client extends OpenApi {
19534
19803
  */
19535
19804
  describeAvailableMetrics(request: DescribeAvailableMetricsRequest): Promise<DescribeAvailableMetricsResponse>;
19536
19805
  /**
19537
- * To query the time range to which you can restore data by using a common backup file, see [DescribeBackups](~~26273~~).
19538
- * Before you call this operation, make sure that the instance runs one of the following database engines:
19539
- * * MySQL. For more information, see [Use the cross-region backup feature for an ApsaraDB RDS for MySQL instance](~~120824~~).
19540
- * * PostgreSQL. For more information, see [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~).
19806
+ * > To view the time range within which you can restore data from a standard backup set, see [DescribeBackups](~~26273~~)
19807
+ * ### [](#)Supported database engines
19808
+ * MySQL
19809
+ * ### [](#)References
19810
+ * > Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
19811
+ * [Use the cross-region backup feature of an ApsaraDB RDS for MySQL instance](~~120824~~)
19541
19812
  *
19542
19813
  * @param request DescribeAvailableRecoveryTimeRequest
19543
19814
  * @param runtime runtime options for this request RuntimeOptions
@@ -19545,10 +19816,12 @@ export default class Client extends OpenApi {
19545
19816
  */
19546
19817
  describeAvailableRecoveryTimeWithOptions(request: DescribeAvailableRecoveryTimeRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAvailableRecoveryTimeResponse>;
19547
19818
  /**
19548
- * To query the time range to which you can restore data by using a common backup file, see [DescribeBackups](~~26273~~).
19549
- * Before you call this operation, make sure that the instance runs one of the following database engines:
19550
- * * MySQL. For more information, see [Use the cross-region backup feature for an ApsaraDB RDS for MySQL instance](~~120824~~).
19551
- * * PostgreSQL. For more information, see [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~).
19819
+ * > To view the time range within which you can restore data from a standard backup set, see [DescribeBackups](~~26273~~)
19820
+ * ### [](#)Supported database engines
19821
+ * MySQL
19822
+ * ### [](#)References
19823
+ * > Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
19824
+ * [Use the cross-region backup feature of an ApsaraDB RDS for MySQL instance](~~120824~~)
19552
19825
  *
19553
19826
  * @param request DescribeAvailableRecoveryTimeRequest
19554
19827
  * @return DescribeAvailableRecoveryTimeResponse
@@ -19615,10 +19888,35 @@ export default class Client extends OpenApi {
19615
19888
  * @return DescribeBackupPolicyResponse
19616
19889
  */
19617
19890
  describeBackupPolicy(request: DescribeBackupPolicyRequest): Promise<DescribeBackupPolicyResponse>;
19891
+ /**
19892
+ * ### [](#)Supported database engines
19893
+ * * RDS MySQL
19894
+ * * RDS PostgreSQL
19895
+ * * RDS SQL Server
19896
+ * * RDS MariaDB
19897
+ *
19898
+ * @param request DescribeBackupTasksRequest
19899
+ * @param runtime runtime options for this request RuntimeOptions
19900
+ * @return DescribeBackupTasksResponse
19901
+ */
19618
19902
  describeBackupTasksWithOptions(request: DescribeBackupTasksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeBackupTasksResponse>;
19903
+ /**
19904
+ * ### [](#)Supported database engines
19905
+ * * RDS MySQL
19906
+ * * RDS PostgreSQL
19907
+ * * RDS SQL Server
19908
+ * * RDS MariaDB
19909
+ *
19910
+ * @param request DescribeBackupTasksRequest
19911
+ * @return DescribeBackupTasksResponse
19912
+ */
19619
19913
  describeBackupTasks(request: DescribeBackupTasksRequest): Promise<DescribeBackupTasksResponse>;
19620
19914
  /**
19621
- * > A backup set can be used to restore data only when **BackupStatus** of the backup set is **Success**.
19915
+ * ### [](#)Supported database engines
19916
+ * * RDS MySQL
19917
+ * * RDS PostgreSQL
19918
+ * * RDS SQL Server
19919
+ * * RDS MariaDB
19622
19920
  *
19623
19921
  * @param request DescribeBackupsRequest
19624
19922
  * @param runtime runtime options for this request RuntimeOptions
@@ -19626,7 +19924,11 @@ export default class Client extends OpenApi {
19626
19924
  */
19627
19925
  describeBackupsWithOptions(request: DescribeBackupsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeBackupsResponse>;
19628
19926
  /**
19629
- * > A backup set can be used to restore data only when **BackupStatus** of the backup set is **Success**.
19927
+ * ### [](#)Supported database engines
19928
+ * * RDS MySQL
19929
+ * * RDS PostgreSQL
19930
+ * * RDS SQL Server
19931
+ * * RDS MariaDB
19630
19932
  *
19631
19933
  * @param request DescribeBackupsRequest
19632
19934
  * @return DescribeBackupsResponse
@@ -19639,9 +19941,9 @@ export default class Client extends OpenApi {
19639
19941
  * * MariaDB
19640
19942
  * ### Usage notes
19641
19943
  * * If the return value of the **DownloadLink** parameter is NULL, ApsaraDB RDS does not provide a download URL.
19642
- * * If the return value of the **DownloadLink** parameter is not NULL, ApsaraDB RDS provides a URL for you to download backup files. The expiration time of the URL is specified by **LinkExpiredTime**. You must download the backup files before the expiration time.
19944
+ * * If the return value of the **DownloadLink** parameter is not NULL, ApsaraDB RDS provides a URL for you to download backup files. The expiration time of the URL is specified by the **LinkExpiredTime** parameter. You must download the backup files before the expiration time.
19643
19945
  * * If you use a RAM user to download backup files, you must grant permissions to the RAM user. For more information, see [Grant backup file download permissions to a RAM user with read-only permissions](~~100043~~).
19644
- * * Each log file that is returned by this operation contains the log entries that are generated over the time range that is specified by StartTime and EndTime.
19946
+ * * Each log file that is returned by this operation contains the log entries that are generated over the time range that is specified by the StartTime and EndTime parameters.
19645
19947
  *
19646
19948
  * @param request DescribeBinlogFilesRequest
19647
19949
  * @param runtime runtime options for this request RuntimeOptions
@@ -19655,9 +19957,9 @@ export default class Client extends OpenApi {
19655
19957
  * * MariaDB
19656
19958
  * ### Usage notes
19657
19959
  * * If the return value of the **DownloadLink** parameter is NULL, ApsaraDB RDS does not provide a download URL.
19658
- * * If the return value of the **DownloadLink** parameter is not NULL, ApsaraDB RDS provides a URL for you to download backup files. The expiration time of the URL is specified by **LinkExpiredTime**. You must download the backup files before the expiration time.
19960
+ * * If the return value of the **DownloadLink** parameter is not NULL, ApsaraDB RDS provides a URL for you to download backup files. The expiration time of the URL is specified by the **LinkExpiredTime** parameter. You must download the backup files before the expiration time.
19659
19961
  * * If you use a RAM user to download backup files, you must grant permissions to the RAM user. For more information, see [Grant backup file download permissions to a RAM user with read-only permissions](~~100043~~).
19660
- * * Each log file that is returned by this operation contains the log entries that are generated over the time range that is specified by StartTime and EndTime.
19962
+ * * Each log file that is returned by this operation contains the log entries that are generated over the time range that is specified by the StartTime and EndTime parameters.
19661
19963
  *
19662
19964
  * @param request DescribeBinlogFilesRequest
19663
19965
  * @return DescribeBinlogFilesResponse
@@ -19784,11 +20086,15 @@ export default class Client extends OpenApi {
19784
20086
  */
19785
20087
  describeCrossRegionBackupDBInstance(request: DescribeCrossRegionBackupDBInstanceRequest): Promise<DescribeCrossRegionBackupDBInstanceResponse>;
19786
20088
  /**
19787
- * For more information about how to query the cross-region log backup files of an RDS instance, see [DescribeCrossRegionLogBackupFiles](~~121734~~).
19788
- * Before you call this operation, make sure that the instance runs one of the following database engines:
19789
- * * MySQL. For more information, see [Back up an ApsaraDB RDS for MySQL instance across regions](~~120824~~).
19790
- * * SQL Server. For more information, see [Back up an ApsaraDB RDS for SQL Server instance across regions](~~187923~~).
19791
- * * PostgreSQL. For more information, see [Back up an ApsaraDB RDS for PostgreSQL instance across regions](~~206671~~).
20089
+ * ### [](#)Supported database engines
20090
+ * * MySQL
20091
+ * * PostgreSQL
20092
+ * * SQL Server
20093
+ * ### [](#)References
20094
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for MySQL instance](~~120824~~)
20095
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)
20096
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)
20097
+ * > For more information about how to query cross-region log backup files, see [DescribeCrossRegionLogBackupFiles](~~121734~~).
19792
20098
  *
19793
20099
  * @param request DescribeCrossRegionBackupsRequest
19794
20100
  * @param runtime runtime options for this request RuntimeOptions
@@ -19796,22 +20102,30 @@ export default class Client extends OpenApi {
19796
20102
  */
19797
20103
  describeCrossRegionBackupsWithOptions(request: DescribeCrossRegionBackupsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeCrossRegionBackupsResponse>;
19798
20104
  /**
19799
- * For more information about how to query the cross-region log backup files of an RDS instance, see [DescribeCrossRegionLogBackupFiles](~~121734~~).
19800
- * Before you call this operation, make sure that the instance runs one of the following database engines:
19801
- * * MySQL. For more information, see [Back up an ApsaraDB RDS for MySQL instance across regions](~~120824~~).
19802
- * * SQL Server. For more information, see [Back up an ApsaraDB RDS for SQL Server instance across regions](~~187923~~).
19803
- * * PostgreSQL. For more information, see [Back up an ApsaraDB RDS for PostgreSQL instance across regions](~~206671~~).
20105
+ * ### [](#)Supported database engines
20106
+ * * MySQL
20107
+ * * PostgreSQL
20108
+ * * SQL Server
20109
+ * ### [](#)References
20110
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for MySQL instance](~~120824~~)
20111
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)
20112
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)
20113
+ * > For more information about how to query cross-region log backup files, see [DescribeCrossRegionLogBackupFiles](~~121734~~).
19804
20114
  *
19805
20115
  * @param request DescribeCrossRegionBackupsRequest
19806
20116
  * @return DescribeCrossRegionBackupsResponse
19807
20117
  */
19808
20118
  describeCrossRegionBackups(request: DescribeCrossRegionBackupsRequest): Promise<DescribeCrossRegionBackupsResponse>;
19809
20119
  /**
19810
- * For more information about how to query the cross-region data backup files of an RDS instance, see [DescribeCrossRegionBackups](~~121733~~).
19811
- * Before you call this operation, make sure that the instance runs one of the following database engine versions and RDS editions:
19812
- * * MySQL 8.0 on RDS High-availability Edition (with local SSDs)
19813
- * * MySQL 5.7 on RDS High-availability Edition (with local SSDs)
19814
- * * MySQL 5.6
20120
+ * ### [](#)Supported database engines
20121
+ * * MySQL
20122
+ * * PostgreSQL
20123
+ * * SQL Server
20124
+ * ### [](#)References
20125
+ * * [Use the cross-region backup feature of an ApsaraDB RDS for MySQL instance](~~120824~~)
20126
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)
20127
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)
20128
+ * > For more information about how to query cross-region data backup files, see [DescribeCrossRegionBackups](~~121733~~).
19815
20129
  *
19816
20130
  * @param request DescribeCrossRegionLogBackupFilesRequest
19817
20131
  * @param runtime runtime options for this request RuntimeOptions
@@ -19819,11 +20133,15 @@ export default class Client extends OpenApi {
19819
20133
  */
19820
20134
  describeCrossRegionLogBackupFilesWithOptions(request: DescribeCrossRegionLogBackupFilesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeCrossRegionLogBackupFilesResponse>;
19821
20135
  /**
19822
- * For more information about how to query the cross-region data backup files of an RDS instance, see [DescribeCrossRegionBackups](~~121733~~).
19823
- * Before you call this operation, make sure that the instance runs one of the following database engine versions and RDS editions:
19824
- * * MySQL 8.0 on RDS High-availability Edition (with local SSDs)
19825
- * * MySQL 5.7 on RDS High-availability Edition (with local SSDs)
19826
- * * MySQL 5.6
20136
+ * ### [](#)Supported database engines
20137
+ * * MySQL
20138
+ * * PostgreSQL
20139
+ * * SQL Server
20140
+ * ### [](#)References
20141
+ * * [Use the cross-region backup feature of an ApsaraDB RDS for MySQL instance](~~120824~~)
20142
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)
20143
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)
20144
+ * > For more information about how to query cross-region data backup files, see [DescribeCrossRegionBackups](~~121733~~).
19827
20145
  *
19828
20146
  * @param request DescribeCrossRegionLogBackupFilesRequest
19829
20147
  * @return DescribeCrossRegionLogBackupFilesResponse
@@ -19872,9 +20190,8 @@ export default class Client extends OpenApi {
19872
20190
  describeDBInstanceEncryptionKeyWithOptions(request: DescribeDBInstanceEncryptionKeyRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBInstanceEncryptionKeyResponse>;
19873
20191
  describeDBInstanceEncryptionKey(request: DescribeDBInstanceEncryptionKeyRequest): Promise<DescribeDBInstanceEncryptionKeyResponse>;
19874
20192
  /**
19875
- * ## Background information
19876
- * * An ApsaraDB RDS for MySQL instance that runs RDS Cluster Edition is created. The instance is referred to as a cluster.
19877
- * * This operation is suitable only for ApsaraDB RDS for MySQL instances that run RDS Cluster Edition.
20193
+ * ### [](#)Supported database engines
20194
+ * RDS MySQL
19878
20195
  *
19879
20196
  * @param request DescribeDBInstanceEndpointsRequest
19880
20197
  * @param runtime runtime options for this request RuntimeOptions
@@ -19882,9 +20199,8 @@ export default class Client extends OpenApi {
19882
20199
  */
19883
20200
  describeDBInstanceEndpointsWithOptions(request: DescribeDBInstanceEndpointsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBInstanceEndpointsResponse>;
19884
20201
  /**
19885
- * ## Background information
19886
- * * An ApsaraDB RDS for MySQL instance that runs RDS Cluster Edition is created. The instance is referred to as a cluster.
19887
- * * This operation is suitable only for ApsaraDB RDS for MySQL instances that run RDS Cluster Edition.
20202
+ * ### [](#)Supported database engines
20203
+ * RDS MySQL
19888
20204
  *
19889
20205
  * @param request DescribeDBInstanceEndpointsRequest
19890
20206
  * @return DescribeDBInstanceEndpointsResponse
@@ -19921,11 +20237,39 @@ export default class Client extends OpenApi {
19921
20237
  * @return DescribeDBInstanceHAConfigResponse
19922
20238
  */
19923
20239
  describeDBInstanceHAConfig(request: DescribeDBInstanceHAConfigRequest): Promise<DescribeDBInstanceHAConfigResponse>;
20240
+ /**
20241
+ * ### [](#)Supported database engines
20242
+ * * RDS MySQL
20243
+ * * RDS PostgreSQL
20244
+ * * RDS SQL Server
20245
+ * * RDS MariaDB
20246
+ *
20247
+ * @param request DescribeDBInstanceIPArrayListRequest
20248
+ * @param runtime runtime options for this request RuntimeOptions
20249
+ * @return DescribeDBInstanceIPArrayListResponse
20250
+ */
19924
20251
  describeDBInstanceIPArrayListWithOptions(request: DescribeDBInstanceIPArrayListRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBInstanceIPArrayListResponse>;
20252
+ /**
20253
+ * ### [](#)Supported database engines
20254
+ * * RDS MySQL
20255
+ * * RDS PostgreSQL
20256
+ * * RDS SQL Server
20257
+ * * RDS MariaDB
20258
+ *
20259
+ * @param request DescribeDBInstanceIPArrayListRequest
20260
+ * @return DescribeDBInstanceIPArrayListResponse
20261
+ */
19925
20262
  describeDBInstanceIPArrayList(request: DescribeDBInstanceIPArrayListRequest): Promise<DescribeDBInstanceIPArrayListResponse>;
19926
20263
  /**
19927
- * ApsaraDB RDS instances are deployed based on ECS instances. This operation is used to query the hostname of the ECS instance where an ApsaraDB RDS instance resides. The hostname is required when you [configure a distributed transaction whitelist](~~124321~~).
19928
- * This operation is applicable to instances that run one of the following SQL Server versions on RDS High-availability Edition: SQL Server 2012 SE, SQL Server 2012 EE, SQL Server 2014 SE, SQL Server 2016 SE, SQL Server 2016 EE, and SQL Server 2017 SE.
20264
+ * ### [](#)Supported database engines
20265
+ * RDS SQL Server
20266
+ * ### [](#)Prerequisites
20267
+ * * The RDS instance runs RDS Basic Edition, RDS High-availability Edition, or RDS Cluster Edition. If your RDS instance runs RDS High-availability Edition, make sure that the instance runs SQL Server 2012 or later.
20268
+ * * The RDS instance belongs to a general-purpose or dedicated instance family. The shared instance family is not supported.
20269
+ * * If the RDS instance runs RDS Basic Edition, the instance is created on or after September 02, 2022. You can view the Creation Time
20270
+ * ### [](#)References
20271
+ * > : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
20272
+ * [Configure a distributed transaction whitelist](~~124321~~)
19929
20273
  *
19930
20274
  * @param request DescribeDBInstanceIpHostnameRequest
19931
20275
  * @param runtime runtime options for this request RuntimeOptions
@@ -19933,8 +20277,15 @@ export default class Client extends OpenApi {
19933
20277
  */
19934
20278
  describeDBInstanceIpHostnameWithOptions(request: DescribeDBInstanceIpHostnameRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBInstanceIpHostnameResponse>;
19935
20279
  /**
19936
- * ApsaraDB RDS instances are deployed based on ECS instances. This operation is used to query the hostname of the ECS instance where an ApsaraDB RDS instance resides. The hostname is required when you [configure a distributed transaction whitelist](~~124321~~).
19937
- * This operation is applicable to instances that run one of the following SQL Server versions on RDS High-availability Edition: SQL Server 2012 SE, SQL Server 2012 EE, SQL Server 2014 SE, SQL Server 2016 SE, SQL Server 2016 EE, and SQL Server 2017 SE.
20280
+ * ### [](#)Supported database engines
20281
+ * RDS SQL Server
20282
+ * ### [](#)Prerequisites
20283
+ * * The RDS instance runs RDS Basic Edition, RDS High-availability Edition, or RDS Cluster Edition. If your RDS instance runs RDS High-availability Edition, make sure that the instance runs SQL Server 2012 or later.
20284
+ * * The RDS instance belongs to a general-purpose or dedicated instance family. The shared instance family is not supported.
20285
+ * * If the RDS instance runs RDS Basic Edition, the instance is created on or after September 02, 2022. You can view the Creation Time
20286
+ * ### [](#)References
20287
+ * > : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
20288
+ * [Configure a distributed transaction whitelist](~~124321~~)
19938
20289
  *
19939
20290
  * @param request DescribeDBInstanceIpHostnameRequest
19940
20291
  * @return DescribeDBInstanceIpHostnameResponse
@@ -20105,10 +20456,10 @@ export default class Client extends OpenApi {
20105
20456
  */
20106
20457
  describeDBInstanceProxyConfiguration(request: DescribeDBInstanceProxyConfigurationRequest): Promise<DescribeDBInstanceProxyConfigurationResponse>;
20107
20458
  /**
20108
- * Before you call this operation, make sure that your instance is one of the following instances:
20109
- * * ApsaraDB RDS for MySQL instances that do not run RDS Basic Edition
20110
- * * ApsaraDB RDS for SQL Server instances
20111
- * * ApsaraDB RDS for PostgreSQL instances that use cloud disks
20459
+ * ### [](#)Supported database engines
20460
+ * * RDS MySQL
20461
+ * * RDS PostgreSQL
20462
+ * * RDS SQL Server
20112
20463
  *
20113
20464
  * @param request DescribeDBInstanceSSLRequest
20114
20465
  * @param runtime runtime options for this request RuntimeOptions
@@ -20116,10 +20467,10 @@ export default class Client extends OpenApi {
20116
20467
  */
20117
20468
  describeDBInstanceSSLWithOptions(request: DescribeDBInstanceSSLRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBInstanceSSLResponse>;
20118
20469
  /**
20119
- * Before you call this operation, make sure that your instance is one of the following instances:
20120
- * * ApsaraDB RDS for MySQL instances that do not run RDS Basic Edition
20121
- * * ApsaraDB RDS for SQL Server instances
20122
- * * ApsaraDB RDS for PostgreSQL instances that use cloud disks
20470
+ * ### [](#)Supported database engines
20471
+ * * RDS MySQL
20472
+ * * RDS PostgreSQL
20473
+ * * RDS SQL Server
20123
20474
  *
20124
20475
  * @param request DescribeDBInstanceSSLRequest
20125
20476
  * @return DescribeDBInstanceSSLResponse
@@ -20127,9 +20478,9 @@ export default class Client extends OpenApi {
20127
20478
  describeDBInstanceSSL(request: DescribeDBInstanceSSLRequest): Promise<DescribeDBInstanceSSLResponse>;
20128
20479
  /**
20129
20480
  * ### [](#)Supported database engines
20130
- * * RDS MySQL
20131
- * * RDS PostgreSQL
20132
- * * RDS SQL Server
20481
+ * * MySQL
20482
+ * * PostgreSQL
20483
+ * * SQL Server
20133
20484
  *
20134
20485
  * @param request DescribeDBInstanceTDERequest
20135
20486
  * @param runtime runtime options for this request RuntimeOptions
@@ -20138,9 +20489,9 @@ export default class Client extends OpenApi {
20138
20489
  describeDBInstanceTDEWithOptions(request: DescribeDBInstanceTDERequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBInstanceTDEResponse>;
20139
20490
  /**
20140
20491
  * ### [](#)Supported database engines
20141
- * * RDS MySQL
20142
- * * RDS PostgreSQL
20143
- * * RDS SQL Server
20492
+ * * MySQL
20493
+ * * PostgreSQL
20494
+ * * SQL Server
20144
20495
  *
20145
20496
  * @param request DescribeDBInstanceTDERequest
20146
20497
  * @return DescribeDBInstanceTDEResponse
@@ -20257,9 +20608,9 @@ export default class Client extends OpenApi {
20257
20608
  */
20258
20609
  describeDBMiniEngineVersions(request: DescribeDBMiniEngineVersionsRequest): Promise<DescribeDBMiniEngineVersionsResponse>;
20259
20610
  /**
20260
- * Before you call the ModifyDBProxyEndpoint operation, make sure that the [ModifyDBProxy](~~141054~~) operation is called to enable the database proxy feature for the instance.
20261
- * * The dedicated proxy feature of ApsaraDB RDS for MySQL provides capabilities such as read/write splitting and short-lived connection optimization. For more information, see [What are database proxies?](~~138705~~)
20262
- * * The database proxy feature of ApsaraDB RDS for PostgreSQL supports read/write splitting. For more information, see [What are database proxies?](~~412194~~)
20611
+ * ### [](#)Supported database engines
20612
+ * * RDS MySQL
20613
+ * * RDS PostgreSQL
20263
20614
  *
20264
20615
  * @param request DescribeDBProxyRequest
20265
20616
  * @param runtime runtime options for this request RuntimeOptions
@@ -20267,18 +20618,18 @@ export default class Client extends OpenApi {
20267
20618
  */
20268
20619
  describeDBProxyWithOptions(request: DescribeDBProxyRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBProxyResponse>;
20269
20620
  /**
20270
- * Before you call the ModifyDBProxyEndpoint operation, make sure that the [ModifyDBProxy](~~141054~~) operation is called to enable the database proxy feature for the instance.
20271
- * * The dedicated proxy feature of ApsaraDB RDS for MySQL provides capabilities such as read/write splitting and short-lived connection optimization. For more information, see [What are database proxies?](~~138705~~)
20272
- * * The database proxy feature of ApsaraDB RDS for PostgreSQL supports read/write splitting. For more information, see [What are database proxies?](~~412194~~)
20621
+ * ### [](#)Supported database engines
20622
+ * * RDS MySQL
20623
+ * * RDS PostgreSQL
20273
20624
  *
20274
20625
  * @param request DescribeDBProxyRequest
20275
20626
  * @return DescribeDBProxyResponse
20276
20627
  */
20277
20628
  describeDBProxy(request: DescribeDBProxyRequest): Promise<DescribeDBProxyResponse>;
20278
20629
  /**
20279
- * Before you call the DescribeDBProxyEndpoint operation, make sure that the [ModifyDBProxy](~~141054~~) operation is called to enable the database proxy feature for the instance.
20280
- * * The dedicated proxy feature of ApsaraDB RDS for MySQL provides capabilities such as read/write splitting and short-lived connection optimization. For more information, see [What are database proxies?](~~138705~~)
20281
- * * The database proxy feature of ApsaraDB RDS for PostgreSQL supports read/write splitting. For more information, see [What are database proxies?](~~412194~~)
20630
+ * ### [](#)Supported database engines
20631
+ * * RDS MySQL
20632
+ * * RDS PostgreSQL
20282
20633
  *
20283
20634
  * @param request DescribeDBProxyEndpointRequest
20284
20635
  * @param runtime runtime options for this request RuntimeOptions
@@ -20286,9 +20637,9 @@ export default class Client extends OpenApi {
20286
20637
  */
20287
20638
  describeDBProxyEndpointWithOptions(request: DescribeDBProxyEndpointRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBProxyEndpointResponse>;
20288
20639
  /**
20289
- * Before you call the DescribeDBProxyEndpoint operation, make sure that the [ModifyDBProxy](~~141054~~) operation is called to enable the database proxy feature for the instance.
20290
- * * The dedicated proxy feature of ApsaraDB RDS for MySQL provides capabilities such as read/write splitting and short-lived connection optimization. For more information, see [What are database proxies?](~~138705~~)
20291
- * * The database proxy feature of ApsaraDB RDS for PostgreSQL supports read/write splitting. For more information, see [What are database proxies?](~~412194~~)
20640
+ * ### [](#)Supported database engines
20641
+ * * RDS MySQL
20642
+ * * RDS PostgreSQL
20292
20643
  *
20293
20644
  * @param request DescribeDBProxyEndpointRequest
20294
20645
  * @return DescribeDBProxyEndpointResponse
@@ -20527,10 +20878,14 @@ export default class Client extends OpenApi {
20527
20878
  describeInstanceAutoRenewalAttributeWithOptions(request: DescribeInstanceAutoRenewalAttributeRequest, runtime: $Util.RuntimeOptions): Promise<DescribeInstanceAutoRenewalAttributeResponse>;
20528
20879
  describeInstanceAutoRenewalAttribute(request: DescribeInstanceAutoRenewalAttributeRequest): Promise<DescribeInstanceAutoRenewalAttributeResponse>;
20529
20880
  /**
20530
- * Before you call this operation, make sure that the instance runs one of the following database engines:
20531
- * * MySQL. For more information, see [Back up an ApsaraDB RDS for MySQL instance across regions](~~120824~~).
20532
- * * SQL Server. For more information, see [Back up an ApsaraDB RDS for SQL Server instance across regions](~~187923~~).
20533
- * * PostgreSQL. For more information, see [Enable cross-region backups for an ApsaraDB RDS for PostgreSQL instance](~~206671~~).
20881
+ * ### [](#)Supported database engines
20882
+ * * MySQL
20883
+ * * PostgreSQL
20884
+ * * SQL Server
20885
+ * ### [](#)References
20886
+ * * [Use the cross-region backup feature of an ApsaraDB RDS for MySQL instance](~~120824~~)
20887
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)
20888
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)
20534
20889
  *
20535
20890
  * @param request DescribeInstanceCrossBackupPolicyRequest
20536
20891
  * @param runtime runtime options for this request RuntimeOptions
@@ -20538,10 +20893,14 @@ export default class Client extends OpenApi {
20538
20893
  */
20539
20894
  describeInstanceCrossBackupPolicyWithOptions(request: DescribeInstanceCrossBackupPolicyRequest, runtime: $Util.RuntimeOptions): Promise<DescribeInstanceCrossBackupPolicyResponse>;
20540
20895
  /**
20541
- * Before you call this operation, make sure that the instance runs one of the following database engines:
20542
- * * MySQL. For more information, see [Back up an ApsaraDB RDS for MySQL instance across regions](~~120824~~).
20543
- * * SQL Server. For more information, see [Back up an ApsaraDB RDS for SQL Server instance across regions](~~187923~~).
20544
- * * PostgreSQL. For more information, see [Enable cross-region backups for an ApsaraDB RDS for PostgreSQL instance](~~206671~~).
20896
+ * ### [](#)Supported database engines
20897
+ * * MySQL
20898
+ * * PostgreSQL
20899
+ * * SQL Server
20900
+ * ### [](#)References
20901
+ * * [Use the cross-region backup feature of an ApsaraDB RDS for MySQL instance](~~120824~~)
20902
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)
20903
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)
20545
20904
  *
20546
20905
  * @param request DescribeInstanceCrossBackupPolicyRequest
20547
20906
  * @return DescribeInstanceCrossBackupPolicyResponse
@@ -20572,11 +20931,31 @@ export default class Client extends OpenApi {
20572
20931
  describeInstanceLinkedWhitelistTemplate(request: DescribeInstanceLinkedWhitelistTemplateRequest): Promise<DescribeInstanceLinkedWhitelistTemplateResponse>;
20573
20932
  describeLocalAvailableRecoveryTimeWithOptions(request: DescribeLocalAvailableRecoveryTimeRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLocalAvailableRecoveryTimeResponse>;
20574
20933
  describeLocalAvailableRecoveryTime(request: DescribeLocalAvailableRecoveryTimeRequest): Promise<DescribeLocalAvailableRecoveryTimeResponse>;
20934
+ /**
20935
+ * ### [](#)Supported database engines
20936
+ * RDS SQL Server
20937
+ * > You can call the [DescribeBinlogFiles](~~610550~~) operation to query the log files of other database engines.
20938
+ *
20939
+ * @param request DescribeLogBackupFilesRequest
20940
+ * @param runtime runtime options for this request RuntimeOptions
20941
+ * @return DescribeLogBackupFilesResponse
20942
+ */
20575
20943
  describeLogBackupFilesWithOptions(request: DescribeLogBackupFilesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeLogBackupFilesResponse>;
20944
+ /**
20945
+ * ### [](#)Supported database engines
20946
+ * RDS SQL Server
20947
+ * > You can call the [DescribeBinlogFiles](~~610550~~) operation to query the log files of other database engines.
20948
+ *
20949
+ * @param request DescribeLogBackupFilesRequest
20950
+ * @return DescribeLogBackupFilesResponse
20951
+ */
20576
20952
  describeLogBackupFiles(request: DescribeLogBackupFilesRequest): Promise<DescribeLogBackupFilesResponse>;
20577
20953
  /**
20954
+ * ### [](#)Supported database engines
20955
+ * MySQL
20956
+ * > This operation is available for RDS instances that run MySQL 8.0, MySQL 5.7, and MySQL 5.6 on RDS High-availability Edition with local disks.
20957
+ * ### [](#)Description
20578
20958
  * Before you call the [RestoreTable](~~131510~~) operation to restore individual databases or tables of an ApsaraDB RDS for MySQL instance, you can call this operation to query the information about the databases and tables that can be restored. For more information, see [Restore individual databases and tables of an ApsaraDB RDS for MySQL instance](~~103175~~).
20579
- * > This operation is supported only when the instance runs MySQL 8.0, MySQL 5.7, or MySQL 5.6 on RDS High-availability Edition with local disks.
20580
20959
  *
20581
20960
  * @param request DescribeMetaListRequest
20582
20961
  * @param runtime runtime options for this request RuntimeOptions
@@ -20584,8 +20963,11 @@ export default class Client extends OpenApi {
20584
20963
  */
20585
20964
  describeMetaListWithOptions(request: DescribeMetaListRequest, runtime: $Util.RuntimeOptions): Promise<DescribeMetaListResponse>;
20586
20965
  /**
20966
+ * ### [](#)Supported database engines
20967
+ * MySQL
20968
+ * > This operation is available for RDS instances that run MySQL 8.0, MySQL 5.7, and MySQL 5.6 on RDS High-availability Edition with local disks.
20969
+ * ### [](#)Description
20587
20970
  * Before you call the [RestoreTable](~~131510~~) operation to restore individual databases or tables of an ApsaraDB RDS for MySQL instance, you can call this operation to query the information about the databases and tables that can be restored. For more information, see [Restore individual databases and tables of an ApsaraDB RDS for MySQL instance](~~103175~~).
20588
- * > This operation is supported only when the instance runs MySQL 8.0, MySQL 5.7, or MySQL 5.6 on RDS High-availability Edition with local disks.
20589
20971
  *
20590
20972
  * @param request DescribeMetaListRequest
20591
20973
  * @return DescribeMetaListResponse
@@ -20614,7 +20996,22 @@ export default class Client extends OpenApi {
20614
20996
  * @return DescribeMigrateTasksResponse
20615
20997
  */
20616
20998
  describeMigrateTasks(request: DescribeMigrateTasksRequest): Promise<DescribeMigrateTasksResponse>;
20999
+ /**
21000
+ * ### [](#)Supported database engines
21001
+ * RDS PostgreSQL
21002
+ *
21003
+ * @param request DescribeModifyPGHbaConfigLogRequest
21004
+ * @param runtime runtime options for this request RuntimeOptions
21005
+ * @return DescribeModifyPGHbaConfigLogResponse
21006
+ */
20617
21007
  describeModifyPGHbaConfigLogWithOptions(request: DescribeModifyPGHbaConfigLogRequest, runtime: $Util.RuntimeOptions): Promise<DescribeModifyPGHbaConfigLogResponse>;
21008
+ /**
21009
+ * ### [](#)Supported database engines
21010
+ * RDS PostgreSQL
21011
+ *
21012
+ * @param request DescribeModifyPGHbaConfigLogRequest
21013
+ * @return DescribeModifyPGHbaConfigLogResponse
21014
+ */
20618
21015
  describeModifyPGHbaConfigLog(request: DescribeModifyPGHbaConfigLogRequest): Promise<DescribeModifyPGHbaConfigLogResponse>;
20619
21016
  describeModifyParameterLogWithOptions(request: DescribeModifyParameterLogRequest, runtime: $Util.RuntimeOptions): Promise<DescribeModifyParameterLogResponse>;
20620
21017
  describeModifyParameterLog(request: DescribeModifyParameterLogRequest): Promise<DescribeModifyParameterLogResponse>;
@@ -20633,7 +21030,22 @@ export default class Client extends OpenApi {
20633
21030
  * @return DescribeOssDownloadsResponse
20634
21031
  */
20635
21032
  describeOssDownloads(request: DescribeOssDownloadsRequest): Promise<DescribeOssDownloadsResponse>;
21033
+ /**
21034
+ * ### [](#)Supported database engines
21035
+ * RDS PostgreSQL
21036
+ *
21037
+ * @param request DescribePGHbaConfigRequest
21038
+ * @param runtime runtime options for this request RuntimeOptions
21039
+ * @return DescribePGHbaConfigResponse
21040
+ */
20636
21041
  describePGHbaConfigWithOptions(request: DescribePGHbaConfigRequest, runtime: $Util.RuntimeOptions): Promise<DescribePGHbaConfigResponse>;
21042
+ /**
21043
+ * ### [](#)Supported database engines
21044
+ * RDS PostgreSQL
21045
+ *
21046
+ * @param request DescribePGHbaConfigRequest
21047
+ * @return DescribePGHbaConfigResponse
21048
+ */
20637
21049
  describePGHbaConfig(request: DescribePGHbaConfigRequest): Promise<DescribePGHbaConfigResponse>;
20638
21050
  /**
20639
21051
  * You can configure a number of parameters at a time by using a parameter template and then apply the parameter template to instances. For more information, see [Use a parameter template to configure the parameters of ApsaraDB RDS for MySQL instances](~~130565~~) or [Use a parameter template to configure the parameters of ApsaraDB RDS for PostgreSQL instances](~~457176~~).
@@ -21239,14 +21651,8 @@ export default class Client extends OpenApi {
21239
21651
  */
21240
21652
  getDBInstanceTopology(request: GetDBInstanceTopologyRequest): Promise<GetDBInstanceTopologyResponse>;
21241
21653
  /**
21242
- * ApsaraDB RDS provides the dedicated proxy feature. You can configure SSL encryption for the dedicated proxy endpoint of an instance. This allows you to ensure the data security of the instance. For more information about the dedicated proxy feature, see [Dedicated proxy](~~138705~~).
21243
- * Before you call this operation, make sure that the following requirements are met:
21244
- * * The dedicated proxy feature must be enabled for the instance.
21245
- * * The minor engine version that the dedicated proxies of the instance run must be 1.12.8 or later.
21246
- * * The minor engine version of the instance must be 20200831 or later, and the instance must run the following MySQL versions and RDS editions:
21247
- * * MySQL 8.0 on RDS High-availability Edition with local SSDs
21248
- * * MySQL 5.7 on RDS High-availability Edition with local SSDs
21249
- * * MySQL 5.6 on RDS High-availability Edition with local SSDs
21654
+ * ### [](#)Supported database engines
21655
+ * RDS MySQL
21250
21656
  *
21251
21657
  * @param request GetDbProxyInstanceSslRequest
21252
21658
  * @param runtime runtime options for this request RuntimeOptions
@@ -21254,14 +21660,8 @@ export default class Client extends OpenApi {
21254
21660
  */
21255
21661
  getDbProxyInstanceSslWithOptions(request: GetDbProxyInstanceSslRequest, runtime: $Util.RuntimeOptions): Promise<GetDbProxyInstanceSslResponse>;
21256
21662
  /**
21257
- * ApsaraDB RDS provides the dedicated proxy feature. You can configure SSL encryption for the dedicated proxy endpoint of an instance. This allows you to ensure the data security of the instance. For more information about the dedicated proxy feature, see [Dedicated proxy](~~138705~~).
21258
- * Before you call this operation, make sure that the following requirements are met:
21259
- * * The dedicated proxy feature must be enabled for the instance.
21260
- * * The minor engine version that the dedicated proxies of the instance run must be 1.12.8 or later.
21261
- * * The minor engine version of the instance must be 20200831 or later, and the instance must run the following MySQL versions and RDS editions:
21262
- * * MySQL 8.0 on RDS High-availability Edition with local SSDs
21263
- * * MySQL 5.7 on RDS High-availability Edition with local SSDs
21264
- * * MySQL 5.6 on RDS High-availability Edition with local SSDs
21663
+ * ### [](#)Supported database engines
21664
+ * RDS MySQL
21265
21665
  *
21266
21666
  * @param request GetDbProxyInstanceSslRequest
21267
21667
  * @return GetDbProxyInstanceSslResponse
@@ -21285,11 +21685,13 @@ export default class Client extends OpenApi {
21285
21685
  */
21286
21686
  grantAccountPrivilege(request: GrantAccountPrivilegeRequest): Promise<GrantAccountPrivilegeResponse>;
21287
21687
  /**
21288
- * When you seek help from Alibaba Cloud technical support to troubleshoot instance exceptions, you need to grant permissions to the service account of your instance. The service account is used by Alibaba Cloud technical support to perform operations on the databases of your instance.
21289
- * This operation is available only when your instance runs one of the following database engines:
21688
+ * ### [](#)Supported database engines
21290
21689
  * * MySQL
21291
21690
  * * SQL Server
21292
- * For more information, see [Grant permissions to the service account of an ApsaraDB RDS for MySQL instance](~~96102~~) and [Grant permissions to the service account of an ApsaraDB RDS for SQL Server instance](~~95693~~).
21691
+ * ### [](#)References
21692
+ * > Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.
21693
+ * * [Grant permissions to the service account of an ApsaraDB RDS for MySQL instance](~~96102~~)
21694
+ * * [Grant permissions to the service account of an ApsaraDB RDS for SQL Server instance](~~95693~~)
21293
21695
  *
21294
21696
  * @param request GrantOperatorPermissionRequest
21295
21697
  * @param runtime runtime options for this request RuntimeOptions
@@ -21297,11 +21699,13 @@ export default class Client extends OpenApi {
21297
21699
  */
21298
21700
  grantOperatorPermissionWithOptions(request: GrantOperatorPermissionRequest, runtime: $Util.RuntimeOptions): Promise<GrantOperatorPermissionResponse>;
21299
21701
  /**
21300
- * When you seek help from Alibaba Cloud technical support to troubleshoot instance exceptions, you need to grant permissions to the service account of your instance. The service account is used by Alibaba Cloud technical support to perform operations on the databases of your instance.
21301
- * This operation is available only when your instance runs one of the following database engines:
21702
+ * ### [](#)Supported database engines
21302
21703
  * * MySQL
21303
21704
  * * SQL Server
21304
- * For more information, see [Grant permissions to the service account of an ApsaraDB RDS for MySQL instance](~~96102~~) and [Grant permissions to the service account of an ApsaraDB RDS for SQL Server instance](~~95693~~).
21705
+ * ### [](#)References
21706
+ * > Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.
21707
+ * * [Grant permissions to the service account of an ApsaraDB RDS for MySQL instance](~~96102~~)
21708
+ * * [Grant permissions to the service account of an ApsaraDB RDS for SQL Server instance](~~95693~~)
21305
21709
  *
21306
21710
  * @param request GrantOperatorPermissionRequest
21307
21711
  * @return GrantOperatorPermissionResponse
@@ -21467,11 +21871,15 @@ export default class Client extends OpenApi {
21467
21871
  */
21468
21872
  migrateSecurityIPMode(request: MigrateSecurityIPModeRequest): Promise<MigrateSecurityIPModeResponse>;
21469
21873
  /**
21470
- * The prerequisites for this operation vary based on the database engine of the instance. For more information, see the following topics:
21471
- * * [RDS MySQL](~~96053~~)
21472
- * * [RDS PostgreSQL](~~96746~~)
21473
- * * [RDS SQL Server](~~95658~~)
21474
- * > This operation allows you to migrate an instance across zones in the same region. This operation does not allow you to migrate an instance across zones in different regions. For example, you cannot migrate an instance from a zone in the China (Hangzhou) region to a zone in the China (Qingdao) region.
21874
+ * ### [](#)Supported database engines
21875
+ * * RDS MySQL
21876
+ * * RDS PostgreSQL
21877
+ * * RDS SQL Server
21878
+ * ### [](#)References
21879
+ * > : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
21880
+ * * [Migrate an ApsaraDB RDS for MySQL instance across zones in the same region](~~96053~~)
21881
+ * * [Migrate an ApsaraDB RDS for PostgreSQL instance across zones in the same region](~~96746~~)
21882
+ * * [Migrate an ApsaraDB RDS for SQL Server instance across zones in the same region](~~95658~~)
21475
21883
  *
21476
21884
  * @param request MigrateToOtherZoneRequest
21477
21885
  * @param runtime runtime options for this request RuntimeOptions
@@ -21479,11 +21887,15 @@ export default class Client extends OpenApi {
21479
21887
  */
21480
21888
  migrateToOtherZoneWithOptions(request: MigrateToOtherZoneRequest, runtime: $Util.RuntimeOptions): Promise<MigrateToOtherZoneResponse>;
21481
21889
  /**
21482
- * The prerequisites for this operation vary based on the database engine of the instance. For more information, see the following topics:
21483
- * * [RDS MySQL](~~96053~~)
21484
- * * [RDS PostgreSQL](~~96746~~)
21485
- * * [RDS SQL Server](~~95658~~)
21486
- * > This operation allows you to migrate an instance across zones in the same region. This operation does not allow you to migrate an instance across zones in different regions. For example, you cannot migrate an instance from a zone in the China (Hangzhou) region to a zone in the China (Qingdao) region.
21890
+ * ### [](#)Supported database engines
21891
+ * * RDS MySQL
21892
+ * * RDS PostgreSQL
21893
+ * * RDS SQL Server
21894
+ * ### [](#)References
21895
+ * > : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
21896
+ * * [Migrate an ApsaraDB RDS for MySQL instance across zones in the same region](~~96053~~)
21897
+ * * [Migrate an ApsaraDB RDS for PostgreSQL instance across zones in the same region](~~96746~~)
21898
+ * * [Migrate an ApsaraDB RDS for SQL Server instance across zones in the same region](~~95658~~)
21487
21899
  *
21488
21900
  * @param request MigrateToOtherZoneRequest
21489
21901
  * @return MigrateToOtherZoneResponse
@@ -21505,7 +21917,11 @@ export default class Client extends OpenApi {
21505
21917
  */
21506
21918
  modifyADInfo(request: ModifyADInfoRequest): Promise<ModifyADInfoResponse>;
21507
21919
  /**
21508
- * > This operation is not supported for instances that run SQL Server 2017 on RDS Cluster Edition or run PostgreSQL.
21920
+ * ### [](#)Supported database engines
21921
+ * * RDS MySQL
21922
+ * * RDS PostgreSQL
21923
+ * * RDS SQL Server
21924
+ * * RDS MariaDB
21509
21925
  *
21510
21926
  * @param request ModifyAccountDescriptionRequest
21511
21927
  * @param runtime runtime options for this request RuntimeOptions
@@ -21513,7 +21929,11 @@ export default class Client extends OpenApi {
21513
21929
  */
21514
21930
  modifyAccountDescriptionWithOptions(request: ModifyAccountDescriptionRequest, runtime: $Util.RuntimeOptions): Promise<ModifyAccountDescriptionResponse>;
21515
21931
  /**
21516
- * > This operation is not supported for instances that run SQL Server 2017 on RDS Cluster Edition or run PostgreSQL.
21932
+ * ### [](#)Supported database engines
21933
+ * * RDS MySQL
21934
+ * * RDS PostgreSQL
21935
+ * * RDS SQL Server
21936
+ * * RDS MariaDB
21517
21937
  *
21518
21938
  * @param request ModifyAccountDescriptionRequest
21519
21939
  * @return ModifyAccountDescriptionResponse
@@ -21600,7 +22020,11 @@ export default class Client extends OpenApi {
21600
22020
  */
21601
22021
  modifyCollationTimeZone(request: ModifyCollationTimeZoneRequest): Promise<ModifyCollationTimeZoneResponse>;
21602
22022
  /**
21603
- * > This operation is not applicable to instances that run PostgreSQL.
22023
+ * ### [](#)Supported database engines
22024
+ * * RDS MySQL
22025
+ * * RDS PostgreSQL
22026
+ * * RDS SQL Server
22027
+ * * RDS MariaDB
21604
22028
  *
21605
22029
  * @param request ModifyDBDescriptionRequest
21606
22030
  * @param runtime runtime options for this request RuntimeOptions
@@ -21608,7 +22032,11 @@ export default class Client extends OpenApi {
21608
22032
  */
21609
22033
  modifyDBDescriptionWithOptions(request: ModifyDBDescriptionRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBDescriptionResponse>;
21610
22034
  /**
21611
- * > This operation is not applicable to instances that run PostgreSQL.
22035
+ * ### [](#)Supported database engines
22036
+ * * RDS MySQL
22037
+ * * RDS PostgreSQL
22038
+ * * RDS SQL Server
22039
+ * * RDS MariaDB
21612
22040
  *
21613
22041
  * @param request ModifyDBDescriptionRequest
21614
22042
  * @return ModifyDBDescriptionResponse
@@ -21724,9 +22152,8 @@ export default class Client extends OpenApi {
21724
22152
  modifyDBInstanceDescriptionWithOptions(request: ModifyDBInstanceDescriptionRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBInstanceDescriptionResponse>;
21725
22153
  modifyDBInstanceDescription(request: ModifyDBInstanceDescriptionRequest): Promise<ModifyDBInstanceDescriptionResponse>;
21726
22154
  /**
21727
- * ## Background information
21728
- * * This operation is suitable only for ApsaraDB RDS for MySQL instances that run RDS Cluster Edition.
21729
- * * When you modify information about the endpoint of an instance, you can modify the settings only of common parameters of the endpoint, such as the weight and description. This operation is called to manage an endpoint.
22155
+ * ### [](#)Supported database engines
22156
+ * RDS MySQL
21730
22157
  *
21731
22158
  * @param tmpReq ModifyDBInstanceEndpointRequest
21732
22159
  * @param runtime runtime options for this request RuntimeOptions
@@ -21734,19 +22161,19 @@ export default class Client extends OpenApi {
21734
22161
  */
21735
22162
  modifyDBInstanceEndpointWithOptions(tmpReq: ModifyDBInstanceEndpointRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBInstanceEndpointResponse>;
21736
22163
  /**
21737
- * ## Background information
21738
- * * This operation is suitable only for ApsaraDB RDS for MySQL instances that run RDS Cluster Edition.
21739
- * * When you modify information about the endpoint of an instance, you can modify the settings only of common parameters of the endpoint, such as the weight and description. This operation is called to manage an endpoint.
22164
+ * ### [](#)Supported database engines
22165
+ * RDS MySQL
21740
22166
  *
21741
22167
  * @param request ModifyDBInstanceEndpointRequest
21742
22168
  * @return ModifyDBInstanceEndpointResponse
21743
22169
  */
21744
22170
  modifyDBInstanceEndpoint(request: ModifyDBInstanceEndpointRequest): Promise<ModifyDBInstanceEndpointResponse>;
21745
22171
  /**
21746
- * ## Background information
21747
- * * This operation is suitable only for ApsaraDB RDS for MySQL instances that run RDS Cluster Edition.
22172
+ * ### [](#)Supported database engines
22173
+ * RDS MySQL
22174
+ * ### [](#)Precautions
21748
22175
  * * You can modify the following information about the endpoint of an instance: the public and internal endpoints, the public and internal ports, and the virtual private cloud (VPC), vSwitch, and IP address of the internal endpoint.
21749
- * * The VPC and vSwitch must be modified at the same time. If you specify the VPC, vSwitch, and IP address of the internal endpoint, you do not need to specify the endpoint and port. If you specify the endpoint and port of the internal endpoint, you do not need to specify the VPC, vSwitch, and IP address.
22176
+ * * The VPC and vSwitch must be modified at the same time. If you specify the VPC, vSwitch, and IP address of the internal endpoint, you do not need to specify the endpoint and port. If you specify the endpoint and port, you do not need to specify the VPC, vSwitch, and IP address of the internal endpoint.
21750
22177
  *
21751
22178
  * @param request ModifyDBInstanceEndpointAddressRequest
21752
22179
  * @param runtime runtime options for this request RuntimeOptions
@@ -21754,10 +22181,11 @@ export default class Client extends OpenApi {
21754
22181
  */
21755
22182
  modifyDBInstanceEndpointAddressWithOptions(request: ModifyDBInstanceEndpointAddressRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBInstanceEndpointAddressResponse>;
21756
22183
  /**
21757
- * ## Background information
21758
- * * This operation is suitable only for ApsaraDB RDS for MySQL instances that run RDS Cluster Edition.
22184
+ * ### [](#)Supported database engines
22185
+ * RDS MySQL
22186
+ * ### [](#)Precautions
21759
22187
  * * You can modify the following information about the endpoint of an instance: the public and internal endpoints, the public and internal ports, and the virtual private cloud (VPC), vSwitch, and IP address of the internal endpoint.
21760
- * * The VPC and vSwitch must be modified at the same time. If you specify the VPC, vSwitch, and IP address of the internal endpoint, you do not need to specify the endpoint and port. If you specify the endpoint and port of the internal endpoint, you do not need to specify the VPC, vSwitch, and IP address.
22188
+ * * The VPC and vSwitch must be modified at the same time. If you specify the VPC, vSwitch, and IP address of the internal endpoint, you do not need to specify the endpoint and port. If you specify the endpoint and port, you do not need to specify the VPC, vSwitch, and IP address of the internal endpoint.
21761
22189
  *
21762
22190
  * @param request ModifyDBInstanceEndpointAddressRequest
21763
22191
  * @return ModifyDBInstanceEndpointAddressResponse
@@ -21836,8 +22264,15 @@ export default class Client extends OpenApi {
21836
22264
  */
21837
22265
  modifyDBInstanceNetworkExpireTime(request: ModifyDBInstanceNetworkExpireTimeRequest): Promise<ModifyDBInstanceNetworkExpireTimeResponse>;
21838
22266
  /**
21839
- * ## Prerequisites
21840
- * The network type of the instance is classic network.
22267
+ * ### [](#)Supported database engines
22268
+ * * RDS MySQL
22269
+ * * RDS PostgreSQL
22270
+ * * RDS SQL Server
22271
+ * ### [](#)References
22272
+ * > : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
22273
+ * * [Change the network type of an ApsaraDB RDS for MySQL instance](~~96109~~)
22274
+ * * [Change the network type of an ApsaraDB RDS for PostgreSQL instance](~~96761~~)
22275
+ * * [Change the network type of an ApsaraDB RDS for SQL Server instance](~~95707~~)
21841
22276
  *
21842
22277
  * @param request ModifyDBInstanceNetworkTypeRequest
21843
22278
  * @param runtime runtime options for this request RuntimeOptions
@@ -21845,8 +22280,15 @@ export default class Client extends OpenApi {
21845
22280
  */
21846
22281
  modifyDBInstanceNetworkTypeWithOptions(request: ModifyDBInstanceNetworkTypeRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBInstanceNetworkTypeResponse>;
21847
22282
  /**
21848
- * ## Prerequisites
21849
- * The network type of the instance is classic network.
22283
+ * ### [](#)Supported database engines
22284
+ * * RDS MySQL
22285
+ * * RDS PostgreSQL
22286
+ * * RDS SQL Server
22287
+ * ### [](#)References
22288
+ * > : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
22289
+ * * [Change the network type of an ApsaraDB RDS for MySQL instance](~~96109~~)
22290
+ * * [Change the network type of an ApsaraDB RDS for PostgreSQL instance](~~96761~~)
22291
+ * * [Change the network type of an ApsaraDB RDS for SQL Server instance](~~95707~~)
21850
22292
  *
21851
22293
  * @param request ModifyDBInstanceNetworkTypeRequest
21852
22294
  * @return ModifyDBInstanceNetworkTypeResponse
@@ -21897,13 +22339,15 @@ export default class Client extends OpenApi {
21897
22339
  */
21898
22340
  modifyDBInstanceProxyConfiguration(request: ModifyDBInstanceProxyConfigurationRequest): Promise<ModifyDBInstanceProxyConfigurationResponse>;
21899
22341
  /**
21900
- * This operation is used to configure SSL encryption for an instance. For more information, see [](~~32474~~).
21901
- * >
21902
- * * Before you call this operation, make sure that your instance is one of the following instances:
21903
- * * ApsaraDB RDS for MySQL instances that do not run RDS Basic Edition
21904
- * * ApsaraDB RDS for SQL Server instances
21905
- * * ApsaraDB RDS for PostgreSQL instances that use cloud disks
21906
- * * SSL encryption is not supported for the connections to the read/write splitting endpoint of an instance.
22342
+ * ### [](#)Supported database engines
22343
+ * * MySQL
22344
+ * * PostgreSQL
22345
+ * * SQL Server
22346
+ * ### [](#)References
22347
+ * > Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.
22348
+ * * [Use the SSL encryption feature for an ApsaraDB RDS for MySQL instance](~~96120~~)
22349
+ * * [Use the SSL encryption feature for an ApsaraDB RDS for PostgreSQL instance](~~229517~~)
22350
+ * * [Use the SSL encryption feature for an ApsaraDB RDS for SQL Server instance](~~95715~~)
21907
22351
  *
21908
22352
  * @param request ModifyDBInstanceSSLRequest
21909
22353
  * @param runtime runtime options for this request RuntimeOptions
@@ -21911,13 +22355,15 @@ export default class Client extends OpenApi {
21911
22355
  */
21912
22356
  modifyDBInstanceSSLWithOptions(request: ModifyDBInstanceSSLRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBInstanceSSLResponse>;
21913
22357
  /**
21914
- * This operation is used to configure SSL encryption for an instance. For more information, see [](~~32474~~).
21915
- * >
21916
- * * Before you call this operation, make sure that your instance is one of the following instances:
21917
- * * ApsaraDB RDS for MySQL instances that do not run RDS Basic Edition
21918
- * * ApsaraDB RDS for SQL Server instances
21919
- * * ApsaraDB RDS for PostgreSQL instances that use cloud disks
21920
- * * SSL encryption is not supported for the connections to the read/write splitting endpoint of an instance.
22358
+ * ### [](#)Supported database engines
22359
+ * * MySQL
22360
+ * * PostgreSQL
22361
+ * * SQL Server
22362
+ * ### [](#)References
22363
+ * > Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.
22364
+ * * [Use the SSL encryption feature for an ApsaraDB RDS for MySQL instance](~~96120~~)
22365
+ * * [Use the SSL encryption feature for an ApsaraDB RDS for PostgreSQL instance](~~229517~~)
22366
+ * * [Use the SSL encryption feature for an ApsaraDB RDS for SQL Server instance](~~95715~~)
21921
22367
  *
21922
22368
  * @param request ModifyDBInstanceSSLRequest
21923
22369
  * @return ModifyDBInstanceSSLResponse
@@ -21989,6 +22435,8 @@ export default class Client extends OpenApi {
21989
22435
  * @return ModifyDBInstanceTDEResponse
21990
22436
  */
21991
22437
  modifyDBInstanceTDE(request: ModifyDBInstanceTDERequest): Promise<ModifyDBInstanceTDEResponse>;
22438
+ modifyDBNodeWithOptions(tmpReq: ModifyDBNodeRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBNodeResponse>;
22439
+ modifyDBNode(request: ModifyDBNodeRequest): Promise<ModifyDBNodeResponse>;
21992
22440
  /**
21993
22441
  * ### [](#)Supported database engines
21994
22442
  * * RDS MySQL
@@ -22017,9 +22465,13 @@ export default class Client extends OpenApi {
22017
22465
  */
22018
22466
  modifyDBProxy(request: ModifyDBProxyRequest): Promise<ModifyDBProxyResponse>;
22019
22467
  /**
22020
- * Before you call the ModifyDBProxyEndpoint operation, make sure that the [ModifyDBProxy](~~141054~~) operation is called to enable the database proxy feature for the instance.
22021
- * * The dedicated proxy feature of ApsaraDB RDS for MySQL provides capabilities such as read/write splitting and short-lived connection optimization. For more information, see [What are database proxies?](~~138705~~)
22022
- * * The database proxy feature of ApsaraDB RDS for PostgreSQL supports read/write splitting. For more information, see [What are database proxies?](~~412194~~)
22468
+ * ### [](#)Supported database engines
22469
+ * * RDS MySQL
22470
+ * * RDS PostgreSQL
22471
+ * ### [](#)References
22472
+ * > : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
22473
+ * * [Enable and configure the dedicated proxy feature](~~197456~~)
22474
+ * * [Create a database proxy terminal for an ApsaraDB RDS for PostgreSQL instance](~~418273~~)
22023
22475
  *
22024
22476
  * @param request ModifyDBProxyEndpointRequest
22025
22477
  * @param runtime runtime options for this request RuntimeOptions
@@ -22027,9 +22479,13 @@ export default class Client extends OpenApi {
22027
22479
  */
22028
22480
  modifyDBProxyEndpointWithOptions(request: ModifyDBProxyEndpointRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBProxyEndpointResponse>;
22029
22481
  /**
22030
- * Before you call the ModifyDBProxyEndpoint operation, make sure that the [ModifyDBProxy](~~141054~~) operation is called to enable the database proxy feature for the instance.
22031
- * * The dedicated proxy feature of ApsaraDB RDS for MySQL provides capabilities such as read/write splitting and short-lived connection optimization. For more information, see [What are database proxies?](~~138705~~)
22032
- * * The database proxy feature of ApsaraDB RDS for PostgreSQL supports read/write splitting. For more information, see [What are database proxies?](~~412194~~)
22482
+ * ### [](#)Supported database engines
22483
+ * * RDS MySQL
22484
+ * * RDS PostgreSQL
22485
+ * ### [](#)References
22486
+ * > : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
22487
+ * * [Enable and configure the dedicated proxy feature](~~197456~~)
22488
+ * * [Create a database proxy terminal for an ApsaraDB RDS for PostgreSQL instance](~~418273~~)
22033
22489
  *
22034
22490
  * @param request ModifyDBProxyEndpointRequest
22035
22491
  * @return ModifyDBProxyEndpointResponse
@@ -22115,18 +22571,35 @@ export default class Client extends OpenApi {
22115
22571
  * @return ModifyDasInstanceConfigResponse
22116
22572
  */
22117
22573
  modifyDasInstanceConfig(request: ModifyDasInstanceConfigRequest): Promise<ModifyDasInstanceConfigResponse>;
22574
+ /**
22575
+ * ### [](#)Supported database engine
22576
+ * * SQL Server
22577
+ * ### [](#)References
22578
+ * > : Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.
22579
+ * [Manage advanced features of an ApsaraDB RDS for SQL Server instance](~~2401398~~)
22580
+ *
22581
+ * @param request ModifyDatabaseConfigRequest
22582
+ * @param runtime runtime options for this request RuntimeOptions
22583
+ * @return ModifyDatabaseConfigResponse
22584
+ */
22118
22585
  modifyDatabaseConfigWithOptions(request: ModifyDatabaseConfigRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDatabaseConfigResponse>;
22586
+ /**
22587
+ * ### [](#)Supported database engine
22588
+ * * SQL Server
22589
+ * ### [](#)References
22590
+ * > : Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.
22591
+ * [Manage advanced features of an ApsaraDB RDS for SQL Server instance](~~2401398~~)
22592
+ *
22593
+ * @param request ModifyDatabaseConfigRequest
22594
+ * @return ModifyDatabaseConfigResponse
22595
+ */
22119
22596
  modifyDatabaseConfig(request: ModifyDatabaseConfigRequest): Promise<ModifyDatabaseConfigResponse>;
22120
22597
  /**
22121
- * The system provides the dedicated proxy feature. You can configure SSL encryption for the dedicated proxy endpoint of an instance. This allows you to ensure the data security of the instance. For more information about the dedicated proxy feature, see [Dedicated proxy](~~138705~~).
22122
- * Before you call this operation, make sure that the following requirements are met:
22123
- * * The dedicated proxy feature is enabled for the instance.
22124
- * * The minor engine version that the dedicated proxies of the instance run is 1.12.8 or later.
22125
- * * Your RDS instance runs one of the following MySQL versions:
22126
- * * MySQL 8.0 on RDS High-availability Edition with local disks. The minor engine version is 20200831 or later.
22127
- * * MySQL 5.7 on RDS High-availability Edition with local disks. The minor engine version is 20200831 or later.
22128
- * * MySQL 5.6 on RDS High-availability Edition with local disks. The minor engine version is 20200831 or later.
22129
- * > Calling this operation causes your instance to restart. Proceed with caution.
22598
+ * ### [](#)Supported database engines
22599
+ * RDS MySQL
22600
+ * ### [](#)References
22601
+ * > : Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation:
22602
+ * [Configure SSL encryption for a proxy endpoint](~~188164~~)
22130
22603
  *
22131
22604
  * @param request ModifyDbProxyInstanceSslRequest
22132
22605
  * @param runtime runtime options for this request RuntimeOptions
@@ -22134,15 +22607,11 @@ export default class Client extends OpenApi {
22134
22607
  */
22135
22608
  modifyDbProxyInstanceSslWithOptions(request: ModifyDbProxyInstanceSslRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDbProxyInstanceSslResponse>;
22136
22609
  /**
22137
- * The system provides the dedicated proxy feature. You can configure SSL encryption for the dedicated proxy endpoint of an instance. This allows you to ensure the data security of the instance. For more information about the dedicated proxy feature, see [Dedicated proxy](~~138705~~).
22138
- * Before you call this operation, make sure that the following requirements are met:
22139
- * * The dedicated proxy feature is enabled for the instance.
22140
- * * The minor engine version that the dedicated proxies of the instance run is 1.12.8 or later.
22141
- * * Your RDS instance runs one of the following MySQL versions:
22142
- * * MySQL 8.0 on RDS High-availability Edition with local disks. The minor engine version is 20200831 or later.
22143
- * * MySQL 5.7 on RDS High-availability Edition with local disks. The minor engine version is 20200831 or later.
22144
- * * MySQL 5.6 on RDS High-availability Edition with local disks. The minor engine version is 20200831 or later.
22145
- * > Calling this operation causes your instance to restart. Proceed with caution.
22610
+ * ### [](#)Supported database engines
22611
+ * RDS MySQL
22612
+ * ### [](#)References
22613
+ * > : Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation:
22614
+ * [Configure SSL encryption for a proxy endpoint](~~188164~~)
22146
22615
  *
22147
22616
  * @param request ModifyDbProxyInstanceSslRequest
22148
22617
  * @return ModifyDbProxyInstanceSslResponse
@@ -22164,8 +22633,17 @@ export default class Client extends OpenApi {
22164
22633
  */
22165
22634
  modifyHADiagnoseConfig(request: ModifyHADiagnoseConfigRequest): Promise<ModifyHADiagnoseConfigResponse>;
22166
22635
  /**
22167
- * After a switchover is complete, the original primary RDS instance runs as the secondary RDS instance. For more information, see [Switch workloads over between primary and secondary ApsaraDB RDS for MySQL instances](~~96054~~).
22168
- * Before you call this operation, make sure that the instance does not run the RDS Basic Edition.
22636
+ * ### [](#)Supported database engines
22637
+ * * MySQL
22638
+ * * PostgreSQL
22639
+ * * SQL Server
22640
+ * * MariaDB
22641
+ * ### [](#)References
22642
+ * > Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.
22643
+ * * [Use the automatic primary/secondary switchover feature for an ApsaraDB RDS for MySQL instance](~~96054~~)
22644
+ * * [Use the automatic primary/secondary switchover feature for an ApsaraDB RDS for PostgreSQL instance](~~96747~~)
22645
+ * * [Use the automatic primary/secondary switchover feature for an ApsaraDB RDS for SQL Server instance](~~95659~~)
22646
+ * * [Use the automatic primary/secondary switchover feature for an ApsaraDB RDS for MariaDB instance](~~97127~~)
22169
22647
  *
22170
22648
  * @param request ModifyHASwitchConfigRequest
22171
22649
  * @param runtime runtime options for this request RuntimeOptions
@@ -22173,8 +22651,17 @@ export default class Client extends OpenApi {
22173
22651
  */
22174
22652
  modifyHASwitchConfigWithOptions(request: ModifyHASwitchConfigRequest, runtime: $Util.RuntimeOptions): Promise<ModifyHASwitchConfigResponse>;
22175
22653
  /**
22176
- * After a switchover is complete, the original primary RDS instance runs as the secondary RDS instance. For more information, see [Switch workloads over between primary and secondary ApsaraDB RDS for MySQL instances](~~96054~~).
22177
- * Before you call this operation, make sure that the instance does not run the RDS Basic Edition.
22654
+ * ### [](#)Supported database engines
22655
+ * * MySQL
22656
+ * * PostgreSQL
22657
+ * * SQL Server
22658
+ * * MariaDB
22659
+ * ### [](#)References
22660
+ * > Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.
22661
+ * * [Use the automatic primary/secondary switchover feature for an ApsaraDB RDS for MySQL instance](~~96054~~)
22662
+ * * [Use the automatic primary/secondary switchover feature for an ApsaraDB RDS for PostgreSQL instance](~~96747~~)
22663
+ * * [Use the automatic primary/secondary switchover feature for an ApsaraDB RDS for SQL Server instance](~~95659~~)
22664
+ * * [Use the automatic primary/secondary switchover feature for an ApsaraDB RDS for MariaDB instance](~~97127~~)
22178
22665
  *
22179
22666
  * @param request ModifyHASwitchConfigRequest
22180
22667
  * @return ModifyHASwitchConfigResponse
@@ -22196,10 +22683,14 @@ export default class Client extends OpenApi {
22196
22683
  */
22197
22684
  modifyInstanceAutoRenewalAttribute(request: ModifyInstanceAutoRenewalAttributeRequest): Promise<ModifyInstanceAutoRenewalAttributeResponse>;
22198
22685
  /**
22199
- * Before you call this operation, make sure that the instance runs one of the following database engines:
22200
- * * MySQL. For more information, see [Back up an ApsaraDB RDS for MySQL instance across regions](~~120824~~).
22201
- * * SQL Server. For more information, see [Back up an ApsaraDB RDS for SQL Server instance across regions](~~187923~~).
22202
- * * PostgreSQL. For more information, see [Enable cross-region backups for an ApsaraDB RDS for PostgreSQL instance](~~206671~~).
22686
+ * ### [](#)Supported database engines
22687
+ * * MySQL
22688
+ * * PostgreSQL
22689
+ * * SQL Server
22690
+ * ### [](#)References
22691
+ * * [Use the cross-region backup feature of an ApsaraDB RDS for MySQL instance](~~120824~~)
22692
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)
22693
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)
22203
22694
  *
22204
22695
  * @param request ModifyInstanceCrossBackupPolicyRequest
22205
22696
  * @param runtime runtime options for this request RuntimeOptions
@@ -22207,18 +22698,26 @@ export default class Client extends OpenApi {
22207
22698
  */
22208
22699
  modifyInstanceCrossBackupPolicyWithOptions(request: ModifyInstanceCrossBackupPolicyRequest, runtime: $Util.RuntimeOptions): Promise<ModifyInstanceCrossBackupPolicyResponse>;
22209
22700
  /**
22210
- * Before you call this operation, make sure that the instance runs one of the following database engines:
22211
- * * MySQL. For more information, see [Back up an ApsaraDB RDS for MySQL instance across regions](~~120824~~).
22212
- * * SQL Server. For more information, see [Back up an ApsaraDB RDS for SQL Server instance across regions](~~187923~~).
22213
- * * PostgreSQL. For more information, see [Enable cross-region backups for an ApsaraDB RDS for PostgreSQL instance](~~206671~~).
22701
+ * ### [](#)Supported database engines
22702
+ * * MySQL
22703
+ * * PostgreSQL
22704
+ * * SQL Server
22705
+ * ### [](#)References
22706
+ * * [Use the cross-region backup feature of an ApsaraDB RDS for MySQL instance](~~120824~~)
22707
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)
22708
+ * * [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)
22214
22709
  *
22215
22710
  * @param request ModifyInstanceCrossBackupPolicyRequest
22216
22711
  * @return ModifyInstanceCrossBackupPolicyResponse
22217
22712
  */
22218
22713
  modifyInstanceCrossBackupPolicy(request: ModifyInstanceCrossBackupPolicyRequest): Promise<ModifyInstanceCrossBackupPolicyResponse>;
22219
22714
  /**
22220
- * ApsaraDB RDS for PostgreSQL allows you to modify the pg_hba.conf file based on your business requirements. For more information, see [Introduction to the pg_hba.conf file](https://www.postgresql.org/docs/11/auth-pg-hba-conf.html).
22221
- * You can modify the information of the Active Directory (AD) domain controller in the pg_hba.conf file of an instance. Then, you can connect the instance to a self-managed AD domain. For more information, see [Connect an ApsaraDB RDS for PostgreSQL instance to a self-managed AD domain](~~349288~~).
22715
+ * ### [](#)Supported database engines
22716
+ * RDS PostgreSQL
22717
+ * ### [](#)References
22718
+ * > : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
22719
+ * * [Connect an ApsaraDB RDS for PostgreSQL instance to a self-managed AD domain](~~349288~~)
22720
+ * * [The pg_hba.conf File](https://www.postgresql.org/docs/11/auth-pg-hba-conf.html)
22222
22721
  *
22223
22722
  * @param request ModifyPGHbaConfigRequest
22224
22723
  * @param runtime runtime options for this request RuntimeOptions
@@ -22226,8 +22725,12 @@ export default class Client extends OpenApi {
22226
22725
  */
22227
22726
  modifyPGHbaConfigWithOptions(request: ModifyPGHbaConfigRequest, runtime: $Util.RuntimeOptions): Promise<ModifyPGHbaConfigResponse>;
22228
22727
  /**
22229
- * ApsaraDB RDS for PostgreSQL allows you to modify the pg_hba.conf file based on your business requirements. For more information, see [Introduction to the pg_hba.conf file](https://www.postgresql.org/docs/11/auth-pg-hba-conf.html).
22230
- * You can modify the information of the Active Directory (AD) domain controller in the pg_hba.conf file of an instance. Then, you can connect the instance to a self-managed AD domain. For more information, see [Connect an ApsaraDB RDS for PostgreSQL instance to a self-managed AD domain](~~349288~~).
22728
+ * ### [](#)Supported database engines
22729
+ * RDS PostgreSQL
22730
+ * ### [](#)References
22731
+ * > : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
22732
+ * * [Connect an ApsaraDB RDS for PostgreSQL instance to a self-managed AD domain](~~349288~~)
22733
+ * * [The pg_hba.conf File](https://www.postgresql.org/docs/11/auth-pg-hba-conf.html)
22231
22734
  *
22232
22735
  * @param request ModifyPGHbaConfigRequest
22233
22736
  * @return ModifyPGHbaConfigResponse
@@ -22829,14 +23332,15 @@ export default class Client extends OpenApi {
22829
23332
  restoreDdrTableWithOptions(request: RestoreDdrTableRequest, runtime: $Util.RuntimeOptions): Promise<RestoreDdrTableResponse>;
22830
23333
  restoreDdrTable(request: RestoreDdrTableRequest): Promise<RestoreDdrTableResponse>;
22831
23334
  /**
22832
- * ApsaraDB RDS for MySQL supports the restoration of individual databases and tables. If you delete databases or tables from an instance, you can restore the databases or tables by using a backup file. For more information, see [Restore individual databases and tables of an ApsaraDB RDS for MySQL instance](~~103175~~).
22833
- * Before you call this operation, make sure that the following requirements are met:
23335
+ * ### [](#)Supported database engines
23336
+ * MySQL
23337
+ * ### [](#)Description
23338
+ * ApsaraDB RDS for MySQL supports the restoration of individual databases and tables. If you delete databases or tables from an instance, you can restore the databases or tables by using a backup file. For more information, see [Restore individual databases and tables of an ApsaraDB RDS for MySQL instance](~~103175~~). Before you call this operation, make sure that the following requirements are met:
22834
23339
  * * The instance is in the Running state.
22835
23340
  * * The instance does not have ongoing migration tasks.
22836
23341
  * * If you want to restore data to a specific point in time, make sure that the log backup feature is enabled for the instance. For more information, see [Back up an ApsaraDB RDS for MySQL instance](~~98818~~).
22837
23342
  * * The restoration of individual databases or tables is enabled, and new backups are created. For more information, see [Restore individual databases and tables of an ApsaraDB RDS for MySQL instance](~~103175~~).
22838
23343
  * * The names that you want to use for the restored tables do not exist in the instance.
22839
- * > This operation is supported only for instances that run MySQL.
22840
23344
  *
22841
23345
  * @param request RestoreTableRequest
22842
23346
  * @param runtime runtime options for this request RuntimeOptions
@@ -22844,14 +23348,15 @@ export default class Client extends OpenApi {
22844
23348
  */
22845
23349
  restoreTableWithOptions(request: RestoreTableRequest, runtime: $Util.RuntimeOptions): Promise<RestoreTableResponse>;
22846
23350
  /**
22847
- * ApsaraDB RDS for MySQL supports the restoration of individual databases and tables. If you delete databases or tables from an instance, you can restore the databases or tables by using a backup file. For more information, see [Restore individual databases and tables of an ApsaraDB RDS for MySQL instance](~~103175~~).
22848
- * Before you call this operation, make sure that the following requirements are met:
23351
+ * ### [](#)Supported database engines
23352
+ * MySQL
23353
+ * ### [](#)Description
23354
+ * ApsaraDB RDS for MySQL supports the restoration of individual databases and tables. If you delete databases or tables from an instance, you can restore the databases or tables by using a backup file. For more information, see [Restore individual databases and tables of an ApsaraDB RDS for MySQL instance](~~103175~~). Before you call this operation, make sure that the following requirements are met:
22849
23355
  * * The instance is in the Running state.
22850
23356
  * * The instance does not have ongoing migration tasks.
22851
23357
  * * If you want to restore data to a specific point in time, make sure that the log backup feature is enabled for the instance. For more information, see [Back up an ApsaraDB RDS for MySQL instance](~~98818~~).
22852
23358
  * * The restoration of individual databases or tables is enabled, and new backups are created. For more information, see [Restore individual databases and tables of an ApsaraDB RDS for MySQL instance](~~103175~~).
22853
23359
  * * The names that you want to use for the restored tables do not exist in the instance.
22854
- * > This operation is supported only for instances that run MySQL.
22855
23360
  *
22856
23361
  * @param request RestoreTableRequest
22857
23362
  * @return RestoreTableResponse