@alicloud/polardb20170801 8.2.4 → 8.3.0

package/dist/client.d.ts

@@ -4005,11 +4005,11 @@ export default class Client extends OpenApi {
      */
     describeDbClusterAttributeZonal(request: $_model.DescribeDbClusterAttributeZonalRequest): Promise<$_model.DescribeDbClusterAttributeZonalResponse>;
     /**
-     * Queries the information about the backup sets in a released PolarDB cluster.
+     * Queries the details of backup sets in a released PolarDB cluster.
      *
      * @remarks
-     * Before you call this operation, make sure that the PolarDB cluster is in the **Released** state. You must also confirm that the **Retain All Backups Permanently** or **Retain Last Automatic Backup Permanently** backup retention policy takes effect after you release the cluster. If you delete all backup sets after the cluster is released, you cannot use this API operation to query the cluster.
-     * >  You can call the [DescribeDBClusterAttribute](https://help.aliyun.com/document_detail/98181.html) operation to query the cluster status.
+     * When you invoke this operation, the PolarDB cluster must be in the **Released** state, and one of the following backup retention options must have been selected when the cluster was released: **Long-term Retention (LTR) of All Backups** or **Long-term Retention (LTR) of the Last Backup (Automatic Backup Before Deletion)**. If all retained backup sets of a released cluster have been manually deleted, this operation can no longer query the cluster.
+     * > You can invoke the [DescribeDBClusterAttribute](https://help.aliyun.com/document_detail/98181.html) operation to query the cluster status.
      *
      * @param request - DescribeDetachedBackupsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -4017,11 +4017,11 @@ export default class Client extends OpenApi {
      */
     describeDetachedBackupsWithOptions(request: $_model.DescribeDetachedBackupsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDetachedBackupsResponse>;
     /**
-     * Queries the information about the backup sets in a released PolarDB cluster.
+     * Queries the details of backup sets in a released PolarDB cluster.
      *
      * @remarks
-     * Before you call this operation, make sure that the PolarDB cluster is in the **Released** state. You must also confirm that the **Retain All Backups Permanently** or **Retain Last Automatic Backup Permanently** backup retention policy takes effect after you release the cluster. If you delete all backup sets after the cluster is released, you cannot use this API operation to query the cluster.
-     * >  You can call the [DescribeDBClusterAttribute](https://help.aliyun.com/document_detail/98181.html) operation to query the cluster status.
+     * When you invoke this operation, the PolarDB cluster must be in the **Released** state, and one of the following backup retention options must have been selected when the cluster was released: **Long-term Retention (LTR) of All Backups** or **Long-term Retention (LTR) of the Last Backup (Automatic Backup Before Deletion)**. If all retained backup sets of a released cluster have been manually deleted, this operation can no longer query the cluster.
+     * > You can invoke the [DescribeDBClusterAttribute](https://help.aliyun.com/document_detail/98181.html) operation to query the cluster status.
      *
      * @param request - DescribeDetachedBackupsRequest
      * @returns DescribeDetachedBackupsResponse
@@ -4274,7 +4274,7 @@ export default class Client extends OpenApi {
      */
     describeHistoryTasksStat(request: $_model.DescribeHistoryTasksStatRequest): Promise<$_model.DescribeHistoryTasksStatResponse>;
     /**
-     * Queries the synchronization list of a knowledge base.
+     * Queries the list of knowledge base synchronization links.
      *
      * @param request - DescribeKBSyncLinksRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -4282,7 +4282,7 @@ export default class Client extends OpenApi {
      */
     describeKBSyncLinksWithOptions(request: $_model.DescribeKBSyncLinksRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeKBSyncLinksResponse>;
     /**
-     * Queries the synchronization list of a knowledge base.
+     * Queries the list of knowledge base synchronization links.
      *
      * @param request - DescribeKBSyncLinksRequest
      * @returns DescribeKBSyncLinksResponse
@@ -6043,10 +6043,10 @@ export default class Client extends OpenApi {
      */
     modifyAutoRenewAttribute(request: $_model.ModifyAutoRenewAttributeRequest): Promise<$_model.ModifyAutoRenewAttributeResponse>;
     /**
-     * Modifies the automatic backup policy for a PolarDB cluster.
+     * Modifies the automatic backup policy of a PolarDB cluster.
      *
      * @remarks
-     * > You can also modify the automatic backup policy for a PolarDB cluster in the console. For more information, see [backup settings](https://help.aliyun.com/document_detail/280422.html).
+     * > You can also modify the automatic backup policy of a PolarDB cluster in the console. For more information, see [Backup settings](https://help.aliyun.com/document_detail/280422.html).
      *
      * @param tmpReq - ModifyBackupPolicyRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -6054,10 +6054,10 @@ export default class Client extends OpenApi {
      */
     modifyBackupPolicyWithOptions(tmpReq: $_model.ModifyBackupPolicyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyBackupPolicyResponse>;
     /**
-     * Modifies the automatic backup policy for a PolarDB cluster.
+     * Modifies the automatic backup policy of a PolarDB cluster.
      *
      * @remarks
-     * > You can also modify the automatic backup policy for a PolarDB cluster in the console. For more information, see [backup settings](https://help.aliyun.com/document_detail/280422.html).
+     * > You can also modify the automatic backup policy of a PolarDB cluster in the console. For more information, see [Backup settings](https://help.aliyun.com/document_detail/280422.html).
      *
      * @param request - ModifyBackupPolicyRequest
      * @returns ModifyBackupPolicyResponse
@@ -7085,6 +7085,21 @@ export default class Client extends OpenApi {
      * @returns RefreshDBClusterStorageUsageResponse
      */
     refreshDBClusterStorageUsage(request: $_model.RefreshDBClusterStorageUsageRequest): Promise<$_model.RefreshDBClusterStorageUsageResponse>;
+    /**
+     * Registers an OSS file in a knowledge base.
+     *
+     * @param request - RegisterKnowledgeBaseFileRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns RegisterKnowledgeBaseFileResponse
+     */
+    registerKnowledgeBaseFileWithOptions(request: $_model.RegisterKnowledgeBaseFileRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RegisterKnowledgeBaseFileResponse>;
+    /**
+     * Registers an OSS file in a knowledge base.
+     *
+     * @param request - RegisterKnowledgeBaseFileRequest
+     * @returns RegisterKnowledgeBaseFileResponse
+     */
+    registerKnowledgeBaseFile(request: $_model.RegisterKnowledgeBaseFileRequest): Promise<$_model.RegisterKnowledgeBaseFileResponse>;
     /**
      * Rejects a PolarClaw device pairing request.
      *
@@ -7357,7 +7372,7 @@ export default class Client extends OpenApi {
      */
     restoreTable(request: $_model.RestoreTableRequest): Promise<$_model.RestoreTableResponse>;
     /**
-     * Retrieves information from a knowledge base.
+     * Retrieves knowledge base search results.
      *
      * @param request - RetrievalKnowledgeBaseRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -7365,7 +7380,7 @@ export default class Client extends OpenApi {
      */
     retrievalKnowledgeBaseWithOptions(request: $_model.RetrievalKnowledgeBaseRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RetrievalKnowledgeBaseResponse>;
     /**
-     * Retrieves information from a knowledge base.
+     * Retrieves knowledge base search results.
      *
      * @param request - RetrievalKnowledgeBaseRequest
      * @returns RetrievalKnowledgeBaseResponse

package/dist/client.js

@@ -14296,11 +14296,11 @@ class Client extends openapi_core_1.default {
         return await this.describeDbClusterAttributeZonalWithOptions(request, runtime);
     }
     /**
-     * Queries the information about the backup sets in a released PolarDB cluster.
+     * Queries the details of backup sets in a released PolarDB cluster.
      *
      * @remarks
-     * Before you call this operation, make sure that the PolarDB cluster is in the **Released** state. You must also confirm that the **Retain All Backups Permanently** or **Retain Last Automatic Backup Permanently** backup retention policy takes effect after you release the cluster. If you delete all backup sets after the cluster is released, you cannot use this API operation to query the cluster.
-     * >  You can call the [DescribeDBClusterAttribute](https://help.aliyun.com/document_detail/98181.html) operation to query the cluster status.
+     * When you invoke this operation, the PolarDB cluster must be in the **Released** state, and one of the following backup retention options must have been selected when the cluster was released: **Long-term Retention (LTR) of All Backups** or **Long-term Retention (LTR) of the Last Backup (Automatic Backup Before Deletion)**. If all retained backup sets of a released cluster have been manually deleted, this operation can no longer query the cluster.
+     * > You can invoke the [DescribeDBClusterAttribute](https://help.aliyun.com/document_detail/98181.html) operation to query the cluster status.
      *
      * @param request - DescribeDetachedBackupsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -14365,11 +14365,11 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeDetachedBackupsResponse({}));
     }
     /**
-     * Queries the information about the backup sets in a released PolarDB cluster.
+     * Queries the details of backup sets in a released PolarDB cluster.
      *
      * @remarks
-     * Before you call this operation, make sure that the PolarDB cluster is in the **Released** state. You must also confirm that the **Retain All Backups Permanently** or **Retain Last Automatic Backup Permanently** backup retention policy takes effect after you release the cluster. If you delete all backup sets after the cluster is released, you cannot use this API operation to query the cluster.
-     * >  You can call the [DescribeDBClusterAttribute](https://help.aliyun.com/document_detail/98181.html) operation to query the cluster status.
+     * When you invoke this operation, the PolarDB cluster must be in the **Released** state, and one of the following backup retention options must have been selected when the cluster was released: **Long-term Retention (LTR) of All Backups** or **Long-term Retention (LTR) of the Last Backup (Automatic Backup Before Deletion)**. If all retained backup sets of a released cluster have been manually deleted, this operation can no longer query the cluster.
+     * > You can invoke the [DescribeDBClusterAttribute](https://help.aliyun.com/document_detail/98181.html) operation to query the cluster status.
      *
      * @param request - DescribeDetachedBackupsRequest
      * @returns DescribeDetachedBackupsResponse
@@ -15321,7 +15321,7 @@ class Client extends openapi_core_1.default {
         return await this.describeHistoryTasksStatWithOptions(request, runtime);
     }
     /**
-     * Queries the synchronization list of a knowledge base.
+     * Queries the list of knowledge base synchronization links.
      *
      * @param request - DescribeKBSyncLinksRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -15336,6 +15336,12 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.knowledgeBaseId)) {
             query["KnowledgeBaseId"] = request.knowledgeBaseId;
         }
+        if (!$dara.isNull(request.pageNumber)) {
+            query["PageNumber"] = request.pageNumber;
+        }
+        if (!$dara.isNull(request.pageSize)) {
+            query["PageSize"] = request.pageSize;
+        }
         if (!$dara.isNull(request.regionId)) {
             query["RegionId"] = request.regionId;
         }
@@ -15356,7 +15362,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeKBSyncLinksResponse({}));
     }
     /**
-     * Queries the synchronization list of a knowledge base.
+     * Queries the list of knowledge base synchronization links.
      *
      * @param request - DescribeKBSyncLinksRequest
      * @returns DescribeKBSyncLinksResponse
@@ -21418,10 +21424,10 @@ class Client extends openapi_core_1.default {
         return await this.modifyAutoRenewAttributeWithOptions(request, runtime);
     }
     /**
-     * Modifies the automatic backup policy for a PolarDB cluster.
+     * Modifies the automatic backup policy of a PolarDB cluster.
      *
      * @remarks
-     * > You can also modify the automatic backup policy for a PolarDB cluster in the console. For more information, see [backup settings](https://help.aliyun.com/document_detail/280422.html).
+     * > You can also modify the automatic backup policy of a PolarDB cluster in the console. For more information, see [Backup settings](https://help.aliyun.com/document_detail/280422.html).
      *
      * @param tmpReq - ModifyBackupPolicyRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -21509,10 +21515,10 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyBackupPolicyResponse({}));
     }
     /**
-     * Modifies the automatic backup policy for a PolarDB cluster.
+     * Modifies the automatic backup policy of a PolarDB cluster.
      *
      * @remarks
-     * > You can also modify the automatic backup policy for a PolarDB cluster in the console. For more information, see [backup settings](https://help.aliyun.com/document_detail/280422.html).
+     * > You can also modify the automatic backup policy of a PolarDB cluster in the console. For more information, see [Backup settings](https://help.aliyun.com/document_detail/280422.html).
      *
      * @param request - ModifyBackupPolicyRequest
      * @returns ModifyBackupPolicyResponse
@@ -25481,6 +25487,51 @@ class Client extends openapi_core_1.default {
         let runtime = new $dara.RuntimeOptions({});
         return await this.refreshDBClusterStorageUsageWithOptions(request, runtime);
     }
+    /**
+     * Registers an OSS file in a knowledge base.
+     *
+     * @param request - RegisterKnowledgeBaseFileRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns RegisterKnowledgeBaseFileResponse
+     */
+    async registerKnowledgeBaseFileWithOptions(request, runtime) {
+        request.validate();
+        let query = {};
+        if (!$dara.isNull(request.filePath)) {
+            query["FilePath"] = request.filePath;
+        }
+        if (!$dara.isNull(request.knowledgeBaseId)) {
+            query["KnowledgeBaseId"] = request.knowledgeBaseId;
+        }
+        if (!$dara.isNull(request.regionId)) {
+            query["RegionId"] = request.regionId;
+        }
+        let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
+            query: openapi_core_2.OpenApiUtil.query(query),
+        });
+        let params = new openapi_core_2.$OpenApiUtil.Params({
+            action: "RegisterKnowledgeBaseFile",
+            version: "2017-08-01",
+            protocol: "HTTPS",
+            pathname: "/",
+            method: "POST",
+            authType: "AK",
+            style: "RPC",
+            reqBodyType: "formData",
+            bodyType: "json",
+        });
+        return $dara.cast(await this.callApi(params, req, runtime), new $_model.RegisterKnowledgeBaseFileResponse({}));
+    }
+    /**
+     * Registers an OSS file in a knowledge base.
+     *
+     * @param request - RegisterKnowledgeBaseFileRequest
+     * @returns RegisterKnowledgeBaseFileResponse
+     */
+    async registerKnowledgeBaseFile(request) {
+        let runtime = new $dara.RuntimeOptions({});
+        return await this.registerKnowledgeBaseFileWithOptions(request, runtime);
+    }
     /**
      * Rejects a PolarClaw device pairing request.
      *
@@ -26382,7 +26433,7 @@ class Client extends openapi_core_1.default {
         return await this.restoreTableWithOptions(request, runtime);
     }
     /**
-     * Retrieves information from a knowledge base.
+     * Retrieves knowledge base search results.
      *
      * @param request - RetrievalKnowledgeBaseRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -26426,7 +26477,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.RetrievalKnowledgeBaseResponse({}));
     }
     /**
-     * Retrieves information from a knowledge base.
+     * Retrieves knowledge base search results.
      *
      * @param request - RetrievalKnowledgeBaseRequest
      * @returns RetrievalKnowledgeBaseResponse