@alicloud/polardb20170801 8.4.3 → 9.0.0

package/src/models/DescribeAccountsZonalRequest.ts

@@ -15,6 +15,8 @@ export class DescribeAccountsZonalRequest extends $dara.Model {
    * @remarks
    * The cluster ID.
    * 
+   * > Note: Only the IDs of edge clusters (clusters created by setting the CloudProvider parameter to ENS when calling CreateDBCluster) are supported. If you specify the ID of common clusters, the CrossCloudOpenAPI.CallError error is returned.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -23,7 +25,7 @@ export class DescribeAccountsZonalRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The maximum number of entries to return in a single request.
+   * The maximum number of entries to return for this request.
    * 
    * @example
    * 10
@@ -31,7 +33,7 @@ export class DescribeAccountsZonalRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The token to retrieve the next page of results. You do not need to specify this parameter for the first request. In a subsequent request, set this parameter to the NextToken value returned in the previous response.
+   * The query token. Set the value to the NextToken value returned in the last API call. If no subsequent query is required, do not specify this parameter.
    * 
    * @example
    * 212db86sca4384811e0b5e8707e******
@@ -39,7 +41,7 @@ export class DescribeAccountsZonalRequest extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * The node type. This parameter is required when you query the accounts of a PolarDB Search node.
+   * The node type. This parameter is required when you query the accounts of PolarDB Search nodes. Valid values:
    * 
    * - Search
    * 
@@ -51,7 +53,7 @@ export class DescribeAccountsZonalRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The page number. The value must be an integer that is greater than 0. The default value is 1.
+   * The page number. Valid values: integers greater than 0 and less than or equal to the maximum value of the Integer type. Default value: 1.
    * 
    * @example
    * 1
@@ -59,7 +61,7 @@ export class DescribeAccountsZonalRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page. Valid values:
+   * The number of entries per page. Valid values:
    * 
    * - 30
    * 
@@ -67,7 +69,7 @@ export class DescribeAccountsZonalRequest extends $dara.Model {
    * 
    * - 100
    * 
-   * The default value is 30.
+   * Default value: 30.
    * 
    * @example
    * 30

package/src/models/DescribeAccountsZonalResponseBody.ts

@@ -53,7 +53,7 @@ export class DescribeAccountsZonalResponseBodyAccounts extends $dara.Model {
   accountDescription?: string;
   /**
    * @remarks
-   * The lock state of the account. Valid values:
+   * The lock status of the account. Valid values:
    * 
    * - UnLock: The account is not locked.
    * 
@@ -73,7 +73,7 @@ export class DescribeAccountsZonalResponseBodyAccounts extends $dara.Model {
   accountName?: string;
   /**
    * @remarks
-   * The time when the password expires.
+   * The expiration time of the password.
    * 
    * @example
    * undefined
@@ -83,11 +83,11 @@ export class DescribeAccountsZonalResponseBodyAccounts extends $dara.Model {
    * @remarks
    * The status of the account. Valid values:
    * 
-   * Creating: The account is being created.
+   * - Creating: The account is being created.
    * 
-   * Available: The account is active.
+   * - Available: The account is available.
    * 
-   * Deleting: The account is being deleted.
+   * - Deleting: The account is being deleted.
    * 
    * @example
    * Available
@@ -97,11 +97,11 @@ export class DescribeAccountsZonalResponseBodyAccounts extends $dara.Model {
    * @remarks
    * The type of the account. Valid values:
    * 
-   * - Normal: A standard account.
+   * - Normal: standard account.
    * 
-   * - Super: A privileged account.
+   * - Super: privileged account.
    * 
-   * - ReadOnly: A global read-only account.
+   * - ReadOnly: global read-only account.
    * 
    * @example
    * Normal
@@ -109,7 +109,7 @@ export class DescribeAccountsZonalResponseBodyAccounts extends $dara.Model {
   accountType?: string;
   /**
    * @remarks
-   * The details of the database permissions that the account has.
+   * The details of the database permissions granted to the account.
    */
   databasePrivileges?: DescribeAccountsZonalResponseBodyAccountsDatabasePrivileges[];
   static names(): { [key: string]: string } {
@@ -151,12 +151,12 @@ export class DescribeAccountsZonalResponseBodyAccounts extends $dara.Model {
 export class DescribeAccountsZonalResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The details of the accounts.
+   * The details of the account information.
    */
   accounts?: DescribeAccountsZonalResponseBodyAccounts[];
   /**
    * @remarks
-   * The maximum number of entries returned in the request.
+   * The maximum number of entries to return for this request.
    * 
    * @example
    * 10
@@ -164,7 +164,7 @@ export class DescribeAccountsZonalResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The token to retrieve the next page of results. If the results are not fully returned, this token is returned. You can use this token in the next request to retrieve the remaining results.
+   * The query token. Set the value to the NextToken value returned in the last API call. If no subsequent query is required, do not specify this parameter.
    * 
    * @example
    * 212db86sca4384811e0b5e8707e******

package/src/models/DescribeActiveOperationMaintainConfResponseBody.ts

@@ -5,7 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeActiveOperationMaintainConfResponseBodyConfig extends $dara.Model {
   /**
    * @remarks
-   * The time when the configuration was created.
+   * The creation time.
+   * 
+   * The time is in the YYYY-MM-DDTHH:mm:ss format.
    * 
    * @example
    * 2023-07-04T19:28:46
@@ -13,11 +15,10 @@ export class DescribeActiveOperationMaintainConfResponseBodyConfig extends $dara
   createdTime?: string;
   /**
    * @remarks
-   * The day of the cycle.
-   * 
-   * - If CycleType is set to Month, this parameter returns a number from 1 to 28 that indicates the day of the month. Multiple days are separated by commas (,).
+   * The cycle time.
    * 
-   * - If CycleType is set to Week, this parameter returns a number from 1 to 7 that indicates the day of the week. Multiple days are separated by commas (,).
+   * - If CycleType is set to Month, a number from 1 to 28 is returned, indicating the day of the month. Multiple values are separated by commas (,).
+   * - If CycleType is set to Week, a number from 1 to 7 is returned, indicating the day of the week. Multiple values are separated by commas (,).
    * 
    * @example
    * 1
@@ -28,7 +29,6 @@ export class DescribeActiveOperationMaintainConfResponseBodyConfig extends $dara
    * The cycle type. Valid values:
    * 
    * - Month: monthly
-   * 
    * - Week: weekly
    * 
    * @example
@@ -39,6 +39,8 @@ export class DescribeActiveOperationMaintainConfResponseBodyConfig extends $dara
    * @remarks
    * The end time of the maintenance window.
    * 
+   * The time is in UTC in the HH:mmZ format.
+   * 
    * @example
    * 09:00Z
    */
@@ -47,13 +49,17 @@ export class DescribeActiveOperationMaintainConfResponseBodyConfig extends $dara
    * @remarks
    * The start time of the maintenance window.
    * 
+   * The time is in UTC. Example: 8:00Z.
+   * 
    * @example
    * 8:00Z
    */
   maintainStartTime?: string;
   /**
    * @remarks
-   * The time when the configuration was last modified.
+   * The modification time.
+   * 
+   * The time is in the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format. The time is displayed in UTC.
    * 
    * @example
    * 2025-04-02T02:10:08Z
@@ -61,7 +67,7 @@ export class DescribeActiveOperationMaintainConfResponseBodyConfig extends $dara
   modifiedTime?: string;
   /**
    * @remarks
-   * Indicates whether the configuration is enabled. Valid values:1: Enabled2: Disabled
+   * Indicates whether the configuration is effective. Valid values: 1 (yes) and 2 (no).
    * 
    * @example
    * 1
@@ -108,7 +114,7 @@ export class DescribeActiveOperationMaintainConfResponseBody extends $dara.Model
   config?: DescribeActiveOperationMaintainConfResponseBodyConfig;
   /**
    * @remarks
-   * Indicates whether a configuration has been set. Valid values:1: Yes0: NoThe value of this parameter is 0 for the first query.
+   * Indicates whether the configuration has been set. Valid values: 1 (yes) and 0 (no). On the first visit, HasConfig is 0.
    * 
    * @example
    * 0

package/src/models/DescribeAgenticDbbranchEndpointsRequest.ts

@@ -15,7 +15,7 @@ export class DescribeAgenticDBBranchEndpointsRequest extends $dara.Model {
   branchId?: string;
   /**
    * @remarks
-   * The AgenticDB cluster ID.
+   * The ID of the AgenticDB cluster.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeAgenticDbbranchEndpointsResponseBody.ts

@@ -21,7 +21,9 @@ export class DescribeAgenticDBBranchEndpointsResponseBodyItemsAddressItems exten
   connectionString?: string;
   /**
    * @remarks
-   * The network type. Valid values: Private and Public.
+   * The network type. Valid values:
+   * - Private: private network.
+   * - Public: public network.
    * 
    * @example
    * Private
@@ -73,7 +75,7 @@ export class DescribeAgenticDBBranchEndpointsResponseBodyItems extends $dara.Mod
   account?: string;
   /**
    * @remarks
-   * The compatible connection address. The public endpoint is returned first. If no public endpoint is available, the private endpoint is returned.
+   * The compatible connection address. A public endpoint is returned first. If no public endpoint is available, a private endpoint is returned.
    * 
    * @example
    * 10.0.1.100
@@ -86,7 +88,7 @@ export class DescribeAgenticDBBranchEndpointsResponseBodyItems extends $dara.Mod
   addressItems?: DescribeAgenticDBBranchEndpointsResponseBodyItemsAddressItems[];
   /**
    * @remarks
-   * The compatible connection string. The public connection string is returned first. If no public connection string is available, the private connection string is returned.
+   * The compatible connection string. A public connection string is returned first. If no public connection string is available, a private connection string is returned.
    * 
    * @example
    * postgresql://cloud_admin:******@10.0.1.100:5432/neondb

package/src/models/DescribeAgenticDbbranchLineageRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAgenticDBBranchLineageRequest extends $dara.Model {
   /**
    * @remarks
-   * The anchor branch ID. If this parameter is not specified, the primary branch of the project is used by default.
+   * The ID of the anchor branch. If this parameter is not specified, the primary branch of the project is used by default.
    * 
    * @example
    * br-7g8h9i0j1k2l
@@ -13,7 +13,7 @@ export class DescribeAgenticDBBranchLineageRequest extends $dara.Model {
   branchId?: string;
   /**
    * @remarks
-   * The AgenticDB cluster ID.
+   * The ID of the AgenticDB cluster.
    * 
    * This parameter is required.
    * 
@@ -30,6 +30,9 @@ export class DescribeAgenticDBBranchLineageRequest extends $dara.Model {
    */
   includeDestroying?: boolean;
   /**
+   * @remarks
+   * The maximum number of levels to return in the view, including the anchor branch itself. Valid values: 1 to 20. Default value: 3. The server automatically allocates the budget for ancestor and descendant levels with a downward bias.
+   * 
    * @example
    * 3
    */

package/src/models/DescribeAgenticDbbranchLineageResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAgenticDBBranchLineageResponseBodyItems extends $dara.Model {
   /**
    * @remarks
-   * The compute cluster ID of the branch.
+   * The ID of the compute cluster associated with the branch.
    * 
    * @example
    * pc-g0lsayq8c5qe
@@ -39,13 +39,15 @@ export class DescribeAgenticDBBranchLineageResponseBodyItems extends $dara.Model
    * @remarks
    * The time when the branch was created.
    * 
+   * The time is in the ISO 8601 standard in the UTC time zone (format: YYYY-MM-DDTHH:mm:ssZ).
+   * 
    * @example
    * 2026-06-10T11:00:00Z
    */
   createTime?: string;
   /**
    * @remarks
-   * The depth relative to the anchor branch. The anchor branch has a depth of 0. Ancestor branches have negative values. Descendant branches have positive values.
+   * The depth relative to the anchor branch. The anchor branch has a depth of 0. Ancestor branches have negative values, and descendant branches have positive values.
    * 
    * @example
    * 0
@@ -84,6 +86,9 @@ export class DescribeAgenticDBBranchLineageResponseBodyItems extends $dara.Model
    */
   isAnchor?: boolean;
   /**
+   * @remarks
+   * Indicates whether the branch is the default branch.
+   * 
    * @example
    * false
    */
@@ -98,7 +103,7 @@ export class DescribeAgenticDBBranchLineageResponseBodyItems extends $dara.Model
   isRoot?: boolean;
   /**
    * @remarks
-   * The parent branch ID.
+   * The ID of the parent branch.
    * 
    * @example
    * br-1a2b3c4d5e6f
@@ -106,7 +111,7 @@ export class DescribeAgenticDBBranchLineageResponseBodyItems extends $dara.Model
   parentBranchId?: string;
   /**
    * @remarks
-   * The parent branch name.
+   * The name of the parent branch.
    * 
    * @example
    * main
@@ -174,7 +179,7 @@ export class DescribeAgenticDBBranchLineageResponseBodyItems extends $dara.Model
 export class DescribeAgenticDBBranchLineageResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The anchor branch ID.
+   * The ID of the anchor branch.
    * 
    * @example
    * br-7g8h9i0j1k2l
@@ -187,7 +192,7 @@ export class DescribeAgenticDBBranchLineageResponseBody extends $dara.Model {
   items?: DescribeAgenticDBBranchLineageResponseBodyItems[];
   /**
    * @remarks
-   * The total number of returned nodes.
+   * The total number of nodes returned.
    * 
    * @example
    * 6
@@ -219,7 +224,7 @@ export class DescribeAgenticDBBranchLineageResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The primary branch ID.
+   * The ID of the primary branch.
    * 
    * @example
    * br-root

package/src/models/DescribeAgenticDbbranchRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAgenticDBBranchRequest extends $dara.Model {
   /**
    * @remarks
+   * The branch ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DescribeAgenticDBBranchRequest extends $dara.Model {
   branchId?: string;
   /**
    * @remarks
+   * The AgenticDB cluster ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class DescribeAgenticDBBranchRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
+   * The ID of the project to which the branch belongs.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,6 +35,8 @@ export class DescribeAgenticDBBranchRequest extends $dara.Model {
   projectId?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -37,6 +45,8 @@ export class DescribeAgenticDBBranchRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
+   * The ID of the tenant to which the branch belongs.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeAgenticDbbranchResponseBody.ts

@@ -4,86 +4,143 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeAgenticDBBranchResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the compute cluster associated with the branch.
+   * 
    * @example
    * pc-g0lsayq8c5qe
    */
   branchComputeClusterId?: string;
   /**
+   * @remarks
+   * The number of compute nodes. The value is fixed to 1 in the initial phase.
+   * 
    * @example
    * 1
    */
   branchComputeNodeCount?: number;
   /**
+   * @remarks
+   * The branch ID.
+   * 
    * @example
    * br-7g8h9i0j1k2l
    */
   branchId?: string;
   /**
+   * @remarks
+   * The branch name.
+   * 
    * @example
    * feature-analytics
    */
   branchName?: string;
   /**
+   * @remarks
+   * The time when the branch was created.
+   * 
+   * The time is in the ISO 8601 standard in UTC (format: YYYY-MM-DDTHH:mm:ssZ).
+   * 
    * @example
    * 2026-06-10T11:00:00Z
    */
   createTime?: string;
   /**
+   * @remarks
+   * The description of the branch.
+   * 
    * @example
    * Feature branch for analytics
    */
   description?: string;
   /**
+   * @remarks
+   * Indicates whether the branch is the default branch.
+   * 
    * @example
    * false
    */
   isDefaultBranch?: boolean;
   /**
+   * @remarks
+   * The time when the branch was last activated.
+   * 
    * @example
    * 2026-06-10T12:30:00Z
    */
   lastActivatedAt?: string;
   /**
+   * @remarks
+   * The maximum compute unit.
+   * 
    * @example
    * 2
    */
   maxCU?: string;
   /**
+   * @remarks
+   * The minimum compute unit.
+   * 
    * @example
    * 0.25
    */
   minCU?: string;
   /**
+   * @remarks
+   * The ID of the parent branch.
+   * 
    * @example
    * br-1a2b3c4d5e6f
    */
   parentBranchId?: string;
   /**
+   * @remarks
+   * The name of the parent branch.
+   * 
    * @example
    * main
    */
   parentBranchName?: string;
   /**
+   * @remarks
+   * The ID of the project to which the branch belongs.
+   * 
    * @example
    * proj-a1b2c3d4e5f6
    */
   projectId?: string;
   /**
+   * @remarks
+   * The name of the project to which the branch belongs.
+   * 
    * @example
    * analytics-prod
    */
   projectName?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * C3D4E5F6-A7B8-9012-CDEF-345678901CDE
    */
   requestId?: string;
   /**
+   * @remarks
+   * The status of the branch. Valid values:
+   * 
+   * - Running
+   * - Pending
+   * - Paused
+   * 
    * @example
    * Active
    */
   status?: string;
   /**
+   * @remarks
+   * The ID of the tenant to which the branch belongs.
+   * 
    * @example
    * t-4b83e0da66674951
    */

package/src/models/DescribeAgenticDbbranchesRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeAgenticDBBranchesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The branch name for fuzzy match.
+   * 
    * @example
    * feature
    */
   branchName?: string;
   /**
    * @remarks
+   * The AgenticDB cluster ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -17,22 +22,33 @@ export class DescribeAgenticDBBranchesRequest extends $dara.Model {
    */
   DBClusterId?: string;
   /**
+   * @remarks
+   * The page number. Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page. Default value: 30. Maximum value: 100.
+   * 
    * @example
    * 30
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The ID of the project to which the branch belongs.
+   * 
    * @example
    * proj-a1b2c3d4e5f6
    */
   projectId?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -40,11 +56,21 @@ export class DescribeAgenticDBBranchesRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The status filter. Valid values:
+   * 
+   * - Running
+   * - Pending
+   * - Paused
+   * 
    * @example
    * Active
    */
   status?: string;
   /**
+   * @remarks
+   * The ID of the tenant to which the branch belongs.
+   * 
    * @example
    * t-4b83e0da66674951
    */