@alicloud/polardbx20200202 3.4.2 → 3.5.0

package/src/models/DescribeBackupSetListResponseBody.ts

@@ -4,36 +4,67 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeBackupSetListResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The backup mode. Valid values:
+   * 
+   * - **0**: automatic backup.
+   * - **1**: manual backup.
+   * 
    * @example
    * 0
    */
   backupModel?: number;
   /**
+   * @remarks
+   * The ID of the backup set.
+   * 
    * @example
    * 111
    */
   backupSetId?: string;
   /**
+   * @remarks
+   * The size of the backup set. Unit: bytes.
+   * 
    * @example
    * 88803195
    */
   backupSetSize?: number;
   /**
+   * @remarks
+   * The backup type. Valid values:
+   * 
+   * - **0**: fast backup.
+   * - **1**: consistent backup.
+   * 
    * @example
    * 1
    */
   backupType?: number;
   /**
+   * @remarks
+   * The time when the backup started.
+   * 
    * @example
    * 1635706960956
    */
   beginTime?: number;
   /**
+   * @remarks
+   * The time when the backup ended.
+   * 
    * @example
    * 1635706960956
    */
   endTime?: number;
   /**
+   * @remarks
+   * The status of the backup set. Valid values:
+   * 
+   * - **0**: Being backed up.
+   * - **1**: Backup succeeded.
+   * - **2**: Backup failed.
+   * 
    * @example
    * 1
    */
@@ -72,18 +103,31 @@ export class DescribeBackupSetListResponseBodyData extends $dara.Model {
 }
 
 export class DescribeBackupSetListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data struct.
+   */
   data?: DescribeBackupSetListResponseBodyData[];
   /**
+   * @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
    * 1A6D328C-84B8-40DC-BF49-6C73984D7494
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request is successful.
+   * 
    * @example
    * true
    */

package/src/models/DescribeBackupSetRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeBackupSetRequest extends $dara.Model {
   /**
    * @remarks
+   * The backup set ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,14 +15,26 @@ export class DescribeBackupSetRequest extends $dara.Model {
   backupSetId?: string;
   /**
    * @remarks
+   * The name of the PolarDB-X instance.
+   * 
    * This parameter is required.
    * 
    * @example
    * pxc-htri0ori2r****
    */
   DBInstanceName?: string;
+  /**
+   * @remarks
+   * The destination region for cross-region backup.
+   * 
+   * @example
+   * cn-shanghai
+   */
   destCrossRegion?: string;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-hangzhou
    */

package/src/models/DescribeBackupSetResponseBody.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeBackupSetResponseBodyDataOSSList extends $dara.Model {
   /**
+   * @remarks
+   * The OSS file name.
+   * 
    * @example
    * hins3084_data_20220418110623_qp.xb
    */
   backupSetFile?: string;
   /**
+   * @remarks
+   * The public download URL.
+   * 
    * @example
-   * https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI5tJEmRFdJ8aBPDR7****&Expires=1650441697&dd=7KJzkUSbXf6dwy
+   * https://pre-rdsbak-cn-xxx.oss-cn-beijing.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?OSSAccessKeyId=LTAI****************&Expires=1650441697&dd=7KJzkUSbXf6dwy
    */
   downloadLink?: string;
   /**
+   * @remarks
+   * The internal network download URL for the OSS file.
+   * 
    * @example
    * http://pre-rdsbak-cn-beijing.oss-cn-beijing-internal.aliyuncs.com/custins2255/hins3084_data_20220418110623_qp.xb?
    */
   intranetDownloadLink?: string;
   /**
+   * @remarks
+   * The expiration time of the OSS file link.
+   * 
    * @example
    * 2022-04-20T08:01:37Z
    */
@@ -52,37 +64,72 @@ export class DescribeBackupSetResponseBodyDataOSSList extends $dara.Model {
 
 export class DescribeBackupSetResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The backup mode. Valid values:
+   * 
+   * - **0**: Automatic backup.
+   * - **1**: Manual backup.
+   * 
    * @example
    * 0
    */
   backupModel?: number;
   /**
+   * @remarks
+   * The backup set ID.
+   * 
    * @example
    * 111
    */
   backupSetId?: number;
   /**
+   * @remarks
+   * The size of the backup set, in bytes.
+   * 
    * @example
    * 88803195
    */
   backupSetSize?: number;
   /**
+   * @remarks
+   * The backup type. Valid values:
+   * 
+   * - **0**: Fast backup.
+   * - **1**: Consistent backup.
+   * 
    * @example
    * 1
    */
   backupType?: number;
   /**
+   * @remarks
+   * The time when the backup started.
+   * 
    * @example
    * 1650250861754
    */
   beginTime?: number;
   /**
+   * @remarks
+   * The time when the backup ended.
+   * 
    * @example
    * 1650251308000
    */
   endTime?: number;
+  /**
+   * @remarks
+   * The list of OSS information for the backup set.
+   */
   OSSList?: DescribeBackupSetResponseBodyDataOSSList[];
   /**
+   * @remarks
+   * The status of the backup set. Valid values:
+   * 
+   * - **0**: Backing up.
+   * - **1**: Backup succeeded.
+   * - **2**: Backup failed.
+   * 
    * @example
    * 1
    */
@@ -126,18 +173,31 @@ export class DescribeBackupSetResponseBodyData extends $dara.Model {
 }
 
 export class DescribeBackupSetResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data list.
+   */
   data?: DescribeBackupSetResponseBodyData[];
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * successs
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 1A6D328C-84B8-40DC-BF49-6C73984D7494
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/DescribeBinaryLogListRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeBinaryLogListRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DescribeBinaryLogListRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * The end time for querying the binlog list.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,17 +25,25 @@ export class DescribeBinaryLogListRequest extends $dara.Model {
   endTime?: string;
   instanceName?: string;
   /**
+   * @remarks
+   * The page number when paginating through the current binlog list. Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of binlog entries to return per page. Default value: 30.
+   * 
    * @example
    * 30
    */
   pageSize?: number;
   /**
    * @remarks
+   * The ID of the region where the instance resides.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -40,6 +52,8 @@ export class DescribeBinaryLogListRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
+   * The start time for querying the binlog list.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeBinaryLogListResponseBody.ts

@@ -4,56 +4,96 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeBinaryLogListResponseBodyLogList extends $dara.Model {
   /**
+   * @remarks
+   * The start time of the log.
+   * 
    * @example
    * 2021-09-09 10:27:46
    */
   beginTime?: string;
   /**
+   * @remarks
+   * The creation time of the file.
+   * 
    * @example
    * 2021-09-09 10:27:46
    */
   createdTime?: string;
   /**
+   * @remarks
+   * The download link for the file. The link is valid for 2 days.
+   * 
    * @example
    * http://polarx-cdc-binlog-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/polardbx_cdc/pxc-hzfd132143sfds1/binlog.000001?Expires=1636469502&OSSAccessKeyId=LT13fds12dsafddsf&Signature=fdpm%bdsfadsa%2F%bdsafdsaf%3D
    */
   downloadLink?: string;
   /**
+   * @remarks
+   * The end time of the current binlog.
+   * 
    * @example
    * 2021-11-09 10:27:46
    */
   endTime?: string;
   /**
+   * @remarks
+   * The name of the binlog file.
+   * 
    * @example
    * binlog.000001
    */
   fileName?: string;
   /**
+   * @remarks
+   * The unique ID of the current record.
+   * 
    * @example
    * 100
    */
   id?: number;
   /**
+   * @remarks
+   * The size of the current log file.
+   * 
    * @example
    * 536870912
    */
   logSize?: number;
   /**
+   * @remarks
+   * The last modification time.
+   * 
    * @example
    * 2021-11-09 10:27:46
    */
   modifiedTime?: string;
   /**
+   * @remarks
+   * The purge status. Valid values:
+   * 
+   * - 0: Not deleted.
+   * - 1: Deleted.
+   * 
    * @example
    * 0
    */
   purgeStatus?: number;
   /**
+   * @remarks
+   * The backup host.
+   * 
    * @example
    * 10.110.88.9
    */
   uploadHost?: string;
   /**
+   * @remarks
+   * The backup status. Valid values:
+   * 
+   * - 0: Not backed up.
+   * - 1: Backing up.
+   * - 2: Backed up.
+   * 
    * @example
    * 2
    */
@@ -100,23 +140,39 @@ export class DescribeBinaryLogListResponseBodyLogList extends $dara.Model {
 }
 
 export class DescribeBinaryLogListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of binlog files.
+   */
   logList?: DescribeBinaryLogListResponseBodyLogList[];
   /**
+   * @remarks
+   * The page number of the current query.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of binlog entries displayed on the current page.
+   * 
    * @example
    * 30
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of binlog files found.
+   * 
    * @example
    * 100
    */

package/src/models/DescribeCdcClassListRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCdcClassListRequest extends $dara.Model {
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,12 +14,17 @@ export class DescribeCdcClassListRequest extends $dara.Model {
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The instance name.
+   * 
    * @example
    * pxc-hzrh51fze****pon-cdc
    */
   instanceName?: string;
   /**
    * @remarks
+   * The region in which the instance resides.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeCdcClassListResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeCdcClassListResponseBodyDataClassCodeList extends $dara.Model {
   /**
+   * @remarks
+   * The instance specification.
+   * 
    * @example
    * polarx.n2.small.2e.cdc
    */
   classCode?: string;
   /**
+   * @remarks
+   * The number of CPU cores.
+   * 
    * @example
    * 2
    */
   cpuCore?: string;
   /**
+   * @remarks
+   * The total memory size of the tenant. Unit: GB.
+   * 
    * @example
    * 2048
    */
@@ -74,6 +83,10 @@ export class DescribeCdcClassListResponseBodyData extends $dara.Model {
 }
 
 export class DescribeCdcClassListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data struct.
+   */
   data?: DescribeCdcClassListResponseBodyData;
   /**
    * @remarks

package/src/models/DescribeCdcInfoRequest.ts

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