@alicloud/polardb20170801 7.12.2 → 8.0.0

package/src/models/AddPolarOssauthorizedAccountRequest.ts

@@ -0,0 +1,68 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class AddPolarOSSAuthorizedAccountRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The list of authorized accounts to add, separated by commas. You can pass in UIDs and RAM role ARNs in mixed parameter notation.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 1234567890,acs:ram::123456:role/myrole
+   */
+  authorizedUserIds?: string;
+  /**
+   * @remarks
+   * The ID of the PolarDB cluster.
+   * 
+   * @example
+   * pc-xxxxxxxxxxxxxxxxx
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The cold storage instance ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * pfs-xxxxxxxxxxxxxxxxx
+   */
+  pfsInstanceId?: string;
+  /**
+   * @remarks
+   * The region ID.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      authorizedUserIds: 'AuthorizedUserIds',
+      DBClusterId: 'DBClusterId',
+      pfsInstanceId: 'PfsInstanceId',
+      regionId: 'RegionId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      authorizedUserIds: 'string',
+      DBClusterId: 'string',
+      pfsInstanceId: 'string',
+      regionId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/AddPolarOssauthorizedAccountResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { AddPolarOSSAuthorizedAccountResponseBody } from "./AddPolarOssauthorizedAccountResponseBody";
+
+
+export class AddPolarOSSAuthorizedAccountResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: AddPolarOSSAuthorizedAccountResponseBody;
+  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: AddPolarOSSAuthorizedAccountResponseBody,
+    };
+  }
+
+  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/AddPolarOssauthorizedAccountResponseBody.ts

@@ -0,0 +1,64 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class AddPolarOSSAuthorizedAccountResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The updated list of RAM role ARNs, separated by commas.
+   * 
+   * @example
+   * arn:sts::123456:assumed-role/myrole/*
+   */
+  authorizedUserArnIds?: string;
+  /**
+   * @remarks
+   * The updated list of UIDs, separated by commas.
+   * 
+   * @example
+   * 1234567890,9876543210
+   */
+  authorizedUserIds?: string;
+  /**
+   * @remarks
+   * The cold storage instance ID.
+   * 
+   * @example
+   * pfs-xxxxxxxxxxxxxxxxx
+   */
+  pfsInstanceId?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * F45FFACC-xxx
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      authorizedUserArnIds: 'AuthorizedUserArnIds',
+      authorizedUserIds: 'AuthorizedUserIds',
+      pfsInstanceId: 'PfsInstanceId',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      authorizedUserArnIds: 'string',
+      authorizedUserIds: 'string',
+      pfsInstanceId: 'string',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateAgenticDbtenantApiKeyRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAgenticDBTenantApiKeyRequest extends $dara.Model {
   /**
    * @remarks
+   * The AgenticDB cluster ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,17 +14,25 @@ export class CreateAgenticDBTenantApiKeyRequest extends $dara.Model {
    */
   DBClusterId?: string;
   /**
+   * @remarks
+   * The description of the API key usage.
+   * 
    * @example
-   * MCP Server专用Key
+   * Dedicated key for MCP Server
    */
   description?: string;
   /**
+   * @remarks
+   * The expiration time in ISO 8601 format. If this parameter is not specified, the API key never expires.
+   * 
    * @example
    * 2027-01-01T00:00:00Z
    */
   expireTime?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -31,6 +41,8 @@ export class CreateAgenticDBTenantApiKeyRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
+   * The tenant name. The name must be unique within the cluster and contain 2 to 64 characters.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CreateAgenticDbtenantApiKeyResponseBody.ts

@@ -4,36 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateAgenticDBTenantApiKeyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The plaintext of the API key. This value is returned only in this response.
+   * 
    * @example
    * pagc_key_xxxx.yyyy
    */
   apiKey?: string;
   /**
+   * @remarks
+   * The resource ID of the API key.
+   * 
    * @example
    * ak-xxxxxxxxxxxx
    */
   apiKeyId?: string;
   /**
+   * @remarks
+   * The time when the API key was created.
+   * 
    * @example
    * 2026-06-10T08:00:00Z
    */
   createTime?: string;
   /**
+   * @remarks
+   * The expiration time of the API key. This value is empty if the API key never expires.
+   * 
    * @example
    * 2027-01-01T00:00:00Z
    */
   expireTime?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F45FFACC-1B2C-3D4E-5F6A-7B8C9D0E1F2A
    */
   requestId?: string;
   /**
+   * @remarks
+   * The tenant ID.
+   * 
    * @example
    * t-aaaa111122223333
    */
   tenantId?: string;
   /**
+   * @remarks
+   * The tenant name.
+   * 
    * @example
    * my-tenant
    */

package/src/models/CreateAidbclusterApiKeyRequest.ts

@@ -12,6 +12,9 @@ export class CreateAIDBClusterApiKeyRequest extends $dara.Model {
    */
   description?: string;
   /**
+   * @remarks
+   * The model space ID.
+   * 
    * @example
    * pms-xxx
    */
@@ -19,8 +22,8 @@ export class CreateAIDBClusterApiKeyRequest extends $dara.Model {
   /**
    * @remarks
    * The region ID.
-   * > * You can call the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) operation to query the regions of all clusters under the specified account.
-   * > * If you leave this parameter empty, scheduled tasks across all regions under the current account are queried.
+   * > * You can call the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) operation to query the region information of all clusters under the specified account.
+   * > * If this parameter is left empty, scheduled tasks in all regions under the current account are queried by default.
    * 
    * This parameter is required.
    * 

package/src/models/CreateAidbclusterApiKeyResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAIDBClusterApiKeyResponseBodyApiKey extends $dara.Model {
   /**
    * @remarks
-   * The API key of the model service.
+   * The API key for model serving.
    * 
    * @example
    * xxx

package/src/models/CreateAidbclusterRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAIDBClusterRequestTimeSlices extends $dara.Model {
   /**
    * @remarks
-   * The start time of the billing interval. The time is in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.
+   * The start time of the task. The time is in the `YYYY-MM-DDThh:mm:ssZ` format (UTC).
    * 
    * @example
    * 1758729600
@@ -13,7 +13,7 @@ export class CreateAIDBClusterRequestTimeSlices extends $dara.Model {
   beginTime?: number;
   /**
    * @remarks
-   * The end time of the billing interval, which must be later than the start time. The time is in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.
+   * The end time of the query. The end time must be later than the start time. The time is in the `YYYY-MM-DDThh:mmZ` format (UTC).
    * 
    * @example
    * 1758733200
@@ -56,8 +56,7 @@ export class CreateAIDBClusterRequest extends $dara.Model {
    * Specifies whether to enable auto-renewal. Valid values:
    * 
    * - **true**: Auto-renewal is enabled.
-   * 
-   * - **false**: Auto-renewal is disabled.
+   * - **false**: Auto-renewal is not enabled.
    * 
    * Default value: **false**.
    * 
@@ -69,25 +68,26 @@ export class CreateAIDBClusterRequest extends $dara.Model {
   autoRenew?: string;
   /**
    * @remarks
-   * Specifies whether to automatically use a coupon. Valid values:
+   * Specifies whether to automatically use coupons. Valid values:
+   * * true (default): Use coupons.
+   * * false: Do not use coupons.
    * 
    * @example
    * false
    */
   autoUseCoupon?: boolean;
-  /**
-   * @remarks
-   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
-   */
   clientToken?: string;
   /**
+   * @remarks
+   * Specifies whether to create a public endpoint.
+   * 
    * @example
    * ON
    */
   createPublicEndpoint?: string;
   /**
    * @remarks
-   * The description of the cluster. You can use the description to perform a fuzzy search.
+   * The cluster description. Fuzzy match is supported.
    * 
    * @example
    * test
@@ -95,7 +95,7 @@ export class CreateAIDBClusterRequest extends $dara.Model {
   DBClusterDescription?: string;
   /**
    * @remarks
-   * The ID of the PolarDB cluster that the application depends on.
+   * The instance ID of the PolarDB instance on which the application depends.
    * 
    * @example
    * pc-******************
@@ -103,7 +103,7 @@ export class CreateAIDBClusterRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The node specification.
+   * The node specifications.
    * 
    * @example
    * polar.pg.g4.6xlarge.gu4
@@ -127,7 +127,7 @@ export class CreateAIDBClusterRequest extends $dara.Model {
   inferenceEngine?: string;
   /**
    * @remarks
-   * The Container Service for Kubernetes (ACK) cluster ID.
+   * The ACK cluster ID.
    * 
    * @example
    * xxxxxxxxxxxxxxxxxxxxxxx
@@ -143,7 +143,7 @@ export class CreateAIDBClusterRequest extends $dara.Model {
   kubeConfig?: string;
   /**
    * @remarks
-   * The management mode of the Kubernetes cluster.
+   * The Kubernetes cluster management mode.
    * 
    * @example
    * self_k8s
@@ -151,7 +151,7 @@ export class CreateAIDBClusterRequest extends $dara.Model {
   kubeManagement?: string;
   /**
    * @remarks
-   * The type of the Kubernetes deployment.
+   * aideploy
    * 
    * @example
    * aideploy
@@ -174,11 +174,17 @@ export class CreateAIDBClusterRequest extends $dara.Model {
    */
   managementMode?: string;
   /**
+   * @remarks
+   * The model name.
+   * 
    * @example
    * Qwen3-30B-A3B
    */
   modelName?: string;
   /**
+   * @remarks
+   * The model operator space.
+   * 
    * @example
    * pms-xxx
    */
@@ -195,10 +201,9 @@ export class CreateAIDBClusterRequest extends $dara.Model {
   password?: string;
   /**
    * @remarks
-   * The billing method. Valid values:
+   * The billing method. Valid values: 
    * 
    * - **Postpaid**: pay-as-you-go.
-   * 
    * - **Prepaid**: subscription.
    * 
    * This parameter is required.
@@ -209,11 +214,10 @@ export class CreateAIDBClusterRequest extends $dara.Model {
   payType?: string;
   /**
    * @remarks
-   * The unit of the subscription duration. This parameter is required if **PayType** is set to **Prepaid**. Valid values:
-   * 
-   * - **Year**
+   * This parameter is required to pass parameter when **PayType** is set to **Prepaid**. Specifies the unit of the upfront payment duration for the subscription cluster. 
    * 
-   * - **Month**
+   * - **Year**: The subscription duration is measured in years.
+   * - **Month**: The subscription duration is measured in months.
    * 
    * @example
    * 5
@@ -221,11 +225,7 @@ export class CreateAIDBClusterRequest extends $dara.Model {
   period?: string;
   /**
    * @remarks
-   * The coupon code. If you do not specify this parameter, the default coupon is used.
-   * 
-   * - true (default): Use a coupon.
-   * 
-   * - false: Do not use a coupon.
+   * The coupon code. If this parameter is not specified, the default coupon is used.
    * 
    * @example
    * 727xxxxxx934
@@ -253,7 +253,7 @@ export class CreateAIDBClusterRequest extends $dara.Model {
   securityGroupId?: string;
   /**
    * @remarks
-   * The storage space. Unit: GB.
+   * The storage space.
    * 
    * @example
    * 1024
@@ -269,16 +269,14 @@ export class CreateAIDBClusterRequest extends $dara.Model {
   storageType?: string;
   /**
    * @remarks
-   * The billing intervals for the pay-as-you-go cluster.
+   * The pay-as-you-go time intervals.
    */
   timeSlices?: CreateAIDBClusterRequestTimeSlices[];
   /**
    * @remarks
-   * The subscription duration. This parameter is required if **PayType** is set to **Prepaid**.
-   * 
-   * - If **Period** is set to **Month**, the value of **UsedTime** must be an integer from `[1-9]`.
-   * 
-   * - If **Period** is set to **Year**, the value of **UsedTime** must be an integer from `[1-3]`.
+   * This parameter is required when **PayType** is set to **Prepaid**.
+   * - If **Period** is set to **Month**, the valid values of **UsedTime** are integers in the range of `[1-9]`.
+   * - If **Period** is set to **Year**, the valid values of **UsedTime** are integers in the range of `[1-3]`.
    * 
    * @example
    * 1
@@ -286,7 +284,7 @@ export class CreateAIDBClusterRequest extends $dara.Model {
   usedTime?: string;
   /**
    * @remarks
-   * The virtual private cloud (VPC) ID.
+   * The VPC ID.
    * 
    * This parameter is required.
    * 
@@ -306,7 +304,7 @@ export class CreateAIDBClusterRequest extends $dara.Model {
   vSwitchId?: string;
   /**
    * @remarks
-   * The availability zone ID.
+   * The zone ID.
    * 
    * @example
    * cn-beijing-i

package/src/models/CreateAidbclusterResponseBody.ts

@@ -21,7 +21,7 @@ export class CreateAIDBClusterResponseBody extends $dara.Model {
   orderId?: string;
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * CDB3258F-B5DE-43C4-8935-CBA0CA******

package/src/models/CreateAidbclusterTaskRequest.ts

@@ -104,7 +104,7 @@ export class CreateAIDBClusterTaskRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The running parameters in JSON string format.
+   * The running parameters in a JSON string.
    * 
    * This parameter is required.
    * 
@@ -122,7 +122,7 @@ export class CreateAIDBClusterTaskRequest extends $dara.Model {
   securityGroupId?: string;
   /**
    * @remarks
-   * The description of the model service.
+   * The model service description.
    * 
    * @example
    * xxxx

package/src/models/CreateKnowledgeBaseRequest.ts

@@ -0,0 +1,96 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateKnowledgeBaseRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The description of the knowledge base.
+   * 
+   * @example
+   * testkbDesc
+   */
+  description?: string;
+  /**
+   * @remarks
+   * The type of the knowledge base: PERSONAL or PUBLIC.
+   * 
+   * @example
+   * PUBLIC
+   */
+  knowledgeBaseType?: string;
+  /**
+   * @remarks
+   * The unique identifier of the knowledge space.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * pks-xxxxxx
+   */
+  knowledgeSpaceId?: string;
+  /**
+   * @remarks
+   * The name of the knowledge base.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * testkb
+   */
+  name?: string;
+  /**
+   * @remarks
+   * The region ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The search mode. Valid values:
+   * 
+   * * balanced (default): balanced mode
+   * * precise: precise mode
+   * * semantic: semantic mode
+   * * knn: KNN mode
+   * * rrf: reciprocal rank fusion
+   * 
+   * @example
+   * balanced
+   */
+  searchMode?: string;
+  static names(): { [key: string]: string } {
+    return {
+      description: 'Description',
+      knowledgeBaseType: 'KnowledgeBaseType',
+      knowledgeSpaceId: 'KnowledgeSpaceId',
+      name: 'Name',
+      regionId: 'RegionId',
+      searchMode: 'SearchMode',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      description: 'string',
+      knowledgeBaseType: 'string',
+      knowledgeSpaceId: 'string',
+      name: 'string',
+      regionId: 'string',
+      searchMode: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateKnowledgeBaseResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { CreateKnowledgeBaseResponseBody } from "./CreateKnowledgeBaseResponseBody";
+
+
+export class CreateKnowledgeBaseResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: CreateKnowledgeBaseResponseBody;
+  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: CreateKnowledgeBaseResponseBody,
+    };
+  }
+
+  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);
+  }
+}
+