@alicloud/polardb20170801 8.2.4 → 8.3.0

package/src/models/ModifyBackupPolicyShrinkRequest.ts

@@ -5,32 +5,24 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyBackupPolicyShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The advanced backup policies.
-   * 
-   * > - - This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
-   * >
-   * > - - This parameter is supported only for clusters for which `BackupPolicyLevel` is set to `Advanced`.
+   * The advanced backup policy.
+   * > * * PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter.
+   * > * * Only clusters with BackupPolicyLevel set to Advanced support this parameter.
    */
   advancedDataPoliciesShrink?: string;
   /**
    * @remarks
    * The backup frequency. Valid values:
    * 
-   * - **Normal** (default): standard backup. The cluster is backed up once a day.
-   * 
-   * - **2/24H**: high-frequency backup. The cluster is backed up every 2 hours.
-   * 
-   * - **3/24H**: high-frequency backup. The cluster is backed up every 3 hours.
+   * - **Normal** (default): regular backup. Automatic backup is performed once a day at a scheduled time.
+   * - **2/24H**: high-frequency backup. Backup is performed every 2 hours.
+   * - **3/24H**: high-frequency backup. Backup is performed every 3 hours.
+   * - **4/24H**: high-frequency backup. Backup is performed every 4 hours.
    * 
-   * - **4/24H**: high-frequency backup. The cluster is backed up every 4 hours.
-   * 
-   * > * * If you enable high-frequency backup, all backups completed within the last 24 hours are retained. For backups older than 24 hours, the system retains only the first backup completed after 00:00 each day and deletes the rest.
-   * >
-   * > * - If you enable high-frequency backup, the **PreferredBackupPeriod** parameter is automatically set to all days of the week (from Monday to Sunday).
-   * >
-   * > * - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
-   * >
-   * > * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+   * > * * After high-frequency backup is enabled, all backups completed within 24 hours are retained. For backups older than 24 hours, only the first backup completed after 00:00 each day is retained, and all others are deleted.
+   * > * * After high-frequency backup is enabled, the backup cycle parameter PreferredBackupPeriod defaults to all days of the week (Monday through Sunday).
+   * > * * If the region of your PolarDB for MySQL cluster supports the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
+   * > * * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
    * 
    * @example
    * Normal
@@ -38,17 +30,12 @@ export class ModifyBackupPolicyShrinkRequest extends $dara.Model {
   backupFrequency?: string;
   /**
    * @remarks
-   * The level of the backup policy. Valid values:
-   * 
-   * - **Normal**: standard backup
-   * 
-   * - **Advanced**: advanced backup
-   * 
-   * > * * This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
-   * >
-   * > * - Check the `AdvancedPolicyOption` parameter in the response of the [DescribeBackupPolicy](https://help.aliyun.com/document_detail/2319231.html) operation to determine whether the cluster supports advanced backup. If the cluster supports advanced backup, you can request this feature in [Advanced backup settings](~611727~~).
-   * >
-   * > * - After you enable advanced backup, you **cannot** switch back to standard backup.
+   * The backup policy level. Valid values:
+   * * **Normal**: regular backup.
+   * * **Advanced**: advanced backup.
+   * > * * PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter.
+   * > * * You can check the AdvancedPolicyOption response parameter of the [DescribeBackupPolicy](https://help.aliyun.com/document_detail/2319231.html) operation to determine whether the cluster supports advanced backup. If the cluster supports advanced backup, you can apply to use this feature through [Advanced backup settings](~611727~~).
+   * > * * After advanced backup is enabled, rollback to regular backup is **not supported**.
    * 
    * @example
    * Normal
@@ -56,15 +43,15 @@ export class ModifyBackupPolicyShrinkRequest extends $dara.Model {
   backupPolicyLevel?: string;
   /**
    * @remarks
-   * Specifies whether to retain backups when you delete the cluster. Valid values:
+   * Specifies whether to retain backups when the cluster is deleted. Valid values:
    * 
-   * - **ALL**: Permanently retains all backups.
+   * - **ALL**: Long-term retention (LTR) of all backups.
    * 
-   * - **LATEST**: Permanently retains the last backup.
+   * - **LATEST**: Long-term retention (LTR) of only the last backup.
    * 
-   * - **NONE**: Does not retain backup sets.
+   * - **NONE**: Does not retain any backups.
    * 
-   * > The default value is `NONE`.
+   * > Default value: NONE.
    * 
    * @example
    * NONE
@@ -74,7 +61,7 @@ export class ModifyBackupPolicyShrinkRequest extends $dara.Model {
    * @remarks
    * The cluster ID.
    * 
-   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to query the details of all clusters in a specified region, including the cluster IDs.
+   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to query information about all clusters in a specific region, including cluster IDs.
    * 
    * This parameter is required.
    * 
@@ -86,19 +73,14 @@ export class ModifyBackupPolicyShrinkRequest extends $dara.Model {
    * @remarks
    * The backup frequency. Valid values:
    * 
-   * - **Normal** (default): standard backup. The cluster is backed up once a day.
-   * 
-   * - **2/24H**: high-frequency backup. The cluster is backed up every 2 hours.
-   * 
-   * - **3/24H**: high-frequency backup. The cluster is backed up every 3 hours.
+   * - **Normal** (default): regular backup. Automatic backup is performed once a day at a scheduled time.
+   * - **2/24H**: high-frequency backup. Backup is performed every 2 hours.
+   * - **3/24H**: high-frequency backup. Backup is performed every 3 hours.
+   * - **4/24H**: high-frequency backup. Backup is performed every 4 hours.
    * 
-   * - **4/24H**: high-frequency backup. The cluster is backed up every 4 hours.
-   * 
-   * > * * This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
-   * >
-   * > * - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
-   * >
-   * > * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+   * > * * PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter.
+   * > * * If the region of your PolarDB for MySQL cluster does not support the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
+   * > * * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
    * 
    * @example
    * Normal
@@ -106,29 +88,19 @@ export class ModifyBackupPolicyShrinkRequest extends $dara.Model {
   dataLevel1BackupFrequency?: string;
   /**
    * @remarks
-   * The level-1 backup cycle. Valid values:
-   * 
-   * - **Monday**
-   * 
-   * - **Tuesday**
-   * 
-   * - **Wednesday**
-   * 
-   * - **Thursday**
-   * 
-   * - **Friday**
-   * 
-   * - **Saturday**
-   * 
-   * - **Sunday**
-   * 
-   * > * * You must select at least two days. Separate multiple values with commas.
-   * >
-   * > * - This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
-   * >
-   * > * - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
-   * >
-   * > * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+   * The level-1 backup cycle. Valid values: 
+   * * **Monday**
+   * * **Tuesday**
+   * * **Wednesday**
+   * * **Thursday**
+   * * **Friday**
+   * * **Saturday**
+   * * **Sunday**
+   * 
+   * > * * Select at least 2 days. Separate multiple values with commas (,).
+   * > * * PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter.
+   * > * * If the region of your PolarDB for MySQL cluster does not support the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
+   * > * * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
    * 
    * @example
    * Monday,Tuesday
@@ -136,9 +108,9 @@ export class ModifyBackupPolicyShrinkRequest extends $dara.Model {
   dataLevel1BackupPeriod?: string;
   /**
    * @remarks
-   * The retention period for level-1 backups, in days. Valid values: 3 to 14.
+   * The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.
    * 
-   * > - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+   * > * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
    * 
    * @example
    * 3
@@ -146,11 +118,10 @@ export class ModifyBackupPolicyShrinkRequest extends $dara.Model {
   dataLevel1BackupRetentionPeriod?: string;
   /**
    * @remarks
-   * The time window for automatic backups. Specify the time in UTC and in the `hh:mmZ-hh:mmZ` format. The time window must be a one-hour period that starts on the hour. For example, `14:00Z-15:00Z`.
+   * The time period during which automatic backup is performed. Specify the time period in the `hh:mmZ-hh:mmZ` format in UTC. The values must be on the hour with an interval of 1 hour, such as `14:00Z-15:00Z`.
    * 
-   * > - This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
-   * >
-   * > - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
+   * > * PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter.
+   * > * If the region of your PolarDB for MySQL cluster does not support the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
    * 
    * @example
    * 15:00Z-16:00Z
@@ -158,9 +129,8 @@ export class ModifyBackupPolicyShrinkRequest extends $dara.Model {
   dataLevel1BackupTime?: string;
   /**
    * @remarks
-   * The destination region for the cross-region level-2 backup. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
-   * 
-   * > - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+   * The destination region for cross-region level-2 backups. For regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
+   * > * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
    * 
    * @example
    * cn-hangzhou
@@ -168,17 +138,16 @@ export class ModifyBackupPolicyShrinkRequest extends $dara.Model {
   dataLevel2BackupAnotherRegionRegion?: string;
   /**
    * @remarks
-   * The retention period of cross-region level-2 backups. Valid values:
+   * The retention period of cross-region backups for level-2 backups. Valid values:
    * 
-   * - **0**: Disables the cross-region level-2 backup feature.
+   * - **0**: Disables the level-2 cross-region backup feature.
    * 
-   * - **30 to 7300**: The retention period of cross-region level-2 backups, in days.
+   * - **30 to 7300**: The retention period of level-2 backups. Unit: days.
    * 
-   * - **-1**: Cross-region level-2 backups are permanently retained.
+   * - **-1**: Long-term retention (LTR) of level-2 backups.
    * 
-   * > * * When you create a cluster, the default value is **0**, which disables the cross-region level-2 backup feature.
-   * >
-   * > * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+   *  > * * When a cluster is created, the default value is **0**, which means the level-2 cross-region backup feature is disabled.
+   * > * * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
    * 
    * @example
    * 30
@@ -186,29 +155,19 @@ export class ModifyBackupPolicyShrinkRequest extends $dara.Model {
   dataLevel2BackupAnotherRegionRetentionPeriod?: string;
   /**
    * @remarks
-   * The level-2 backup cycle. Valid values:
-   * 
-   * - **Monday**
-   * 
-   * - **Tuesday**
-   * 
-   * - **Wednesday**
-   * 
-   * - **Thursday**
-   * 
-   * - **Friday**
-   * 
-   * - **Saturday**
-   * 
-   * - **Sunday**
-   * 
-   * > * * You must select at least two days. Separate multiple values with commas.
-   * >
-   * > * - This parameter is not supported for PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
-   * >
-   * > * - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
-   * >
-   * > * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+   * The level-2 backup cycle. Valid values: 
+   * * **Monday**
+   * * **Tuesday**
+   * * **Wednesday**
+   * * **Thursday**
+   * * **Friday**
+   * * **Saturday**
+   * * **Sunday**
+   * 
+   * > * * Select at least 2 days. Separate multiple values with commas (,).
+   * > * * PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter.
+   * > * * If the region of your PolarDB for MySQL cluster does not support the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
+   * > * * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
    * 
    * @example
    * Monday,Tuesday
@@ -220,13 +179,12 @@ export class ModifyBackupPolicyShrinkRequest extends $dara.Model {
    * 
    * - **0**: Disables the level-2 backup feature.
    * 
-   * - **30 to 7300**: The retention period of level-2 backups, in days.
+   * - **30 to 7300**: The retention period of level-2 backups. Unit: days.
    * 
-   * - **-1**: Level-2 backups are permanently retained.
+   * - **-1**: Long-term retention (LTR) of level-2 backups.
    * 
-   * > * * When you create a cluster, the default value is **0**, which disables the level-2 backup feature.
-   * >
-   * > * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+   *  > * * When a cluster is created, the default value is **0**, which means the level-2 backup feature is disabled.
+   * > * * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
    * 
    * @example
    * 0
@@ -236,27 +194,18 @@ export class ModifyBackupPolicyShrinkRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The backup cycle. Valid values:
-   * 
-   * - **Monday**
-   * 
-   * - **Tuesday**
-   * 
-   * - **Wednesday**
-   * 
-   * - **Thursday**
-   * 
-   * - **Friday**
-   * 
-   * - **Saturday**
-   * 
-   * - **Sunday**
-   * 
-   * > * * You must select at least two days. Separate multiple values with commas.
-   * >
-   * > * - This parameter is not supported if your PolarDB for MySQL cluster is in a region that supports the cross-region backup feature. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
-   * >
-   * > * - After you enable advanced backup, this parameter is no longer effective. Use the `AdvancedDataPolicies` parameter instead.
+   * The backup cycle. Valid values: 
+   * * **Monday**
+   * * **Tuesday**
+   * * **Wednesday**
+   * * **Thursday**
+   * * **Friday**
+   * * **Saturday**
+   * * **Sunday**
+   * 
+   * > * * Select at least 2 days. Separate multiple values with commas (,).
+   * > * * If the region of your PolarDB for MySQL cluster supports the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
+   * > * * After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.
    * 
    * @example
    * Monday,Tuesday
@@ -264,7 +213,7 @@ export class ModifyBackupPolicyShrinkRequest extends $dara.Model {
   preferredBackupPeriod?: string;
   /**
    * @remarks
-   * The time window for automatic backups. Specify the time in UTC and in the `hh:mmZ-hh:mmZ` format. The time window must be a one-hour period that starts on the hour. For example, `14:00Z-15:00Z`.
+   * The time period during which automatic backup is performed. Specify the time period in the `hh:mmZ-hh:mmZ` format in UTC. The values must be on the hour with an interval of 1 hour, such as `14:00Z-15:00Z`.
    * 
    * @example
    * 15:00Z-16:00Z

package/src/models/RegisterKnowledgeBaseFileRequest.ts

@@ -0,0 +1,60 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class RegisterKnowledgeBaseFileRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The OSS object key of the uploaded file, excluding the oss://BucketName/ prefix.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * pks-2ze123456789abcd/pkb-2ze123456789abcd/example.pdf
+   */
+  filePath?: string;
+  /**
+   * @remarks
+   * The knowledge base ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * pkb-2ze123456789abcd
+   */
+  knowledgeBaseId?: string;
+  /**
+   * @remarks
+   * The ID of the region where the knowledge base resides.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      filePath: 'FilePath',
+      knowledgeBaseId: 'KnowledgeBaseId',
+      regionId: 'RegionId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      filePath: 'string',
+      knowledgeBaseId: 'string',
+      regionId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/RegisterKnowledgeBaseFileResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { RegisterKnowledgeBaseFileResponseBody } from "./RegisterKnowledgeBaseFileResponseBody";
+
+
+export class RegisterKnowledgeBaseFileResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: RegisterKnowledgeBaseFileResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: RegisterKnowledgeBaseFileResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/RegisterKnowledgeBaseFileResponseBody.ts

@@ -0,0 +1,86 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class RegisterKnowledgeBaseFileResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The file ID, which is generated by the server based on the ETL rules for native OSS files.
+   * 
+   * @example
+   * 3566626f-3cc5-57a3-904c-e777b39baa3d
+   */
+  fileId?: string;
+  /**
+   * @remarks
+   * The file name.
+   * 
+   * @example
+   * example.pdf
+   */
+  fileName?: string;
+  /**
+   * @remarks
+   * The OSS object key of the registered file.
+   * 
+   * @example
+   * pks-2ze123456789abcd/pkb-2ze123456789abcd/example.pdf
+   */
+  filePath?: string;
+  /**
+   * @remarks
+   * Indicates whether an existing idempotent record is matched. Valid values:
+   * - true: An existing idempotent record is matched.
+   * - false: No existing idempotent record is matched.
+   * 
+   * @example
+   * false
+   */
+  idempotent?: boolean;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 9C3E5A7B-12D4-4F68-9A01-2B3C4D5E6F70
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The file processing status.
+   * 
+   * @example
+   * DISPATCHED
+   */
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      fileId: 'FileId',
+      fileName: 'FileName',
+      filePath: 'FilePath',
+      idempotent: 'Idempotent',
+      requestId: 'RequestId',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      fileId: 'string',
+      fileName: 'string',
+      filePath: 'string',
+      idempotent: 'boolean',
+      requestId: 'string',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+