@alicloud/polardbx20200202 3.4.2 → 3.5.0

package/src/models/ModifyDbinstanceClassRequest.ts

@@ -4,36 +4,209 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyDBInstanceClassRequest extends $dara.Model {
   /**
+   * @remarks
+   * The client token. It can be any unique string.
+   * 
    * @example
    * FEA5DC20-6D8A-5979-97AA-FC57546ADC20
    */
   clientToken?: string;
+  /**
+   * @remarks
+   * **Target specifications for Enterprise Edition compute node specification changes**
+   * 
+   * **Primary instance compute node specifications (Enterprise Edition CN) general-purpose**	
+   * - polarx.x4.medium.2e	2 cores, 8 GB (general-purpose)
+   * - polarx.x4.large.2e	4 cores, 16 GB (general-purpose)
+   * - polarx.x4.xlarge.2e	8 cores, 32 GB (general-purpose)
+   * - polarx.x4.2xlarge.2e 16 cores, 64 GB (general-purpose)
+   * 
+   * **Primary instance compute node specifications (Enterprise Edition CN) dedicated**	
+   * - polarx.x8.large.2e	4 cores, 32 GB (dedicated)
+   * - polarx.x8.xlarge.2e	8 cores, 64 GB (dedicated)
+   * - polarx.x8.2xlarge.2e	16 cores, 128 GB (dedicated)
+   * - polarx.x4.4xlarge.2e	32 cores, 128 GB (dedicated)
+   * - polarx.x8.4xlarge.2e	32 cores, 256 GB (dedicated)
+   * - polarx.st.8xlarge.2e	60 cores, 470 GB (dedicated)
+   * - polarx.st.12xlarge.2e	90 cores, 720 GB (dedicated)
+   * 
+   * **Read-only instance compute node specifications (Enterprise Edition CN) general-purpose**	
+   * 
+   * - polarxro.x4.medium.2e	2 cores, 8 GB (general-purpose)
+   * - polarxro.x4.large.2e	4 cores, 16 GB (general-purpose)
+   * - polarxro.x4.xlarge.2e	8 cores, 32 GB (general-purpose)
+   * - polarxro.x4.2xlarge.2e	16 cores, 64 GB (general-purpose)
+   * 
+   * **Read-only instance compute node specifications (Enterprise Edition CN) dedicated**	
+   * 
+   * - polarxro.x8.large.2e	4 cores, 32 GB (dedicated)
+   * - polarxro.x8.xlarge.2e	8 cores, 64 GB (dedicated)
+   * - polarxro.x8.2xlarge.2e	16 cores, 128 GB (dedicated)
+   * - polarxro.x4.4xlarge.2e	32 cores, 128 GB (dedicated)
+   * - polarxro.x8.4xlarge.2e	32 cores, 256 GB (dedicated)
+   * - polarxro.st.8xlarge.2e	60 cores, 470 GB (dedicated physical machine)
+   * - polarxro.st.12xlarge.2e	90 cores, 720 GB (dedicated physical machine).
+   * 
+   * @example
+   * polarx.x4.medium.2e
+   */
   cnClass?: string;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
    * pxc-hzjasd****
    */
   DBInstanceName?: string;
+  /**
+   * @remarks
+   * **Target specifications for Enterprise Edition storage node specification changes**
+   * 
+   * **Storage node specifications (Enterprise Edition DN) general-purpose**	
+   * 
+   * - mysql.n4.medium.25	2 cores, 8 GB (general-purpose)
+   * - mysql.n4.large.25	4 cores, 16 GB (general-purpose)
+   * - mysql.n4.xlarge.25	8 cores, 32 GB (general-purpose)
+   * - mysql.n4.2xlarge.25	16 cores, 64 GB (general-purpose)
+   * 
+   * **Storage node specifications (Enterprise Edition DN) dedicated**	
+   * 
+   * - mysql.x8.large.25	4 cores, 32 GB (dedicated)
+   * - mysql.x8.xlarge.25	8 cores, 64 GB (dedicated)
+   * - mysql.x8.2xlarge.25	16 cores, 128 GB (dedicated)
+   * - mysql.x4.4xlarge.25	32 cores, 128 GB (dedicated)
+   * - mysql.x8.4xlarge.25	32 cores, 256 GB (dedicated)
+   * - mysql.st.8xlarge.25	60 cores, 470 GB (dedicated)
+   * - mysql.st.12xlarge.25	90 cores, 720 GB (dedicated)
+   * 
+   * **Read-only instance storage node specifications (Enterprise Edition DN) general-purpose**	
+   * 
+   * - rds.mysql.s2.xlarge	2 cores, 8 GB (general-purpose)
+   * - mysqlro.x4.large.1	4 cores, 16 GB (general-purpose)
+   * - mysqlro.x4.xlarge.1	8 cores, 32 GB (general-purpose)
+   * - mysqlro.x4.2xlarge.1	16 cores, 64 GB (general-purpose)
+   * 
+   * **Read-only instance storage node specifications (Enterprise Edition DN) dedicated**	
+   * 
+   * - mysqlro.x8.large.1	4 cores, 32 GB (dedicated)
+   * - mysqlro.x8.xlarge.1	8 cores, 64 GB (dedicated)
+   * - mysqlro.x8.2xlarge.1	16 cores, 128 GB (dedicated)
+   * - mysqlro.x4.4xlarge.1	32 cores, 128 GB (dedicated)
+   * - mysqlro.x8.4xlarge.1	32 cores, 256 GB (dedicated)
+   * - rds.mysql.st.h43	60 cores, 470 GB (dedicated physical machine)
+   * - rds.mysql.st.v52	90 cores, 720 GB (dedicated physical machine).
+   * 
+   * @example
+   * mysql.n4.medium.25
+   */
   dnClass?: string;
+  /**
+   * @remarks
+   * The target disk size for the specification change.
+   * 
+   * - If the instance uses a fixed-size disk, the disk cannot be changed. In this case, do not specify DnStorageSpace.
+   * - Valid values of DnStorageSpace: [20, 3072].
+   * 
+   * @example
+   * 50
+   */
   dnStorageSpace?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
+  /**
+   * @remarks
+   * Specifies whether to change specifications for multiple DNs.
+   * 
+   * @example
+   * true
+   */
   specifiedDNScale?: boolean;
+  /**
+   * @remarks
+   * The target specifications for each DN when changing specifications for multiple DNs.
+   * 
+   * @example
+   * {"pxc-xdb-s-htr3rh44ki3s6a4354":"mysql.n4.medium.25","pxc-xdb-s-htr3rh44ki3s6a71c6":"mysql.n4.medium.25"}
+   */
   specifiedDNSpecMapJson?: string;
+  /**
+   * @remarks
+   * The start time of the switch. The switch time range is [start time T, T+30m]. This parameter is not yet available.
+   * 
+   * @example
+   * 2024-12-11T17:10:00Z
+   */
   switchTime?: string;
+  /**
+   * @remarks
+   * The switch time. Valid values:
+   * - 0: immediately
+   * - 1: within the O&M window.
+   * 
+   * @example
+   * 0
+   */
   switchTimeMode?: string;
   /**
+   * @remarks
+   * **Target specifications for Standard Edition specification changes**
+   * 
+   * **Primary instance node specifications (for Standard Edition) (general-purpose):**
+   * - mysql.n2.medium.25	2 cores, 4 GB (general-purpose)
+   * - mysql.n4.medium.25	2 cores, 8 GB (general-purpose)
+   * - mysql.n8.medium.25	2 cores, 16 GB (general-purpose)
+   * - mysql.n2.large.25	4 cores, 8 GB (general-purpose)
+   * - mysql.n4.large.25	4 cores, 16 GB (general-purpose)
+   * - mysql.n8.large.25	4 cores, 32 GB (general-purpose)
+   * - mysql.n2.xlarge.25	8 cores, 16 GB (general-purpose)
+   * - mysql.n4.xlarge.25	8 cores, 32 GB (general-purpose)
+   * - mysql.n8.xlarge.25	8 cores, 64 GB (general-purpose)
+   * - mysql.n2.2xlarge.25	16 cores, 32 GB (general-purpose)
+   * - mysql.n4.2xlarge.25	16 cores, 64 GB (general-purpose)
+   * - mysql.n8.2xlarge.25	16 cores, 128 GB (general-purpose)
+   * 
+   * **Primary instance node specifications (for Standard Edition) (dedicated):**
+   * - mysql.x2.medium.25	2 cores, 4 GB (dedicated)
+   * - mysql.x4.medium.25	2 cores, 8 GB (dedicated)
+   * - mysql.x8.medium.25	2 cores, 16 GB (dedicated)
+   * - mysql.x2.large.25	4 cores, 8 GB (dedicated)
+   * - mysql.x4.large.25	4 cores, 16 GB (dedicated)
+   * - mysql.x8.large.25	4 cores, 32 GB (dedicated)
+   * - mysql.x2.xlarge.25	8 cores, 16 GB (dedicated)
+   * - mysql.x4.xlarge.25	8 cores, 32 GB (dedicated)
+   * - mysql.x8.xlarge.25	8 cores, 64 GB (dedicated)
+   * - mysql.x2.2xlarge.25	16 cores, 32 GB (dedicated)
+   * - mysql.x4.2xlarge.25	16 cores, 64 GB (dedicated)
+   * - mysql.x8.2xlarge.25	16 cores, 128 GB (dedicated)
+   * 
+   * **Read-only instance node specifications (for Standard Edition) general-purpose**	
+   * 
+   * - rds.mysql.s2.xlarge 	2 cores, 8 GB (general-purpose)
+   * - mysqlro.x4.large.1 	4 cores, 16 GB (general-purpose)
+   * - mysqlro.x4.xlarge.1 	8 cores, 32 GB (general-purpose)
+   * - mysqlro.x4.2xlarge.1 	16 cores, 64 GB (general-purpose) 
+   * 
+   * **Read-only instance node specifications (for Standard Edition) dedicated**	
+   * 
+   * - mysqlro.x8.large.1 	4 cores, 32 GB (dedicated) 
+   * - mysqlro.x8.xlarge.1 	8 cores, 64 GB (dedicated) 
+   * - mysqlro.x8.2xlarge.1 	16 cores, 128 GB (dedicated) 
+   * - mysqlro.x4.4xlarge.1 	32 cores, 128 GB (dedicated) 
+   * - mysqlro.x8.4xlarge.1	32 cores, 256 GB (dedicated).
+   * 
    * @example
-   * polarx.x4.xlarge.2e
+   * mysql.n2.medium.25
    */
   targetDBInstanceClass?: string;
   static names(): { [key: string]: string } {

package/src/models/ModifyDbinstanceClassResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyDBInstanceClassResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The order ID. An order is generated when you upgrade, downgrade, or change the specifications of an instance.
+   * 
    * @example
    * 20211103105558
    */
   orderId?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * FEA5DC20-6D8A-5979-97AA-FC57546ADC20
    */

package/src/models/ModifyDbinstanceConfigRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDBInstanceConfigRequest extends $dara.Model {
   /**
    * @remarks
+   * The configuration item to modify. For more information, see [Compute layer variables](https://help.aliyun.com/document_detail/316576.html).
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ModifyDBInstanceConfigRequest extends $dara.Model {
   configName?: string;
   /**
    * @remarks
+   * If configName is set to ENABLE_CONSISTENT_REPLICA_READ, the valid values are "true" and "false".
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class ModifyDBInstanceConfigRequest extends $dara.Model {
   configValue?: string;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,6 +35,8 @@ export class ModifyDBInstanceConfigRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ModifyDbinstanceConfigResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyDBInstanceConfigResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * FEA5DC20-6D8A-5979-97AA-FC57546ADC20
    */

package/src/models/ModifyDbinstanceConnectionStringRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDBInstanceConnectionStringRequest extends $dara.Model {
   /**
    * @remarks
+   * The original connection string.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ModifyDBInstanceConnectionStringRequest extends $dara.Model {
   connectionString?: string;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class ModifyDBInstanceConnectionStringRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * The new port number.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,6 +35,8 @@ export class ModifyDBInstanceConnectionStringRequest extends $dara.Model {
   newPort?: string;
   /**
    * @remarks
+   * The new connection string prefix.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -37,6 +45,8 @@ export class ModifyDBInstanceConnectionStringRequest extends $dara.Model {
   newPrefix?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ModifyDbinstanceConnectionStringResponseBody.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyDBInstanceConnectionStringResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The connection string.
+   * 
    * @example
    * test2.polarx.huhehaote.rds.aliyuncs.com
    */
   connectionString?: string;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * pxc-unrf5ssig0ecg8
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The network type of the connection string.
+   * 
    * @example
    * 1
    */
   DBInstanceNetType?: string;
   /**
+   * @remarks
+   * The port number.
+   * 
    * @example
    * 3300
    */
@@ -52,17 +64,30 @@ export class ModifyDBInstanceConnectionStringResponseBodyData extends $dara.Mode
 
 export class ModifyDBInstanceConnectionStringResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * 200
    */
   code?: number;
+  /**
+   * @remarks
+   * The new connection string information.
+   */
   data?: ModifyDBInstanceConnectionStringResponseBodyData;
   /**
+   * @remarks
+   * The response message. This is typically an error message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID. It is a unique identifier.
+   * 
    * @example
    * c3cf535c-a585-11ea-8263-00163e04d3a7
    */

package/src/models/ModifyDbinstanceDescriptionRequest.ts

@@ -5,11 +5,18 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDBInstanceDescriptionRequest extends $dara.Model {
   /**
    * @remarks
+   * The description of the instance.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 测试实例
    */
   DBInstanceDescription?: string;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -18,6 +25,8 @@ export class ModifyDBInstanceDescriptionRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ModifyDbinstanceDescriptionResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyDBInstanceDescriptionResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * FEA5DC20-6D8A-5979-97AA-FC57546ADC20
    */

package/src/models/ModifyDbinstanceMaintainTimeRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyDBInstanceMaintainTimeRequest extends $dara.Model {
   /**
+   * @remarks
+   * The unique token.
+   * 
    * @example
    * 73559800-3c8c-11ec-bd40-99cfcff3fe1e
    */
   clientToken?: string;
   /**
    * @remarks
+   * The name of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -18,14 +23,18 @@ export class ModifyDBInstanceMaintainTimeRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * The maintenance window in UTC. Valid values: 00:00Z-23:59Z.
+   * 
    * This parameter is required.
    * 
    * @example
-   * 19:00Z-20:00Z
+   * 21:00Z-00:00Z
    */
   maintainTime?: string;
   /**
    * @remarks
+   * The region ID of the instance.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ModifyDbinstanceMaintainTimeResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyDBInstanceMaintainTimeResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The unique request ID.
+   * 
    * @example
    * 73559800-3c8c-11ec-bd40-99cfcff3fe1e
    */

package/src/models/ModifyDbinstanceVipRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDBInstanceVipRequest extends $dara.Model {
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -14,6 +16,8 @@ export class ModifyDBInstanceVipRequest extends $dara.Model {
   instanceClusterName?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -22,6 +26,8 @@ export class ModifyDBInstanceVipRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
+   * The vSwitch ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -30,6 +36,8 @@ export class ModifyDBInstanceVipRequest extends $dara.Model {
   vSwitchId?: string;
   /**
    * @remarks
+   * The ID of the virtual private cloud (VPC) where the access endpoint resides.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ModifyDbinstanceVipResponseBody.ts

@@ -4,16 +4,26 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyDBInstanceVipResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response message.
+   * > This parameter is empty when the request succeeds. When the request fails, an exception message is returned, such as an error code.
+   * 
    * @example
    * *****
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 9B2F3840-5C98-475C-B269-2D5C3A31797C
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/ModifyEngineMigrationRequest.ts

@@ -4,31 +4,54 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyEngineMigrationRequest extends $dara.Model {
   /**
+   * @remarks
+   * The specific endpoints to switch. Set this parameter to a JSON string that contains the pairs of endpoints to swap.
+   * > This parameter takes effect only when SwapConnectionString is set to true.
+   * 
    * @example
    * {\\"pc-bp1m9tt23o5kh834y.rwlb.rds.aliyuncs.com\\":\\"rm-bp1ycl5o6ojs957o0.mysql.rds.aliyuncs.com\\"}
    */
   connectionStrings?: string;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * pxc-htri0****r4k9p
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The name of the new primary instance after the migration is complete.
+   * 
    * @example
    * newmaster789
    */
   newMasterDBInstanceName?: string;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-shanghai
    */
   regionId?: string;
   /**
+   * @remarks
+   * The name of the source database instance.
+   * 
    * @example
    * source456
    */
   sourceDBInstanceName?: string;
   /**
+   * @remarks
+   * Specifies whether to automatically swap connection strings. Valid values:
+   * 
+   * - true: The application does not need to modify its configuration. Connections are automatically directed to the new instance.
+   * 
+   * - false: You must manually update the application endpoint.
+   * 
    * @example
    * true
    */

package/src/models/ModifyEngineMigrationResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyEngineMigrationResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * pxc-*********
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The task ID.
+   * 
    * @example
    * 42292****
    */
@@ -38,17 +44,30 @@ export class ModifyEngineMigrationResponseBodyData extends $dara.Model {
 
 export class ModifyEngineMigrationResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * 200
    */
   code?: string;
+  /**
+   * @remarks
+   * The returned data.
+   */
   data?: ModifyEngineMigrationResponseBodyData;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: string;
   /**
+   * @remarks
+   * The additional information. The value success is returned if the request succeeds. Otherwise, an error code is returned.
+   * 
    * @example
    * Success
    */
@@ -62,6 +81,9 @@ export class ModifyEngineMigrationResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */