@alicloud/gpdb20160503 3.10.0 → 3.11.0

package/src/models/DescribeModelOperatorUsageRequest.ts

@@ -3,25 +3,74 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeModelOperatorUsageRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The list of API key IDs. Separate multiple IDs with commas (,). If this parameter is not specified, all API key IDs under the instance ID are used by default.
+   * 
+   * > The list can contain up to 50 items.
+   */
   apiKeyIds?: number[];
   /**
+   * @remarks
+   * The end time of the query. Specify the time in the <i>YYYY-MM-DDThh:mmZ</i> format (UTC).
+   * 
+   * > The end time must be later than the start time, and the interval between the start time and end time cannot exceed 7 days.
+   * 
    * @example
    * 2026-06-02T00:00Z
    */
   endTime?: string;
   /**
+   * @remarks
+   * The dimension by which to split the series. Separate multiple dimensions with commas (,). The order is not significant. Valid values:
+   * 
+   * - model (default): splits by model.
+   * - api_key: splits by API key.
+   * - model,api_key: splits by model and API key.
+   * 
    * @example
    * model
    */
   groupBy?: string;
+  /**
+   * @remarks
+   * The list of metrics. Separate multiple metrics with commas (,). Valid values:
+   * 
+   * - request_count: the number of requests.
+   * - success_count: the number of successful requests.
+   * - error_count: the number of failed requests.
+   * - success_rate: the request success rate.
+   * - input_token: the number of input tokens.
+   * - output_token: the number of output tokens.
+   * - total_token: the total number of tokens.
+   */
   keys?: string[];
+  /**
+   * @remarks
+   * The list of model names. Separate multiple names with commas (,).
+   */
   modelNames?: string[];
   /**
+   * @remarks
+   * The time bucket size in seconds. Valid values: 1, 5, 15, 60, 300, and 3600.
+   * 
+   * >
+   * > - 1. If Period is not specified, the default value is determined by the following rules:
+   * > - - Window range ≤ 1 hour: Period = 1.
+   * > - - Window range ≤ 1 day: Period = 60.
+   * > - - Window range ≤ 7 days: Period = 60.
+   * > - 2. When Period is set to 1, the window must be ≤ 1 day.
+   * 
    * @example
    * 1
    */
   period?: number;
   /**
+   * @remarks
+   * The start time of the query. Specify the time in the <i>YYYY-MM-DDThh:mmZ</i> format (UTC).
+   * 
+   * > Only metrics within the last 30 days can be queried.
+   * 
    * @example
    * 2026-06-01T00:00Z
    */

package/src/models/DescribeModelOperatorUsageResponseBody.ts

@@ -3,6 +3,10 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeModelOperatorUsageResponseBodyKeysSeriesValues extends $dara.Model {
+  /**
+   * @remarks
+   * The specific metric information, consisting of a timestamp and a metric value.
+   */
   point?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -30,20 +34,33 @@ export class DescribeModelOperatorUsageResponseBodyKeysSeriesValues extends $dar
 
 export class DescribeModelOperatorUsageResponseBodyKeysSeries extends $dara.Model {
   /**
+   * @remarks
+   * The API key ID. This value is returned only when GroupBy contains api_key.
+   * 
    * @example
    * 1
    */
   apiKeyId?: number;
   /**
+   * @remarks
+   * The model name when GroupBy contains model. The api_key_id string when GroupBy contains only api_key.
+   * 
    * @example
    * qwen3.6-plus
    */
   name?: string;
   /**
+   * @remarks
+   * The normalized GroupBy value: model, api_key, or model,api_key.
+   * 
    * @example
    * model
    */
   role?: string;
+  /**
+   * @remarks
+   * The list of metric values. Each value corresponds to a collection time point.
+   */
   values?: DescribeModelOperatorUsageResponseBodyKeysSeriesValues[];
   static names(): { [key: string]: string } {
     return {
@@ -77,12 +94,26 @@ export class DescribeModelOperatorUsageResponseBodyKeysSeries extends $dara.Mode
 
 export class DescribeModelOperatorUsageResponseBodyKeys extends $dara.Model {
   /**
+   * @remarks
+   * The metric name.
+   * 
    * @example
    * request_count
    */
   name?: string;
+  /**
+   * @remarks
+   * The collection of metric values.
+   */
   series?: DescribeModelOperatorUsageResponseBodyKeysSeries[];
   /**
+   * @remarks
+   * The unit. Valid values:
+   * 
+   * - requests
+   * - tokens
+   * - %
+   * 
    * @example
    * requests
    */
@@ -117,22 +148,38 @@ export class DescribeModelOperatorUsageResponseBodyKeys extends $dara.Model {
 
 export class DescribeModelOperatorUsageResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The end time of the query. The time is in the <i>YYYY-MM-DDThh:mmZ</i> format (UTC).
+   * 
    * @example
    * 2026-06-02T00:00Z
    */
   endTime?: string;
+  /**
+   * @remarks
+   * The list of metric values.
+   */
   keys?: DescribeModelOperatorUsageResponseBodyKeys[];
   /**
+   * @remarks
+   * The actual bucket size used, in seconds.
+   * 
    * @example
    * 1
    */
   period?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * ABB39CC3-4488-4857-905D-2E4A051D0521
    */
   requestId?: string;
   /**
+   * @remarks
+   * The start time of the query. The time is in the <i>YYYY-MM-DDThh:mmZ</i> format (UTC).
+   * 
    * @example
    * 2026-06-01T00:00Z
    */

package/src/models/DescribeModelOperatorUsageShrinkRequest.ts

@@ -3,25 +3,74 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeModelOperatorUsageShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The list of API key IDs. Separate multiple IDs with commas (,). If this parameter is not specified, all API key IDs under the instance ID are used by default.
+   * 
+   * > The list can contain up to 50 items.
+   */
   apiKeyIdsShrink?: string;
   /**
+   * @remarks
+   * The end time of the query. Specify the time in the <i>YYYY-MM-DDThh:mmZ</i> format (UTC).
+   * 
+   * > The end time must be later than the start time, and the interval between the start time and end time cannot exceed 7 days.
+   * 
    * @example
    * 2026-06-02T00:00Z
    */
   endTime?: string;
   /**
+   * @remarks
+   * The dimension by which to split the series. Separate multiple dimensions with commas (,). The order is not significant. Valid values:
+   * 
+   * - model (default): splits by model.
+   * - api_key: splits by API key.
+   * - model,api_key: splits by model and API key.
+   * 
    * @example
    * model
    */
   groupBy?: string;
+  /**
+   * @remarks
+   * The list of metrics. Separate multiple metrics with commas (,). Valid values:
+   * 
+   * - request_count: the number of requests.
+   * - success_count: the number of successful requests.
+   * - error_count: the number of failed requests.
+   * - success_rate: the request success rate.
+   * - input_token: the number of input tokens.
+   * - output_token: the number of output tokens.
+   * - total_token: the total number of tokens.
+   */
   keysShrink?: string;
+  /**
+   * @remarks
+   * The list of model names. Separate multiple names with commas (,).
+   */
   modelNamesShrink?: string;
   /**
+   * @remarks
+   * The time bucket size in seconds. Valid values: 1, 5, 15, 60, 300, and 3600.
+   * 
+   * >
+   * > - 1. If Period is not specified, the default value is determined by the following rules:
+   * > - - Window range ≤ 1 hour: Period = 1.
+   * > - - Window range ≤ 1 day: Period = 60.
+   * > - - Window range ≤ 7 days: Period = 60.
+   * > - 2. When Period is set to 1, the window must be ≤ 1 day.
+   * 
    * @example
    * 1
    */
   period?: number;
   /**
+   * @remarks
+   * The start time of the query. Specify the time in the <i>YYYY-MM-DDThh:mmZ</i> format (UTC).
+   * 
+   * > Only metrics within the last 30 days can be queried.
+   * 
    * @example
    * 2026-06-01T00:00Z
    */

package/src/models/DescribeModelServiceRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeModelServiceRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the instance.
+   * The instance ID.
    * 
-   * >  You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.
+   * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including the instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeModelServiceResponseBody.ts

@@ -42,7 +42,7 @@ export class DescribeModelServiceResponseBody extends $dara.Model {
   modelName?: string;
   /**
    * @remarks
-   * Model parameters.
+   * The model parameters.
    * 
    * @example
    * Not yet available.
@@ -58,7 +58,7 @@ export class DescribeModelServiceResponseBody extends $dara.Model {
   modelServiceId?: string;
   /**
    * @remarks
-   * The internal endpoint.
+   * The internal network connection string.
    * 
    * @example
    * http://ms-xxxxxxx.xxxx.rds.aliyuncs.com
@@ -66,7 +66,7 @@ export class DescribeModelServiceResponseBody extends $dara.Model {
   privateConnectUrl?: string;
   /**
    * @remarks
-   * The public endpoint.
+   * The public network connection string.
    * 
    * @example
    * http://ms-xxxxxxx-o.xxxx.rds.aliyuncs.com
@@ -74,7 +74,7 @@ export class DescribeModelServiceResponseBody extends $dara.Model {
   publicConnectUrl?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * ABB39CC3-4488-4857-905D-2E4A051D0521
@@ -82,7 +82,7 @@ export class DescribeModelServiceResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * A comma-separated list of IP addresses and CIDR blocks allowed to connect.
+   * The list of IP addresses in the IP whitelist, separated by commas.
    * 
    * @example
    * 127.0.0.1
@@ -90,7 +90,7 @@ export class DescribeModelServiceResponseBody extends $dara.Model {
   securityIpList?: string;
   /**
    * @remarks
-   * The status of the model service.
+   * The model service status.
    * 
    * @example
    * - deployming

package/src/models/DescribeTableRequest.ts

@@ -7,7 +7,7 @@ export class DescribeTableRequest extends $dara.Model {
    * @remarks
    * The instance ID.
    * 
-   * >  You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.
+   * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including instance IDs.
    * 
    * @example
    * gp-xxxxxxxxx
@@ -15,7 +15,7 @@ export class DescribeTableRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * The name of the database.
+   * The database name.
    * 
    * This parameter is required.
    * 
@@ -36,7 +36,7 @@ export class DescribeTableRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The name of the schema to which the table belongs.
+   * The name of the schema that contains the table.
    * 
    * This parameter is required.
    * 
@@ -46,9 +46,9 @@ export class DescribeTableRequest extends $dara.Model {
   schema?: string;
   /**
    * @remarks
-   * The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. You can call the CreateSecret operation to create an access credential.
+   * The access credential. Created by calling the CreateSecret operation.
    * 
-   * >  To call the DescribeTable operation as a Resource Access Management (RAM) user, the RAM user must have the permissions to call the UseSecret or GetSecretValue operation on the ARN of the access credential.
+   * > When you access this operation by using a RAM user, you must have the UseSecret or GetSecretValue permission on this SecretArn.
    * 
    * This parameter is required.
    * 
@@ -58,7 +58,7 @@ export class DescribeTableRequest extends $dara.Model {
   secretArn?: string;
   /**
    * @remarks
-   * The name of the table.
+   * The table name.
    * 
    * This parameter is required.
    * 
@@ -68,7 +68,7 @@ export class DescribeTableRequest extends $dara.Model {
   table?: string;
   /**
    * @remarks
-   * The ID of the workspace composed of multiple database instances. This parameter and the DBInstanceId parameter cannot both be empty. If both parameters are specified, this parameter takes precedence.
+   * The ID of the workspace that consists of multiple database instances. This parameter and DBInstanceId cannot both be empty. If both this parameter and DBInstanceId are specified, this parameter takes precedence.
    * 
    * @example
    * gp-ws-*****

package/src/models/DescribeTableResponseBody.ts

@@ -33,7 +33,7 @@ export class DescribeTableResponseBody extends $dara.Model {
   columnList?: DescribeTableResponseBodyColumnList;
   /**
    * @remarks
-   * The returned message.
+   * The detailed information returned by the operation.
    * 
    * @example
    * success
@@ -49,10 +49,9 @@ export class DescribeTableResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The status of the operation. Valid values:
-   * 
-   * *   **success**
-   * *   **fail**
+   * The execution status of the API operation. Valid values:
+   * - **success**: The execution was successful.
+   * - **fail**: The execution failed.
    * 
    * @example
    * success

package/src/models/ExecuteStatementRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class ExecuteStatementRequestRagWorkspaceCollection extends $dara.Model {
   /**
    * @remarks
-   * Collection name.  
+   * The collection name.
    * 
-   * > You can view the list by using the [ListCollections](https://help.aliyun.com/document_detail/2401503.html) API.
+   * > You can call the [ListCollections](https://help.aliyun.com/document_detail/2401503.html) operation to query the list.
    * 
    * @example
    * mycollection
@@ -15,9 +15,9 @@ export class ExecuteStatementRequestRagWorkspaceCollection extends $dara.Model {
   collection?: string;
   /**
    * @remarks
-   * Namespace.  
+   * The namespace.
    * 
-   * > You can view the list by using the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) API.
+   * > You can call the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation to query the list.
    * 
    * @example
    * mynamespace
@@ -51,7 +51,7 @@ export class ExecuteStatementRequest extends $dara.Model {
    * @remarks
    * The instance ID.
    * 
-   * >  You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.
+   * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including instance IDs.
    * 
    * @example
    * gp-xxxxxxxxx
@@ -59,7 +59,7 @@ export class ExecuteStatementRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * The name of the database.
+   * The database name.
    * 
    * This parameter is required.
    * 
@@ -70,13 +70,13 @@ export class ExecuteStatementRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The configuration parameters.
+   * The list of configuration parameters.
    */
   parameters?: any[];
   /**
    * @remarks
-   * Parameters for the vector dataset.  
-   * > When WorkspaceId is not empty, you must also pass this parameter.
+   * The vector dataset parameters.
+   * > If WorkspaceId is not empty, this parameter is required.
    */
   ragWorkspaceCollection?: ExecuteStatementRequestRagWorkspaceCollection;
   /**
@@ -91,10 +91,9 @@ export class ExecuteStatementRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The execution type. Valid values:
-   * 
-   * *   synchronous
-   * *   asynchronous (not supported)
+   * The run type. Valid values:
+   * - synchronous: synchronous execution.
+   * - asynchronous: asynchronous execution. Currently not supported.
    * 
    * @example
    * synchronous
@@ -102,9 +101,9 @@ export class ExecuteStatementRequest extends $dara.Model {
   runType?: string;
   /**
    * @remarks
-   * The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. You can call the CreateSecret operation to create an access credential.
+   * The access credential. Created by calling the CreateSecret operation.
    * 
-   * >  To call the ExecuteStatement operation as a Resource Access Management (RAM) user, the RAM user must have the permissions to call the UseSecret or GetSecretValue operation on the ARN of the access credential.
+   * > When you access this operation by using a RAM user, you must have the UseSecret or GetSecretValue permission on this SecretArn.
    * 
    * This parameter is required.
    * 
@@ -114,7 +113,7 @@ export class ExecuteStatementRequest extends $dara.Model {
   secretArn?: string;
   /**
    * @remarks
-   * The SQL statements that you want to execute.
+   * The SQL statement to execute.
    * 
    * @example
    * select * from table1
@@ -122,12 +121,12 @@ export class ExecuteStatementRequest extends $dara.Model {
   sql?: string;
   /**
    * @remarks
-   * The SQL statements.
+   * The list of multiple SQL statements.
    */
   sqls?: string[];
   /**
    * @remarks
-   * The name of the set of SQL statements that you want to execute. This parameter takes effect when the RunType parameter is set to asynchronous.
+   * The name of the execution statement. This parameter takes effect only when RunType is set to asynchronous.
    * 
    * @example
    * test
@@ -135,7 +134,7 @@ export class ExecuteStatementRequest extends $dara.Model {
   statementName?: string;
   /**
    * @remarks
-   * The ID of a workspace composed of multiple database instances. This parameter and DBInstanceId cannot both be empty. If both are specified, this parameter takes precedence.
+   * The ID of the workspace that consists of multiple database instances. This parameter and DBInstanceId cannot both be empty. If both this parameter and DBInstanceId are specified, this parameter takes precedence.
    * 
    * @example
    * gp-ws-*****

package/src/models/ExecuteStatementResponseBody.ts

@@ -87,7 +87,7 @@ export class ExecuteStatementResponseBodyData extends $dara.Model {
   records?: ExecuteStatementResponseBodyDataRecords;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of rows.
    * 
    * @example
    * 10
@@ -127,7 +127,7 @@ export class ExecuteStatementResponseBodyData extends $dara.Model {
 export class ExecuteStatementResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The time when the SQL statements were created.
+   * The creation time.
    * 
    * @example
    * 2023-12-04T10:08:47+0800
@@ -143,12 +143,12 @@ export class ExecuteStatementResponseBody extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * The returned results of the synchronous call.
+   * The result returned for synchronous calls.
    */
   data?: ExecuteStatementResponseBodyData;
   /**
    * @remarks
-   * The name of the database.
+   * The database name.
    * 
    * @example
    * adbtest
@@ -156,7 +156,7 @@ export class ExecuteStatementResponseBody extends $dara.Model {
   database?: string;
   /**
    * @remarks
-   * The ID of the job for asynchronously executing the SQL statements.
+   * The task ID for asynchronous SQL execution.
    * 
    * @example
    * ABB39CC3
@@ -164,7 +164,7 @@ export class ExecuteStatementResponseBody extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The returned message.
+   * The response message.
    * 
    * @example
    * success
@@ -180,7 +180,7 @@ export class ExecuteStatementResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The ARN of the access credential for the created Data API account.
+   * The access credential.
    * 
    * @example
    * acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ
@@ -188,10 +188,9 @@ export class ExecuteStatementResponseBody extends $dara.Model {
   secretArn?: string;
   /**
    * @remarks
-   * The status of the operation. Valid values:
-   * 
-   * *   **success**
-   * *   **fail**
+   * The execution status of the API operation. Valid values:
+   * - **success**: The execution is successful.
+   * - **fail**: The execution failed.
    * 
    * @example
    * success