@alicloud/polardb20170801 8.4.2 → 9.0.0

package/src/models/DescribeDbclusterVersionZonalResponseBody.ts

@@ -14,14 +14,10 @@ export class DescribeDBClusterVersionZonalResponseBodyDBRevisionVersionList exte
   /**
    * @remarks
    * The release status of the database version. Valid values:
-   * 
-   * - **Stable**: The current version is stable.
-   * 
-   * - **Old**: The current version is outdated. Do not upgrade to this version.
-   * 
-   * - **HighRisk**: The current version has critical bugs. Do not upgrade to this version.
-   * 
-   * - **Beta**: The current version is a beta version.
+   * * **Stable**: The current version is stable.
+   * * **Old**: The current version is outdated. Do not upgrade to this version.
+   * * **HighRisk**: The current version has critical defects. Do not upgrade to this version.
+   * * **Beta**: The current version is a beta release.
    * 
    * @example
    * Stable
@@ -29,7 +25,7 @@ export class DescribeDBClusterVersionZonalResponseBodyDBRevisionVersionList exte
   releaseType?: string;
   /**
    * @remarks
-   * The code of the patch version for the database engine. Use this code to specify the target version for an upgrade.
+   * The revision version code of the database engine, which is used to specify the target version for the upgrade.
    * 
    * @example
    * 20230707
@@ -37,7 +33,7 @@ export class DescribeDBClusterVersionZonalResponseBodyDBRevisionVersionList exte
   revisionVersionCode?: string;
   /**
    * @remarks
-   * The patch version of the database engine.
+   * The revision version number of the database engine.
    * 
    * @example
    * 8.0.1.1.35.1
@@ -82,10 +78,8 @@ export class DescribeDBClusterVersionZonalResponseBodyProxyRevisionVersionList e
   /**
    * @remarks
    * The release type. Valid values:
-   * 
-   * - **LTS**: Long-Term Support (LTS) version.
-   * 
-   * - **BETA**: Preview version.
+   * * **LTS**: Long-term support version.
+   * * **BETA**: Preview version.
    * 
    * @example
    * LTS
@@ -93,7 +87,7 @@ export class DescribeDBClusterVersionZonalResponseBodyProxyRevisionVersionList e
   releaseType?: string;
   /**
    * @remarks
-   * The code of the patch version for the database proxy. Use this code to specify the target version for an upgrade.
+   * The revision version code of the PolarProxy engine, which is used to specify the target version for the upgrade.
    * 
    * @example
    * 20230707
@@ -101,7 +95,7 @@ export class DescribeDBClusterVersionZonalResponseBodyProxyRevisionVersionList e
   revisionVersionCode?: string;
   /**
    * @remarks
-   * The patch version of the database proxy.
+   * The revision version number of the PolarProxy engine.
    * 
    * @example
    * 2.8.24
@@ -145,7 +139,7 @@ export class DescribeDBClusterVersionZonalResponseBody extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The latest version of the database kernel.
+   * The latest version of the database kernel engine.
    * 
    * @example
    * 8.0.1.1.16
@@ -153,17 +147,13 @@ export class DescribeDBClusterVersionZonalResponseBody extends $dara.Model {
   DBLatestVersion?: string;
   /**
    * @remarks
-   * The minor version of the database engine.
+   * The minor version number of the database engine.
+   * * If `DBVersion` is **8.0**, valid values are:
+   *     * **8.0.2**
+   *     * **8.0.1**
+   * * If `DBVersion` is **5.7**, the value is **5.7.28**.
    * 
-   * - If `DBVersion` is **8.0**, the valid values are:
-   * 
-   *   - **8.0.2**
-   * 
-   *   - **8.0.1**
-   * 
-   * - If `DBVersion` is **5.7**, the value is **5.7.28**.
-   * 
-   * - If `DBVersion` is **5.6**, the value is **5.6.16**.
+   * * If `DBVersion` is **5.6**, the value is **5.6.16**.
    * 
    * @example
    * 8.0.1
@@ -171,7 +161,7 @@ export class DescribeDBClusterVersionZonalResponseBody extends $dara.Model {
   DBMinorVersion?: string;
   /**
    * @remarks
-   * The patch version of the database engine.
+   * The revision version number of the database engine.
    * 
    * @example
    * 8.0.1.1.7
@@ -184,7 +174,7 @@ export class DescribeDBClusterVersionZonalResponseBody extends $dara.Model {
   DBRevisionVersionList?: DescribeDBClusterVersionZonalResponseBodyDBRevisionVersionList[];
   /**
    * @remarks
-   * The major version of the database engine. Valid values:
+   * The major version number of the database engine. Valid values:
    * 
    * - 8.0
    * 
@@ -198,15 +188,15 @@ export class DescribeDBClusterVersionZonalResponseBody extends $dara.Model {
   DBVersion?: string;
   /**
    * @remarks
-   * The status of the current minor version of the database. Valid values:
+   * The status of the current database minor version. Valid values:
    * 
    * - Stable: The current version is stable.
    * 
    * - Old: The current version is outdated. Upgrade to the latest version.
    * 
-   * - HighRisk: The current version has critical bugs. Upgrade to the latest version immediately.
+   * - HighRisk: The current version has critical defects. Upgrade to the latest version immediately.
    * 
-   * - Beta: The current version is a beta version.
+   * - Beta: The current version is a beta release.
    * 
    * @example
    * Stable
@@ -214,7 +204,7 @@ export class DescribeDBClusterVersionZonalResponseBody extends $dara.Model {
   DBVersionStatus?: string;
   /**
    * @remarks
-   * Indicates whether the current database kernel version is the latest version. Valid values:
+   * Indicates whether the current database kernel engine version is the latest version. Valid values:
    * 
    * - true
    * 
@@ -226,7 +216,7 @@ export class DescribeDBClusterVersionZonalResponseBody extends $dara.Model {
   isLatestVersion?: string;
   /**
    * @remarks
-   * Indicates whether the current database proxy version is the latest version. Valid values:
+   * Indicates whether the current database kernel engine version is the latest version. Valid values:
    * 
    * - true
    * 
@@ -238,7 +228,7 @@ export class DescribeDBClusterVersionZonalResponseBody extends $dara.Model {
   isProxyLatestVersion?: string;
   /**
    * @remarks
-   * The latest version of the database proxy.
+   * The latest version of PolarProxy.
    * 
    * @example
    * 2.4.17
@@ -246,7 +236,7 @@ export class DescribeDBClusterVersionZonalResponseBody extends $dara.Model {
   proxyLatestVersion?: string;
   /**
    * @remarks
-   * The version of the database proxy.
+   * The version of PolarProxy.
    * 
    * @example
    * 2.4.15
@@ -254,28 +244,25 @@ export class DescribeDBClusterVersionZonalResponseBody extends $dara.Model {
   proxyRevisionVersion?: string;
   /**
    * @remarks
-   * The list of upgradable database proxy versions.
+   * The release status of the PolarProxy version. Valid values:
    * 
    * - **Stable**: The current version is stable.
-   * 
    * - **Old**: The current version is outdated. Do not upgrade to this version.
-   * 
-   * - **HighRisk**: The current version has critical bugs. Do not upgrade to this version.
-   * 
-   * - **Beta**: The current version is a beta version.
+   * - **HighRisk**: The current version has critical defects. Do not upgrade to this version.
+   * - **Beta**: The current version is a beta release.
    */
   proxyRevisionVersionList?: DescribeDBClusterVersionZonalResponseBodyProxyRevisionVersionList[];
   /**
    * @remarks
-   * The status of the database proxy version. Valid values:
+   * The version status of PolarProxy. Valid values:
    * 
    * - Stable: The current version is stable.
    * 
    * - Old: The current version is outdated. Upgrade to the latest version.
    * 
-   * - HighRisk: The current version has critical bugs. Upgrade to the latest version immediately.
+   * - HighRisk: The current version has critical defects. Upgrade to the latest version immediately.
    * 
-   * - Beta: The current version is a beta version.
+   * - Beta: The current version is a beta release.
    * 
    * @example
    * Stable

package/src/models/DescribeDbclustersRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDBClustersRequestTag extends $dara.Model {
   /**
    * @remarks
-   * The tag key. You can use tags to filter the cluster list. You can specify up to 20 tag pairs. The number n for each tag pair must be unique and must be a consecutive integer that starts from 1. The Tag.n.Key parameter is paired with the Tag.n.Value parameter.
+   * The tag key. You can filter the cluster list based on tags. You can specify up to 20 tag key-value pairs. The number n in each tag key-value pair must be unique and must be a consecutive integer starting from 1. The value of Tag.n.Key is Tag.n.Value.
    * 
    * > The tag key can be up to 64 characters in length and cannot start with `aliyun`, `acs:`, `http://`, or `https://`.
    * 
@@ -65,7 +65,7 @@ export class DescribeDBClustersRequest extends $dara.Model {
   DBClusterDescription?: string;
   /**
    * @remarks
-   * The cluster ID. Separate multiple cluster IDs with commas (,).
+   * The cluster IDs. Separate multiple cluster IDs with commas (,).
    * 
    * @example
    * pc-****************
@@ -81,7 +81,7 @@ export class DescribeDBClustersRequest extends $dara.Model {
   DBClusterStatus?: string;
   /**
    * @remarks
-   * The node ID. You can specify multiple node IDs, separated by commas (,).
+   * The node IDs. You can specify multiple node IDs and separate them with commas (,).
    * 
    * @example
    * pi-***************
@@ -100,7 +100,7 @@ export class DescribeDBClustersRequest extends $dara.Model {
   DBType?: string;
   /**
    * @remarks
-   * The database engine version.
+   * The database version.
    * 
    * @example
    * 5.6
@@ -108,8 +108,8 @@ export class DescribeDBClustersRequest extends $dara.Model {
   DBVersion?: string;
   /**
    * @remarks
-   * The query mode for the list. Set the value to Simple to use the simple mode, which returns only basic metadata of clusters.
-   * > If you do not specify this parameter, the detailed mode is used by default, which returns detailed information about clusters.
+   * The query mode for the list. A value of Simple indicates the brief mode, in which only the basic metadata of the clusters is returned.
+   * > If this parameter is not specified, the detailed mode is used by default, and the detailed information of the clusters is returned.
    * 
    * @example
    * Simple
@@ -151,8 +151,8 @@ export class DescribeDBClustersRequest extends $dara.Model {
    * @remarks
    * The billing method. Valid values: 
    * 
-   * - **Postpaid**: pay-as-you-go.
-   * - **Prepaid**: subscription.
+   * - **Postpaid**: pay-as-you-go
+   * - **Prepaid**: subscription
    * 
    * @example
    * Postpaid
@@ -160,7 +160,7 @@ export class DescribeDBClustersRequest extends $dara.Model {
   payType?: string;
   /**
    * @remarks
-   * Filters clusters created within the last N days. Valid values: 0 to 15.
+   * Filters the clusters created in the last N days. Valid values: 0 to 15.
    * 
    * @example
    * 7
@@ -168,7 +168,7 @@ export class DescribeDBClustersRequest extends $dara.Model {
   recentCreationInterval?: number;
   /**
    * @remarks
-   * Filters clusters that expire within the next N days. Valid values: 0 to 15.
+   * Filters the clusters that expire in N days. Valid values: 0 to 15.
    * 
    * @example
    * 6
@@ -197,7 +197,7 @@ export class DescribeDBClustersRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The tags.
+   * The list of tags.
    */
   tag?: DescribeDBClustersRequestTag[];
   static names(): { [key: string]: string } {

package/src/models/DescribeDbclustersResponseBody.ts

@@ -302,7 +302,7 @@ export class DescribeDBClustersResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of clusters on the current page.
+   * The number of clusters returned on the current page.
    * 
    * @example
    * 5
@@ -318,7 +318,7 @@ export class DescribeDBClustersResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of records.
+   * The total number of entries.
    * 
    * @example
    * 16

package/src/models/DescribeGatewayListRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeGatewayListRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the gateway instance.
+   * The gateway instance ID.
    * 
    * @example
    * pg-xxxxxxxxxx
@@ -13,7 +13,7 @@ export class DescribeGatewayListRequest extends $dara.Model {
   gwClusterId?: string;
   /**
    * @remarks
-   * The description of the gateway instance.
+   * The gateway description.
    * 
    * @example
    * test
@@ -21,7 +21,7 @@ export class DescribeGatewayListRequest extends $dara.Model {
   gwDescription?: string;
   /**
    * @remarks
-   * The page number.
+   * The current page number.
    * 
    * @example
    * 1
@@ -30,12 +30,9 @@ export class DescribeGatewayListRequest extends $dara.Model {
   /**
    * @remarks
    * The number of entries per page. Valid values:
-   * 
-   * - **30**
-   * 
-   * - **50**
-   * 
-   * - **100**
+   * * **30**
+   * * **50**
+   * * **100**
    * 
    * Default value: **30**.
    * 

package/src/models/DescribeGatewayListResponseBody.ts

@@ -5,7 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeGatewayListResponseBodyItems extends $dara.Model {
   /**
    * @remarks
-   * The time when the gateway instance was created.
+   * The creation time.
+   * 
+   * The time is in ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).
    * 
    * @example
    * 2020-08-14T05:58:42Z
@@ -21,11 +23,11 @@ export class DescribeGatewayListResponseBodyItems extends $dara.Model {
   dbType?: string;
   /**
    * @remarks
-   * The expiration time of the gateway instance.
-   * 
-   * - For subscription instances, this parameter indicates the expiration time.
+   * The expiration time of the cluster.
+   * - If the billing method of the cluster is subscription, the actual expiration time is returned.
+   * - If the billing method of the cluster is pay-as-you-go, an empty value is returned.
    * 
-   * - This parameter is empty for pay-as-you-go instances.
+   * The time is in ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).
    * 
    * @example
    * 2028-09-01T16:00:00Z
@@ -33,7 +35,7 @@ export class DescribeGatewayListResponseBodyItems extends $dara.Model {
   expireTime?: string;
   /**
    * @remarks
-   * Indicates whether the gateway instance has expired. Valid values:
+   * Indicates whether the cluster has expired. Valid values:
    * 
    * - **true**
    * 
@@ -53,7 +55,7 @@ export class DescribeGatewayListResponseBodyItems extends $dara.Model {
   gwClusterId?: string;
   /**
    * @remarks
-   * The description of the gateway instance.
+   * The gateway description.
    * 
    * @example
    * pg-xxxxxx
@@ -61,7 +63,9 @@ export class DescribeGatewayListResponseBodyItems extends $dara.Model {
   gwDescription?: string;
   /**
    * @remarks
-   * The time when the gateway instance was last modified.
+   * The last modification time.
+   * 
+   * The time is in ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).
    * 
    * @example
    * 2024-10-29T09:31:37Z
@@ -69,11 +73,10 @@ export class DescribeGatewayListResponseBodyItems extends $dara.Model {
   modifyTime?: string;
   /**
    * @remarks
-   * The billing method. Valid values:
-   * 
-   * - **Postpaid**: pay-as-you-go
+   * The billing method. Valid values: 
    * 
-   * - **Prepaid**: subscription
+   * - **Postpaid**: pay-as-you-go.
+   * - **Prepaid**: subscription.
    * 
    * @example
    * Postpaid
@@ -89,11 +92,10 @@ export class DescribeGatewayListResponseBodyItems extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The status of the gateway instance. Valid values:
+   * The application status. Valid values:
    * 
-   * - **CREATE**: creating
-   * 
-   * - **ACTIVATION**: running
+   * - CREATE: being created.
+   * - ACTIVATION: running.
    * 
    * @example
    * ACTIVATION
@@ -109,7 +111,7 @@ export class DescribeGatewayListResponseBodyItems extends $dara.Model {
   vSwitchId?: string;
   /**
    * @remarks
-   * The ID of the virtual private cloud (VPC).
+   * The VPC ID.
    * 
    * @example
    * vpc-****************
@@ -161,12 +163,12 @@ export class DescribeGatewayListResponseBodyItems extends $dara.Model {
 export class DescribeGatewayListResponseBody extends $dara.Model {
   /**
    * @remarks
-   * A list of gateway instances.
+   * The list of gateway instances.
    */
   items?: DescribeGatewayListResponseBodyItems[];
   /**
    * @remarks
-   * The page number.
+   * The page number. Default value: 1.
    * 
    * @example
    * 1
@@ -174,7 +176,7 @@ export class DescribeGatewayListResponseBody extends $dara.Model {
   pageNumber?: string;
   /**
    * @remarks
-   * The number of entries returned on the current page.
+   * The number of entries on the current page.
    * 
    * @example
    * 30
@@ -182,13 +184,10 @@ export class DescribeGatewayListResponseBody extends $dara.Model {
   pageRecordCount?: string;
   /**
    * @remarks
-   * The number of entries per page.
-   * 
-   * - **30**
-   * 
-   * - **50**
-   * 
-   * - **100**
+   * The number of entries per page. Valid values:
+   * * **30**
+   * * **50**
+   * * **100**
    * 
    * Default value: 30.
    * 
@@ -198,7 +197,7 @@ export class DescribeGatewayListResponseBody extends $dara.Model {
   pageSize?: string;
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * CED079B7-A408-41A1-BFF1-EC608E******

package/src/models/DescribeGlobalDataNetworkListRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeGlobalDataNetworkListRequest extends $dara.Model {
   /**
    * @remarks
-   * The page number to return.
+   * The page number of the query results.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class DescribeGlobalDataNetworkListRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of records to return on each page.
+   * The number of records per page.
    * 
    * @example
    * 30