@alicloud/polardb20170801 7.4.0 → 7.5.0

package/dist/client.js

@@ -1873,7 +1873,7 @@ class Client extends openapi_core_1.default {
         return await this.createAIDBClusterDatasetWithOptions(request, runtime);
     }
     /**
-     * Creates a model operator instance.
+     * Creates a model creation operator instance.
      *
      * @param request - CreateAIDBClusterTaskRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1930,6 +1930,9 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.taskName)) {
             query["TaskName"] = request.taskName;
         }
+        if (!$dara.isNull(request.tuneArch)) {
+            query["TuneArch"] = request.tuneArch;
+        }
         if (!$dara.isNull(request.VPCId)) {
             query["VPCId"] = request.VPCId;
         }
@@ -1956,7 +1959,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateAIDBClusterTaskResponse({}));
     }
     /**
-     * Creates a model operator instance.
+     * Creates a model creation operator instance.
      *
      * @param request - CreateAIDBClusterTaskRequest
      * @returns CreateAIDBClusterTaskResponse
@@ -2655,11 +2658,9 @@ class Client extends openapi_core_1.default {
      * Creates a full snapshot backup for a PolarDB cluster.
      *
      * @remarks
-     * > - Each cluster can have up to three manually created backups at a time.
-     * >
-     * > - If you receive the error message `Exceeding the daily backup times of this DB cluster`, this indicates that three manual backups already exist for your cluster. [Delete a backup](https://help.aliyun.com/document_detail/98101.html) before you call this operation again.
-     * >
-     * > - After you call this operation, a backup job is created in the background. The job may take a long time to complete if the data volume is large.
+     * > * Each cluster can have up to 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 you call 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 - CreateBackupRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2671,6 +2672,9 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.clientToken)) {
             query["ClientToken"] = request.clientToken;
         }
+        if (!$dara.isNull(request.comment)) {
+            query["Comment"] = request.comment;
+        }
         if (!$dara.isNull(request.DBClusterId)) {
             query["DBClusterId"] = request.DBClusterId;
         }
@@ -2706,11 +2710,9 @@ class Client extends openapi_core_1.default {
      * Creates a full snapshot backup for a PolarDB cluster.
      *
      * @remarks
-     * > - Each cluster can have up to three manually created backups at a time.
-     * >
-     * > - If you receive the error message `Exceeding the daily backup times of this DB cluster`, this indicates that three manual backups already exist for your cluster. [Delete a backup](https://help.aliyun.com/document_detail/98101.html) before you call this operation again.
-     * >
-     * > - After you call this operation, a backup job is created in the background. The job may take a long time to complete if the data volume is large.
+     * > * Each cluster can have up to 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 you call 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 - CreateBackupRequest
      * @returns CreateBackupResponse
@@ -7800,7 +7802,7 @@ class Client extends openapi_core_1.default {
         return await this.describeAIDBClusterPerformanceWithOptions(request, runtime);
     }
     /**
-     * Get task instance details
+     * Retrieves the details of a task instance.
      *
      * @param request - DescribeAIDBClusterTaskAttributeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -7847,7 +7849,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeAIDBClusterTaskAttributeResponse({}));
     }
     /**
-     * Get task instance details
+     * Retrieves the details of a task instance.
      *
      * @param request - DescribeAIDBClusterTaskAttributeRequest
      * @returns DescribeAIDBClusterTaskAttributeResponse
@@ -7983,12 +7985,12 @@ class Client extends openapi_core_1.default {
         return await this.describeAIDBClusterTaskMetricsWithOptions(request, runtime);
     }
     /**
-     * Retrieves a list of model operators for a specified PolarDB instance.
+     * Retrieves the list of model operators for a specified PolarDB database instance.
      *
      * @remarks
-     * ## Request
-     * - This API returns a list of model operators filtered by the `RelativeDBClusterId` and `KubeType` parameters.
-     * - Note: Ensure the provided `RelativeDBClusterId` matches the ID of an existing PolarDB database instance. Otherwise, no data will be returned.
+     * ## Description
+     * - This operation supports filtering and returning the list of model operators based on the `RelativeDBClusterId` and `KubeType` parameters.
+     * - Note: Ensure that the `RelativeDBClusterId` provided in the request matches an existing PolarDB database instance ID. Otherwise, data cannot be retrieved correctly.
      *
      * @param request - DescribeAIDBClusterTasksRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -8035,12 +8037,12 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeAIDBClusterTasksResponse({}));
     }
     /**
-     * Retrieves a list of model operators for a specified PolarDB instance.
+     * Retrieves the list of model operators for a specified PolarDB database instance.
      *
      * @remarks
-     * ## Request
-     * - This API returns a list of model operators filtered by the `RelativeDBClusterId` and `KubeType` parameters.
-     * - Note: Ensure the provided `RelativeDBClusterId` matches the ID of an existing PolarDB database instance. Otherwise, no data will be returned.
+     * ## Description
+     * - This operation supports filtering and returning the list of model operators based on the `RelativeDBClusterId` and `KubeType` parameters.
+     * - Note: Ensure that the `RelativeDBClusterId` provided in the request matches an existing PolarDB database instance ID. Otherwise, data cannot be retrieved correctly.
      *
      * @param request - DescribeAIDBClusterTasksRequest
      * @returns DescribeAIDBClusterTasksResponse
@@ -9149,7 +9151,7 @@ class Client extends openapi_core_1.default {
         return await this.describeApplicationAttributeWithOptions(request, runtime);
     }
     /**
-     * AI Application Log Details
+     * Queries the log details of an AI application.
      *
      * @param request - DescribeApplicationLogsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -9217,7 +9219,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeApplicationLogsResponse({}));
     }
     /**
-     * AI Application Log Details
+     * Queries the log details of an AI application.
      *
      * @param request - DescribeApplicationLogsRequest
      * @returns DescribeApplicationLogsResponse
@@ -9592,7 +9594,7 @@ class Client extends openapi_core_1.default {
         return await this.describeAvailableCrossRegionsWithOptions(request, runtime);
     }
     /**
-     * Lists the available models in an AI cluster.
+     * Retrieves the list of AI cluster models.
      *
      * @param request - DescribeAvailableModelsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -9624,7 +9626,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeAvailableModelsResponse({}));
     }
     /**
-     * Lists the available models in an AI cluster.
+     * Retrieves the list of AI cluster models.
      *
      * @param request - DescribeAvailableModelsRequest
      * @returns DescribeAvailableModelsResponse
@@ -9859,7 +9861,7 @@ class Client extends openapi_core_1.default {
         return await this.describeBackupTasksWithOptions(request, runtime);
     }
     /**
-     * Queries backup information for a PolarDB cluster.
+     * Queries the backup information of a PolarDB cluster.
      *
      * @param request - DescribeBackupsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -9924,7 +9926,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeBackupsResponse({}));
     }
     /**
-     * Queries backup information for a PolarDB cluster.
+     * Queries the backup information of a PolarDB cluster.
      *
      * @param request - DescribeBackupsRequest
      * @returns DescribeBackupsResponse
@@ -10032,7 +10034,7 @@ class Client extends openapi_core_1.default {
         return await this.describeBatchTasksWithOptions(request, runtime);
     }
     /**
-     * Querying budget policies
+     * Queries cost budget policies.
      *
      * @param request - DescribeBudgetPoliciesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -10062,6 +10064,9 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.regionId)) {
             query["RegionId"] = request.regionId;
         }
+        if (!$dara.isNull(request.scopeRefName)) {
+            query["ScopeRefName"] = request.scopeRefName;
+        }
         if (!$dara.isNull(request.status)) {
             query["Status"] = request.status;
         }
@@ -10082,7 +10087,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeBudgetPoliciesResponse({}));
     }
     /**
-     * Querying budget policies
+     * Queries cost budget policies.
      *
      * @param request - DescribeBudgetPoliciesRequest
      * @returns DescribeBudgetPoliciesResponse
@@ -10341,7 +10346,7 @@ class Client extends openapi_core_1.default {
         return await this.describeConsumerGroupsWithOptions(request, runtime);
     }
     /**
-     * Returns a list of consumers.
+     * Queries the list of consumers.
      *
      * @param request - DescribeConsumersRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -10356,6 +10361,12 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.consumerId)) {
             query["ConsumerId"] = request.consumerId;
         }
+        if (!$dara.isNull(request.consumerName)) {
+            query["ConsumerName"] = request.consumerName;
+        }
+        if (!$dara.isNull(request.consumerNameList)) {
+            query["ConsumerNameList"] = request.consumerNameList;
+        }
         if (!$dara.isNull(request.gwClusterId)) {
             query["GwClusterId"] = request.gwClusterId;
         }
@@ -10385,7 +10396,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeConsumersResponse({}));
     }
     /**
-     * Returns a list of consumers.
+     * Queries the list of consumers.
      *
      * @param request - DescribeConsumersRequest
      * @returns DescribeConsumersResponse
@@ -10650,7 +10661,7 @@ class Client extends openapi_core_1.default {
         return await this.describeCrossCloudRegionMappingToAliyunWithOptions(request, runtime);
     }
     /**
-     * Queries the IP whitelists and security groups that are allowed to access a database cluster.
+     * Queries the IP whitelist and security groups that are allowed to access a database cluster.
      *
      * @param request - DescribeDBClusterAccessWhitelistRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -10668,6 +10679,9 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.ownerId)) {
             query["OwnerId"] = request.ownerId;
         }
+        if (!$dara.isNull(request.pfsInstanceId)) {
+            query["PfsInstanceId"] = request.pfsInstanceId;
+        }
         if (!$dara.isNull(request.resourceOwnerAccount)) {
             query["ResourceOwnerAccount"] = request.resourceOwnerAccount;
         }
@@ -10691,7 +10705,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeDBClusterAccessWhitelistResponse({}));
     }
     /**
-     * Queries the IP whitelists and security groups that are allowed to access a database cluster.
+     * Queries the IP whitelist and security groups that are allowed to access a database cluster.
      *
      * @param request - DescribeDBClusterAccessWhitelistRequest
      * @returns DescribeDBClusterAccessWhitelistResponse
@@ -11405,6 +11419,110 @@ class Client extends openapi_core_1.default {
         let runtime = new $dara.RuntimeOptions({});
         return await this.describeDBClusterPerformanceWithOptions(request, runtime);
     }
+    /**
+     * Queries the price of a cluster.
+     *
+     * @param tmpReq - DescribeDBClusterPriceRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribeDBClusterPriceResponse
+     */
+    async describeDBClusterPriceWithOptions(tmpReq, runtime) {
+        tmpReq.validate();
+        let request = new $_model.DescribeDBClusterPriceShrinkRequest({});
+        openapi_core_2.OpenApiUtil.convert(tmpReq, request);
+        if (!$dara.isNull(tmpReq.DBNodes)) {
+            request.DBNodesShrink = openapi_core_2.OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.DBNodes, "DBNodes", "json");
+        }
+        let query = {};
+        if (!$dara.isNull(request.creationCategory)) {
+            query["CreationCategory"] = request.creationCategory;
+        }
+        if (!$dara.isNull(request.DBClusterId)) {
+            query["DBClusterId"] = request.DBClusterId;
+        }
+        if (!$dara.isNull(request.DBNodeClass)) {
+            query["DBNodeClass"] = request.DBNodeClass;
+        }
+        if (!$dara.isNull(request.DBNodeIds)) {
+            query["DBNodeIds"] = request.DBNodeIds;
+        }
+        if (!$dara.isNull(request.DBNodeNum)) {
+            query["DBNodeNum"] = request.DBNodeNum;
+        }
+        if (!$dara.isNull(request.DBNodesShrink)) {
+            query["DBNodes"] = request.DBNodesShrink;
+        }
+        if (!$dara.isNull(request.DBType)) {
+            query["DBType"] = request.DBType;
+        }
+        if (!$dara.isNull(request.DBVersion)) {
+            query["DBVersion"] = request.DBVersion;
+        }
+        if (!$dara.isNull(request.hotStandbyCluster)) {
+            query["HotStandbyCluster"] = request.hotStandbyCluster;
+        }
+        if (!$dara.isNull(request.modifyType)) {
+            query["ModifyType"] = request.modifyType;
+        }
+        if (!$dara.isNull(request.orderType)) {
+            query["OrderType"] = request.orderType;
+        }
+        if (!$dara.isNull(request.payType)) {
+            query["PayType"] = request.payType;
+        }
+        if (!$dara.isNull(request.period)) {
+            query["Period"] = request.period;
+        }
+        if (!$dara.isNull(request.provisionedIops)) {
+            query["ProvisionedIops"] = request.provisionedIops;
+        }
+        if (!$dara.isNull(request.regionId)) {
+            query["RegionId"] = request.regionId;
+        }
+        if (!$dara.isNull(request.serverlessType)) {
+            query["ServerlessType"] = request.serverlessType;
+        }
+        if (!$dara.isNull(request.storageChargeType)) {
+            query["StorageChargeType"] = request.storageChargeType;
+        }
+        if (!$dara.isNull(request.storageSpace)) {
+            query["StorageSpace"] = request.storageSpace;
+        }
+        if (!$dara.isNull(request.storageType)) {
+            query["StorageType"] = request.storageType;
+        }
+        if (!$dara.isNull(request.usedTime)) {
+            query["UsedTime"] = request.usedTime;
+        }
+        if (!$dara.isNull(request.zoneId)) {
+            query["ZoneId"] = request.zoneId;
+        }
+        let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
+            query: openapi_core_2.OpenApiUtil.query(query),
+        });
+        let params = new openapi_core_2.$OpenApiUtil.Params({
+            action: "DescribeDBClusterPrice",
+            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.DescribeDBClusterPriceResponse({}));
+    }
+    /**
+     * Queries the price of a cluster.
+     *
+     * @param request - DescribeDBClusterPriceRequest
+     * @returns DescribeDBClusterPriceResponse
+     */
+    async describeDBClusterPrice(request) {
+        let runtime = new $dara.RuntimeOptions({});
+        return await this.describeDBClusterPriceWithOptions(request, runtime);
+    }
     /**
      * Queries a database cluster proxy.
      *
@@ -11481,6 +11599,9 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.ownerId)) {
             query["OwnerId"] = request.ownerId;
         }
+        if (!$dara.isNull(request.pfsInstanceId)) {
+            query["PfsInstanceId"] = request.pfsInstanceId;
+        }
         if (!$dara.isNull(request.resourceOwnerAccount)) {
             query["ResourceOwnerAccount"] = request.resourceOwnerAccount;
         }
@@ -15249,7 +15370,7 @@ class Client extends openapi_core_1.default {
         return await this.describePolarClawTaskWithOptions(request, runtime);
     }
     /**
-     * 查看polarfs信息
+     * Queries PolarFS information.
      *
      * @param request - DescribePolarFsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -15302,7 +15423,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribePolarFsResponse({}));
     }
     /**
-     * 查看polarfs信息
+     * Queries PolarFS information.
      *
      * @param request - DescribePolarFsRequest
      * @returns DescribePolarFsResponse
@@ -19804,7 +19925,7 @@ class Client extends openapi_core_1.default {
         return await this.modifyDBClusterWithOptions(request, runtime);
     }
     /**
-     * Creates or modifies the access whitelist for a cluster. The whitelist can be an IP address whitelist or a security group.
+     * Creates or modifies the whitelist of a cluster, including the IP whitelist and security groups.
      *
      * @param request - ModifyDBClusterAccessWhitelistRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -19831,6 +19952,9 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.ownerId)) {
             query["OwnerId"] = request.ownerId;
         }
+        if (!$dara.isNull(request.pfsInstanceId)) {
+            query["PfsInstanceId"] = request.pfsInstanceId;
+        }
         if (!$dara.isNull(request.resourceOwnerAccount)) {
             query["ResourceOwnerAccount"] = request.resourceOwnerAccount;
         }
@@ -19863,7 +19987,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyDBClusterAccessWhitelistResponse({}));
     }
     /**
-     * Creates or modifies the access whitelist for a cluster. The whitelist can be an IP address whitelist or a security group.
+     * Creates or modifies the whitelist of a cluster, including the IP whitelist and security groups.
      *
      * @param request - ModifyDBClusterAccessWhitelistRequest
      * @returns ModifyDBClusterAccessWhitelistResponse
@@ -20867,7 +20991,7 @@ class Client extends openapi_core_1.default {
         return await this.modifyDBClusterResourceGroupWithOptions(request, runtime);
     }
     /**
-     * Enables or disables SSL encryption for a PolarDB cluster, or updates its CA certificate.
+     * Enables or shuts down 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
@@ -20876,6 +21000,9 @@ class Client extends openapi_core_1.default {
     async modifyDBClusterSSLWithOptions(request, runtime) {
         request.validate();
         let query = {};
+        if (!$dara.isNull(request.connectionString)) {
+            query["ConnectionString"] = request.connectionString;
+        }
         if (!$dara.isNull(request.DBClusterId)) {
             query["DBClusterId"] = request.DBClusterId;
         }
@@ -20891,6 +21018,9 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.ownerId)) {
             query["OwnerId"] = request.ownerId;
         }
+        if (!$dara.isNull(request.pfsInstanceId)) {
+            query["PfsInstanceId"] = request.pfsInstanceId;
+        }
         if (!$dara.isNull(request.resourceOwnerAccount)) {
             query["ResourceOwnerAccount"] = request.resourceOwnerAccount;
         }
@@ -20920,7 +21050,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyDBClusterSSLResponse({}));
     }
     /**
-     * Enables or disables SSL encryption for a PolarDB cluster, or updates its CA certificate.
+     * Enables or shuts down 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