@alicloud/polardb20170801 7.0.0 → 7.1.0

package/dist/client.d.ts

@@ -698,6 +698,21 @@ export default class Client extends OpenApi {
      * @returns CreateBackupResponse
      */
     createBackup(request: $_model.CreateBackupRequest): Promise<$_model.CreateBackupResponse>;
+    /**
+     * Creates API keys in batches.
+     *
+     * @param request - CreateBatchConsumerRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateBatchConsumerResponse
+     */
+    createBatchConsumerWithOptions(request: $_model.CreateBatchConsumerRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateBatchConsumerResponse>;
+    /**
+     * Creates API keys in batches.
+     *
+     * @param request - CreateBatchConsumerRequest
+     * @returns CreateBatchConsumerResponse
+     */
+    createBatchConsumer(request: $_model.CreateBatchConsumerRequest): Promise<$_model.CreateBatchConsumerResponse>;
     /**
      * Creates a batch task.
      *
@@ -2021,7 +2036,7 @@ export default class Client extends OpenApi {
      */
     deleteSQLRateLimitingRules(request: $_model.DeleteSQLRateLimitingRulesRequest): Promise<$_model.DeleteSQLRateLimitingRulesResponse>;
     /**
-     * Gets the details of a custom instance.
+     * Queries the details of a custom instance.
      *
      * @param request - DescribeAIDBClusterAttributeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2029,7 +2044,7 @@ export default class Client extends OpenApi {
      */
     describeAIDBClusterAttributeWithOptions(request: $_model.DescribeAIDBClusterAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeAIDBClusterAttributeResponse>;
     /**
-     * Gets the details of a custom instance.
+     * Queries the details of a custom instance.
      *
      * @param request - DescribeAIDBClusterAttributeRequest
      * @returns DescribeAIDBClusterAttributeResponse
@@ -2261,6 +2276,21 @@ export default class Client extends OpenApi {
      * @returns DescribeActiveOperationTasksResponse
      */
     describeActiveOperationTasks(request: $_model.DescribeActiveOperationTasksRequest): Promise<$_model.DescribeActiveOperationTasksResponse>;
+    /**
+     * 查询该apikey的详细信息
+     *
+     * @param request - DescribeApikeyAttributeRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribeApikeyAttributeResponse
+     */
+    describeApikeyAttributeWithOptions(request: $_model.DescribeApikeyAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeApikeyAttributeResponse>;
+    /**
+     * 查询该apikey的详细信息
+     *
+     * @param request - DescribeApikeyAttributeRequest
+     * @returns DescribeApikeyAttributeResponse
+     */
+    describeApikeyAttribute(request: $_model.DescribeApikeyAttributeRequest): Promise<$_model.DescribeApikeyAttributeResponse>;
     /**
      * Retrieves the details of a specific application in a PolarDB instance.
      *
@@ -3374,6 +3404,21 @@ export default class Client extends OpenApi {
      * @returns DescribeFirewallRulesResponse
      */
     describeFirewallRules(request: $_model.DescribeFirewallRulesRequest): Promise<$_model.DescribeFirewallRulesResponse>;
+    /**
+     * Queries all API keys under the current UID.
+     *
+     * @param request - DescribeGatewayApikeyListRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribeGatewayApikeyListResponse
+     */
+    describeGatewayApikeyListWithOptions(request: $_model.DescribeGatewayApikeyListRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeGatewayApikeyListResponse>;
+    /**
+     * Queries all API keys under the current UID.
+     *
+     * @param request - DescribeGatewayApikeyListRequest
+     * @returns DescribeGatewayApikeyListResponse
+     */
+    describeGatewayApikeyList(request: $_model.DescribeGatewayApikeyListRequest): Promise<$_model.DescribeGatewayApikeyListResponse>;
     /**
      * Viewing gateway instance details
      *
@@ -3832,7 +3877,7 @@ export default class Client extends OpenApi {
      */
     describePolarAgentUserSessions(request: $_model.DescribePolarAgentUserSessionsRequest): Promise<$_model.DescribePolarAgentUserSessionsResponse>;
     /**
-     * Queries the details of agents installed in a specified application.
+     * Queries all installed plug-ins and their status information under a specified application.
      *
      * @param tmpReq - DescribePolarClawAgentsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3840,7 +3885,7 @@ export default class Client extends OpenApi {
      */
     describePolarClawAgentsWithOptions(tmpReq: $_model.DescribePolarClawAgentsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribePolarClawAgentsResponse>;
     /**
-     * Queries the details of agents installed in a specified application.
+     * Queries all installed plug-ins and their status information under a specified application.
      *
      * @param request - DescribePolarClawAgentsRequest
      * @returns DescribePolarClawAgentsResponse
@@ -3942,7 +3987,7 @@ export default class Client extends OpenApi {
      */
     describePolarClawTask(request: $_model.DescribePolarClawTaskRequest): Promise<$_model.DescribePolarClawTaskResponse>;
     /**
-     * Gets the details of a PolarFS instance.
+     * Retrieves the details of a PolarLakebase instance.
      *
      * @param request - DescribePolarFsAttributeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3950,21 +3995,21 @@ export default class Client extends OpenApi {
      */
     describePolarFsAttributeWithOptions(request: $_model.DescribePolarFsAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribePolarFsAttributeResponse>;
     /**
-     * Gets the details of a PolarFS instance.
+     * Retrieves the details of a PolarLakebase instance.
      *
      * @param request - DescribePolarFsAttributeRequest
      * @returns DescribePolarFsAttributeResponse
      */
     describePolarFsAttribute(request: $_model.DescribePolarFsAttributeRequest): Promise<$_model.DescribePolarFsAttributeResponse>;
     /**
-     * Lists the files and subdirectories at a specified path.
+     * Lists the files and subdirectories under a specified path.
      *
      * @remarks
-     * ## Usage notes
-     * - The **Path** parameter must be an absolute path.
-     * - The **Recursive** parameter defaults to `false`. If set to `true`, the operation recursively lists the contents of all subdirectories.
-     * - The **Depth** parameter limits the recursive depth. The default value is `1`.
-     * - The **Filter** parameter supports filtering with wildcards or regular expressions.
+     * ## 请求说明
+     * - **Path** 参数必须提供一个绝对路径。
+     * - **Recursive** 参数默认为 `false`，如果设置为 `true`，则会递归列出所有子目录的内容。
+     * - **Depth** 参数用于限制递归深度，默认值为 `1`。
+     * - **Filter** 参数支持通配符或正则表达式过滤结果。
      *
      * @param request - DescribePolarFsObjectsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3972,14 +4017,14 @@ export default class Client extends OpenApi {
      */
     describePolarFsObjectsWithOptions(request: $_model.DescribePolarFsObjectsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribePolarFsObjectsResponse>;
     /**
-     * Lists the files and subdirectories at a specified path.
+     * Lists the files and subdirectories under a specified path.
      *
      * @remarks
-     * ## Usage notes
-     * - The **Path** parameter must be an absolute path.
-     * - The **Recursive** parameter defaults to `false`. If set to `true`, the operation recursively lists the contents of all subdirectories.
-     * - The **Depth** parameter limits the recursive depth. The default value is `1`.
-     * - The **Filter** parameter supports filtering with wildcards or regular expressions.
+     * ## 请求说明
+     * - **Path** 参数必须提供一个绝对路径。
+     * - **Recursive** 参数默认为 `false`，如果设置为 `true`，则会递归列出所有子目录的内容。
+     * - **Depth** 参数用于限制递归深度，默认值为 `1`。
+     * - **Filter** 参数支持通配符或正则表达式过滤结果。
      *
      * @param request - DescribePolarFsObjectsRequest
      * @returns DescribePolarFsObjectsResponse

package/dist/client.js

@@ -2557,6 +2557,57 @@ class Client extends openapi_core_1.default {
         let runtime = new $dara.RuntimeOptions({});
         return await this.createBackupWithOptions(request, runtime);
     }
+    /**
+     * Creates API keys in batches.
+     *
+     * @param request - CreateBatchConsumerRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateBatchConsumerResponse
+     */
+    async createBatchConsumerWithOptions(request, runtime) {
+        request.validate();
+        let query = {};
+        if (!$dara.isNull(request.clientToken)) {
+            query["ClientToken"] = request.clientToken;
+        }
+        if (!$dara.isNull(request.consumerGroupId)) {
+            query["ConsumerGroupId"] = request.consumerGroupId;
+        }
+        if (!$dara.isNull(request.count)) {
+            query["Count"] = request.count;
+        }
+        if (!$dara.isNull(request.gwClusterId)) {
+            query["GwClusterId"] = request.gwClusterId;
+        }
+        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: "CreateBatchConsumer",
+            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.CreateBatchConsumerResponse({}));
+    }
+    /**
+     * Creates API keys in batches.
+     *
+     * @param request - CreateBatchConsumerRequest
+     * @returns CreateBatchConsumerResponse
+     */
+    async createBatchConsumer(request) {
+        let runtime = new $dara.RuntimeOptions({});
+        return await this.createBatchConsumerWithOptions(request, runtime);
+    }
     /**
      * Creates a batch task.
      *
@@ -7212,7 +7263,7 @@ class Client extends openapi_core_1.default {
         return await this.deleteSQLRateLimitingRulesWithOptions(request, runtime);
     }
     /**
-     * Gets the details of a custom instance.
+     * Queries the details of a custom instance.
      *
      * @param request - DescribeAIDBClusterAttributeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -7253,7 +7304,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeAIDBClusterAttributeResponse({}));
     }
     /**
-     * Gets the details of a custom instance.
+     * Queries the details of a custom instance.
      *
      * @param request - DescribeAIDBClusterAttributeRequest
      * @returns DescribeAIDBClusterAttributeResponse
@@ -8133,6 +8184,54 @@ class Client extends openapi_core_1.default {
         let runtime = new $dara.RuntimeOptions({});
         return await this.describeActiveOperationTasksWithOptions(request, runtime);
     }
+    /**
+     * 查询该apikey的详细信息
+     *
+     * @param request - DescribeApikeyAttributeRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribeApikeyAttributeResponse
+     */
+    async describeApikeyAttributeWithOptions(request, runtime) {
+        request.validate();
+        let query = {};
+        if (!$dara.isNull(request.apiKey)) {
+            query["ApiKey"] = request.apiKey;
+        }
+        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;
+        }
+        let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
+            query: openapi_core_2.OpenApiUtil.query(query),
+        });
+        let params = new openapi_core_2.$OpenApiUtil.Params({
+            action: "DescribeApikeyAttribute",
+            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.DescribeApikeyAttributeResponse({}));
+    }
+    /**
+     * 查询该apikey的详细信息
+     *
+     * @param request - DescribeApikeyAttributeRequest
+     * @returns DescribeApikeyAttributeResponse
+     */
+    async describeApikeyAttribute(request) {
+        let runtime = new $dara.RuntimeOptions({});
+        return await this.describeApikeyAttributeWithOptions(request, runtime);
+    }
     /**
      * Retrieves the details of a specific application in a PolarDB instance.
      *
@@ -12073,6 +12172,51 @@ class Client extends openapi_core_1.default {
         let runtime = new $dara.RuntimeOptions({});
         return await this.describeFirewallRulesWithOptions(request, runtime);
     }
+    /**
+     * Queries all API keys under the current UID.
+     *
+     * @param request - DescribeGatewayApikeyListRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribeGatewayApikeyListResponse
+     */
+    async describeGatewayApikeyListWithOptions(request, runtime) {
+        request.validate();
+        let query = {};
+        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;
+        }
+        let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
+            query: openapi_core_2.OpenApiUtil.query(query),
+        });
+        let params = new openapi_core_2.$OpenApiUtil.Params({
+            action: "DescribeGatewayApikeyList",
+            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.DescribeGatewayApikeyListResponse({}));
+    }
+    /**
+     * Queries all API keys under the current UID.
+     *
+     * @param request - DescribeGatewayApikeyListRequest
+     * @returns DescribeGatewayApikeyListResponse
+     */
+    async describeGatewayApikeyList(request) {
+        let runtime = new $dara.RuntimeOptions({});
+        return await this.describeGatewayApikeyListWithOptions(request, runtime);
+    }
     /**
      * Viewing gateway instance details
      *
@@ -13806,7 +13950,7 @@ class Client extends openapi_core_1.default {
         return await this.describePolarAgentUserSessionsWithOptions(request, runtime);
     }
     /**
-     * Queries the details of agents installed in a specified application.
+     * Queries all installed plug-ins and their status information under a specified application.
      *
      * @param tmpReq - DescribePolarClawAgentsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -13843,7 +13987,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribePolarClawAgentsResponse({}));
     }
     /**
-     * Queries the details of agents installed in a specified application.
+     * Queries all installed plug-ins and their status information under a specified application.
      *
      * @param request - DescribePolarClawAgentsRequest
      * @returns DescribePolarClawAgentsResponse
@@ -14102,7 +14246,7 @@ class Client extends openapi_core_1.default {
         return await this.describePolarClawTaskWithOptions(request, runtime);
     }
     /**
-     * Gets the details of a PolarFS instance.
+     * Retrieves the details of a PolarLakebase instance.
      *
      * @param request - DescribePolarFsAttributeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -14137,7 +14281,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribePolarFsAttributeResponse({}));
     }
     /**
-     * Gets the details of a PolarFS instance.
+     * Retrieves the details of a PolarLakebase instance.
      *
      * @param request - DescribePolarFsAttributeRequest
      * @returns DescribePolarFsAttributeResponse
@@ -14147,14 +14291,14 @@ class Client extends openapi_core_1.default {
         return await this.describePolarFsAttributeWithOptions(request, runtime);
     }
     /**
-     * Lists the files and subdirectories at a specified path.
+     * Lists the files and subdirectories under a specified path.
      *
      * @remarks
-     * ## Usage notes
-     * - The **Path** parameter must be an absolute path.
-     * - The **Recursive** parameter defaults to `false`. If set to `true`, the operation recursively lists the contents of all subdirectories.
-     * - The **Depth** parameter limits the recursive depth. The default value is `1`.
-     * - The **Filter** parameter supports filtering with wildcards or regular expressions.
+     * ## 请求说明
+     * - **Path** 参数必须提供一个绝对路径。
+     * - **Recursive** 参数默认为 `false`，如果设置为 `true`，则会递归列出所有子目录的内容。
+     * - **Depth** 参数用于限制递归深度，默认值为 `1`。
+     * - **Filter** 参数支持通配符或正则表达式过滤结果。
      *
      * @param request - DescribePolarFsObjectsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -14186,14 +14330,14 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribePolarFsObjectsResponse({}));
     }
     /**
-     * Lists the files and subdirectories at a specified path.
+     * Lists the files and subdirectories under a specified path.
      *
      * @remarks
-     * ## Usage notes
-     * - The **Path** parameter must be an absolute path.
-     * - The **Recursive** parameter defaults to `false`. If set to `true`, the operation recursively lists the contents of all subdirectories.
-     * - The **Depth** parameter limits the recursive depth. The default value is `1`.
-     * - The **Filter** parameter supports filtering with wildcards or regular expressions.
+     * ## 请求说明
+     * - **Path** 参数必须提供一个绝对路径。
+     * - **Recursive** 参数默认为 `false`，如果设置为 `true`，则会递归列出所有子目录的内容。
+     * - **Depth** 参数用于限制递归深度，默认值为 `1`。
+     * - **Filter** 参数支持通配符或正则表达式过滤结果。
      *
      * @param request - DescribePolarFsObjectsRequest
      * @returns DescribePolarFsObjectsResponse
@@ -23597,6 +23741,12 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.filesShrink)) {
             query["Files"] = request.filesShrink;
         }
+        if (!$dara.isNull(request.isDefault)) {
+            query["IsDefault"] = request.isDefault;
+        }
+        if (!$dara.isNull(request.keepWorkspaceFiles)) {
+            query["KeepWorkspaceFiles"] = request.keepWorkspaceFiles;
+        }
         if (!$dara.isNull(request.model)) {
             query["Model"] = request.model;
         }