@alicloud/polardb20170801 7.6.0 → 7.8.0

package/dist/client.d.ts

@@ -742,6 +742,11 @@ export default class Client extends OpenApi {
     /**
      * Creates API keys in batches.
      *
+     * @remarks
+     * > * Each cluster can have a maximum of three manually created backups at the same time.
+     * > * If the error message `Exceeding the daily backup times of this DB cluster` is returned, three manually created backups already exist in your cluster. [Delete backups](https://help.aliyun.com/document_detail/98101.html) before calling this operation.
+     * > * After you call this operation, a backup task is created in the background. If the data volume is large, the backup may take a long time. Wait until the backup is complete.
+     *
      * @param request - CreateBatchConsumerRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns CreateBatchConsumerResponse
@@ -750,6 +755,11 @@ export default class Client extends OpenApi {
     /**
      * Creates API keys in batches.
      *
+     * @remarks
+     * > * Each cluster can have a maximum of three manually created backups at the same time.
+     * > * If the error message `Exceeding the daily backup times of this DB cluster` is returned, three manually created backups already exist in your cluster. [Delete backups](https://help.aliyun.com/document_detail/98101.html) before calling this operation.
+     * > * After you call this operation, a backup task is created in the background. If the data volume is large, the backup may take a long time. Wait until the backup is complete.
+     *
      * @param request - CreateBatchConsumerRequest
      * @returns CreateBatchConsumerResponse
      */
@@ -862,6 +872,9 @@ export default class Client extends OpenApi {
     /**
      * Creates a PolarDB cluster.
      *
+     * @remarks
+     * DBLink can connect two PolarDB for PostgreSQL (Compatible with Oracle) clusters, or connect a PolarDB for PostgreSQL (Compatible with Oracle) cluster to a self-managed PostgreSQL database on an ECS instance. You can use DBLink to query data across clusters.
+     *
      * @param request - CreateDBClusterRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns CreateDBClusterResponse
@@ -870,6 +883,9 @@ export default class Client extends OpenApi {
     /**
      * Creates a PolarDB cluster.
      *
+     * @remarks
+     * DBLink can connect two PolarDB for PostgreSQL (Compatible with Oracle) clusters, or connect a PolarDB for PostgreSQL (Compatible with Oracle) cluster to a self-managed PostgreSQL database on an ECS instance. You can use DBLink to query data across clusters.
+     *
      * @param request - CreateDBClusterRequest
      * @returns CreateDBClusterResponse
      */
@@ -1098,6 +1114,21 @@ export default class Client extends OpenApi {
      * @returns CreateGlobalSecurityIPGroupResponse
      */
     createGlobalSecurityIPGroup(request: $_model.CreateGlobalSecurityIPGroupRequest): Promise<$_model.CreateGlobalSecurityIPGroupResponse>;
+    /**
+     * Places an order to purchase a token resource plan and activates a redemption code.
+     *
+     * @param request - CreateGwConsumerOrderRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateGwConsumerOrderResponse
+     */
+    createGwConsumerOrderWithOptions(request: $_model.CreateGwConsumerOrderRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateGwConsumerOrderResponse>;
+    /**
+     * Places an order to purchase a token resource plan and activates a redemption code.
+     *
+     * @param request - CreateGwConsumerOrderRequest
+     * @returns CreateGwConsumerOrderResponse
+     */
+    createGwConsumerOrder(request: $_model.CreateGwConsumerOrderRequest): Promise<$_model.CreateGwConsumerOrderResponse>;
     /**
      * Creates a model API.
      *
@@ -2538,10 +2569,10 @@ export default class Client extends OpenApi {
      */
     describeApikeyAttribute(request: $_model.DescribeApikeyAttributeRequest): Promise<$_model.DescribeApikeyAttributeResponse>;
     /**
-     * Retrieves the details of a specific application in a PolarDB instance.
+     * Retrieves the detailed information of a specified PolarDB application.
      *
      * @remarks
-     * Retrieves all information about a specific PolarDB application, such as component details and endpoints.
+     * This API is used to query all related information of a specific PolarDB application, including but not limited to component details and endpoints.
      *
      * @param request - DescribeApplicationAttributeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2549,17 +2580,17 @@ export default class Client extends OpenApi {
      */
     describeApplicationAttributeWithOptions(request: $_model.DescribeApplicationAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeApplicationAttributeResponse>;
     /**
-     * Retrieves the details of a specific application in a PolarDB instance.
+     * Retrieves the detailed information of a specified PolarDB application.
      *
      * @remarks
-     * Retrieves all information about a specific PolarDB application, such as component details and endpoints.
+     * This API is used to query all related information of a specific PolarDB application, including but not limited to component details and endpoints.
      *
      * @param request - DescribeApplicationAttributeRequest
      * @returns DescribeApplicationAttributeResponse
      */
     describeApplicationAttribute(request: $_model.DescribeApplicationAttributeRequest): Promise<$_model.DescribeApplicationAttributeResponse>;
     /**
-     * Queries the log details of an AI application.
+     * Queries the details of AI application logs.
      *
      * @param request - DescribeApplicationLogsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2567,7 +2598,7 @@ export default class Client extends OpenApi {
      */
     describeApplicationLogsWithOptions(request: $_model.DescribeApplicationLogsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeApplicationLogsResponse>;
     /**
-     * Queries the log details of an AI application.
+     * Queries the details of AI application logs.
      *
      * @param request - DescribeApplicationLogsRequest
      * @returns DescribeApplicationLogsResponse
@@ -2589,7 +2620,7 @@ export default class Client extends OpenApi {
      */
     describeApplicationParameters(request: $_model.DescribeApplicationParametersRequest): Promise<$_model.DescribeApplicationParametersResponse>;
     /**
-     * Querying PolarDB AI application performance.
+     * Queries the performance of a PolarDB AI application.
      *
      * @param request - DescribeApplicationPerformanceRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2597,7 +2628,7 @@ export default class Client extends OpenApi {
      */
     describeApplicationPerformanceWithOptions(request: $_model.DescribeApplicationPerformanceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeApplicationPerformanceResponse>;
     /**
-     * Querying PolarDB AI application performance.
+     * Queries the performance of a PolarDB AI application.
      *
      * @param request - DescribeApplicationPerformanceRequest
      * @returns DescribeApplicationPerformanceResponse
@@ -5865,7 +5896,7 @@ export default class Client extends OpenApi {
      */
     modifyDBClusterResourceGroup(request: $_model.ModifyDBClusterResourceGroupRequest): Promise<$_model.ModifyDBClusterResourceGroupResponse>;
     /**
-     * Enables or shuts down the Secure Sockets Layer (SSL) encryption feature for a PolarDB cluster, or updates the CA certificate of a PolarDB cluster.
+     * Enables or performs shutdown of the Secure Sockets Layer (SSL) encryption feature for a PolarDB cluster, or updates the CA certificate of a PolarDB cluster.
      *
      * @param request - ModifyDBClusterSSLRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -5873,7 +5904,7 @@ export default class Client extends OpenApi {
      */
     modifyDBClusterSSLWithOptions(request: $_model.ModifyDBClusterSSLRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyDBClusterSSLResponse>;
     /**
-     * Enables or shuts down the Secure Sockets Layer (SSL) encryption feature for a PolarDB cluster, or updates the CA certificate of a PolarDB cluster.
+     * Enables or performs shutdown of the Secure Sockets Layer (SSL) encryption feature for a PolarDB cluster, or updates the CA certificate of a PolarDB cluster.
      *
      * @param request - ModifyDBClusterSSLRequest
      * @returns ModifyDBClusterSSLResponse
@@ -6676,6 +6707,21 @@ export default class Client extends OpenApi {
      * @returns RestartDBNodeZonalResponse
      */
     restartDBNodeZonal(request: $_model.RestartDBNodeZonalRequest): Promise<$_model.RestartDBNodeZonalResponse>;
+    /**
+     * Restarts a PolarClaw gateway.
+     *
+     * @param request - RestartPolarClawGatewayRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns RestartPolarClawGatewayResponse
+     */
+    restartPolarClawGatewayWithOptions(request: $_model.RestartPolarClawGatewayRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RestartPolarClawGatewayResponse>;
+    /**
+     * Restarts a PolarClaw gateway.
+     *
+     * @param request - RestartPolarClawGatewayRequest
+     * @returns RestartPolarClawGatewayResponse
+     */
+    restartPolarClawGateway(request: $_model.RestartPolarClawGatewayRequest): Promise<$_model.RestartPolarClawGatewayResponse>;
     /**
      * Restores databases or tables to a PolarDB cluster.
      *

package/dist/client.js

@@ -127,9 +127,7 @@ class Client extends openapi_core_1.default {
             'ap-southeast-6': "polardb.ap-southeast-6.aliyuncs.com",
             'ap-southeast-5': "polardb.ap-southeast-5.aliyuncs.com",
             'ap-southeast-3': "polardb.ap-southeast-3.aliyuncs.com",
-            'ap-southeast-2': "polardb.ap-southeast-2.aliyuncs.com",
             'ap-southeast-1': "polardb.ap-southeast-1.aliyuncs.com",
-            'ap-south-1': "polardb.ap-south-1.aliyuncs.com",
             'ap-northeast-2': "polardb.ap-northeast-2.aliyuncs.com",
             'ap-northeast-1': "polardb.ap-northeast-1.aliyuncs.com",
         };
@@ -2724,6 +2722,11 @@ class Client extends openapi_core_1.default {
     /**
      * Creates API keys in batches.
      *
+     * @remarks
+     * > * Each cluster can have a maximum of three manually created backups at the same time.
+     * > * If the error message `Exceeding the daily backup times of this DB cluster` is returned, three manually created backups already exist in your cluster. [Delete backups](https://help.aliyun.com/document_detail/98101.html) before calling this operation.
+     * > * After you call this operation, a backup task is created in the background. If the data volume is large, the backup may take a long time. Wait until the backup is complete.
+     *
      * @param request - CreateBatchConsumerRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns CreateBatchConsumerResponse
@@ -2740,6 +2743,12 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.count)) {
             query["Count"] = request.count;
         }
+        if (!$dara.isNull(request.creditToken)) {
+            query["CreditToken"] = request.creditToken;
+        }
+        if (!$dara.isNull(request.description)) {
+            query["Description"] = request.description;
+        }
         if (!$dara.isNull(request.gwClusterId)) {
             query["GwClusterId"] = request.gwClusterId;
         }
@@ -2765,6 +2774,11 @@ class Client extends openapi_core_1.default {
     /**
      * Creates API keys in batches.
      *
+     * @remarks
+     * > * Each cluster can have a maximum of three manually created backups at the same time.
+     * > * If the error message `Exceeding the daily backup times of this DB cluster` is returned, three manually created backups already exist in your cluster. [Delete backups](https://help.aliyun.com/document_detail/98101.html) before calling this operation.
+     * > * After you call this operation, a backup task is created in the background. If the data volume is large, the backup may take a long time. Wait until the backup is complete.
+     *
      * @param request - CreateBatchConsumerRequest
      * @returns CreateBatchConsumerResponse
      */
@@ -3209,6 +3223,9 @@ class Client extends openapi_core_1.default {
     /**
      * Creates a PolarDB cluster.
      *
+     * @remarks
+     * DBLink can connect two PolarDB for PostgreSQL (Compatible with Oracle) clusters, or connect a PolarDB for PostgreSQL (Compatible with Oracle) cluster to a self-managed PostgreSQL database on an ECS instance. You can use DBLink to query data across clusters.
+     *
      * @param request - CreateDBClusterRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns CreateDBClusterResponse
@@ -3433,6 +3450,9 @@ class Client extends openapi_core_1.default {
     /**
      * Creates a PolarDB cluster.
      *
+     * @remarks
+     * DBLink can connect two PolarDB for PostgreSQL (Compatible with Oracle) clusters, or connect a PolarDB for PostgreSQL (Compatible with Oracle) cluster to a self-managed PostgreSQL database on an ECS instance. You can use DBLink to query data across clusters.
+     *
      * @param request - CreateDBClusterRequest
      * @returns CreateDBClusterResponse
      */
@@ -4384,6 +4404,60 @@ class Client extends openapi_core_1.default {
         let runtime = new $dara.RuntimeOptions({});
         return await this.createGlobalSecurityIPGroupWithOptions(request, runtime);
     }
+    /**
+     * Places an order to purchase a token resource plan and activates a redemption code.
+     *
+     * @param request - CreateGwConsumerOrderRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateGwConsumerOrderResponse
+     */
+    async createGwConsumerOrderWithOptions(request, runtime) {
+        request.validate();
+        let query = {};
+        if (!$dara.isNull(request.clientToken)) {
+            query["ClientToken"] = request.clientToken;
+        }
+        if (!$dara.isNull(request.expireTime)) {
+            query["ExpireTime"] = request.expireTime;
+        }
+        if (!$dara.isNull(request.gatewayId)) {
+            query["GatewayId"] = request.gatewayId;
+        }
+        if (!$dara.isNull(request.keyCount)) {
+            query["KeyCount"] = request.keyCount;
+        }
+        if (!$dara.isNull(request.packageSpec)) {
+            query["PackageSpec"] = request.packageSpec;
+        }
+        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: "CreateGwConsumerOrder",
+            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.CreateGwConsumerOrderResponse({}));
+    }
+    /**
+     * Places an order to purchase a token resource plan and activates a redemption code.
+     *
+     * @param request - CreateGwConsumerOrderRequest
+     * @returns CreateGwConsumerOrderResponse
+     */
+    async createGwConsumerOrder(request) {
+        let runtime = new $dara.RuntimeOptions({});
+        return await this.createGwConsumerOrderWithOptions(request, runtime);
+    }
     /**
      * Creates a model API.
      *
@@ -9106,10 +9180,10 @@ class Client extends openapi_core_1.default {
         return await this.describeApikeyAttributeWithOptions(request, runtime);
     }
     /**
-     * Retrieves the details of a specific application in a PolarDB instance.
+     * Retrieves the detailed information of a specified PolarDB application.
      *
      * @remarks
-     * Retrieves all information about a specific PolarDB application, such as component details and endpoints.
+     * This API is used to query all related information of a specific PolarDB application, including but not limited to component details and endpoints.
      *
      * @param request - DescribeApplicationAttributeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -9138,10 +9212,10 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeApplicationAttributeResponse({}));
     }
     /**
-     * Retrieves the details of a specific application in a PolarDB instance.
+     * Retrieves the detailed information of a specified PolarDB application.
      *
      * @remarks
-     * Retrieves all information about a specific PolarDB application, such as component details and endpoints.
+     * This API is used to query all related information of a specific PolarDB application, including but not limited to component details and endpoints.
      *
      * @param request - DescribeApplicationAttributeRequest
      * @returns DescribeApplicationAttributeResponse
@@ -9151,7 +9225,7 @@ class Client extends openapi_core_1.default {
         return await this.describeApplicationAttributeWithOptions(request, runtime);
     }
     /**
-     * Queries the log details of an AI application.
+     * Queries the details of AI application logs.
      *
      * @param request - DescribeApplicationLogsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -9219,7 +9293,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeApplicationLogsResponse({}));
     }
     /**
-     * Queries the log details of an AI application.
+     * Queries the details of AI application logs.
      *
      * @param request - DescribeApplicationLogsRequest
      * @returns DescribeApplicationLogsResponse
@@ -9276,7 +9350,7 @@ class Client extends openapi_core_1.default {
         return await this.describeApplicationParametersWithOptions(request, runtime);
     }
     /**
-     * Querying PolarDB AI application performance.
+     * Queries the performance of a PolarDB AI application.
      *
      * @param request - DescribeApplicationPerformanceRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -9338,7 +9412,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeApplicationPerformanceResponse({}));
     }
     /**
-     * Querying PolarDB AI application performance.
+     * Queries the performance of a PolarDB AI application.
      *
      * @param request - DescribeApplicationPerformanceRequest
      * @returns DescribeApplicationPerformanceResponse
@@ -21066,7 +21140,7 @@ class Client extends openapi_core_1.default {
         return await this.modifyDBClusterResourceGroupWithOptions(request, runtime);
     }
     /**
-     * Enables or shuts down the Secure Sockets Layer (SSL) encryption feature for a PolarDB cluster, or updates the CA certificate of a PolarDB cluster.
+     * Enables or performs shutdown of the Secure Sockets Layer (SSL) encryption feature for a PolarDB cluster, or updates the CA certificate of a PolarDB cluster.
      *
      * @param request - ModifyDBClusterSSLRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -21075,6 +21149,9 @@ class Client extends openapi_core_1.default {
     async modifyDBClusterSSLWithOptions(request, runtime) {
         request.validate();
         let query = {};
+        if (!$dara.isNull(request.certValidDays)) {
+            query["CertValidDays"] = request.certValidDays;
+        }
         if (!$dara.isNull(request.connectionString)) {
             query["ConnectionString"] = request.connectionString;
         }
@@ -21125,7 +21202,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyDBClusterSSLResponse({}));
     }
     /**
-     * Enables or shuts down the Secure Sockets Layer (SSL) encryption feature for a PolarDB cluster, or updates the CA certificate of a PolarDB cluster.
+     * Enables or performs shutdown of the Secure Sockets Layer (SSL) encryption feature for a PolarDB cluster, or updates the CA certificate of a PolarDB cluster.
      *
      * @param request - ModifyDBClusterSSLRequest
      * @returns ModifyDBClusterSSLResponse
@@ -24181,6 +24258,48 @@ class Client extends openapi_core_1.default {
         let runtime = new $dara.RuntimeOptions({});
         return await this.restartDBNodeZonalWithOptions(request, runtime);
     }
+    /**
+     * Restarts a PolarClaw gateway.
+     *
+     * @param request - RestartPolarClawGatewayRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns RestartPolarClawGatewayResponse
+     */
+    async restartPolarClawGatewayWithOptions(request, runtime) {
+        request.validate();
+        let query = {};
+        if (!$dara.isNull(request.applicationId)) {
+            query["ApplicationId"] = request.applicationId;
+        }
+        if (!$dara.isNull(request.mode)) {
+            query["Mode"] = request.mode;
+        }
+        let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
+            query: openapi_core_2.OpenApiUtil.query(query),
+        });
+        let params = new openapi_core_2.$OpenApiUtil.Params({
+            action: "RestartPolarClawGateway",
+            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.RestartPolarClawGatewayResponse({}));
+    }
+    /**
+     * Restarts a PolarClaw gateway.
+     *
+     * @param request - RestartPolarClawGatewayRequest
+     * @returns RestartPolarClawGatewayResponse
+     */
+    async restartPolarClawGateway(request) {
+        let runtime = new $dara.RuntimeOptions({});
+        return await this.restartPolarClawGatewayWithOptions(request, runtime);
+    }
     /**
      * Restores databases or tables to a PolarDB cluster.
      *