@alicloud/polardbx20200202 3.4.2 → 3.6.0

package/src/models/StopDataImportTaskResponseBody.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class StopDataImportTaskResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the import task is successful.
+   * 
    * @example
    * true
    */
   data?: boolean;
   /**
+   * @remarks
+   * The response message. >This parameter is empty if the request is successful. If the request fails, an error message is returned, such as an error code.
+   * 
    * @example
    * *****
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 14036EBE-***-44DB-ACE9-AC6157D3A6FC
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request is successful.
+   * 
    * @example
    * true
    */

package/src/models/SubmitSqlFlashbackTaskRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class SubmitSqlFlashbackTaskRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the database.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class SubmitSqlFlashbackTaskRequest extends $dara.Model {
   dbName?: string;
   /**
    * @remarks
+   * The end time for executing the flashback SQL.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class SubmitSqlFlashbackTaskRequest extends $dara.Model {
   endTime?: string;
   /**
    * @remarks
+   * The instance ID of the PolarDB-X instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,6 +35,11 @@ export class SubmitSqlFlashbackTaskRequest extends $dara.Model {
   polardbxInstanceId?: string;
   /**
    * @remarks
+   * The restoration type. Valid values:
+   * 
+   * - **1**: Image-based restoration.
+   * - **0**: Reverse restoration.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -36,6 +47,12 @@ export class SubmitSqlFlashbackTaskRequest extends $dara.Model {
    */
   recallRestoreType?: string;
   /**
+   * @remarks
+   * The matching mode. Valid values:
+   * 
+   * - **0**: exact match.
+   * - **1**: fuzzy match.
+   * 
    * @example
    * 0
    * 
@@ -45,6 +62,8 @@ export class SubmitSqlFlashbackTaskRequest extends $dara.Model {
   recallType?: string;
   /**
    * @remarks
+   * The region where the instance resides.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -52,6 +71,9 @@ export class SubmitSqlFlashbackTaskRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The primary key of the flashback SQL.
+   * 
    * @example
    * 1111
    * 
@@ -60,6 +82,9 @@ export class SubmitSqlFlashbackTaskRequest extends $dara.Model {
    */
   sqlPk?: string;
   /**
+   * @remarks
+   * The type of SQL. Valid values: INSERT, UPDATE, and DELETE. Separate multiple types with commas (,).
+   * 
    * @example
    * INSERT,UPDATE
    * 
@@ -69,6 +94,8 @@ export class SubmitSqlFlashbackTaskRequest extends $dara.Model {
   sqlType?: string;
   /**
    * @remarks
+   * The start time for executing the flashback SQL.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -76,6 +103,9 @@ export class SubmitSqlFlashbackTaskRequest extends $dara.Model {
    */
   startTime?: string;
   /**
+   * @remarks
+   * The name of the table on which the flashback SQL operation is performed.
+   * 
    * @example
    * test
    * 
@@ -84,6 +114,9 @@ export class SubmitSqlFlashbackTaskRequest extends $dara.Model {
    */
   tableName?: string;
   /**
+   * @remarks
+   * The trace ID of the flashback SQL.
+   * 
    * @example
    * ase*****
    * 

package/src/models/SubmitSqlFlashbackTaskResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class SubmitSqlFlashbackTaskResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The task ID.
+   * 
    * @example
    * 1111
    */
@@ -30,18 +33,31 @@ export class SubmitSqlFlashbackTaskResponseBodyData extends $dara.Model {
 }
 
 export class SubmitSqlFlashbackTaskResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data returned by the request.
+   */
   data?: SubmitSqlFlashbackTaskResponseBodyData;
   /**
+   * @remarks
+   * The description of the request result.
+   * 
    * @example
    * OK
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 1AD222E9-E606-4A42-BF6D-8A4442913CEF
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the API request was successful.
+   * 
    * @example
    * true
    */

package/src/models/SwitchGdnMemberRoleRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class SwitchGdnMemberRoleRequest extends $dara.Model {
   /**
    * @remarks
+   * The instance ID of the primary instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -16,6 +18,8 @@ export class SwitchGdnMemberRoleRequest extends $dara.Model {
   isModifyEndpoint?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -26,9 +30,22 @@ export class SwitchGdnMemberRoleRequest extends $dara.Model {
   srcMainPort?: string;
   /**
    * @remarks
+   * The switchover mode.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 常规切换：switch_over
+   * 强制切换：fail_over
    */
   switchMode?: string;
+  /**
+   * @remarks
+   * The timeout period of the switchover task. Unit: seconds.
+   * 
+   * @example
+   * 10
+   */
   taskTimeout?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/SwitchGdnMemberRoleResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class SwitchGdnMemberRoleResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The task ID.
+   * 
    * @example
    * 2209883
    */
@@ -30,8 +33,15 @@ export class SwitchGdnMemberRoleResponseBodyData extends $dara.Model {
 }
 
 export class SwitchGdnMemberRoleResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data struct.
+   */
   data?: SwitchGdnMemberRoleResponseBodyData;
   /**
+   * @remarks
+   * The additional information returned. If the request is successful, success is returned. If the request fails, the corresponding error code is returned.
+   * 
    * @example
    * success
    */
@@ -45,6 +55,9 @@ export class SwitchGdnMemberRoleResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request is successful.
+   * 
    * @example
    * true
    */

package/src/models/TagResourcesRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class TagResourcesRequestTag extends $dara.Model {
   /**
+   * @remarks
+   * The tag key.
+   * 
    * @example
    * 12
    */
   key?: string;
   /**
+   * @remarks
+   * The tag value.
+   * 
    * @example
    * 22
    */
@@ -39,6 +45,8 @@ export class TagResourcesRequestTag extends $dara.Model {
 export class TagResourcesRequest extends $dara.Model {
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -47,11 +55,15 @@ export class TagResourcesRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
+   * The resource IDs. You can specify up to 50 resource IDs.
+   * 
    * This parameter is required.
    */
   resourceId?: string[];
   /**
    * @remarks
+   * The resource type. Set this parameter to PolarDBXInstance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -60,6 +72,8 @@ export class TagResourcesRequest extends $dara.Model {
   resourceType?: string;
   /**
    * @remarks
+   * The tags. You can specify up to 20 tags.
+   * 
    * This parameter is required.
    */
   tag?: TagResourcesRequestTag[];

package/src/models/UntagResourcesRequest.ts

@@ -3,9 +3,18 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UntagResourcesRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to delete all tags. This parameter is valid only when TagKey.N is empty. Valid values: true, false, True, and False. Default value: false.
+   * 
+   * @example
+   * 是否全部删除
+   */
   all?: boolean;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -14,17 +23,25 @@ export class UntagResourcesRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
+   * The resource IDs. A maximum of 50 subkeys are supported.
+   * 
    * This parameter is required.
    */
   resourceId?: string[];
   /**
    * @remarks
+   * The resource type. Set this parameter to PolarDBXInstance.
+   * 
    * This parameter is required.
    * 
    * @example
    * PolarDBXInstance
    */
   resourceType?: string;
+  /**
+   * @remarks
+   * The tag keys. A maximum of 20 subkeys are supported.
+   */
   tagKey?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateBackupPolicyRequest.ts

@@ -4,77 +4,170 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateBackupPolicyRequest extends $dara.Model {
   /**
+   * @remarks
+   * The backup cycle. You must specify at least 2 days. The value is a 7-digit number. From left to right, each digit indicates whether backup is enabled from Monday to Sunday. A value of 0 indicates that backup is disabled, and a value of 1 indicates that backup is enabled:
+   * 
+   * - First digit: Monday
+   * - Second digit: Tuesday
+   * - Third digit: Wednesday
+   * - Fourth digit: Thursday
+   * - Fifth digit: Friday
+   * - Sixth digit: Saturday
+   * - Seventh digit: Sunday.
+   * 
    * @example
    * 1001000
    */
   backupPeriod?: string;
   /**
+   * @remarks
+   * The start time of the daily backup, in UTC.
+   * 
    * @example
    * 03:00Z
    */
   backupPlanBegin?: string;
   /**
+   * @remarks
+   * The retention period of backup sets. Unit: days.
+   * 
    * @example
    * 30
    */
   backupSetRetention?: number;
   /**
+   * @remarks
+   * The backup type. Currently, only "0" is supported, which indicates fast backup.
+   * 
    * @example
    * 0
    */
   backupType?: string;
   /**
+   * @remarks
+   * The backup method. Valid values:
+   * 
+   * - **P**: physical backup
+   * - **L**: logical backup.
+   * 
    * @example
    * P
    */
   backupWay?: string;
   /**
+   * @remarks
+   * The interval for cold data backups. Unit: days. Valid values: 1 to 59.
+   * 
    * @example
    * 30
    */
   coldDataBackupInterval?: number;
   /**
+   * @remarks
+   * The retention period for cold data backups. Unit: days. Valid values: 30 to 730.
+   * 
    * @example
    * 30
    */
   coldDataBackupRetention?: number;
+  /**
+   * @remarks
+   * The retention period for cross-region data backups. Unit: days.
+   * 
+   * @example
+   * 30
+   */
   crossRegionDataBackupRetention?: number;
   crossRegionFilterValue?: string;
+  /**
+   * @remarks
+   * The retention period for cross-region log backups. Unit: days.
+   * 
+   * @example
+   * 30
+   */
   crossRegionLogBackupRetention?: number;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
    * pxc-hzjasdyuoo
    */
   DBInstanceName?: string;
+  /**
+   * @remarks
+   * The destination region for cross-region backup.
+   * 
+   * @example
+   * cn-shanghai
+   */
   destCrossRegion?: string;
   /**
+   * @remarks
+   * Specifies whether to forcibly clean up binary logs when the total space usage of the instance exceeds 80% or the remaining space is less than 50 GB. The cleanup starts from the earliest logs until the total space usage drops below 80% and the remaining space exceeds 50 GB. Valid values:
+   * 
+   * - **1**: yes
+   * - **0**: no.
+   * 
    * @example
    * 1
    */
   forceCleanOnHighSpaceUsage?: number;
+  /**
+   * @remarks
+   * Specifies whether to enable cross-region data backup. Default value: false.
+   * 
+   * @example
+   * false
+   */
   isCrossRegionDataBackupEnabled?: boolean;
+  /**
+   * @remarks
+   * Specifies whether to enable cross-region log backup. Default value: false.
+   * 
+   * @example
+   * false
+   */
   isCrossRegionLogBackupEnabled?: boolean;
   /**
+   * @remarks
+   * Specifies whether to enable backup. The value is fixed to 1, which indicates that backup is enabled.
+   * 
    * @example
    * 1
    */
   isEnabled?: number;
   /**
+   * @remarks
+   * The number of hours that log backups are retained locally. Valid values: 0 to 168 (7 × 24 hours). A value of 0 indicates that log backups are not retained locally. Default value: 7.
+   * 
    * @example
    * 7
    */
   localLogRetention?: number;
+  /**
+   * @remarks
+   * The number of binary logs retained locally. Default value: 60. Valid values: 6 to 100.
+   * 
+   * @example
+   * 60
+   */
   localLogRetentionNumber?: number;
   /**
+   * @remarks
+   * The maximum space usage for binary logs, expressed as a percentage. Valid values: 0 to 50. This parameter specifies a loop space. Default value: 30.
+   * 
    * @example
    * 30
    */
   logLocalRetentionSpace?: number;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -82,6 +175,9 @@ export class UpdateBackupPolicyRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The number of days that log backups are retained remotely. Valid values: 7 to 730. Unit: days. Default value: 7.
+   * 
    * @example
    * 7
    */

package/src/models/UpdateBackupPolicyResponseBody.ts

@@ -83,18 +83,31 @@ export class UpdateBackupPolicyResponseBodyData extends $dara.Model {
 }
 
 export class UpdateBackupPolicyResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The details of the backup policy.
+   */
   data?: UpdateBackupPolicyResponseBodyData;
   /**
+   * @remarks
+   * The response message. The value success is returned if the request is successful. Otherwise, the corresponding error code is returned.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * FEA5DC20-6D8A-5979-97AA-FC57546ADC20
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request is successful.
+   * 
    * @example
    * true
    */

package/src/models/UpdateCustinsParamRequest.ts

@@ -14,6 +14,9 @@ export class UpdateCustinsParamRequest extends $dara.Model {
   /**
    * @remarks
    * This parameter is required.
+   * 
+   * @example
+   * 数仓抽数地址
    */
   name?: string;
   /**

package/src/models/UpdateCustinsParamResponseBody.ts

@@ -32,9 +32,6 @@ export class UpdateCustinsParamResponseBodyData extends $dara.Model {
 export class UpdateCustinsParamResponseBody extends $dara.Model {
   data?: UpdateCustinsParamResponseBodyData;
   /**
-   * @remarks
-   * Id of the request
-   * 
    * @example
    * 73559800-3c8c-****-bd40-99cfcff3fe1e
    */

package/src/models/UpdateDbinstanceSslrequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateDBInstanceSSLRequest extends $dara.Model {
   /**
+   * @remarks
+   * The domain name bound to the certificate.
+   * 
    * @example
    * pxc-hzrqjarxdocd4t.polarx.rds.aliyuncs.com
    */
   certCommonName?: string;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -18,6 +23,8 @@ export class UpdateDBInstanceSSLRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * Specifies whether to enable SSL.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -25,6 +32,9 @@ export class UpdateDBInstanceSSLRequest extends $dara.Model {
    */
   enableSSL?: boolean;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-hangzhou
    */

package/src/models/UpdateDbinstanceSslresponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateDBInstanceSSLResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The backend task ID.
+   * 
    * @example
    * 2209883
    */
@@ -30,8 +33,15 @@ export class UpdateDBInstanceSSLResponseBodyData extends $dara.Model {
 }
 
 export class UpdateDBInstanceSSLResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data returned by the request.
+   */
   data?: UpdateDBInstanceSSLResponseBodyData;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * FEA5DC20-6D8A-5979-97AA-FC57546ADC20
    */

package/src/models/UpdateDbinstanceTderequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateDBInstanceTDERequest extends $dara.Model {
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,12 +14,17 @@ export class UpdateDBInstanceTDERequest extends $dara.Model {
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The custom key ID. If you do not specify this parameter, a key is automatically generated by the backend.
+   * 
    * @example
    * RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******
    */
   encryptionKey?: string;
   /**
    * @remarks
+   * The region ID of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -25,12 +32,17 @@ export class UpdateDBInstanceTDERequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The global resource descriptor of the role, used to specify a specific role. For details, see RAM role overview.
+   * 
    * @example
    * acs:ram::1406926****:role/aliyunrdsinstanceencryptiondefaultrole
    */
   roleArn?: string;
   /**
    * @remarks
+   * Enables TDE. Set this parameter to 1.
+   * 
    * This parameter is required.
    * 
    * @example