@alicloud/polardb20170801 7.2.0 → 7.4.0

package/src/models/CreateAccountRequest.ts

@@ -7,9 +7,8 @@ export class CreateAccountRequest extends $dara.Model {
    * @remarks
    * The description of the account. The description must meet the following requirements:
    * 
-   * - It cannot start with `http://` or `https://`.
-   * 
-   * - It must be 2 to 256 characters in length.
+   * - Cannot start with `http://` or `https://`.
+   * - Is 2 to 256 characters in length.
    * 
    * @example
    * testdes
@@ -17,15 +16,12 @@ export class CreateAccountRequest extends $dara.Model {
   accountDescription?: string;
   /**
    * @remarks
-   * The name of the database account. The name must meet the following requirements:
-   * 
-   * - It must start with a lowercase letter and end with a letter or a digit.
-   * 
-   * - It can contain lowercase letters, digits, and underscores (_).
+   * The account name. The name must meet the following requirements:
    * 
-   * - It must be 2 to 16 characters in length.
-   * 
-   * - It cannot be a reserved keyword, such as root or admin.
+   * * Starts with a lowercase letter and ends with a letter or digit.
+   * * Contains only lowercase letters, digits, or underscores (_).
+   * * Is 2 to 16 characters in length.
+   * * Cannot use certain reserved usernames such as root or admin.
    * 
    * This parameter is required.
    * 
@@ -35,13 +31,10 @@ export class CreateAccountRequest extends $dara.Model {
   accountName?: string;
   /**
    * @remarks
-   * The password of the database account. The password must meet the following requirements:
-   * 
-   * - It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
-   * 
-   * - It must be 8 to 32 characters in length.
-   * 
-   * - The special characters are `!@#$%^&*()_+-=`.
+   * The account password. The password must meet the following requirements:
+   * * Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
+   * * Is 8 to 32 characters in length.
+   * * Special characters include `!@#$%^&*()_+-=`.
    * 
    * This parameter is required.
    * 
@@ -51,23 +44,17 @@ export class CreateAccountRequest extends $dara.Model {
   accountPassword?: string;
   /**
    * @remarks
-   * The privilege level to grant on the specified databases. Valid values:
-   * 
-   * - **ReadWrite**: read and write permissions
-   * 
-   * - **ReadOnly**: read-only permissions
+   * The permissions of the account. Valid values: 
    * 
-   * - **DMLOnly**: DML permissions only
+   * * **ReadWrite**: read and write
+   * * **ReadOnly**: read-only
+   * * **DMLOnly**: DML only
+   * * **DDLOnly**: DDL only
+   * * **ReadIndex**: read-only and index
    * 
-   * - **DDLOnly**: DDL permissions only
-   * 
-   * - **ReadIndex**: read-only and index permissions
-   * 
-   * > * This parameter takes effect only when you specify the `DBName` parameter.
-   * >
-   * > * If you specify multiple databases in `DBName`, you must specify a corresponding permission for each in `AccountPrivilege`, separated by commas. The `AccountPrivilege` string cannot exceed 900 characters. For example, to grant read and write permissions to database DB1 and read-only permissions to database DB2, set `DBName` to `DB1,DB2` and set `AccountPrivilege` to `ReadWrite,ReadOnly`.
-   * >
-   * > * This parameter applies only to standard accounts on PolarDB for MySQL clusters.
+   * >* The DBName parameter must be specified for AccountPrivilege to take effect.
+   * >* If you specify multiple database names for the DBName parameter, you must grant the corresponding permissions to each database. Separate multiple permissions with commas (,) and make sure that the total length of the AccountPrivilege string does not exceed 900 characters. For example, to grant read and write permissions on database DB1 and read-only permissions on database DB2, set DBName to `DB1,DB2` and set AccountPrivilege to `ReadWrite,ReadOnly`.
+   * > * This parameter is supported only for standard accounts of PolarDB for MySQL clusters.
    * 
    * @example
    * ReadWrite
@@ -75,17 +62,18 @@ export class CreateAccountRequest extends $dara.Model {
   accountPrivilege?: string;
   /**
    * @remarks
-   * The type of the account. Valid values:
+   * The account type. Valid values:
    * 
-   * - **Normal**: a standard account.
+   * - **Normal**: standard account. 
+   * - **Super**: privileged account. 
+   * - **DynamoDB**: DynamoDB account. 
    * 
-   * - **Super**: a privileged account.
    * 
-   * > * If you do not specify this parameter, the system creates a **Super** account by default.
-   * >
-   * > * You can create multiple privileged accounts on PolarDB for PostgreSQL (Oracle-Compatible) and PolarDB for PostgreSQL clusters. A privileged account has more permissions than a standard account. For more information, see [Create database accounts](https://help.aliyun.com/document_detail/68508.html).
-   * >
-   * > * For a PolarDB for MySQL cluster, you can create only one privileged account. For more information, see [Create database accounts](https://help.aliyun.com/document_detail/68508.html).
+   *  
+   * > * If this parameter is left empty, a **Super** account is created by default.
+   * > * If the cluster is a PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL cluster, you can create multiple privileged accounts for each cluster. Privileged accounts have more permissions than standard accounts. For more information, see [Create a database account](https://help.aliyun.com/document_detail/68508.html).
+   * > * If the cluster is a PolarDB for MySQL cluster, you can create at most one privileged account for each cluster. Privileged accounts have more permissions than standard accounts. For more information, see [Create a database account](https://help.aliyun.com/document_detail/68508.html).
+   * > * DynamoDB accounts are dedicated accounts created for the DynamoDB compatibility feature of PolarDB for PostgreSQL. For more information, see [DynamoDB usage instructions](https://help.aliyun.com/document_detail/2979941.html).
    * 
    * @example
    * Normal
@@ -93,7 +81,7 @@ export class CreateAccountRequest extends $dara.Model {
   accountType?: string;
   /**
    * @remarks
-   * A client-generated token to ensure request idempotency. The token must be unique across requests. It is case-sensitive and can be up to 64 ASCII characters long.
+   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the value. Make sure that the value is unique among different requests. The token is case-sensitive and cannot exceed 64 ASCII characters in length.
    * 
    * @example
    * 6000170000591aed949d0f54a343f1a4233c1e7d1c5c******
@@ -111,9 +99,9 @@ export class CreateAccountRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The name of the database that the account can access. To specify multiple databases, separate the database names with a comma (,).
+   * The name of the database that the account is authorized to access. You can specify multiple database names separated by commas (,).
    * 
-   * > This parameter applies only to standard accounts on PolarDB for MySQL clusters.
+   * > This parameter is supported only for standard accounts of PolarDB for MySQL clusters.
    * 
    * @example
    * testdb
@@ -121,9 +109,9 @@ export class CreateAccountRequest extends $dara.Model {
   DBName?: string;
   /**
    * @remarks
-   * The type of the node. Valid values:
+   * The node type. Valid values:
    * 
-   * - **Search**: For creating an account on a PolarDB Search node.
+   * - Search: required when creating an account for a PolarDB Search node
    * 
    * @example
    * Search
@@ -133,15 +121,13 @@ export class CreateAccountRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * Specifies whether to grant the account permissions on all current and future databases in the cluster. Valid values:
-   * 
-   * - **0 or do not specify**: The specified permissions are not granted to all databases.
+   * Specifies whether to grant permissions on all existing databases and all new databases in the current cluster. Valid values:
    * 
-   * - **1**: Grants the specified permissions to all current and future databases.
+   * - **0 or empty**: does not grant permissions.
    * 
-   * > * This parameter takes effect only when you specify the `AccountPrivilege` parameter.
-   * >
-   * > * If you set this parameter to `1`, the permissions specified in `AccountPrivilege` are granted to all databases.
+   * - **1**: grants permissions.
+   * >* The AccountPrivilege parameter must be specified for this parameter to take effect.
+   * >* If this parameter is set to `1`, the permissions specified by AccountPrivilege are granted on all databases.
    * 
    * @example
    * 0

package/src/models/CreateAgenticDbbranchRequest.ts

@@ -0,0 +1,104 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateAgenticDBBranchRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the branch.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * feature-analytics
+   */
+  branchName?: string;
+  /**
+   * @remarks
+   * The AgenticDB cluster ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * pagc-bp1abcdef1234567
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The description of the branch.
+   * 
+   * @example
+   * Feature branch for analytics
+   */
+  description?: string;
+  /**
+   * @remarks
+   * The ID of the parent branch. If this parameter is not specified, the branch is derived from the main branch by default.
+   * 
+   * @example
+   * br-1a2b3c4d5e6f
+   */
+  parentBranchId?: string;
+  /**
+   * @remarks
+   * The ID of the project to which the branch belongs.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * proj-a1b2c3d4e5f6
+   */
+  projectId?: string;
+  /**
+   * @remarks
+   * The region ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The ID of the tenant to which the branch belongs.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * t-4b83e0da66674951
+   */
+  tenantId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      branchName: 'BranchName',
+      DBClusterId: 'DBClusterId',
+      description: 'Description',
+      parentBranchId: 'ParentBranchId',
+      projectId: 'ProjectId',
+      regionId: 'RegionId',
+      tenantId: 'TenantId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      branchName: 'string',
+      DBClusterId: 'string',
+      description: 'string',
+      parentBranchId: 'string',
+      projectId: 'string',
+      regionId: 'string',
+      tenantId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateAgenticDbbranchResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { CreateAgenticDBBranchResponseBody } from "./CreateAgenticDbbranchResponseBody";
+
+
+export class CreateAgenticDBBranchResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: CreateAgenticDBBranchResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: CreateAgenticDBBranchResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateAgenticDbbranchResponseBody.ts

@@ -0,0 +1,124 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateAgenticDBBranchResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the compute cluster associated with the branch.
+   * 
+   * @example
+   * pc-g0lsayq8c5qe
+   */
+  branchComputeClusterId?: string;
+  /**
+   * @remarks
+   * The branch ID.
+   * 
+   * @example
+   * br-7g8h9i0j1k2l
+   */
+  branchId?: string;
+  /**
+   * @remarks
+   * The name of the branch.
+   * 
+   * @example
+   * feature-analytics
+   */
+  branchName?: string;
+  /**
+   * @remarks
+   * The AgenticDB cluster ID.
+   * 
+   * @example
+   * pagc-bp1abcdef1234567
+   */
+  DBClusterId?: 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
+   * A1B2C3D4-E5F6-7890-ABCD-1234567890AB
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The status of the branch.
+   * 
+   * @example
+   * Active
+   */
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      branchComputeClusterId: 'BranchComputeClusterId',
+      branchId: 'BranchId',
+      branchName: 'BranchName',
+      DBClusterId: 'DBClusterId',
+      parentBranchId: 'ParentBranchId',
+      parentBranchName: 'ParentBranchName',
+      projectId: 'ProjectId',
+      projectName: 'ProjectName',
+      requestId: 'RequestId',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      branchComputeClusterId: 'string',
+      branchId: 'string',
+      branchName: 'string',
+      DBClusterId: 'string',
+      parentBranchId: 'string',
+      parentBranchName: 'string',
+      projectId: 'string',
+      projectName: 'string',
+      requestId: 'string',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateAgenticDbprojectRequest.ts

@@ -0,0 +1,92 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateAgenticDBProjectRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The AgenticDB cluster ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * pagc-bp1abcdef1234567
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The default branch name. Default value: main.
+   * 
+   * @example
+   * main
+   */
+  defaultBranchName?: string;
+  /**
+   * @remarks
+   * The description of the project.
+   * 
+   * @example
+   * Production analytics database
+   */
+  description?: string;
+  /**
+   * @remarks
+   * The project name. The name must be unique within the same tenant.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * analytics-prod
+   */
+  projectName?: string;
+  /**
+   * @remarks
+   * The region ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The ID of the tenant to which the project belongs.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * t-4b83e0da66674951
+   */
+  tenantId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      DBClusterId: 'DBClusterId',
+      defaultBranchName: 'DefaultBranchName',
+      description: 'Description',
+      projectName: 'ProjectName',
+      regionId: 'RegionId',
+      tenantId: 'TenantId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      DBClusterId: 'string',
+      defaultBranchName: 'string',
+      description: 'string',
+      projectName: 'string',
+      regionId: 'string',
+      tenantId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateAgenticDbprojectResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { CreateAgenticDBProjectResponseBody } from "./CreateAgenticDbprojectResponseBody";
+
+
+export class CreateAgenticDBProjectResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: CreateAgenticDBProjectResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: CreateAgenticDBProjectResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateAgenticDbprojectResponseBody.ts

@@ -0,0 +1,104 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateAgenticDBProjectResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the compute instance associated with the default branch.
+   * 
+   * @example
+   * pc-g0lsayq8c5qe
+   */
+  branchComputeClusterId?: string;
+  /**
+   * @remarks
+   * The time when the project was created.
+   * 
+   * @example
+   * 2026-06-10T11:00:00Z
+   */
+  createTime?: string;
+  /**
+   * @remarks
+   * The default branch ID.
+   * 
+   * @example
+   * br-1a2b3c4d5e6f
+   */
+  defaultBranchId?: string;
+  /**
+   * @remarks
+   * The default branch name.
+   * 
+   * @example
+   * main
+   */
+  defaultBranchName?: string;
+  /**
+   * @remarks
+   * The ID of the new project.
+   * 
+   * @example
+   * proj-a1b2c3d4e5f6
+   */
+  projectId?: string;
+  /**
+   * @remarks
+   * The project name.
+   * 
+   * @example
+   * analytics-prod
+   */
+  projectName?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * E5F6A7B8-C9D0-1234-EFAB-345678901234
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The tenant ID.
+   * 
+   * @example
+   * t-4b83e0da66674951
+   */
+  tenantId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      branchComputeClusterId: 'BranchComputeClusterId',
+      createTime: 'CreateTime',
+      defaultBranchId: 'DefaultBranchId',
+      defaultBranchName: 'DefaultBranchName',
+      projectId: 'ProjectId',
+      projectName: 'ProjectName',
+      requestId: 'RequestId',
+      tenantId: 'TenantId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      branchComputeClusterId: 'string',
+      createTime: 'string',
+      defaultBranchId: 'string',
+      defaultBranchName: 'string',
+      projectId: 'string',
+      projectName: 'string',
+      requestId: 'string',
+      tenantId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+