@alicloud/polardb20170801 6.21.0 → 7.0.0

package/src/models/ModifyCronJobPolicyServerlessRequest.ts

@@ -4,12 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyCronJobPolicyServerlessRequest extends $dara.Model {
   /**
+   * @remarks
+   * Specifies whether to enable No-activity Suspension. Valid values:
+   * 
+   * - **true**: Enables the feature.
+   * 
+   * - **false** (default): Disables the feature.
+   * 
    * @example
    * true
    */
   allowShutDown?: string;
   /**
    * @remarks
+   * The Cron expression.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -18,6 +27,8 @@ export class ModifyCronJobPolicyServerlessRequest extends $dara.Model {
   cronExpression?: string;
   /**
    * @remarks
+   * The cluster ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -26,6 +37,8 @@ export class ModifyCronJobPolicyServerlessRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
+   * The end time.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -33,6 +46,9 @@ export class ModifyCronJobPolicyServerlessRequest extends $dara.Model {
    */
   endTime?: string;
   /**
+   * @remarks
+   * The ID of the scheduled task.
+   * 
    * @example
    * 8006e51c-dab3-4602-bc69-4f728002c6ce
    */
@@ -41,6 +57,8 @@ export class ModifyCronJobPolicyServerlessRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -50,56 +68,93 @@ export class ModifyCronJobPolicyServerlessRequest extends $dara.Model {
   resourceOwnerAccount?: string;
   resourceOwnerId?: number;
   /**
+   * @remarks
+   * The maximum number of read-only column store nodes. Valid values: 0 to 15.
+   * 
    * @example
    * 1
    */
   scaleApRoNumMax?: string;
   /**
+   * @remarks
+   * The minimum number of read-only column store nodes. Valid values: 0 to 15.
+   * 
    * @example
    * 1
    */
   scaleApRoNumMin?: string;
   /**
+   * @remarks
+   * The maximum number of PCUs. Valid values: 1 to 32.
+   * 
    * @example
    * 12
    */
   scaleMax?: string;
   /**
+   * @remarks
+   * The minimum number of PolarDB Capacity Units (PCUs). Valid values: 0.25 to 32. This value must be less than or equal to the value of ScaleMax.
+   * 
    * @example
    * 1
    */
   scaleMin?: string;
   /**
+   * @remarks
+   * The maximum number of read-only nodes for scaling. Valid values: 0 to 15.
+   * 
    * @example
    * 4
    */
   scaleRoNumMax?: string;
   /**
+   * @remarks
+   * The minimum number of read-only nodes for scaling. Valid values: 0 to 15.
+   * 
    * @example
    * 2
    */
   scaleRoNumMin?: string;
   /**
+   * @remarks
+   * The detection period for No-activity Suspension. Unit: minutes. Valid values: 5 to 1440. The value must be a multiple of 5.
+   * 
    * @example
    * 10
    */
   secondsUntilAutoPause?: string;
   /**
+   * @remarks
+   * The CPU utilization threshold for a scale-up. Unit: percent. Valid values: 40 to 100.
+   * 
    * @example
    * 80
    */
   serverlessRuleCpuEnlargeThreshold?: string;
   /**
+   * @remarks
+   * The CPU utilization threshold for a scale-down. Unit: percent. Valid values: 10 to 100. The value of ServerlessRuleCpuEnlargeThreshold minus the value of this parameter must be greater than or equal to 30.
+   * 
    * @example
    * 25
    */
   serverlessRuleCpuShrinkThreshold?: string;
   /**
+   * @remarks
+   * The scaling sensitivity. Valid values:
+   * 
+   * - normal
+   * 
+   * - flexible
+   * 
    * @example
    * normal
    */
   serverlessRuleMode?: string;
   /**
+   * @remarks
+   * The start time. Specify the time in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC.
+   * 
    * @example
    * 2020-09-23T01:00:00Z
    */

package/src/models/ModifyCronJobPolicyServerlessResponseBody.ts

@@ -5,7 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyCronJobPolicyServerlessResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
+   * 
+   * @example
+   * D1401250-910B-57A6-8A6A-D9988A62B1CD
    */
   requestId?: string;
   static names(): { [key: string]: string } {

package/src/models/ModifyDbclusterAccessWhitelistRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
   /**
    * @remarks
-   * The attributes of the IP whitelist group. Set this parameter to **hidden** to hide the IP whitelist group in the console.
+   * The attribute of the IP address whitelist group. If you set this parameter to \\`hidden\\`, the whitelist group is not visible in the console.
    * 
-   * > *   The IP whitelist group that has appeared in the console cannot be hidden.
-   * > *   This parameter can be specified only when the **WhiteListType** parameter is set to **IP**.
+   * > - You cannot hide an IP address whitelist group that is already visible in the console.
+   * >
+   * > - This parameter is available only when **WhiteListType** is set to **IP**.
    * 
    * @example
    * hidden
@@ -16,17 +17,17 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
   DBClusterIPArrayAttribute?: string;
   /**
    * @remarks
-   * The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit.
+   * The name of the IP address whitelist group. The name must be 2 to 120 characters in length. It must consist of lowercase letters and digits. The name must start with a letter and end with a letter or a digit.
    * 
-   * *   If the specified whitelist group name does not exist, the whitelist group is created.
-   * *   If the specified whitelist group name exists, the whitelist group is modified.
-   * *   If you do not specify this parameter, the default group is modified.
+   * - If the specified whitelist group name does not exist, a new whitelist group is created.
    * 
-   * > 
+   * - If the specified whitelist group name already exists, the whitelist group is modified.
    * 
-   * *   You can create a maximum of 50 IP whitelist groups for a cluster.
+   * - If you do not specify this parameter, the \\`default\\` group is modified.
    * 
-   * *   This parameter can be specified only when the **WhiteListType** parameter is set to **IP**.
+   * > * A cluster can have up to 50 IP address whitelist groups.
+   * >
+   * > * This parameter is available only when **WhiteListType** is set to **IP**.
    * 
    * @example
    * default
@@ -44,13 +45,15 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The method used to modify the IP whitelist. Valid values:
+   * The method used to modify the IP address whitelist. Valid values:
    * 
-   * *   **Cover** (default): overwrites the original IP whitelist.
-   * *   **Append**: appends IP addresses to the original whitelist.
-   * *   **Delete**: deletes IP addresses.
+   * - **Cover**: Overwrites the original IP address whitelist. This is the default value.
    * 
-   * >  This parameter can be specified only when the **WhiteListType** parameter is set to **IP**.
+   * - **Append**: Appends IP addresses to the whitelist.
+   * 
+   * - **Delete**: Deletes IP addresses from the whitelist.
+   * 
+   * > This parameter is available only when **WhiteListType** is set to **IP**.
    * 
    * @example
    * Cover
@@ -62,10 +65,11 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The ID of the security group. Separate multiple security groups with commas (,).
+   * The security group ID. Separate multiple security group IDs with commas (,).
    * 
-   * > *   You can add a maximum of three security groups to a cluster.
-   * > *   This parameter can be specified only when the **WhiteListType** parameter is set to **SecurityGroup**.
+   * > - A cluster can be associated with up to three security groups.
+   * >
+   * > - This parameter is available only when **WhiteListType** is set to **SecurityGroup**.
    * 
    * @example
    * sg-*********
@@ -73,12 +77,13 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
   securityGroupIds?: string;
   /**
    * @remarks
-   * The IP addresses or Classless Inter-Domain Routing (CIDR) blocks in the IP whitelist group. You can add 1,000 IP addresses or CIDR blocks to all the IP whitelist groups. Separate multiple IP addresses with commas (,). The following two formats are supported:
+   * The IP addresses or CIDR blocks in the IP address whitelist group. All IP address whitelist groups can contain a total of 1,000 IP addresses or CIDR blocks. Separate multiple IP addresses with commas (,). The following formats are supported:
    * 
-   * *   IP addresses. Example: 10.23.12.24.
-   * *   CIDR blocks. Example: 10.23.12.24/24. 24 indicates the length of the prefix of the CIDR block. The length is the range of 1 to 32.
+   * - IP address format. For example: 10.23.12.24.
    * 
-   * >  This parameter can be specified only when the **WhiteListType** parameter is set to **IP**.
+   * - CIDR format. For example: 10.23.12.24/24. The number 24 indicates the prefix length of the IP address. The prefix length can range from 1 to 32.
+   * 
+   * > This parameter is available only when **WhiteListType** is set to **IP**.
    * 
    * @example
    * 10.23.12.24
@@ -88,10 +93,11 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
    * @remarks
    * The type of the whitelist. Valid values:
    * 
-   * *   **IP**: IP whitelist group.
-   * *   **SecurityGroup**: security group.
+   * - **IP**: IP address whitelist group.
+   * 
+   * - **SecurityGroup**: Security group.
    * 
-   * Default value: **IP**.
+   * The default value is **IP**.
    * 
    * @example
    * IP

package/src/models/ModifyDbclusterAndNodesParametersRequest.ts

@@ -3,33 +3,38 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ModifyDBClusterAndNodesParametersRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to clear binlog. This parameter is valid only when binlog is disabled.
+   */
   clearBinlog?: boolean;
   /**
    * @remarks
-   * The ID of the cluster.
+   * The cluster ID.
    * 
    * This parameter is required.
    * 
    * @example
-   * pc-****************
+   * pc-**********
    */
   DBClusterId?: string;
   /**
    * @remarks
-   * The IDs of nodes. You can specify this parameter, or leave this parameter empty. Separate multiple node IDs with commas (,).
+   * The IDs of the nodes. By setting this parameter, you can modify the parameters of the cluster and specified nodes. Separate multiple node IDs with commas (,).
    * 
-   * >  If you do not specify this parameter, only the cluster parameters are modified.
+   * > If this parameter is not specified, only the cluster parameters are modified.
    * 
    * @example
-   * pi-****************,pi-**********,
+   * pi-**********,pi-**********
    */
   DBNodeIds?: string;
   /**
    * @remarks
-   * Specifies an immediate or scheduled task to modify parameters and restart the cluster. Default value: false. Valid values:
+   * Specifies whether to immediately or scheduledly modify parameters and restart the cluster. Valid values:
+   * 
+   * - **false** (default): scheduled execution
    * 
-   * *   **false**: runs the kernel upgrade task in a scheduled manner.
-   * *   **true**: immediately runs the kernel upgrade task.
+   * - **true**: immediate execution
    * 
    * @example
    * false
@@ -42,12 +47,12 @@ export class ModifyDBClusterAndNodesParametersRequest extends $dara.Model {
    * The ID of the parameter template.
    * 
    * @example
-   * pcpg-**************
+   * pcpg-**********
    */
   parameterGroupId?: string;
   /**
    * @remarks
-   * The JSON string for the parameter and its value.
+   * The JSON string that consists of parameters and their values.
    * 
    * @example
    * {"wait_timeout":"86","innodb_old_blocks_time":"10"}
@@ -55,13 +60,11 @@ export class ModifyDBClusterAndNodesParametersRequest extends $dara.Model {
   parameters?: string;
   /**
    * @remarks
-   * The latest start time to run the task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.
+   * The latest time to start the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.
    * 
-   * > 
-   * 
-   * *   The value of this parameter must be at least 30 minutes later than the value of the PlannedStartTime parameter.
-   * 
-   * *   By default, if you specify the `PlannedStartTime` parameter but do not specify the PlannedEndTime parameter, the latest start time of the task is set to a value that is calculated by using the following formula: `Value of the PlannedEndTime parameter + 30 minutes`. For example, if you set the `PlannedStartTime` parameter to `2021-01-14T09:00:00Z` and you do not specify the PlannedEndTime parameter, the latest start time of the task is set to `2021-01-14T09:30:00Z`.
+   * > - The latest start time must be 30 minutes or more later than the earliest start time.
+   * >
+   * > - If you specify `PlannedStartTime` but not this parameter, the latest start time of the task is `the earliest start time + 30 minutes` by default. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and leave this parameter empty, the task will start no later than `2021-01-14T09:30:00Z`.
    * 
    * @example
    * 2021-01-14T09:30:00Z
@@ -69,13 +72,11 @@ export class ModifyDBClusterAndNodesParametersRequest extends $dara.Model {
   plannedEndTime?: string;
   /**
    * @remarks
-   * The earliest time to upgrade the specifications within the scheduled time period. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.
-   * 
-   * > 
-   * 
-   * *   The earliest start time of the task can be a point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a point in the time range from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.
+   * The earliest time to start the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.
    * 
-   * *   If this parameter is empty, the upgrade task is immediately performed.
+   * > - The start time can be any time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can specify a time that ranges from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.
+   * >
+   * > - If you leave this parameter empty, the task is immediately executed.
    * 
    * @example
    * 2021-01-14T09:00:00Z
@@ -85,7 +86,7 @@ export class ModifyDBClusterAndNodesParametersRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The secondary clusters in the GDN to which the parameter settings are synchronized.
+   * The list of GDN standby clusters to which you want to synchronize the parameter settings.
    * 
    * @example
    * gdn-**********,gdn-**********

package/src/models/ModifyDbclusterAndNodesParametersResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDBClusterAndNodesParametersResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 9B7BFB11-C077-4FE3-B051-F69CEB******

package/src/models/ModifyDbclusterArchRequest.ts

@@ -6,7 +6,7 @@ export class ModifyDBClusterArchRequest extends $dara.Model {
   autoUseCoupon?: boolean;
   /**
    * @remarks
-   * The ID of the cluster.
+   * The cluster ID.
    * 
    * @example
    * pc-****************
@@ -14,10 +14,11 @@ export class ModifyDBClusterArchRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * Specifies whether to enable the hot standby storage cluster feature. Valid values:
+   * Specifies whether to enable a hot standby cluster. Valid values:
    * 
-   * *   **on**: enables hot standby storage cluster.
-   * *   **equal**: Enable a peer-to-peer cluster.
+   * - **on**: Enables a hot standby cluster.
+   * 
+   * - **equal**: Enables a peer cluster.
    * 
    * @example
    * on
@@ -32,7 +33,7 @@ export class ModifyDBClusterArchRequest extends $dara.Model {
    * @remarks
    * The region ID.
    * 
-   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) operation to query information about regions.
+   * > For more information, see [DescribeRegions](https://help.aliyun.com/document_detail/98041.html).
    * 
    * @example
    * cn-beijing
@@ -40,11 +41,11 @@ export class ModifyDBClusterArchRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The zone of the hot standby storage cluster. Valid values:
+   * The zone for the hot standby storage cluster. Valid values:
    * 
-   * *   **auto** (default): The zone is automatically selected.
+   * - **auto** (default): The system automatically selects a zone.
    * 
-   * >  You can use the default value when HotStandbyCluster is set to on. If HotStandbyCluster is set to equal, specify the zone of the hot standby storage cluster. You can call the [DescribeZones](https://help.aliyun.com/document_detail/98041.html) operation to query information about zones.
+   * > The default value is valid only when \\`HotStandbyCluster\\` is set to \\`on\\`. A specific zone is required when \\`HotStandbyCluster\\` is set to \\`equal\\`. For more information about zones, see [DescribeZones](https://help.aliyun.com/document_detail/98041.html).
    * 
    * @example
    * cn-beijing-i

package/src/models/ModifyDbclusterAuditLogCollectorRequest.ts

@@ -7,8 +7,9 @@ export class ModifyDBClusterAuditLogCollectorRequest extends $dara.Model {
    * @remarks
    * Specifies whether to enable or disable SQL collector. Valid values:
    * 
-   * *   Enable
-   * *   Disable
+   * - Enable
+   * 
+   * - Disable
    * 
    * This parameter is required.
    * 

package/src/models/ModifyDbclusterDeletionRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDBClusterDeletionRequest extends $dara.Model {
   /**
    * @remarks
-   * The cluster ID.
+   * The ID of the target cluster.
    * 
-   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to.obtain the cluster ID.
+   * > Call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to find the cluster ID.
    * 
    * This parameter is required.
    * 
@@ -19,10 +19,11 @@ export class ModifyDBClusterDeletionRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * Specifies whether to enable the cluster lock feature. Default value: false. Valid values:
+   * Specifies whether to enable or disable the cluster lock. The default value is false. Valid values:
    * 
-   * *   **true**: enables the cluster lock feature. If you enable the cluster lock feature, you cannot directly release the cluster. You must disable the cluster lock feature before you can release the cluster.
-   * *   **false**: disables the cluster lock feature.
+   * - **true**: Enables the cluster lock. When this feature is enabled, the cluster cannot be released. To release the cluster, first disable the cluster lock.
+   * 
+   * - **false**: Disables the cluster lock.
    * 
    * @example
    * true

package/src/models/ModifyDbclusterDescriptionRequest.ts

@@ -7,8 +7,9 @@ export class ModifyDBClusterDescriptionRequest extends $dara.Model {
    * @remarks
    * The name of the cluster. The name must meet the following requirements:
    * 
-   * *   The name cannot start with `http://` or `https://`.
-   * *   The name must be 2 to 256 characters in length.
+   * - It cannot start with `http://` or `https://`.
+   * 
+   * - It must be 2 to 256 characters in length.
    * 
    * This parameter is required.
    * 
@@ -18,7 +19,7 @@ export class ModifyDBClusterDescriptionRequest extends $dara.Model {
   DBClusterDescription?: string;
   /**
    * @remarks
-   * The ID of the PolarDB cluster.
+   * The cluster ID.
    * 
    * This parameter is required.
    * 

package/src/models/ModifyDbclusterDescriptionResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDBClusterDescriptionResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * D0CEC6AC-7760-409A-A0D5-E6CD86******

package/src/models/ModifyDbclusterDescriptionZonalRequest.ts

@@ -4,12 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyDBClusterDescriptionZonalRequest extends $dara.Model {
   /**
+   * @remarks
+   * A client token to ensure the idempotence of the request. The client generates this value. It must be unique among different requests. The token is case-sensitive and can contain up to 64 ASCII characters.
+   * 
    * @example
    * 6000170000591aed949d0f54a343f1a4233c1e7d1c5c******
    */
   clientToken?: string;
   /**
    * @remarks
+   * The cluster name. The cluster name must meet the following requirements:
+   * 
+   * - It cannot start with `http://` or `https://`.
+   * 
+   * - It must be 2 to 256 characters in length.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -18,6 +27,8 @@ export class ModifyDBClusterDescriptionZonalRequest extends $dara.Model {
   DBClusterDescription?: string;
   /**
    * @remarks
+   * The cluster ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ModifyDbclusterDescriptionZonalResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyDBClusterDescriptionZonalResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 65D7ACE6-4A61-4B6E-B357-8CB24A******
    */