@alicloud/gpdb20160503 3.9.0 → 3.11.0

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

package/src/models/ExecuteStatementShrinkRequest.ts

@@ -7,7 +7,7 @@ export class ExecuteStatementShrinkRequest 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 ExecuteStatementShrinkRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * The name of the database.
+   * The database name.
    * 
    * This parameter is required.
    * 
@@ -26,13 +26,13 @@ export class ExecuteStatementShrinkRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The configuration parameters.
+   * The list of configuration parameters.
    */
   parametersShrink?: string;
   /**
    * @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.
    */
   ragWorkspaceCollectionShrink?: string;
   /**
@@ -47,10 +47,9 @@ export class ExecuteStatementShrinkRequest 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
@@ -58,9 +57,9 @@ export class ExecuteStatementShrinkRequest 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.
    * 
@@ -70,7 +69,7 @@ export class ExecuteStatementShrinkRequest extends $dara.Model {
   secretArn?: string;
   /**
    * @remarks
-   * The SQL statements that you want to execute.
+   * The SQL statement to execute.
    * 
    * @example
    * select * from table1
@@ -78,12 +77,12 @@ export class ExecuteStatementShrinkRequest extends $dara.Model {
   sql?: string;
   /**
    * @remarks
-   * The SQL statements.
+   * The list of multiple SQL statements.
    */
   sqlsShrink?: 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
@@ -91,7 +90,7 @@ export class ExecuteStatementShrinkRequest 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/GetAccountRequest.ts

@@ -5,7 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class GetAccountRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the database account.
+   * The name of the initial account. The name must meet the following requirements:
+   * 
+   * - The name can contain lowercase letters, digits, and underscores (_).
+   * - The name must start with a lowercase letter and end with a lowercase letter or digit.
+   * - The name cannot start with gp.
+   * - The name must be 2 to 16 characters in length.
    * 
    * This parameter is required.
    * 
@@ -16,8 +21,7 @@ export class GetAccountRequest extends $dara.Model {
   /**
    * @remarks
    * The instance ID.
-   * 
-   * >  You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.
+   * >You can specify up to 30 instance IDs for batch operations. Separate multiple instance IDs with commas (,).
    * 
    * This parameter is required.
    * 

package/src/models/GetAccountResponseBody.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class GetAccountResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The new description of the database account.
+   * The modified account description. The description must meet the following requirements:
    * 
-   * *   The description must start with a letter.
-   * *   The description cannot start with `http://` or `https://`.
-   * *   The description can contain letters, underscores (_), hyphens (-), and digits.
-   * *   The description must be 2 to 256 characters in length.
+   * - The description must start with a Chinese character or an English letter.
+   * - The description cannot start with `http://` or `https://`.
+   * - The description can contain Chinese characters, English characters, underscores (_), hyphens (-), and digits.
+   * - The description must be 2 to 256 characters in length.
    * 
    * @example
    * The instance used by this account to log in is DBInstanceId. The name used to log in is AccountName.
@@ -18,12 +18,12 @@ export class GetAccountResponseBody extends $dara.Model {
   accountDescription?: string;
   /**
    * @remarks
-   * The name of the initial account.
+   * The name of the initial account. The name must meet the following requirements:
    * 
-   * *   The name can contain lowercase letters, digits, and underscores (_).
-   * *   The name must start with a lowercase letter and end with a lowercase letter or a digit.
-   * *   The name cannot start with gp.
-   * *   The name must be 2 to 16 characters in length.
+   * - The name can contain lowercase letters, digits, and underscores (_).
+   * - The name must start with a lowercase letter and end with a lowercase letter or digit.
+   * - The name cannot start with gp.
+   * - The name must be 2 to 16 characters in length.
    * 
    * @example
    * testaccount
@@ -31,11 +31,11 @@ export class GetAccountResponseBody extends $dara.Model {
   accountName?: string;
   /**
    * @remarks
-   * The status of the member that you want to query.
+   * The status of the database account. Valid values:
    * 
-   * *   **enabled**: managed.
-   * *   **disabled**: not managed.
-   * *   **disabling**: being deleted.
+   * - **0**: Being created.
+   * - **1**: In use.
+   * - **3**: Being deleted.
    * 
    * @example
    * 1
@@ -43,8 +43,11 @@ export class GetAccountResponseBody extends $dara.Model {
   accountStatus?: string;
   /**
    * @remarks
-   * *   Normal: standard account
-   * *   Super: privileged account
+   * The type of the host account. Valid values:
+   * - **Normal**: standard account.
+   * - **Admin**: administrator account.
+   * 
+   * For more information about the permissions of host accounts, see [Host account permissions](https://help.aliyun.com/document_detail/176240.html).
    * 
    * @example
    * Normal
@@ -54,7 +57,7 @@ export class GetAccountResponseBody 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

package/src/models/GetApiKeyRequest.ts

@@ -0,0 +1,41 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetApiKeyRequest extends $dara.Model {
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * api-xxxxxx
+   */
+  keyId?: string;
+  /**
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      keyId: 'KeyId',
+      regionId: 'RegionId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      keyId: 'string',
+      regionId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/GetApiKeyResponse.ts

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

@@ -0,0 +1,113 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetApiKeyResponseBodyAuthServices extends $dara.Model {
+  /**
+   * @example
+   * agdb-2ze8x9278c9iizl
+   */
+  serviceId?: string;
+  /**
+   * @example
+   * memory
+   */
+  serviceType?: string;
+  static names(): { [key: string]: string } {
+    return {
+      serviceId: 'ServiceId',
+      serviceType: 'ServiceType',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      serviceId: 'string',
+      serviceType: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class GetApiKeyResponseBody extends $dara.Model {
+  /**
+   * @example
+   * sk-xxxxxxx
+   */
+  apiKey?: string;
+  authServices?: GetApiKeyResponseBodyAuthServices[];
+  /**
+   * @example
+   * 2019-09-08T16:00:00Z
+   */
+  createTime?: string;
+  /**
+   * @example
+   * test api key
+   */
+  description?: string;
+  /**
+   * @example
+   * api-xxxxxxx
+   */
+  keyId?: string;
+  /**
+   * @example
+   * test api key
+   */
+  keyName?: string;
+  /**
+   * @example
+   * sk-1235*****
+   */
+  keyPrefix?: string;
+  /**
+   * @example
+   * 7565770E-7C45-462D-BA4A-8A5396****
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      apiKey: 'ApiKey',
+      authServices: 'AuthServices',
+      createTime: 'CreateTime',
+      description: 'Description',
+      keyId: 'KeyId',
+      keyName: 'KeyName',
+      keyPrefix: 'KeyPrefix',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      apiKey: 'string',
+      authServices: { 'type': 'array', 'itemType': GetApiKeyResponseBodyAuthServices },
+      createTime: 'string',
+      description: 'string',
+      keyId: 'string',
+      keyName: 'string',
+      keyPrefix: 'string',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.authServices)) {
+      $dara.Model.validateArray(this.authServices);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+