@alicloud/polardb20170801 7.3.0 → 7.5.0

package/dist/client.d.ts

@@ -550,7 +550,7 @@ export default class Client extends OpenApi {
      */
     createAIDBClusterDataset(request: $_model.CreateAIDBClusterDatasetRequest): Promise<$_model.CreateAIDBClusterDatasetResponse>;
     /**
-     * Creates a model operator instance.
+     * Creates a model creation operator instance.
      *
      * @param request - CreateAIDBClusterTaskRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -558,7 +558,7 @@ export default class Client extends OpenApi {
      */
     createAIDBClusterTaskWithOptions(request: $_model.CreateAIDBClusterTaskRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAIDBClusterTaskResponse>;
     /**
-     * Creates a model operator instance.
+     * Creates a model creation operator instance.
      *
      * @param request - CreateAIDBClusterTaskRequest
      * @returns CreateAIDBClusterTaskResponse
@@ -580,7 +580,7 @@ export default class Client extends OpenApi {
      */
     createAINodes(request: $_model.CreateAINodesRequest): Promise<$_model.CreateAINodesResponse>;
     /**
-     * Creates a database account for a PolarDB cluster.
+     * Creates a PolarDB database account.
      *
      * @param request - CreateAccountRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -588,7 +588,7 @@ export default class Client extends OpenApi {
      */
     createAccountWithOptions(request: $_model.CreateAccountRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAccountResponse>;
     /**
-     * Creates a database account for a PolarDB cluster.
+     * Creates a PolarDB database account.
      *
      * @param request - CreateAccountRequest
      * @returns CreateAccountResponse
@@ -718,11 +718,9 @@ export default class Client extends OpenApi {
      * 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
@@ -733,11 +731,9 @@ export default class Client extends OpenApi {
      * 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
@@ -2186,7 +2182,7 @@ export default class Client extends OpenApi {
      */
     describeAIDBClusterPerformance(request: $_model.DescribeAIDBClusterPerformanceRequest): Promise<$_model.DescribeAIDBClusterPerformanceResponse>;
     /**
-     * Get task instance details
+     * Retrieves the details of a task instance.
      *
      * @param request - DescribeAIDBClusterTaskAttributeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2194,7 +2190,7 @@ export default class Client extends OpenApi {
      */
     describeAIDBClusterTaskAttributeWithOptions(request: $_model.DescribeAIDBClusterTaskAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeAIDBClusterTaskAttributeResponse>;
     /**
-     * Get task instance details
+     * Retrieves the details of a task instance.
      *
      * @param request - DescribeAIDBClusterTaskAttributeRequest
      * @returns DescribeAIDBClusterTaskAttributeResponse
@@ -2237,12 +2233,12 @@ export default class Client extends OpenApi {
      */
     describeAIDBClusterTaskMetrics(request: $_model.DescribeAIDBClusterTaskMetricsRequest): Promise<$_model.DescribeAIDBClusterTaskMetricsResponse>;
     /**
-     * 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
@@ -2250,12 +2246,12 @@ export default class Client extends OpenApi {
      */
     describeAIDBClusterTasksWithOptions(request: $_model.DescribeAIDBClusterTasksRequest, runtime: $dara.RuntimeOptions): Promise<$_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
@@ -2467,7 +2463,7 @@ export default class Client extends OpenApi {
      */
     describeAgenticDBClusters(request: $_model.DescribeAgenticDBClustersRequest): Promise<$_model.DescribeAgenticDBClustersResponse>;
     /**
-     * 查询 AgenticDB 计算实例列表
+     * Queries the list of AgenticDB compute instances.
      *
      * @param request - DescribeAgenticDBComputeClustersRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2475,7 +2471,7 @@ export default class Client extends OpenApi {
      */
     describeAgenticDBComputeClustersWithOptions(request: $_model.DescribeAgenticDBComputeClustersRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeAgenticDBComputeClustersResponse>;
     /**
-     * 查询 AgenticDB 计算实例列表
+     * Queries the list of AgenticDB compute instances.
      *
      * @param request - DescribeAgenticDBComputeClustersRequest
      * @returns DescribeAgenticDBComputeClustersResponse
@@ -2563,7 +2559,7 @@ export default class Client extends OpenApi {
      */
     describeApplicationAttribute(request: $_model.DescribeApplicationAttributeRequest): Promise<$_model.DescribeApplicationAttributeResponse>;
     /**
-     * AI Application Log Details
+     * Queries the log details of an AI application.
      *
      * @param request - DescribeApplicationLogsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2571,7 +2567,7 @@ export default class Client extends OpenApi {
      */
     describeApplicationLogsWithOptions(request: $_model.DescribeApplicationLogsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeApplicationLogsResponse>;
     /**
-     * AI Application Log Details
+     * Queries the log details of an AI application.
      *
      * @param request - DescribeApplicationLogsRequest
      * @returns DescribeApplicationLogsResponse
@@ -2683,7 +2679,7 @@ export default class Client extends OpenApi {
      */
     describeAvailableCrossRegions(request: $_model.DescribeAvailableCrossRegionsRequest): Promise<$_model.DescribeAvailableCrossRegionsResponse>;
     /**
-     * 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
@@ -2691,7 +2687,7 @@ export default class Client extends OpenApi {
      */
     describeAvailableModelsWithOptions(request: $_model.DescribeAvailableModelsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeAvailableModelsResponse>;
     /**
-     * Lists the available models in an AI cluster.
+     * Retrieves the list of AI cluster models.
      *
      * @param request - DescribeAvailableModelsRequest
      * @returns DescribeAvailableModelsResponse
@@ -2758,7 +2754,7 @@ export default class Client extends OpenApi {
      */
     describeBackupTasks(request: $_model.DescribeBackupTasksRequest): Promise<$_model.DescribeBackupTasksResponse>;
     /**
-     * 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
@@ -2766,7 +2762,7 @@ export default class Client extends OpenApi {
      */
     describeBackupsWithOptions(request: $_model.DescribeBackupsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeBackupsResponse>;
     /**
-     * Queries backup information for a PolarDB cluster.
+     * Queries the backup information of a PolarDB cluster.
      *
      * @param request - DescribeBackupsRequest
      * @returns DescribeBackupsResponse
@@ -2803,7 +2799,7 @@ export default class Client extends OpenApi {
      */
     describeBatchTasks(request: $_model.DescribeBatchTasksRequest): Promise<$_model.DescribeBatchTasksResponse>;
     /**
-     * Querying budget policies
+     * Queries cost budget policies.
      *
      * @param request - DescribeBudgetPoliciesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2811,7 +2807,7 @@ export default class Client extends OpenApi {
      */
     describeBudgetPoliciesWithOptions(request: $_model.DescribeBudgetPoliciesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeBudgetPoliciesResponse>;
     /**
-     * Querying budget policies
+     * Queries cost budget policies.
      *
      * @param request - DescribeBudgetPoliciesRequest
      * @returns DescribeBudgetPoliciesResponse
@@ -2878,7 +2874,7 @@ export default class Client extends OpenApi {
      */
     describeConsumerGroups(request: $_model.DescribeConsumerGroupsRequest): Promise<$_model.DescribeConsumerGroupsResponse>;
     /**
-     * Returns a list of consumers.
+     * Queries the list of consumers.
      *
      * @param request - DescribeConsumersRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2886,7 +2882,7 @@ export default class Client extends OpenApi {
      */
     describeConsumersWithOptions(request: $_model.DescribeConsumersRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeConsumersResponse>;
     /**
-     * Returns a list of consumers.
+     * Queries the list of consumers.
      *
      * @param request - DescribeConsumersRequest
      * @returns DescribeConsumersResponse
@@ -2968,7 +2964,7 @@ export default class Client extends OpenApi {
      */
     describeCrossCloudRegionMappingToAliyun(request: $_model.DescribeCrossCloudRegionMappingToAliyunRequest): Promise<$_model.DescribeCrossCloudRegionMappingToAliyunResponse>;
     /**
-     * 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
@@ -2976,7 +2972,7 @@ export default class Client extends OpenApi {
      */
     describeDBClusterAccessWhitelistWithOptions(request: $_model.DescribeDBClusterAccessWhitelistRequest, runtime: $dara.RuntimeOptions): Promise<$_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
@@ -3210,6 +3206,21 @@ export default class Client extends OpenApi {
      * @returns DescribeDBClusterPerformanceResponse
      */
     describeDBClusterPerformance(request: $_model.DescribeDBClusterPerformanceRequest): Promise<$_model.DescribeDBClusterPerformanceResponse>;
+    /**
+     * Queries the price of a cluster.
+     *
+     * @param tmpReq - DescribeDBClusterPriceRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribeDBClusterPriceResponse
+     */
+    describeDBClusterPriceWithOptions(tmpReq: $_model.DescribeDBClusterPriceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDBClusterPriceResponse>;
+    /**
+     * Queries the price of a cluster.
+     *
+     * @param request - DescribeDBClusterPriceRequest
+     * @returns DescribeDBClusterPriceResponse
+     */
+    describeDBClusterPrice(request: $_model.DescribeDBClusterPriceRequest): Promise<$_model.DescribeDBClusterPriceResponse>;
     /**
      * Queries a database cluster proxy.
      *
@@ -4281,6 +4292,21 @@ export default class Client extends OpenApi {
      * @returns DescribePolarClawTaskResponse
      */
     describePolarClawTask(request: $_model.DescribePolarClawTaskRequest): Promise<$_model.DescribePolarClawTaskResponse>;
+    /**
+     * Queries PolarFS information.
+     *
+     * @param request - DescribePolarFsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribePolarFsResponse
+     */
+    describePolarFsWithOptions(request: $_model.DescribePolarFsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribePolarFsResponse>;
+    /**
+     * Queries PolarFS information.
+     *
+     * @param request - DescribePolarFsRequest
+     * @returns DescribePolarFsResponse
+     */
+    describePolarFs(request: $_model.DescribePolarFsRequest): Promise<$_model.DescribePolarFsResponse>;
     /**
      * Retrieves the details of a PolarLakebase instance.
      *
@@ -5526,7 +5552,7 @@ export default class Client extends OpenApi {
      */
     modifyDBCluster(request: $_model.ModifyDBClusterRequest): Promise<$_model.ModifyDBClusterResponse>;
     /**
-     * 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
@@ -5534,7 +5560,7 @@ export default class Client extends OpenApi {
      */
     modifyDBClusterAccessWhitelistWithOptions(request: $_model.ModifyDBClusterAccessWhitelistRequest, runtime: $dara.RuntimeOptions): Promise<$_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
@@ -5824,7 +5850,7 @@ export default class Client extends OpenApi {
      */
     modifyDBClusterResourceGroup(request: $_model.ModifyDBClusterResourceGroupRequest): Promise<$_model.ModifyDBClusterResourceGroupResponse>;
     /**
-     * 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
@@ -5832,7 +5858,7 @@ export default class Client extends OpenApi {
      */
     modifyDBClusterSSLWithOptions(request: $_model.ModifyDBClusterSSLRequest, runtime: $dara.RuntimeOptions): Promise<$_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
@@ -7062,7 +7088,7 @@ export default class Client extends OpenApi {
      */
     upgradePolarClawSkills(request: $_model.UpgradePolarClawSkillsRequest): Promise<$_model.UpgradePolarClawSkillsResponse>;
     /**
-     * 校验 AgenticDB 租户 API Key
+     * Validates an AgenticDB tenant API key.
      *
      * @param request - VerifyAgenticDBTenantApiKeyRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -7070,7 +7096,7 @@ export default class Client extends OpenApi {
      */
     verifyAgenticDBTenantApiKeyWithOptions(request: $_model.VerifyAgenticDBTenantApiKeyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.VerifyAgenticDBTenantApiKeyResponse>;
     /**
-     * 校验 AgenticDB 租户 API Key
+     * Validates an AgenticDB tenant API key.
      *
      * @param request - VerifyAgenticDBTenantApiKeyRequest
      * @returns VerifyAgenticDBTenantApiKeyResponse