@alicloud/polardbx20200202 3.4.2 → 3.6.0

package/src/models/DescribeActiveOperationTaskCountRequest.ts

@@ -4,17 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeActiveOperationTaskCountRequest extends $dara.Model {
   /**
+   * @remarks
+   * A reserved parameter. You do not need to specify this parameter.
+   * 
    * @example
    * Category
    */
   category?: string;
   /**
+   * @remarks
+   * The product. Default value: polarx.
+   * 
    * @example
    * polarx
    */
   product?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeActiveOperationTaskCountResponseBody.ts

@@ -4,16 +4,28 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeActiveOperationTaskCountResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether a pop-up notification is required. Valid values:
+   * 
+   * - 1: Required.
+   * - 0: Not required.
+   * 
    * @example
    * 1
    */
   needPop?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * EC7E27FC-58F8-4722-89BB-D1B6D0971956
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number.
+   * 
    * @example
    * 20
    */

package/src/models/DescribeActiveOperationTasksRequest.ts

@@ -4,52 +4,92 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeActiveOperationTasksRequest extends $dara.Model {
   /**
+   * @remarks
+   * Specifies whether cancellation is allowed. Valid values:
+   * - **-1**: All O&M events can be canceled.
+   * - **0**: Not allowed. 
+   * - **1**: Allowed.
+   * 
    * @example
    * -1
    */
   allowCancel?: number;
   /**
+   * @remarks
+   * Specifies whether the time can be modified. Valid values:
+   * 
+   * - **-1**: The time of all O&M events can be modified.
+   * - **0**: Not allowed. 
+   * - **1**: Allowed.
+   * 
    * @example
    * -1
    */
   allowChange?: number;
   /**
+   * @remarks
+   * The change level. Default value: all. Valid values:
+   * 
+   * - **all**: All levels of exception recovery and system O&M.
+   * - **S0**: Exception recovery.
+   * - **S1**: System O&M.
+   * 
    * @example
    * all
    */
   changeLevel?: string;
   /**
+   * @remarks
+   * The database type. Set this parameter to polarx.
+   * 
    * @example
    * polarx
    */
   dbType?: string;
   /**
+   * @remarks
+   * The instance name. Default value: empty string.
+   * 
    * @example
    * pxc-xxxxx
    */
   insName?: string;
   /**
+   * @remarks
+   * The page number. The value must be greater than 0. Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page. Default value: 25.
+   * 
    * @example
    * 25
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The product name. Default value: polarx.
+   * 
    * @example
    * polarx
    */
   productId?: string;
   /**
+   * @remarks
+   * The region.
+   * 
    * @example
    * cn-hangzhou
    */
   region?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -57,11 +97,21 @@ export class DescribeActiveOperationTasksRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The task status. Valid values:
+   * 
+   * - **-1**: All pending and running tasks.  
+   * - **3**: Pending. 
+   * - **4**: Running.
+   * 
    * @example
    * -1
    */
   status?: number;
   /**
+   * @remarks
+   * The task type. A value of all indicates that all tasks of the user are queried. Set this parameter to all.
+   * 
    * @example
    * all
    */

package/src/models/DescribeActiveOperationTasksResponseBody.ts

@@ -4,124 +4,223 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeActiveOperationTasksResponseBodyItems extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether cancellation is allowed. Valid values:
+   * 
+   * - **0**: Not allowed.
+   * - **1**: Allowed.
+   * 
    * @example
    * 0
    */
   allowCancel?: string;
   /**
+   * @remarks
+   * Indicates whether modification is allowed. Valid values:
+   * 
+   * - **0**: Not allowed.
+   * - **1**: Allowed.
+   * 
    * @example
    * 0
    */
   allowChange?: string;
   /**
+   * @remarks
+   * The change level. This parameter can be ignored.
+   * 
    * @example
    * Risk
    */
   changeLevel?: string;
   /**
+   * @remarks
+   * The change level in English.
+   * 
    * @example
    * Risk repairment
    */
   changeLevelEn?: string;
+  /**
+   * @remarks
+   * The change level in Chinese.
+   * 
+   * @example
+   * 风险修复
+   */
   changeLevelZh?: string;
   /**
+   * @remarks
+   * The creation time.
+   * 
    * @example
    * 2021-06-15T16:00:00Z
    */
   createdTime?: string;
   /**
+   * @remarks
+   * The current availability zone.
+   * 
    * @example
    * cn-shanghai-et-a
    */
   currentAVZ?: string;
   /**
+   * @remarks
+   * The database type.
+   * 
    * @example
    * polarx
    */
   dbType?: string;
   /**
+   * @remarks
+   * The database version.
+   * 
    * @example
    * 2.0
    */
   dbVersion?: string;
   /**
+   * @remarks
+   * The deadline.
+   * 
    * @example
    * 2021-06-15T16:00:00Z
    */
   deadline?: string;
   /**
+   * @remarks
+   * The task ID.
+   * 
    * @example
    * 1
    */
   id?: number;
   /**
+   * @remarks
+   * The impact. This parameter is not returned.
+   * 
    * @example
    * --
    */
   impact?: string;
   /**
+   * @remarks
+   * The impact description in English.
+   * 
    * @example
    * Transient instance disconnection
    */
   impactEn?: string;
+  /**
+   * @remarks
+   * The impact description in Chinese.
+   * 
+   * @example
+   * 中断
+   */
   impactZh?: string;
   /**
+   * @remarks
+   * The description.
+   * 
    * @example
    * xxx
    */
   insComment?: string;
   /**
+   * @remarks
+   * The instance name.
+   * 
    * @example
    * pxc-dd
    */
   insName?: string;
   /**
+   * @remarks
+   * The modification time.
+   * 
    * @example
    * 2021-06-15T16:00:00Z
    */
   modifiedTime?: string;
   /**
+   * @remarks
+   * The preparation interval.
+   * 
    * @example
    * 03:00:00
    */
   prepareInterval?: string;
   /**
+   * @remarks
+   * The region.
+   * 
    * @example
    * cn-shanghai-et15-b01
    */
   region?: string;
   /**
+   * @remarks
+   * The result information. This parameter can be ignored.
+   * 
    * @example
    * --
    */
   resultInfo?: string;
   /**
+   * @remarks
+   * The start time.
+   * 
    * @example
    * 2021-06-15T16:00:00Z
    */
   startTime?: string;
   /**
+   * @remarks
+   * The status. Valid values:
+   * 
+   * - **3**: Pending. 
+   * - **4**: Running.
+   * 
    * @example
    * 3
    */
   status?: number;
+  /**
+   * @remarks
+   * The list of child instances.
+   */
   subInsNames?: string[];
   /**
+   * @remarks
+   * The switchover time.
+   * 
    * @example
    * 2021-06-15T16:00:00Z
    */
   switchTime?: string;
   /**
+   * @remarks
+   * The task type.
+   * 
    * @example
    * rds_apsaradb_transfer
    */
   taskType?: string;
   /**
+   * @remarks
+   * The task type in English. This parameter can be ignored.
+   * 
    * @example
    * --
    */
   taskTypeEn?: string;
   /**
+   * @remarks
+   * The task type in Chinese. This parameter can be ignored.
+   * 
    * @example
    * --
    */
@@ -203,23 +302,39 @@ export class DescribeActiveOperationTasksResponseBodyItems extends $dara.Model {
 }
 
 export class DescribeActiveOperationTasksResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of parameters.
+   */
   items?: DescribeActiveOperationTasksResponseBodyItems[];
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 12
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * xxxx
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of records.
+   * 
    * @example
    * 23
    */

package/src/models/DescribeArchiveTableListRequest.ts

@@ -10,6 +10,8 @@ export class DescribeArchiveTableListRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * The page number. Pages start from 1.
+   * 
    * This parameter is required.
    */
   pageIndex?: number;

package/src/models/DescribeArchiveTableListResponseBody.ts

@@ -4,11 +4,31 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeArchiveTableListResponseBodyDataTables extends $dara.Model {
   archiveStatus?: string;
+  /**
+   * @remarks
+   * The time when the table was created.
+   */
   createdDate?: number;
+  /**
+   * @remarks
+   * The number of files.
+   */
   fileCount?: number;
   lastSuccessArchiveTime?: number;
+  /**
+   * @remarks
+   * The database name.
+   */
   schemaName?: string;
+  /**
+   * @remarks
+   * The space occupied by the table.
+   */
   spaceSize?: number;
+  /**
+   * @remarks
+   * The table name.
+   */
   tableName?: string;
   static names(): { [key: string]: string } {
     return {
@@ -44,13 +64,25 @@ export class DescribeArchiveTableListResponseBodyDataTables extends $dara.Model
 }
 
 export class DescribeArchiveTableListResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The page number.
+   */
   pageIndex?: number;
+  /**
+   * @remarks
+   * The number of entries per page.
+   */
   pageSize?: number;
   pausedCount?: number;
   runningCount?: number;
   successCount?: number;
   tables?: DescribeArchiveTableListResponseBodyDataTables[];
   tobeArchivedConut?: number;
+  /**
+   * @remarks
+   * The total number of entries.
+   */
   total?: number;
   static names(): { [key: string]: string } {
     return {
@@ -91,7 +123,15 @@ export class DescribeArchiveTableListResponseBodyData extends $dara.Model {
 }
 
 export class DescribeArchiveTableListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data returned.
+   */
   data?: DescribeArchiveTableListResponseBodyData;
+  /**
+   * @remarks
+   * requestId
+   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeAvailableCrossRegionsRequest.ts

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

package/src/models/DescribeAvailableCrossRegionsResponseBody.ts

@@ -3,6 +3,10 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeAvailableCrossRegionsResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The instance ID.
+   */
   regions?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -29,8 +33,15 @@ export class DescribeAvailableCrossRegionsResponseBodyData extends $dara.Model {
 }
 
 export class DescribeAvailableCrossRegionsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The parameter details.
+   */
   data?: DescribeAvailableCrossRegionsResponseBodyData[];
   /**
+   * @remarks
+   * The additional information returned. If the request is successful, success is returned. If the request fails, the corresponding error code is returned.
+   * 
    * @example
    * *****
    */
@@ -44,6 +55,9 @@ export class DescribeAvailableCrossRegionsResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request is successful.
+   * 
    * @example
    * true
    */

package/src/models/DescribeBackupPolicyRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeBackupPolicyRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DescribeBackupPolicyRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * The ID of the region where the instance resides.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeBackupPolicyResponseBody.ts

@@ -83,18 +83,31 @@ export class DescribeBackupPolicyResponseBodyData extends $dara.Model {
 }
 
 export class DescribeBackupPolicyResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response body.
+   */
   data?: DescribeBackupPolicyResponseBodyData;
   /**
+   * @remarks
+   * The response message. "success" is returned if the request is successful. Otherwise, an error code is returned.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * B87E2AB3-B7C9-4394-9160-7F639F732031
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request is successful.
+   * 
    * @example
    * true
    */

package/src/models/DescribeBackupSetListRequest.ts

@@ -5,30 +5,50 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeBackupSetListRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
    * pxc-xxxxxx
    */
   DBInstanceName?: string;
+  /**
+   * @remarks
+   * The region where the backup sets reside. If you specify this parameter, backup sets in the specified region are returned. You can specify only one region at a time.
+   * 
+   * @example
+   * cn-hangzhou
+   */
   destCrossRegion?: string;
   /**
+   * @remarks
+   * The end time. Specify a UNIX timestamp in milliseconds.
+   * 
    * @example
    * 1635707845000
    */
   endTime?: number;
   /**
+   * @remarks
+   * The page number. The value starts from 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 30
    */
   pageSize?: number;
   /**
    * @remarks
+   * The ID of the region where the instance resides.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -36,6 +56,9 @@ export class DescribeBackupSetListRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The start time. Specify a UNIX timestamp in milliseconds.
+   * 
    * @example
    * 1635707845000
    */