@alicloud/polardbx20200202 3.4.2 → 3.5.0

package/src/models/DescribeTransformStatusResponseBody.ts

@@ -4,34 +4,68 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeTransformStatusResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the task can be canceled.
+   * 
    * @example
    * true
    */
   canCancel?: boolean;
   /**
+   * @remarks
+   * Indicates whether the current task is completed.
+   * 
    * @example
    * true
    */
   canFinish?: boolean;
+  /**
+   * @remarks
+   * Indicates whether the migration switchover can be performed. Valid values:
+   * - **true**: The migration switchover can be performed.
+   * - **false**: The migration switchover cannot be performed.
+   * 
+   * > This parameter is used by the one-click upgrade feature of PolarDB.
+   */
   canSwitch?: boolean;
+  /**
+   * @remarks
+   * Indicates whether the switchover operation can be reverted.
+   */
   canUndoSwitch?: boolean;
   /**
+   * @remarks
+   * The Enterprise Edition instance name.
+   * 
    * @example
    * pxc-*****
    */
   enterpriseInsName?: string;
   /**
+   * @remarks
+   * The current migration or upgrade phase.
+   * 
    * @example
    * none
    */
   phase?: string;
+  /**
+   * @remarks
+   * The report summary.
+   */
   reportSummary?: { [key: string]: any };
   /**
+   * @remarks
+   * The date when the data report was generated.
+   * 
    * @example
    * 2025-09-02 16:52:47.0
    */
   reportTime?: number;
   /**
+   * @remarks
+   * The standard instance name.
+   * 
    * @example
    * pxc-*****
    */
@@ -77,6 +111,10 @@ export class DescribeTransformStatusResponseBodyData extends $dara.Model {
 }
 
 export class DescribeTransformStatusResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The monitoring data.
+   */
   data?: DescribeTransformStatusResponseBodyData;
   /**
    * @remarks

package/src/models/DescribeUserEncryptionKeyListRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeUserEncryptionKeyListRequest extends $dara.Model {
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * pxc-hzjasd****
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-hangzhou
    */

package/src/models/DescribeUserEncryptionKeyListResponseBody.ts

@@ -3,6 +3,10 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeUserEncryptionKeyListResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The key list.
+   */
   keyIds?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -29,8 +33,15 @@ export class DescribeUserEncryptionKeyListResponseBodyData extends $dara.Model {
 }
 
 export class DescribeUserEncryptionKeyListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned data.
+   */
   data?: DescribeUserEncryptionKeyListResponseBodyData;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * FEA5DC20-6D8A-5979-97AA-FC57546ADC20
    */

package/src/models/DisableRightsSeparationRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DisableRightsSeparationRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the database instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DisableRightsSeparationRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * The name of the DBA account.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class DisableRightsSeparationRequest extends $dara.Model {
   dbaAccountName?: string;
   /**
    * @remarks
+   * The password of the DBA account.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,6 +35,8 @@ export class DisableRightsSeparationRequest extends $dara.Model {
   dbaAccountPassword?: string;
   /**
    * @remarks
+   * The region ID of the instance.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DisableRightsSeparationResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DisableRightsSeparationResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Returns success if the request is successful. Otherwise, returns the corresponding error code.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * The unique request ID.
+   * 
    * @example
    * FE5D94E3-3C93-3594-95D9-AAED2A980915
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request is successful.
+   * 
    * @example
    * true
    */

package/src/models/DisableSqlAuditRequest.ts

@@ -4,17 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DisableSqlAuditRequest extends $dara.Model {
   /**
+   * @remarks
+   * The name of the audit administrator account. > If the three-role mode is enabled, this parameter is required. For more information about the three-role mode, see [Three-role mode](https://help.aliyun.com/document_detail/213824.html).
+   * 
    * @example
    * test_daa
    */
   auditAccountName?: string;
   /**
+   * @remarks
+   * The password of the audit administrator account. > If the three-role mode is enabled, this parameter is required. For more information about the three-role mode, see [Three-role mode](https://help.aliyun.com/document_detail/213824.html).
+   * 
    * @example
    * Pw@11111
    */
   auditAccountPassword?: string;
   /**
    * @remarks
+   * The instance ID. > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/196830.html) operation to query the details of all instances in the specified region, including instance IDs.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -23,6 +31,8 @@ export class DisableSqlAuditRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
+   * The region ID of the instance. > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/196841.html) operation to query the regions supported by PolarDB-X, including region IDs.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DisableSqlAuditResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class DisableSqlAuditResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * DC3DAE3E-0F8A-4596-9104-F5167C******
    */

package/src/models/EnableRightsSeparationRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class EnableRightsSeparationRequest extends $dara.Model {
   /**
+   * @remarks
+   * The description of the audit account.
+   * 
    * @example
    * test123
    */
   auditAccountDescription?: string;
   /**
    * @remarks
+   * The name of the audit account.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -18,6 +23,8 @@ export class EnableRightsSeparationRequest extends $dara.Model {
   auditAccountName?: string;
   /**
    * @remarks
+   * The password of the audit account.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -26,6 +33,8 @@ export class EnableRightsSeparationRequest extends $dara.Model {
   auditAccountPassword?: string;
   /**
    * @remarks
+   * The name of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -34,6 +43,8 @@ export class EnableRightsSeparationRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * The region ID of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -41,12 +52,17 @@ export class EnableRightsSeparationRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The description of the security administrator account.
+   * 
    * @example
    * test123
    */
   securityAccountDescription?: string;
   /**
    * @remarks
+   * The name of the security administrator account.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -55,6 +71,8 @@ export class EnableRightsSeparationRequest extends $dara.Model {
   securityAccountName?: string;
   /**
    * @remarks
+   * The password of the security administrator account.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/EnableRightsSeparationResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class EnableRightsSeparationResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Returns success if the request is successful, or returns the corresponding error code if an error occurs.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * The unique request ID.
+   * 
    * @example
    * 73559800-3c8c-11ec-bd40-99cfcff3fe1e
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request is successful.
+   * 
    * @example
    * true
    */

package/src/models/EnableSqlAuditRequest.ts

@@ -4,17 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class EnableSqlAuditRequest extends $dara.Model {
   /**
+   * @remarks
+   * The name of the audit administrator account. > If the three-authority separation mode is enabled, this parameter is required. For more information about the three-authority separation module, see [Three-authority separation](https://help.aliyun.com/document_detail/213824.html).
+   * 
    * @example
    * test_daa
    */
   auditAccountName?: string;
   /**
+   * @remarks
+   * The password of the audit administrator account. > If the three-authority separation mode is enabled, this parameter is required. For more information about the three-authority separation module, see [Three-authority separation](https://help.aliyun.com/document_detail/213824.html).
+   * 
    * @example
    * Pw@11111
    */
   auditAccountPassword?: string;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -22,12 +30,23 @@ export class EnableSqlAuditRequest extends $dara.Model {
    */
   DBInstanceId?: string;
   /**
+   * @remarks
+   * The number of days to retain audit logs:
+   * 
+   * - 0: Do not retain (i.e., disable automatic log expiration)
+   * 
+   * - >0: Logs are automatically deleted after N days
+   * 
+   * - >Common values: 30, 45, 90, 180, 365
+   * 
    * @example
    * 45
    */
   expireAfterDays?: number;
   /**
    * @remarks
+   * The region where the instance is located.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/EnableSqlAuditResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class EnableSqlAuditResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * DC3ABA3E-0F8A-4596-9104-F5167C******
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/ListTagResourcesRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListTagResourcesRequestTag extends $dara.Model {
   /**
+   * @remarks
+   * The label key.
+   * 
    * @example
    * 1
    */
   key?: string;
   /**
+   * @remarks
+   * The label value.
+   * 
    * @example
    * 2
    */
@@ -38,27 +44,42 @@ export class ListTagResourcesRequestTag extends $dara.Model {
 
 export class ListTagResourcesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The token for the next query. If this parameter is empty, no more results exist.
+   * 
    * @example
    * xxdds
    */
   nextToken?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The resource IDs. You can specify up to 50 subkeys.
+   */
   resourceId?: string[];
   /**
    * @remarks
+   * The resource type. Set this parameter to PolarDBXInstance.
+   * 
    * This parameter is required.
    * 
    * @example
    * PolarDBXInstance
    */
   resourceType?: string;
+  /**
+   * @remarks
+   * The list of labels. You can specify up to 20 subkeys.
+   */
   tag?: ListTagResourcesRequestTag[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListTagResourcesResponseBody.ts

@@ -62,11 +62,17 @@ export class ListTagResourcesResponseBodyTagResources extends $dara.Model {
 
 export class ListTagResourcesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The token for the next query. If this parameter is empty, no more results exist.
+   * 
    * @example
    * xxdd
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * xxxx-xxxxxx
    */

package/src/models/MigrateDbinstanceRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class MigrateDBInstanceRequest extends $dara.Model {
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class MigrateDBInstanceRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * The zone ID of the primary zone for a multi-zone instance. **This parameter is required if you want to create a multi-zone instance.**.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class MigrateDBInstanceRequest extends $dara.Model {
   primaryZoneId?: string;
   /**
    * @remarks
+   * The region ID of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -28,22 +34,40 @@ export class MigrateDBInstanceRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The secondary zone ID.
+   * > This parameter cannot be set to the same value as ZoneId.
+   * 
    * @example
    * cn-beijing-l
    */
   secondaryZoneId?: string;
   /**
+   * @remarks
+   * The switchover mode. Valid values:
+   * 
+   * - 0: immediately switches over.
+   * - 1: switches over within the O&M window.
+   * 
    * @example
    * 0
    */
   switchMode?: string;
   /**
+   * @remarks
+   * The zone ID for Three-zone deployment.
+   * 
    * @example
    * cn-beijing-h
    */
   tertiaryZoneId?: string;
   /**
    * @remarks
+   * The topology type. Valid values:
+   * 
+   * - **3azones**: three-zone deployment.
+   * - **1azone**: single-zone deployment.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -51,11 +75,17 @@ export class MigrateDBInstanceRequest extends $dara.Model {
    */
   topologyType?: string;
   /**
+   * @remarks
+   * The ID of the virtual private cloud (VPC) where the access endpoint resides.
+   * 
    * @example
    * vpc-****
    */
   vpcId?: string;
   /**
+   * @remarks
+   * The vSwitch ID. This parameter is required when you create a DRDS instance of the VPC network type.
+   * 
    * @example
    * vsw-****
    */

package/src/models/MigrateDbinstanceResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class MigrateDBInstanceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Returns success if the request was successful, or an error code if the request failed.
+   * 
    * @example
    * *****
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * FEA5DC20-6D8A-5979-97AA-FC57546ADC20
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/ModifyAccountDescriptionRequest.ts

@@ -3,9 +3,18 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ModifyAccountDescriptionRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The description of the account.
+   * 
+   * @example
+   * 测试账号
+   */
   accountDescription?: string;
   /**
    * @remarks
+   * The name of the instance account.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -14,6 +23,8 @@ export class ModifyAccountDescriptionRequest extends $dara.Model {
   accountName?: string;
   /**
    * @remarks
+   * The name of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -22,6 +33,8 @@ export class ModifyAccountDescriptionRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * The region ID of the instance.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ModifyAccountDescriptionResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyAccountDescriptionResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The additional information returned by the API. "success" is returned if the request is successful. Otherwise, the corresponding error code is returned.
+   * 
    * @example
    * msg
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * FEA5DC20-6D8A-5979-97AA-FC57546ADC20
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request is successful.
+   * 
    * @example
    * true
    */