@alicloud/gpdb20160503 3.5.0 → 3.7.0

package/src/models/ListWorkspacesRequest.ts

@@ -0,0 +1,80 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ListWorkspacesRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The maximum number of entries to return. Default value: 10.
+   * 
+   * @example
+   * 50
+   */
+  maxResults?: number;
+  /**
+   * @remarks
+   * The token for the next query.
+   * 
+   * @example
+   * caeba0bbb2be03f84eb48b699f0a****
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * The current page number.
+   * 
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of entries per page. Valid values:
+   * 
+   * - **20**
+   * - **50**
+   * - **100**
+   * 
+   * Default value: **20**.
+   * 
+   * @example
+   * 20
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The region ID of the workspace.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      maxResults: 'MaxResults',
+      nextToken: 'NextToken',
+      pageNumber: 'PageNumber',
+      pageSize: 'PageSize',
+      regionId: 'RegionId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      maxResults: 'number',
+      nextToken: 'string',
+      pageNumber: 'number',
+      pageSize: 'number',
+      regionId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ListWorkspacesResponse.ts

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

@@ -0,0 +1,412 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ListWorkspacesResponseBodyItemsApikeysAuthServices extends $dara.Model {
+  /**
+   * @remarks
+   * The service ID.
+   * 
+   * @example
+   * agdb-eqxwj5tj5ojx
+   */
+  serviceId?: string;
+  /**
+   * @remarks
+   * The service type. Valid values:
+   * 
+   * - memory
+   * - drama.
+   * 
+   * @example
+   * drama
+   */
+  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 ListWorkspacesResponseBodyItemsApikeys extends $dara.Model {
+  /**
+   * @remarks
+   * The services authorized for the API key.
+   */
+  authServices?: ListWorkspacesResponseBodyItemsApikeysAuthServices[];
+  /**
+   * @remarks
+   * The creation time of the API key.
+   * 
+   * @example
+   * 2026-03-09T02:26:48Z
+   */
+  createTime?: string;
+  /**
+   * @remarks
+   * The description.
+   * 
+   * @example
+   * my api key
+   */
+  description?: string;
+  /**
+   * @remarks
+   * The ID of the API key.
+   * 
+   * @example
+   * api-xxxx
+   */
+  keyId?: string;
+  /**
+   * @remarks
+   * The name of the API key.
+   * 
+   * @example
+   * my-apikey
+   */
+  keyName?: string;
+  /**
+   * @remarks
+   * The prefix of the API key.
+   * 
+   * @example
+   * sk-xxxxxx
+   */
+  keyPrefix?: string;
+  static names(): { [key: string]: string } {
+    return {
+      authServices: 'AuthServices',
+      createTime: 'CreateTime',
+      description: 'Description',
+      keyId: 'KeyId',
+      keyName: 'KeyName',
+      keyPrefix: 'KeyPrefix',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      authServices: { 'type': 'array', 'itemType': ListWorkspacesResponseBodyItemsApikeysAuthServices },
+      createTime: 'string',
+      description: 'string',
+      keyId: 'string',
+      keyName: 'string',
+      keyPrefix: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.authServices)) {
+      $dara.Model.validateArray(this.authServices);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListWorkspacesResponseBodyItemsServices extends $dara.Model {
+  /**
+   * @remarks
+   * The creation time.
+   * 
+   * @example
+   * 2026-03-09T02:26:48Z
+   */
+  createTime?: string;
+  /**
+   * @remarks
+   * The compute resource.
+   * 
+   * @example
+   * 1
+   */
+  cu?: string;
+  /**
+   * @remarks
+   * The expiration time.
+   * 
+   * @example
+   * 2026-01-26T16:00:00Z
+   */
+  expireTime?: string;
+  /**
+   * @remarks
+   * The billing type. Valid values:
+   * 
+   * - **POSTPAY**: pay-as-you-go.
+   * - **PREPAY**: subscription.
+   * 
+   * > - If this parameter is not specified, the default value is pay-as-you-go.
+   * > - In subscription billing mode, a discount is available when you purchase a duration of one year or longer. Select the billing type as needed.
+   * 
+   * @example
+   * POSTPAY
+   */
+  payType?: string;
+  /**
+   * @remarks
+   * [Deprecated].
+   * 
+   * @example
+   * deprecated
+   */
+  plan?: string;
+  /**
+   * @remarks
+   * The service ID.
+   * 
+   * @example
+   * agdb-xxxx
+   */
+  serviceId?: string;
+  /**
+   * @remarks
+   * The service name.
+   * 
+   * @example
+   * agdb-xxxx
+   */
+  serviceName?: string;
+  /**
+   * @remarks
+   * The service type. Valid values:
+   * 
+   * - memory
+   * - drama.
+   * 
+   * @example
+   * memory
+   */
+  serviceType?: string;
+  /**
+   * @remarks
+   * The service status. Valid values:
+   * 
+   * - creating: The service is being created.
+   * - active: The service is running.
+   * 
+   * @example
+   * active
+   */
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      createTime: 'CreateTime',
+      cu: 'Cu',
+      expireTime: 'ExpireTime',
+      payType: 'PayType',
+      plan: 'Plan',
+      serviceId: 'ServiceId',
+      serviceName: 'ServiceName',
+      serviceType: 'ServiceType',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      createTime: 'string',
+      cu: 'string',
+      expireTime: 'string',
+      payType: 'string',
+      plan: 'string',
+      serviceId: 'string',
+      serviceName: 'string',
+      serviceType: 'string',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListWorkspacesResponseBodyItems extends $dara.Model {
+  /**
+   * @remarks
+   * The list of API keys for the workspace.
+   */
+  apikeys?: ListWorkspacesResponseBodyItemsApikeys[];
+  /**
+   * @remarks
+   * The creation time.
+   * 
+   * @example
+   * 2021-10-09T04:54:08Z
+   */
+  createTime?: string;
+  /**
+   * @remarks
+   * The services in the workspace.
+   */
+  services?: ListWorkspacesResponseBodyItemsServices[];
+  /**
+   * @remarks
+   * The workspace ID.
+   * 
+   * @example
+   * gp-ws-wkb4fp3j9u79ha
+   */
+  workspaceId?: string;
+  /**
+   * @remarks
+   * The workspace name.
+   * - Maximum length: 50.
+   * - Must be unique.
+   * - Special characters are not allowed.
+   * 
+   * @example
+   * anchashid8FocugQ.oxs.xaliyun.com/oxspopscand8FocugQ#
+   */
+  workspaceName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      apikeys: 'Apikeys',
+      createTime: 'CreateTime',
+      services: 'Services',
+      workspaceId: 'WorkspaceId',
+      workspaceName: 'WorkspaceName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      apikeys: { 'type': 'array', 'itemType': ListWorkspacesResponseBodyItemsApikeys },
+      createTime: 'string',
+      services: { 'type': 'array', 'itemType': ListWorkspacesResponseBodyItemsServices },
+      workspaceId: 'string',
+      workspaceName: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.apikeys)) {
+      $dara.Model.validateArray(this.apikeys);
+    }
+    if(Array.isArray(this.services)) {
+      $dara.Model.validateArray(this.services);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListWorkspacesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of workspace details.
+   */
+  items?: ListWorkspacesResponseBodyItems[];
+  /**
+   * @remarks
+   * The maximum number of entries to return. Default value: 10.
+   * 
+   * @example
+   * 50
+   */
+  maxResults?: number;
+  /**
+   * @remarks
+   * The token for the next query.
+   * 
+   * @example
+   * caeba0bbb2be03f84eb48b699f0a****
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * The current page number.
+   * 
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of records on the current page.
+   * 
+   * @example
+   * 1
+   */
+  pageRecordCount?: number;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * ABB39CC3-4488-4857-905D-2E4A051D0521
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The total number of records.
+   * 
+   * @example
+   * 1
+   */
+  totalRecordCount?: number;
+  static names(): { [key: string]: string } {
+    return {
+      items: 'Items',
+      maxResults: 'MaxResults',
+      nextToken: 'NextToken',
+      pageNumber: 'PageNumber',
+      pageRecordCount: 'PageRecordCount',
+      requestId: 'RequestId',
+      totalRecordCount: 'TotalRecordCount',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      items: { 'type': 'array', 'itemType': ListWorkspacesResponseBodyItems },
+      maxResults: 'number',
+      nextToken: 'string',
+      pageNumber: 'number',
+      pageRecordCount: 'number',
+      requestId: 'string',
+      totalRecordCount: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.items)) {
+      $dara.Model.validateArray(this.items);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ModifyAiserviceSecurityIpsRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyAIServiceSecurityIpsRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the instance.
+   * 
+   * > To view details of all instances in a destination region, including their IDs, call the [DescribeDBInstances](https://help.aliyun.com/document_detail/196830.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +17,12 @@ export class ModifyAIServiceSecurityIpsRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
+   * A comma-separated list of IP addresses or CIDR blocks in the IP address whitelist group. You can specify up to 1000 entries. To block all external IP addresses, set this parameter to 127.0.0.1. Valid formats include the following:
+   * 
+   * - 10.23.12.24 (an IPv4 address)
+   * 
+   * - 10.23.12.24/24 (a CIDR block. The number after the slash indicates the prefix length and must be between 1 and 32.)
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +31,8 @@ export class ModifyAIServiceSecurityIpsRequest extends $dara.Model {
   securityIPList?: string;
   /**
    * @remarks
+   * The ID of the service.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,6 +41,8 @@ export class ModifyAIServiceSecurityIpsRequest extends $dara.Model {
   serviceId?: string;
   /**
    * @remarks
+   * The service type. Only drama is supported.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ModifyAiserviceSecurityIpsResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyAIServiceSecurityIpsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * ABB39CC3-4488-4857-905D-2E4A051D0521
    */

package/src/models/ModifyBackupPolicyRequest.ts

@@ -49,7 +49,7 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
    * This parameter is required.
    * 
    * @example
-   * Tuesday, Thursday, Saturday
+   * Tuesday,Thursday,Saturday
    */
   preferredBackupPeriod?: string;
   /**

package/src/models/ModifyCollectionRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyCollectionRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the collection.
+   * The collection name.
    * 
-   * >  You can call the [ListCollections](https://help.aliyun.com/document_detail/2401503.html) operation to query a list of collections.
+   * > You can call the [ListCollections](https://help.aliyun.com/document_detail/2401503.html) operation to list all collections.
    * 
    * This parameter is required.
    * 
@@ -19,7 +19,7 @@ export class ModifyCollectionRequest 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 details for all AnalyticDB for PostgreSQL instances in a region, including their instance IDs.
    * 
    * @example
    * gp-xxxxxxxxx
@@ -27,29 +27,29 @@ export class ModifyCollectionRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * The metadata of the addition or modification operation, which is in the JSON string format.
+   * A JSON string that specifies the operations to add or modify metadata fields. For the required format, see the example.
    * 
-   * You can specify this parameter to add a metadata definition, or rename an existing metadata definition and perform implicit type conversion.
+   * Use this parameter to add new metadata fields, rename existing metadata fields, or perform implicit data type conversion on existing fields.
    * 
-   * If you specify `operations[*].operator = add` to add a metadata definition, `operations[*].newMetaName` specifies the name of the metadata definition, and `operations[*].newMetaType` specifies the data type of the metadata definition.
+   * Details:
    * 
-   * If you specify `operations[*].operator = replace` to modify an existing metadata definition, `operations[*].oldMetaName` specifies the current name of the metadata definition, `operations[*].newMetaName` specifies the new name of the metadata definition, and `operations[*].newMetaType` specifies the new data type of the metadata definition. If you only want to rename the metadata definition, you do not need to specify the `operations[*].newMetaType` field. If you only want to perform implicit type conversion, you do not need to specify the `operations[*].newMetaName` field.
+   * To add a new metadata field, set `operations[*].operator = add`. Then, use `operations[*].newMetaName` to specify the field\\"s name, `operations[*].newMetaType` for its data type, and `operations[*].fullTextRetrieval` to enable full-text retrieval for it.
    * 
-   * > 
+   * To modify an existing metadata field, set `operations[*].operator = replace`. You must specify the current field name in `operations[*].oldMetaName`. To rename the field, provide the new name in `operations[*].newMetaName`. To change its data type, provide the new type in `operations[*].newMetaType`.
    * 
-   * *   For information about the supported data types, see [Data types](https://help.aliyun.com/document_detail/424383.html).
+   * > - For a list of supported data types, see [Data types](https://help.aliyun.com/document_detail/424383.html). The money data type is not supported.
+   * >
+   * > - Full-text retrieval can be enabled for a field only during an `add` operation, not a `replace` operation.
    * 
-   * *   The money data type is not supported.
+   * >Warning: 
    * 
-   * **
-   * 
-   * **Warning**Reserved fields such as id, vector, to_tsvector, and source cannot be used.
+   * The field names `id`, `vector`, `to_tsvector`, and `source` are reserved.
    * 
    * This parameter is required.
    * 
    * @example
    * {"operations":[
-   * {"operator":"add","newMetaType":"int","newMetaName":"ext1"},
+   * {"operator":"add","newMetaType":"int","newMetaName":"ext1","fullTextRetrieval":true},
    * {"operator":"replace","oldMetaName":"ext2","newMetaName":"ext3"},
    * {"operator":"replace","newMetaType":"bigint","oldMetaName":"ext4"},
    * {"operator":"replace","newMetaType":"int","oldMetaName":"ext5","newMetaName":"ext6"}
@@ -58,9 +58,9 @@ export class ModifyCollectionRequest extends $dara.Model {
   metadata?: string;
   /**
    * @remarks
-   * The name of the namespace. Default value: public.
+   * The namespace. The default value is `public`.
    * 
-   * >  You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.
+   * > You can call the CreateNamespace operation to create a namespace and the ListNamespaces operation to list existing namespaces.
    * 
    * @example
    * mynamespace
@@ -68,7 +68,7 @@ export class ModifyCollectionRequest extends $dara.Model {
   namespace?: string;
   /**
    * @remarks
-   * The password of the namespace.
+   * The password for the namespace.
    * 
    * This parameter is required.
    * 
@@ -89,7 +89,7 @@ export class ModifyCollectionRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and DBInstanceId parameters. If you specify both parameters, the WorkspaceId parameter takes precedence.
+   * The ID of the workspace that contains multiple database instances. You must specify either this parameter or `DBInstanceId`. If you specify both, this parameter takes precedence.
    * 
    * @example
    * gp-ws-*****