@alicloud/adb20211201 4.7.0 → 5.0.0

package/src/models/DescribeDbclusterHealthStatusResponseBody.ts

@@ -5,23 +5,23 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDBClusterHealthStatusResponseBodyCS extends $dara.Model {
   /**
    * @remarks
-   * The number of healthy access nodes.
+   * The number of healthy instance access nodes.
    * 
    * @example
-   * 2
+   * 0
    */
   activeCount?: number;
   /**
    * @remarks
-   * The total number of access nodes.
+   * The total number of instance access nodes.
    * 
    * @example
-   * 2
+   * 1
    */
   expectedCount?: number;
   /**
    * @remarks
-   * The number of risky nodes.
+   * The number of instance access nodes at risk.
    * 
    * @example
    * 0
@@ -29,22 +29,24 @@ export class DescribeDBClusterHealthStatusResponseBodyCS extends $dara.Model {
   riskCount?: number;
   /**
    * @remarks
-   * The health state of access nodes. Valid values:
+   * The health status of the instance access nodes. Valid values:
+   * 
+   * - **RISK**: The instance access nodes are at risk.
+   * 
+   * - **NORMAL**: The instance access nodes are healthy.
    * 
-   * *   **RISK**
-   * *   **NORMAL**
-   * *   **UNAVAILABLE**
+   * - **UNAVAILABLE**: The instance access nodes are unavailable.
    * 
    * @example
-   * NORMAL
+   * UNAVAILABLE
    */
   status?: string;
   /**
    * @remarks
-   * The number of unavailable access nodes.
+   * The number of unavailable instance access nodes.
    * 
    * @example
-   * 0
+   * 1
    */
   unavailableCount?: number;
   static names(): { [key: string]: string } {
@@ -79,23 +81,23 @@ export class DescribeDBClusterHealthStatusResponseBodyCS extends $dara.Model {
 export class DescribeDBClusterHealthStatusResponseBodyExecutor extends $dara.Model {
   /**
    * @remarks
-   * The number of healthy access nodes.
+   * The number of healthy executor nodes.
    * 
    * @example
-   * 2
+   * 0
    */
   activeCount?: number;
   /**
    * @remarks
-   * The total number of compute nodes.
+   * The total number of executor nodes.
    * 
    * @example
-   * 2
+   * 1
    */
   expectedCount?: number;
   /**
    * @remarks
-   * The number of risky nodes.
+   * The number of executor nodes at risk.
    * 
    * @example
    * 0
@@ -103,22 +105,24 @@ export class DescribeDBClusterHealthStatusResponseBodyExecutor extends $dara.Mod
   riskCount?: number;
   /**
    * @remarks
-   * The health state of compute node groups. Valid values:
+   * The health status of the executor groups. Valid values:
    * 
-   * *   **RISK**
-   * *   **NORMAL**
-   * *   **UNAVAILABLE**
+   * - **RISK**: The executor groups are at risk.
+   * 
+   * - **NORMAL**: The executor groups are healthy.
+   * 
+   * - **UNAVAILABLE**: The executor groups are unavailable.
    * 
    * @example
-   * NORMAL
+   * UNAVAILABLE
    */
   status?: string;
   /**
    * @remarks
-   * The number of unavailable access nodes.
+   * The number of unavailable executor nodes.
    * 
    * @example
-   * 0
+   * 1
    */
   unavailableCount?: number;
   static names(): { [key: string]: string } {
@@ -153,46 +157,48 @@ export class DescribeDBClusterHealthStatusResponseBodyExecutor extends $dara.Mod
 export class DescribeDBClusterHealthStatusResponseBodyWorker extends $dara.Model {
   /**
    * @remarks
-   * The number of healthy storage node groups.
+   * The number of healthy worker node groups.
    * 
    * @example
-   * 2
+   * 0
    */
   activeCount?: number;
   /**
    * @remarks
-   * The total number of storage node groups.
+   * The total number of worker node groups.
    * 
    * @example
-   * 2
+   * 1
    */
   expectedCount?: number;
   /**
    * @remarks
-   * The number of risky storage node groups.
+   * The number of worker node groups at risk.
    * 
    * @example
-   * 0
+   * 1
    */
   riskCount?: number;
   /**
    * @remarks
-   * The health state of storage node groups. Valid values:
+   * The health status of the worker node groups. Valid values:
    * 
-   * *   **RISK**
-   * *   **NORMAL**
-   * *   **UNAVAILABLE**
+   * - **RISK**: The worker node groups are at risk.
+   * 
+   * - **NORMAL**: The worker node groups are healthy.
+   * 
+   * - **UNAVAILABLE**: The worker node groups are unavailable.
    * 
    * @example
-   * NORMAL
+   * UNAVAILABLE
    */
   status?: string;
   /**
    * @remarks
-   * The number of unavailable storage node groups.
+   * The number of unavailable worker node groups.
    * 
    * @example
-   * 0
+   * 1
    */
   unavailableCount?: number;
   static names(): { [key: string]: string } {
@@ -225,26 +231,35 @@ export class DescribeDBClusterHealthStatusResponseBodyWorker extends $dara.Model
 }
 
 export class DescribeDBClusterHealthStatusResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Details of the authentication failure.
+   * 
+   * @example
+   * Authentication failed.
+   */
   accessDeniedDetail?: string;
   /**
    * @remarks
-   * The access nodes of the queried cluster.
+   * The health status of the instance access nodes.
    */
   CS?: DescribeDBClusterHealthStatusResponseBodyCS;
   /**
    * @remarks
-   * The compute node groups of the queried cluster.
+   * The health status of the executor groups.
    */
   executor?: DescribeDBClusterHealthStatusResponseBodyExecutor;
   /**
    * @remarks
-   * The health state of the cluster. Valid values:
+   * The health status of the cluster. Valid values:
+   * 
+   * - **RISK**: The cluster is at risk.
+   * 
+   * - **NORMAL**: The cluster is healthy.
    * 
-   * *   **RISK**
-   * *   **NORMAL**
-   * *   **UNAVAILABLE**
+   * - **UNAVAILABLE**: The cluster is unavailable.
    * 
-   * >  When the states of the access nodes, compute node groups, and storage node groups of a cluster are all **NORMAL** and a connection to the cluster is established, the state of the cluster is **NORMAL**. When the state of the access nodes, compute node groups, or storage node groups of the cluster is **RISK**, the state of the cluster is **RISK**. When the state of the access nodes, compute node groups, or storage node groups of the cluster is **UNAVAILABLE**, the state of the cluster is **UNAVAILABLE**.
+   * > The cluster health status is considered **NORMAL** only if the instance access nodes, executor groups, and worker node groups are all **NORMAL**, and the instance is responsive. If any of these components has a **RISK** status, the cluster status is **RISK**. If any component has an **UNAVAILABLE** status, the cluster status is **UNAVAILABLE**.
    * 
    * @example
    * NORMAL
@@ -255,12 +270,12 @@ export class DescribeDBClusterHealthStatusResponseBody extends $dara.Model {
    * The request ID.
    * 
    * @example
-   * 1AD222E9-E606-4A42-BF6D-8A4442913CEA
+   * 1AD222E9-E606-4A42-BF6D-8A4442913CAV
    */
   requestId?: string;
   /**
    * @remarks
-   * The storage node groups of the queried cluster.
+   * The health status of the worker node groups.
    */
   worker?: DescribeDBClusterHealthStatusResponseBodyWorker;
   static names(): { [key: string]: string } {

package/src/models/DescribeDbclusterPerformanceRequest.ts

@@ -5,9 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDBClusterPerformanceRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
+   * <props="china">The ID of an enterprise edition, basic edition, or Data Lakehouse Edition cluster.
+   * <props="intl">The ID of a Data Lakehouse Edition cluster.
    * 
-   * >  You can call the [DescribeDBClusters](~~~612397~~~) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.
+   * > You can call the [DescribeDBClusters](~~~612397~~~) operation to query the IDs of all clusters in a specific region.
    * 
    * This parameter is required.
    * 
@@ -17,9 +18,9 @@ export class DescribeDBClusterPerformanceRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.
+   * The end of the time range. The time is in UTC and must be in the *yyyy-MM-ddTHH:mmZ* format.
    * 
-   * > The end time must be later than the start time. The maximum time range that can be specified is two days.
+   * > The end time must be later than the start time. The time range cannot exceed two days.
    * 
    * @example
    * 2022-03-11T15:01Z
@@ -27,7 +28,7 @@ export class DescribeDBClusterPerformanceRequest extends $dara.Model {
   endTime?: string;
   /**
    * @remarks
-   * The key of the performance metric that you want to query. Separate multiple keys with commas (,). For more information about the performance metrics, see [Metric overview](https://help.aliyun.com/document_detail/2863211.html).
+   * The key of the performance metric. Separate multiple keys with commas (,). For a list of supported metrics, see [metric overview](https://help.aliyun.com/document_detail/2863211.html).
    * 
    * @example
    * AnalyticDB_CPU_Usage_Percentage
@@ -35,9 +36,9 @@ export class DescribeDBClusterPerformanceRequest extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The region ID of the cluster.
+   * The region ID.
    * 
-   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/612393.html) operation to query the most recent region list.
+   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/612393.html) operation to query the regions and availability zones supported by AnalyticDB for MySQL, including the region IDs.
    * 
    * This parameter is required.
    * 
@@ -47,7 +48,7 @@ export class DescribeDBClusterPerformanceRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The resource group ID.
+   * The name of the resource pool.
    * 
    * @example
    * user_default
@@ -55,7 +56,7 @@ export class DescribeDBClusterPerformanceRequest extends $dara.Model {
   resourcePools?: string;
   /**
    * @remarks
-   * The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.
+   * The start of the time range. The time is in UTC and must be in the *yyyy-MM-ddTHH:mmZ* format.
    * 
    * @example
    * 2022-03-10T23:56Z

package/src/models/DescribeDbclusterPerformanceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDBClusterPerformanceResponseBodyPerformancesSeries extends $dara.Model {
   /**
    * @remarks
-   * The name of the performance metric value. For more information about the performance metrics, see [Metric overview](https://help.aliyun.com/document_detail/2863211.html).
+   * The name of the performance metric. This parameter is the Value Name of the monitoring metric. For more information, see [Overview of Monitoring Items](https://help.aliyun.com/document_detail/2863211.html).
    * 
    * @example
    * AnalyticDB_Storage_CPU_Avg_Usage_Percentage
@@ -13,16 +13,23 @@ export class DescribeDBClusterPerformanceResponseBodyPerformancesSeries extends
   name?: string;
   /**
    * @remarks
-   * The tags that are added to the cluster.
+   * A JSON string that contains the tags for the metric series.
    * 
    * @example
    * {instance_name: "am-***"}
    */
   tags?: string;
+  /**
+   * @remarks
+   * A key for internal internationalization (i18n). You can safely ignore this parameter.
+   * 
+   * @example
+   * AnalyticDB_RP_WaitTime
+   */
   translateKey?: string;
   /**
    * @remarks
-   * The values of the performance metric at different points in time.
+   * An array of data points for the time series.
    */
   values?: string[];
   static names(): { [key: string]: string } {
@@ -66,12 +73,12 @@ export class DescribeDBClusterPerformanceResponseBodyPerformances extends $dara.
   key?: string;
   /**
    * @remarks
-   * The queried performance metric data.
+   * The time series data for the metric.
    */
   series?: DescribeDBClusterPerformanceResponseBodyPerformancesSeries[];
   /**
    * @remarks
-   * The unit of the performance metric.
+   * The unit of the monitoring metric.
    * 
    * @example
    * %
@@ -108,9 +115,9 @@ export class DescribeDBClusterPerformanceResponseBodyPerformances extends $dara.
 export class DescribeDBClusterPerformanceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
+   * The cluster ID.
    * 
-   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/454250.html) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.
+   * > Call the [DescribeDBClusters](https://help.aliyun.com/document_detail/454250.html) operation to query the IDs of all clusters in a specific region.
    * 
    * @example
    * amv-bp1hx5n1o8f61****
@@ -118,7 +125,7 @@ export class DescribeDBClusterPerformanceResponseBody extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The end time of the query. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time is displayed in UTC.
+   * The end time of the query. The time is in UTC and uses the *yyyy-MM-ddTHH:mmZ* format.
    * 
    * @example
    * 2022-03-11T15:01Z
@@ -126,7 +133,7 @@ export class DescribeDBClusterPerformanceResponseBody extends $dara.Model {
   endTime?: string;
   /**
    * @remarks
-   * The queried performance metrics.
+   * The cluster performance metrics.
    */
   performances?: DescribeDBClusterPerformanceResponseBodyPerformances[];
   /**
@@ -139,7 +146,7 @@ export class DescribeDBClusterPerformanceResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The start time of the query. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time is displayed in UTC.
+   * The start time of the query. The time is in UTC and uses the *yyyy-MM-ddTHH:mmZ* format.
    * 
    * @example
    * 2022-03-10T23:56Z

package/src/models/DescribeDbclusterStatusRequest.ts

@@ -6,8 +6,7 @@ export class DescribeDBClusterStatusRequest extends $dara.Model {
   /**
    * @remarks
    * The region ID.
-   * 
-   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/143074.html) operation to query the most recent region list.
+   * >You can call the [DescribeRegions](https://help.aliyun.com/document_detail/143074.html) operation to query available region IDs.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeDbclusterStatusResponseBody.ts

@@ -13,7 +13,7 @@ export class DescribeDBClusterStatusResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The queried cluster states.
+   * The cluster status list.
    */
   status?: string[];
   static names(): { [key: string]: string } {

package/src/models/DescribeDbclustersRequest.ts

@@ -45,10 +45,11 @@ export class DescribeDBClustersRequestTag extends $dara.Model {
 export class DescribeDBClustersRequest extends $dara.Model {
   /**
    * @remarks
-   * The description of the cluster.
+   * The cluster description.
    * 
-   * *   The description cannot start with `http://` or `https://`.
-   * *   The description must be 2 to 256 characters in length
+   * - Cannot start with `http://` or `https://`.
+   * 
+   * - The description must be 2 to 256 characters long.
    * 
    * @example
    * test
@@ -56,9 +57,9 @@ export class DescribeDBClustersRequest extends $dara.Model {
   DBClusterDescription?: string;
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
+   * The cluster ID.
    * 
-   * If you do not specify this parameter, the information about all clusters that reside in the region is returned.
+   * If you omit this parameter, the operation returns information about all clusters in the specified region.
    * 
    * @example
    * amv-bp1r053byu48p****
@@ -66,17 +67,25 @@ export class DescribeDBClustersRequest extends $dara.Model {
   DBClusterIds?: string;
   /**
    * @remarks
-   * The status of the cluster. Valid values:
-   * 
-   * *   **Preparing**
-   * *   **Creating**
-   * *   **Running**
-   * *   **Deleting**
-   * *   **Restoring**
-   * *   **ClassChanging**
-   * *   **NetAddressCreating**
-   * *   **NetAddressDeleting**
-   * *   **NetAddressModifying**
+   * The cluster status. Valid values:
+   * 
+   * - **Preparing**: The cluster is preparing.
+   * 
+   * - **Creating**: The cluster is being created.
+   * 
+   * - **Running**: The cluster is running.
+   * 
+   * - **Deleting**: The cluster is being deleted.
+   * 
+   * - **Restoring**: The cluster is being restored from a backup.
+   * 
+   * - **ClassChanging**: The cluster specifications are changing.
+   * 
+   * - **NetAddressCreating**: A network connection is being created for the cluster.
+   * 
+   * - **NetAddressDeleting**: The network connection of the cluster is being deleted.
+   * 
+   * - **NetAddressModifying**: The network connection of the cluster is being modified.
    * 
    * @example
    * Running
@@ -84,11 +93,13 @@ export class DescribeDBClustersRequest extends $dara.Model {
   DBClusterStatus?: string;
   /**
    * @remarks
-   * The version number corresponding to the edition of the cluster. Valid values:
+   * The cluster version. Valid values:
+   * 
+   * - **3.0**: Data Warehouse edition.
+   * 
+   * - **5.0** (default): Includes the Lakehouse, Enterprise, and Basic editions.
    * 
-   * *   **3.0**: Data Warehouse Edition.
-   * *   **5.0** (default): includes Data Lakehouse Edition, Enterprise Edition, and Basic Edition.
-   * *   **All**: all editions, including Data Warehouse Edition, Data Lakehouse Edition, Enterprise Edition, and Basic Edition.
+   * - **All**: All editions, including the Data Warehouse, Lakehouse, Enterprise, and Basic editions.
    * 
    * @example
    * 5.0
@@ -96,7 +107,7 @@ export class DescribeDBClustersRequest extends $dara.Model {
   DBClusterVersion?: string;
   /**
    * @remarks
-   * The page number. Pages start from page 1. Default value: **1**.
+   * The page number. The value must be a positive integer. Default value: **1**.
    * 
    * @example
    * 1
@@ -104,11 +115,13 @@ export class DescribeDBClustersRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Valid values:
+   * The number of entries to return on each page. Valid values:
    * 
-   * *   **30** (default)
-   * *   **50**
-   * *   **100**
+   * - **30** (default)
+   * 
+   * - **50**
+   * 
+   * - **100**
    * 
    * @example
    * 30
@@ -116,12 +129,13 @@ export class DescribeDBClustersRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The edition of the cluster. Valid values:
+   * The product version. Valid values:
+   * 
+   * - **EnterpriseVersion**: Enterprise edition.
    * 
-   * *   **EnterpriseVersion**: Enterprise Edition.
-   * *   **BasicVersion**: Basic Edition.
+   * - **BasicVersion**: Basic edition.
    * 
-   * >  If you leave this parameter empty, the information about clusters of all editions is returned.
+   * > If you omit this parameter, the operation returns clusters of all product versions.
    * 
    * @example
    * BasicVersion
@@ -129,9 +143,9 @@ export class DescribeDBClustersRequest extends $dara.Model {
   productVersion?: string;
   /**
    * @remarks
-   * The region ID of the cluster.
+   * The region ID.
    * 
-   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/454314.html) operation to query the most recent region list.
+   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/454314.html) operation to query the IDs of available regions.
    * 
    * This parameter is required.
    * 
@@ -141,7 +155,7 @@ export class DescribeDBClustersRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The resource group ID. If you do not specify this parameter, the information about all resource groups in the cluster is returned.
+   * The ID of the resource group. If you omit this parameter, the operation returns information about clusters in all resource groups.
    * 
    * @example
    * rg-4690g37929****
@@ -149,7 +163,7 @@ export class DescribeDBClustersRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The tags that are added to the cluster.
+   * The tags to filter clusters by.
    */
   tag?: DescribeDBClustersRequestTag[];
   static names(): { [key: string]: string } {