@alicloud/polardb20170801 8.4.2 → 9.0.0

package/src/models/DescribeAgenticDbbranchesResponseBody.ts

@@ -4,81 +4,135 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeAgenticDBBranchesResponseBodyItems 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 first 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 ISO 8601 format 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 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
    */
@@ -135,23 +189,39 @@ export class DescribeAgenticDBBranchesResponseBodyItems extends $dara.Model {
 }
 
 export class DescribeAgenticDBBranchesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of branches.
+   */
   items?: DescribeAgenticDBBranchesResponseBodyItems[];
   /**
+   * @remarks
+   * The current page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 30
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * B2C3D4E5-F6A7-8901-BCDE-2345678901BC
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries returned.
+   * 
    * @example
    * 5
    */

package/src/models/DescribeAgenticDbclustersRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAgenticDBClustersRequestTag extends $dara.Model {
   /**
    * @remarks
-   * The tag key. You can filter the cluster list by tag. You can specify up to 20 tag pairs. The number n for each tag pair must be unique and must be a consecutive integer starting from 1. The value of Tag.n.Key corresponds to Tag.n.Value.
+   * The tag key. You can use tags to filter clusters. You can specify up to 20 tags. 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.
    * 
    * @example
    * type
@@ -85,7 +85,7 @@ export class DescribeAgenticDBClustersRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The pagination token. Set this parameter to the NextToken value returned in the previous API call. If there is no next query, do not pass this parameter.
+   * The pagination token. Set this parameter to the NextToken value returned in the previous API call. If there is no next query, do not specify this parameter.
    * 
    * @example
    * 212db86sca4384811e0b5e8707e******

package/src/models/DescribeAgenticDbclustersResponseBody.ts

@@ -79,6 +79,8 @@ export class DescribeAgenticDBClustersResponseBodyItems extends $dara.Model {
    * @remarks
    * The time when the cluster was created.
    * 
+   * The time is in the ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).
+   * 
    * @example
    * 2020-08-14T05:58:42Z
    */
@@ -128,6 +130,8 @@ export class DescribeAgenticDBClustersResponseBodyItems extends $dara.Model {
    * The expiration time of the cluster.
    * > A specific value is returned only for clusters whose billing method is **Prepaid** (subscription). An empty value is returned for **Postpaid** (pay-as-you-go) clusters.
    * 
+   * The time is in the ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).
+   * 
    * @example
    * 2025-06-25T09:37:10Z
    */
@@ -151,8 +155,8 @@ export class DescribeAgenticDBClustersResponseBodyItems extends $dara.Model {
    * The lock status of the cluster. Valid values: 
    * 
    * - **Unlock**: Normal. 
-   * - **ManualLock**: Manually locked. 
-   * - **LockByExpiration**: Automatically locked due to cluster expiration.
+   * - **ManualLock**: manually locked. 
+   * - **LockByExpiration**: automatically locked due to cluster expiration.
    * 
    * @example
    * Unlock
@@ -195,7 +199,7 @@ export class DescribeAgenticDBClustersResponseBodyItems extends $dara.Model {
   scaleMin?: string;
   /**
    * @remarks
-   * The serverless type. A value of **AgileServerless** indicates that the cluster is a serverless cluster.
+   * The serverless type. A return value of **AgileServerless** indicates that the cluster is a serverless cluster.
    * 
    * @example
    * AgileServerless
@@ -223,7 +227,7 @@ export class DescribeAgenticDBClustersResponseBodyItems extends $dara.Model {
   storageUsed?: number;
   /**
    * @remarks
-   * The tag key. You can filter the cluster list by tag. You can specify up to 20 tag pairs. The number n for each tag pair must be unique and must be a consecutive integer starting from 1. The value of Tag.n.Key corresponds to Tag.n.Value.
+   * The tag key. You can use tags to filter clusters. You can specify up to 20 tags. 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.
    */
   tags?: DescribeAgenticDBClustersResponseBodyItemsTags[];
   /**
@@ -334,7 +338,7 @@ export class DescribeAgenticDBClustersResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The pagination token. Set this parameter to the NextToken value returned in the previous API call. If there is no next query, do not pass this parameter.
+   * The pagination token. Set this parameter to the NextToken value returned in the previous API call. If there is no next query, do not specify this parameter.
    * 
    * @example
    * 212db86sca4384811e0b5e8707e******

package/src/models/DescribeAgenticDbcomputeClustersRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeAgenticDBComputeClustersRequest extends $dara.Model {
   /**
+   * @remarks
+   * The compute instance ID for fuzzy match (pc-xxxx), such as pc-2ze8k.
+   * 
    * @example
    * pc-2ze8k
    */
@@ -46,7 +49,7 @@ export class DescribeAgenticDBComputeClustersRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The status filter. Valid values: Running, Stopped, and Waiting.
+   * Filters compute instances by status. Valid values: Running, Stopped, and Waiting.
    * 
    * @example
    * Running

package/src/models/DescribeAgenticDbcomputeClustersResponseBody.ts

@@ -39,6 +39,8 @@ export class DescribeAgenticDBComputeClustersResponseBodyItems extends $dara.Mod
    * @remarks
    * The time when the compute instance 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
    */
@@ -52,6 +54,9 @@ export class DescribeAgenticDBComputeClustersResponseBodyItems extends $dara.Mod
    */
   description?: string;
   /**
+   * @remarks
+   * Indicates whether the compute instance is the default branch.
+   * 
    * @example
    * false
    */
@@ -88,7 +93,15 @@ export class DescribeAgenticDBComputeClustersResponseBodyItems extends $dara.Mod
    * Neon
    */
   operatorType?: string;
+  /**
+   * @remarks
+   * The ID of the parent branch. This value is an empty string for the root branch.
+   */
   parentBranchId?: string;
+  /**
+   * @remarks
+   * The name of the parent branch. This value is an empty string for the root branch.
+   */
   parentBranchName?: string;
   /**
    * @remarks
@@ -116,7 +129,7 @@ export class DescribeAgenticDBComputeClustersResponseBodyItems extends $dara.Mod
   status?: string;
   /**
    * @remarks
-   * The amount of used data, in bytes.
+   * The amount of data used, in bytes.
    * 
    * @example
    * 1073741824

package/src/models/DescribeAgenticDbprojectRequest.ts

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

package/src/models/DescribeAgenticDbprojectResponseBody.ts

@@ -4,46 +4,79 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeAgenticDBProjectResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The time when the project was created.
+   * 
+   * The time is in ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).
+   * 
    * @example
    * 2026-06-10T11:00:00Z
    */
   createTime?: string;
   /**
+   * @remarks
+   * The ID of the default branch.
+   * 
    * @example
    * br-1a2b3c4d5e6f
    */
   defaultBranchId?: string;
   /**
+   * @remarks
+   * The name of the default branch.
+   * 
    * @example
    * main
    */
   defaultBranchName?: string;
   /**
+   * @remarks
+   * The description of the project.
+   * 
    * @example
    * Production analytics database
    */
   description?: string;
   /**
+   * @remarks
+   * Project ID
+   * 
    * @example
    * proj-a1b2c3d4e5f6
    */
   projectId?: string;
   /**
+   * @remarks
+   * The project name.
+   * 
    * @example
    * analytics-prod
    */
   projectName?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * I9J0K1L2-M3N4-5678-IJKL-789012345678
    */
   requestId?: string;
   /**
+   * @remarks
+   * The project status. Valid values:
+   * 
+   * - Active: Normal.
+   * - Destroying: Being destroyed.
+   * - Destroyed: Destroyed.
+   * 
    * @example
    * Active
    */
   status?: string;
   /**
+   * @remarks
+   * The ID of the tenant to which the project belongs.
+   * 
    * @example
    * t-4b83e0da66674951
    */

package/src/models/DescribeAgenticDbprojectsRequest.ts

@@ -57,7 +57,7 @@ export class DescribeAgenticDBProjectsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The tenant ID to which the project belongs.
+   * The ID of the tenant to which the project belongs.
    * 
    * @example
    * t-4b83e0da66674951

package/src/models/DescribeAgenticDbprojectsResponseBody.ts

@@ -5,7 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAgenticDBProjectsResponseBodyItems extends $dara.Model {
   /**
    * @remarks
-   * The creation time.
+   * The time when the project was created.
+   * 
+   * The time is in the ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).
    * 
    * @example
    * 2026-06-10T11:00:00Z
@@ -13,7 +15,7 @@ export class DescribeAgenticDBProjectsResponseBodyItems extends $dara.Model {
   createTime?: string;
   /**
    * @remarks
-   * The associated AgenticDB cluster ID.
+   * The ID of the associated AgenticDB cluster.
    * 
    * @example
    * pagc-bp1abcdef1234567
@@ -60,13 +62,20 @@ export class DescribeAgenticDBProjectsResponseBodyItems extends $dara.Model {
    */
   projectName?: string;
   /**
+   * @remarks
+   * The project status. Valid values:
+   * 
+   * - Active: Normal.
+   * - Destroying: Being destroyed.
+   * - Destroyed: Destroyed.
+   * 
    * @example
    * Active
    */
   status?: string;
   /**
    * @remarks
-   * The tenant ID to which the project belongs.
+   * The ID of the tenant to which the project belongs.
    * 
    * @example
    * t-4b83e0da66674951

package/src/models/DescribeAgenticDbtenantApiKeysRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAgenticDBTenantApiKeysRequest extends $dara.Model {
   /**
    * @remarks
+   * The AgenticDB cluster ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,17 +14,25 @@ export class DescribeAgenticDBTenantApiKeysRequest 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 region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -30,6 +40,9 @@ export class DescribeAgenticDBTenantApiKeysRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * Filters results by tenant name.
+   * 
    * @example
    * my-saas-app
    */

package/src/models/DescribeAgenticDbtenantApiKeysResponseBody.ts

@@ -4,41 +4,69 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeAgenticDBTenantApiKeysResponseBodyItems extends $dara.Model {
   /**
+   * @remarks
+   * The resource ID of the API key.
+   * 
    * @example
    * ak-71304e39c7e841a1
    */
   apiKeyId?: string;
   /**
+   * @remarks
+   * The masked API key value.
+   * 
    * @example
    * pagc_key_cGFnYy1icDFhMmIz****
    */
   apiKeyMasked?: string;
   /**
+   * @remarks
+   * The time when the API key was created.
+   * 
+   * The time is in ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).
+   * 
    * @example
    * 2026-06-10T10:30:00Z
    */
   createTime?: string;
   /**
+   * @remarks
+   * The description of the API key.
+   * 
    * @example
    * MCP server token
    */
   description?: string;
   /**
+   * @remarks
+   * The time when the API key expires.
+   * 
+   * The time is in ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).
+   * 
    * @example
    * 2027-01-01T00:00:00Z
    */
   expireTime?: string;
   /**
+   * @remarks
+   * The status of the API key.
+   * 
    * @example
    * Active
    */
   status?: string;
   /**
+   * @remarks
+   * The ID of the tenant to which the API key belongs.
+   * 
    * @example
    * t-4b83e0da66674951
    */
   tenantId?: string;
   /**
+   * @remarks
+   * The name of the tenant to which the API key belongs.
+   * 
    * @example
    * my-saas-app
    */
@@ -79,23 +107,39 @@ export class DescribeAgenticDBTenantApiKeysResponseBodyItems extends $dara.Model
 }
 
 export class DescribeAgenticDBTenantApiKeysResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of API keys.
+   */
   items?: DescribeAgenticDBTenantApiKeysResponseBodyItems[];
   /**
+   * @remarks
+   * The current page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 30
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * C3D4E5F6-A7B8-9012-CDEF-123456789012
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries returned.
+   * 
    * @example
    * 2
    */

package/src/models/DescribeAidbclusterApiKeysResponseBody.ts

@@ -15,6 +15,8 @@ export class DescribeAIDBClusterApiKeysResponseBodyApiKeys extends $dara.Model {
    * @remarks
    * The creation time.
    * 
+   * The time is displayed in ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).
+   * 
    * @example
    * 2026-04-09T03:19:19Z
    */