# Alibaba Cloud AnalyticDB for PostgreSQL API

> Alibaba Cloud AnalyticDB for PostgreSQL API on Apizie: 302 endpoints (Adds AI nodes to the cluster, Allocates a public endpoint for an AnalyticDB for PostgreSQL instance, Binds a resource group to a database role, Cancels an index creation task, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-gpdb`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/gpdb
- Page: https://zieapi.vercel.app/api/cloud/aliyun-gpdb
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-gpdb/openapi.json

Alibaba Cloud OpenAPI for AnalyticDB for PostgreSQL (gpdb, version 2016-05-03). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds AI nodes to the cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/add-ainode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID |
| AINodePoolId | string | no | The ID of the resource pool to which the AI node belongs |
| AINodeSpecInfos | string | yes | The AI node specifications (JSON-encoded) |

### Allocates a public endpoint for an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/allocate-instance-public-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the details of all… |
| ConnectionStringPrefix | string | yes | The prefix of the endpoint. Specify a prefix for the endpoint. Example: `gp-bp12ga6v69h86****`. In this example, the endpoint is… |
| Port | string | yes | The port number. Example: 5432 |
| AddressType | string | no | The network type of the endpoint. Valid values: primary: primary endpoint cluster: instance endpoint. This value is supported only for an… |

### Binds a resource group to a database role
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/bind-dbresource-group-with-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| ResourceGroupName | string | yes | The name of the resource group |
| RoleList | string | yes | The roles (JSON-encoded) |

### Cancels an index creation task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/cancel-create-index-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/86912.html operation to query available region IDs |
| DBInstanceId | string | no | The instance ID. You can call the https://help.aliyun.com/document_detail/196830.html operation to query the details of all instances in… |
| WorkspaceId | string | no | The ID of the workspace that consists of multiple database instances. This parameter and the DBInstanceId parameter cannot be both empty.… |
| Namespace | string | yes | The namespace. You can call the https://help.aliyun.com/document_detail/2401495.html operation to create a namespace, or call the… |
| NamespacePassword | string | yes | The password for the namespace. This value is specified when you call the CreateNamespace operation |
| Collection | string | yes | The collection name. You can call the https://help.aliyun.com/document_detail/2401503.html operation to view the collection list |
| JobId | string | yes | The ID of the index creation task, which is returned by the CreateIndex operation |

### Cancels an asynchronous document upload task by job ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/cancel-upload-document-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the instance for which the vector engine optimization feature is enabled. You can call the… |
| Namespace | string | no | The namespace. Default value: public. You can call the CreateNamespace operation to create a namespace and call the ListNamespaces… |
| Collection | string | yes | The name of the document collection. The document collection is created by calling the… |
| RegionId | string | yes | The region ID of the instance |
| NamespacePassword | string | yes | The password of the namespace. This value is specified when you call the CreateNamespace operation |
| JobId | string | yes | The ID of the document upload task. You can obtain the task ID from the response of the UploadDocumentAsync operation |

### Cancels an asynchronous vector data upload job by using a job ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/cancel-upsert-collection-data-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | no | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| Namespace | string | no | The name of the namespace. Default value: public. You can call the CreateNamespace operation to create a namespace and call the… |
| Collection | string | yes | The name of the collection. You can call the https://help.aliyun.com/document_detail/2401503.html operation to query a list of collections |
| RegionId | string | yes | The region ID of the instance |
| NamespacePassword | string | yes | The password of the namespace. The value of this parameter is specified when you call the CreateNamespace operation |
| JobId | string | yes | The ID of the vector data upload job. You can call the `UpsertCollectionDataAsync` operation to query the job ID |
| WorkspaceId | string | no | The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and… |

### Provides intelligent Q&A services by combining knowledge bases with large models
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/chat-with-knowledge-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/196830.html operation to query the details of all instances in… |
| RegionId | string | yes | The region ID of the instance |
| KnowledgeParams | string | no | The knowledge retrieval parameter object. If not specified, only chat is performed (JSON-encoded) |
| PromptParams | string | no | The system prompt template, which must include {{ text_chunks }}, {{ user_system_prompt }}, {{ graph_entities }}, and {{ graph_relations… |
| ModelParams | string | yes | The large language model (LLM) invocation parameter object (JSON-encoded) |
| IncludeKnowledgeBaseResults | string | no | Specifies whether to return the recall results. Default value: false |

### Provides AI chat services by combining knowledge bases and large language models. This streaming API can be…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/chat-with-knowledge-base-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html API operation to view the instance IDs of all… |
| RegionId | string | yes | The region ID of the instance |
| KnowledgeParams | string | no | The knowledge retrieval parameters. If this parameter is not specified, only the chat feature is used (JSON-encoded) |
| PromptParams | string | no | The system prompt template. It must include {{ text_chunks }}, {{ user_system_prompt }}, {{ graph_entities }}, and {{ graph_relations }}.… |
| ModelParams | string | yes | The call parameters for the large language model (LLM) (JSON-encoded) |
| IncludeKnowledgeBaseResults | string | no | Specifies whether to return the recall results. Default value: false |

### Checks the configurations of a Hadoop data source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/check-hadoop-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/86912.html operation to query the most recent region list |
| DBInstanceId | string | yes | The instance ID |
| DataSourceId | string | yes | The data source ID |
| CheckDir | string | yes | The Hadoop path that you want to check |

### Checks the network connectivity of a Hadoop external data source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/check-hadoop-net-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | Region ID |
| DBInstanceId | string | yes | Instance ID |
| EmrInstanceId | string | no | EMR instance ID |
| DataSourceId | string | no | Either DataSourceId or EmrInstanceId must be specified as input, otherwise an error will occur. If both of the above parameters are… |

### Check the network connectivity of the JDBC connection string
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/check-jdbcsource-net-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The ID of the region where the instance is located |
| DBInstanceId | string | yes | Instance ID |
| JdbcConnectionString | string | no | JDBC connection string |
| DataSourceId | string | no | Either DataSourceId or JdbcConnectionString must be specified as input, otherwise an error will occur. If both parameters are specified,… |

### Checks the available update versions for a SaaS service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/check-saas-service-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| ServiceId | string | yes | The service ID |

### Checks whether a service-linked role is created
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/check-service-linked-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The ID of the region. You can call the https://help.aliyun.com/document_detail/86912.html operation to query the most recent region list |

### Restores data to a new AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/clone-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the new instance. You can call the https://help.aliyun.com/document_detail/196830.html operation to query the information about… |
| SrcDbInstanceName | string | yes | The ID of the source instance. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information… |
| BackupId | string | yes | The ID of the backup set. You can call the https://help.aliyun.com/document_detail/210093.html operation to query the IDs of all backup… |

### Creates an AI service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-aiservice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the details of all AnalyticDB for… |
| Type | string | yes | The service type. Currently, only drama is supported |
| ServiceAccount | string | yes | The service account. The following limits apply: The account name can contain lowercase letters, digits, and underscores (_). The account… |
| ServiceAccountPassword | string | yes | The password of the service account. The following limits apply: The password must contain at least three of the following character… |
| Description | string | no | The description |
| SecurityIPList | string | no | The list of IP addresses in IP address whitelist group. You can specify up to 1,000 IP addresses, separated by commas (,). The value… |

### Creates an initial account for an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the details of all… |
| DatabaseName | string | no | The name of the database |
| AccountName | string | yes | The name of the initial account. The name can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase… |
| AccountPassword | string | yes | The password of the initial account. The password must contain at least three of the following character types: uppercase letters,… |
| AccountDescription | string | no | The description of the initial account |
| AccountType | string | no | The type of the initial account. Default value: Super, which specifies a privileged account. To create a standard account, set the value… |

### Creates an API key
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-api-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| WorkspaceId | string | yes | The workspace ID |
| KeyName | string | yes | The name of the API key |
| Description | string | no | The description |
| ServiceIds | string | no | The list of service IDs to authorize (JSON-encoded) |

### Creates a backup set
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-backup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |

### Creates a Supabase project branch
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-branch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. This parameter is required when you create a primary branch. When you create a child branch, the region is inherited from… |
| ProjectId | string | yes | The ID of the Supabase project that corresponds to the primary branch |
| ParentBranchId | string | yes | The ID of the parent branch. This parameter specifies the parent branch for the new branch or query condition |
| BranchName | string | yes | The branch name |
| Description | string | no | The description of the branch |
| Tag | string | no | The list of branch tags (JSON-encoded) |
| InitSource | string | no | The initialization source of the branch. Valid values: ParentData: copies the schema and data from the parent branch. This is the default… |
| ParentTimestamp | string | no | The point in time for data synchronization when creating a branch from the parent branch. The value is in the ISO 8601 UTC format. Default… |
| ParentLsn | string | no | The log sequence number (LSN) selected when creating a branch from the parent branch |
| Protected | string | no | Specifies whether to enable branch protection. Valid values: true: Enables branch protection. false: Disables branch protection. This is… |
| ExpiresAt | string | no | The time when the branch automatically expires and is deleted. The value is in the ISO 8601 UTC format |
| ClientToken | string | no | The client idempotency token. This token ensures the idempotence of retry requests |

### Creates a vector dataset
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | no | Instance ID of the instance. You can call the https://help.aliyun.com/document_detail/86911.html operation to query instance IDs of all… |
| ManagerAccount | string | yes | The name of the administrator account that has the rds_superuser permission. You can call the… |
| ManagerAccountPassword | string | yes | The password of the administrator account |
| Namespace | string | no | The namespace. You can call the https://help.aliyun.com/document_detail/2401495.html operation to create a namespace, and call the… |
| Collection | string | yes | The name of the collection to be created. The name must comply with the PostgreSQL object naming conventions |
| Dimension | integer | no | The vector dimensions. If you specify this value, an index is built, and the length of Rows.Vector in the subsequent… |
| FullTextRetrievalFields | string | no | The fields used to retrieve data via full-text index. Separate multiple fields with commas (,). The fields must be keys defined in Metadata |
| Metadata | string | yes | The metadata of the vector data, which is a JSON string in MAP format. The key represents the field name, and the value represents the… |
| Parser | string | no | The tokenizer used to retrieve data via full-text index. Default value: zh_cn |
| RegionId | string | yes | The region ID of the instance |
| Metrics | string | no | The distance metric used to build the vector index. Valid values: l2: Euclidean distance. ip: Inner product. cosine: Cosine similarity |
| HnswM | integer | no | The maximum number of neighbors in the HNSW algorithm. The operation automatically sets this value based on the vector dimensions.… |
| HnswEfConstruction | string | no | The size of the candidate set when building the index by using the HNSW algorithm. The value must be greater than or equal to 2 × HNSW_M.… |
| PqEnable | integer | no | Specifies whether to enable the Product Quantization (PQ) algorithm to accelerate the index. Enable this feature when the data volume… |
| ExternalStorage | integer | no | Specifies whether to use mmap to build the HNSW index. Default value: 0. If the data does not need to be deleted and you have high… |
| WorkspaceId | string | no | The ID of the workspace that consists of multiple database instances. This parameter and the DBInstanceId parameter cannot be empty at the… |
| MetadataIndices | string | no | The scalar index fields. Separate multiple fields with commas (,). The fields must be keys defined in Metadata |
| SupportSparse | string | no | Specifies whether to support sparse vectors. Default value: false |
| SparseVectorIndexConfig | string | no | The sparse vector index configuration. If this parameter is passed, a sparse vector index is created (JSON-encoded) |
| VectorIndexConfig | string | no | The dense vector index configuration (JSON-encoded) |
| Algorithm | string | no | The vector index algorithm. Valid values: hnswflat: HNSW index without quantization compression (default). novam: Graph index without… |

### Creates an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/86912.html operation to query available region IDs |
| ZoneId | string | yes | The zone ID. You can call the https://help.aliyun.com/document_detail/86912.html operation to query available zone IDs |
| EngineVersion | string | yes | The database engine version. Valid values: 6.0: version 6.0. 7.0: version 7.0 |
| Engine | string | yes | The database engine. Set the value to gpdb |
| DBInstanceClass | string | no | The instance specifications. For more information, see the supplementary description of the DBInstanceClass parameter. This parameter is… |
| DBInstanceGroupCount | string | no | The number of compute groups. Valid values: 2, 4, 8, 12, 16, 24, 32, 64, 96, and 128. This parameter is required when you create a storage… |
| DBInstanceDescription | string | no | The description of the instance |
| SecurityIPList | string | no | The IP address whitelist. A value of 127.0.0.1 indicates that no external IP addresses are allowed to access the instance. After the… |
| PayType | string | no | The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription. If you do not specify this parameter, the default value… |
| Period | string | no | The unit of the subscription duration. Valid values: Month: month. Year: year. This parameter is required when you create a subscription… |
| UsedTime | string | no | The subscription duration. Valid values: If Period is set to Month, valid values are 1 to 9. If Period is set to Year, valid values are 1… |
| ClientToken | string | no | The client token used for idempotence checks. For more information, see https://help.aliyun.com/document_detail/327176.html |
| InstanceNetworkType | string | no | The network type of the instance. Set the value to VPC. Only VPC is supported on the public cloud. If you do not specify this parameter,… |
| VPCId | string | no | The VPC ID. VPCId is required. The VPC must be in the same region as the value specified by RegionId |
| VSwitchId | string | no | The vSwitch ID. vSwitchId is required. The vSwitch must be in the same zone as the value specified by ZoneId |
| PrivateIpAddress | string | no | [Deprecated] This parameter is deprecated. You do not need to specify this parameter |
| SegStorageType | string | no | The cloud disk storage type. Currently, only ESSD cloud disks are supported. Set the value to cloud_essd. This parameter is required when… |
| SegDiskPerformanceLevel | string | no | The performance level (PL) of the ESSD cloud disk. Valid values: pl0: PL0. pl1: PL1. pl2: PL2. This parameter takes effect only when the… |
| InstanceSpec | string | no | The node specifications of compute nodes. Valid values for storage elastic mode (high-availability edition): 2C16G 4C32G 16C128G Valid… |
| SegNodeNum | string | no | The number of compute nodes. Valid values: Storage elastic mode (high-availability edition): 4 to 512. The value must be a multiple of 4.… |
| MasterNodeNum | string | no | [Deprecated] This parameter is deprecated. You do not need to specify this parameter |
| DBInstanceMode | string | yes | The resource type of the instance. Valid values: StorageElastic: storage elastic mode. Serverless: Serverless mode. ServerlessPro:… |
| StorageType | string | no | [Deprecated] This parameter is deprecated. You do not need to specify this parameter |
| DBInstanceCategory | string | no | The instance edition. Valid values: HighAvailability: high-availability edition. Basic: basic edition. This parameter is required when you… |
| ResourceGroupId | string | no | The ID of the enterprise resource group to which the instance belongs |
| StorageSize | integer | no | The storage capacity. Unit: GB. Valid values: 50 to 8000 50 to 6000 . This parameter is required when you create a storage elastic mode… |
| CreateSampleData | string | no | Specifies whether to load a sample dataset after the instance is created. Valid values: true: Load a sample dataset. false: Do not load a… |
| Tag | string | no | The Nth tag. Valid values of N: 1 to 20 (JSON-encoded) |
| ServerlessResource | integer | no | The compute resource threshold. Valid values: 16 to 1024. The step size is 8. Unit: ACU. This parameter is required only for Serverless… |
| IdleTime | integer | no | The idle release wait time. The instance transitions to an idle state after no service traffic is detected for the specified duration.… |
| ServerlessMode | string | no | The mode of the Serverless instance. Valid values: Manual: manual scheduling. This is the default value. Auto: automatic scheduling. This… |
| EncryptionType | string | no | The encryption type. Valid values: NULL: Encryption is not enabled. This is the default value. CloudDisk: Cloud disk encryption is… |
| EncryptionKey | string | no | The encryption key ID. If the EncryptionType parameter is set to CloudDisk, specify the encryption key ID in the same region. Otherwise,… |
| VectorConfigurationStatus | string | no | Specifies whether to enable vector engine optimization. Valid values: enabled: Enable vector engine optimization. disabled (default): Do… |
| MasterCU | integer | no | The master resources. Valid values: 2 CU 4 CU 8 CU 16 CU 32 CU Master resources above 8 CU incur additional fees |
| SrcDbInstanceName | string | no | The ID of the source instance to clone. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the details… |
| BackupId | string | no | The backup set ID. You can call the https://help.aliyun.com/document_detail/210093.html operation to query the backup set IDs of all… |
| EnableSSL | string | no | Indicates whether to enable Secure Sockets Layer (SSL) encryption. Valid values: true: Enable SSL encryption. false (default): Do not… |
| ProdType | string | no | The product type. Valid values: standard: Standard Edition. cost-effective: Economy Edition. If you do not specify this parameter, the… |
| DeployMode | string | no | The deployment mode. Valid values: multiple: multi-zone deployment. single: single-zone deployment. If you do not specify this parameter,… |
| StandbyZoneId | string | no | The secondary zone ID. This parameter is required only for multi-zone deployment. You can call the… |
| StandbyVSwitchId | string | no | The vSwitch ID in the secondary zone. This parameter is required only for multi-zone deployment. The vSwitch must be in the same zone as… |
| MasterAISpec | string | no | Specify this parameter if you want to change the master node to a MasterAI node. This parameter and MasterCU cannot be specified at the… |
| AINodeSpecInfos | string | no | The AI node specifications information (JSON-encoded) |
| CacheStorageSize | string | no | The Serverless cache storage size. Valid values: 800 to 102400. The step size is 32 GB. Unit: GB |

### Adds an IP whitelist group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-dbinstance-iparray` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| IPArrayName | string | yes | The name of the IP whitelist group |
| IPArrayAttribute | string | no | The attribute of the IP whitelist group |
| SecurityIPList | string | yes | The IP addresses in the IP whitelist group. A maximum of 1,000 IP addresses or CIDR blocks are allowed (JSON-encoded) |

### Creates a plan for an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-dbinstance-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the IDs of all AnalyticDB for… |
| PlanName | string | yes | The name of the plan |
| PlanDesc | string | no | The description of the plan |
| PlanType | string | yes | The type of the plan. Valid values: PauseResume: pauses and resumes an instance. Resize: changes the number of compute nodes. ModifySpec:… |
| PlanScheduleType | string | yes | The execution mode of the plan. Valid values: Postpone: The plan is executed later. Regular: The plan is executed periodically |
| PlanStartDate | string | no | The start time of the plan. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. This… |
| PlanEndDate | string | no | The end time of the plan. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The end… |
| PlanConfig | string | yes | The execution information of the plan. Specify the parameter in the JSON format. The parameter value varies based on the values of… |

### Creates a resource group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-dbresource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| ResourceGroupName | string | yes | The name of the resource group |
| ResourceGroupConfig | string | yes | The configurations of the resource group. CpuRateLimit: the percentage of CPU resources that are available for the resource group. Unit:… |

### Creates a database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| DatabaseName | string | yes | The name of the database. Only contains letters, digits, and underscores (_). Must start with a letter. Up to 63 characters in length |
| CharacterSetName | string | no | The character set. For more information about the value range, see Document [https://www.postgresql.org/docs/current/multibyte.html](url).… |
| Collate | string | no | Database locale parameter (specifies string comparison/sorting rules). The locale must be compatible with the character set specified by… |
| Ctype | string | no | Database locale parameter (defines character classification/case conversion rules). The locale must be compatible with the character set… |
| Owner | string | yes | The owner of the table. Only contains lowercase letters, digits, and underscores (_). Must start with a lowercase letter and end with a… |
| Description | string | no | The description of the database. Must start with a letter. Cannot start with http:// or https://. Only contains letters, underscores (_),… |

### Creates a knowledge base
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-document-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the details of all AnalyticDB for… |
| ManagerAccount | string | yes | The name of the management account that has the rds_superuser permission. You can create an account in the console by navigating to… |
| ManagerAccountPassword | string | yes | The password of the management account |
| Namespace | string | no | The namespace. Default value: public. You can create a namespace by calling the https://help.aliyun.com/document_detail/2401495.html… |
| Collection | string | yes | The name of the knowledge base to create. The name must comply with PostgreSQL object naming conventions |
| RegionId | string | yes | The region ID of the instance |
| EmbeddingModel | string | no | The embedding model. Default value: text-embedding-v3. Supported models: text-embedding-v3 (recommended, default): 1024, 768, or 512… |
| Dimension | integer | no | The vector dimensions. The default value is the dimension supported by the embedding model |
| FullTextRetrievalFields | string | no | The fields used for full-text retrieval. Separate multiple fields with commas (,). The fields must be keys defined in Metadata |
| Metadata | string | no | The metadata of vector data, in the format of a JSON string representing a MAP. The key represents the field name, and the value… |
| Parser | string | no | The tokenizer used for full-text retrieval. Default value: zh_cn |
| Metrics | string | no | The distance metric used for building vector indexes. Valid values: l2: Euclidean distance. ip: inner product distance. cosine (default):… |
| HnswM | integer | no | The maximum number of neighbors in the HNSW algorithm. This value is automatically set based on the vector dimensions. Manual… |
| HnswEfConstruction | string | no | The candidate set size when building an index with the HNSW algorithm. The value must be >= 2*HNSW_M. Valid values: AnalyticDB for… |
| PqEnable | integer | no | Specifies whether to enable Product Quantization (PQ) algorithm acceleration for the index. We recommend enabling this feature when the… |
| ExternalStorage | integer | no | Specifies whether to use mmap to build the HNSW index. Default value: 0. If data does not need to be deleted and you require high upload… |
| MetadataIndices | string | no | The scalar index fields. Separate multiple fields with commas (,). The fields must be keys defined in Metadata |
| EnableGraph | string | no | Specifies whether to enable knowledge graph construction. Default value: false. Before using this parameter, upgrade the instance to a… |
| LLMModel | string | no | The LLM model name. Valid values: knowledge-extract-standard: default value. knowledge-extract-mini This parameter takes effect only when… |
| Language | string | no | The language used for knowledge graph construction. Valid values: Simplified Chinese: Simplified Chinese. Default value. English: English.… |
| EntityTypes | string | no | The list of entity types. This parameter is required when knowledge graph construction is enabled (JSON-encoded) |
| RelationshipTypes | string | no | The list of relationship edge types. This parameter is required when knowledge graph construction is enabled (JSON-encoded) |
| SupportSparse | string | no | Specifies whether to support sparse vectors. Default value: false |
| SparseVectorIndexConfig | string | no | The sparse vector index configuration. If specified, a sparse vector index is created (JSON-encoded) |
| SparseRetrievalFields | string | no | The metadata fields used for building sparse vectors. Separate multiple fields with commas (,). The fields must be keys defined in Metadata |
| Algorithm | string | no | The vector index algorithm. Valid values: hnswflat: HNSW index without quantization compression (default). novam: graph index without… |
| VectorIndexConfig | string | no | The dense vector index configuration (JSON-encoded) |

### Installs extensions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-extensions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/86912.html operation to query the most recent region list |
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the IDs of all AnalyticDB for… |
| Extensions | string | yes | The name of the extension that you want to install. Separate multiple extension names with commas (,) |
| DBNames | string | yes | The name of the database |

### Create External Data Service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-external-data-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | Region ID, you can view available region IDs through the https://help.aliyun.com/document_detail/86912.html interface |
| ServiceName | string | yes | Service name |
| DBInstanceId | string | yes | Instance ID |
| ServiceSpec | string | yes | Service specification (in CU), value: 8 |
| ServiceDescription | string | no | Service description |

### Create Hadoop data source configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-hadoop-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | Region ID. You can call the https://help.aliyun.com/document_detail/86912.html interface to view available region IDs |
| DataSourceName | string | no | Service name |
| DataSourceDescription | string | no | Service description |
| DataSourceType | string | no | Type of Hadoop external table to be enabled, with values: HDFS Hive |
| HadoopCreateType | string | no | External service type: emr hadoop: Self-built Hadoop |
| HadoopHostsAddress | string | no | Address and hostname of the Hadoop cluster's source node in the /etc/hosts file |
| HadoopCoreConf | string | no | Content string of the Hadoop core-site.xml file |
| HDFSConf | string | no | Content string of the Hadoop hdfs-site.xml file. This field is required when enabling an HDFS external table |
| HiveConf | string | no | Content string of the Hadoop hive-site.xml file. This field is required when enabling a HIVE external table |
| YarnConf | string | no | Content string of the Hadoop yarn-site.xml file. This field is required when enabling an HDFS external table |
| DBInstanceId | string | yes | Instance ID |
| MapReduceConf | string | no | Content string of the Hadoop mapred-site.xml file. This field is required when enabling an HDFS external table |
| EmrInstanceId | string | no | When HadoopCreateType=Emr, this field should contain the EMR instance ID |

### Creates an index. Usage notes: Only scalar indexes are supported. Write operations on the table are…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID of the instance |
| DBInstanceId | string | no | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the IDs of all AnalyticDB for… |
| WorkspaceId | string | no | The ID of the workspace that consists of multiple database instances. This parameter and DBInstanceId cannot both be empty. If both this… |
| Namespace | string | yes | The namespace. You can call the https://help.aliyun.com/document_detail/2401502.html operation to query the list |
| NamespacePassword | string | yes | The password of the namespace. This value is specified by the CreateNamespace operation |
| Collection | string | yes | The collection name. You can call the https://help.aliyun.com/document_detail/2401503.html operation to query the list |
| IndexName | string | no | The index name |
| IndexField | string | no | The index field. Only a single field is supported, and the field must be a key defined in Metadata |
| IndexConfig | string | no | The index parameters. If this parameter is not specified, a B-tree index is created by default. b-tree: The fillFactor parameter. Valid… |

### Creates a JDBC data source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-jdbcdata-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID of the instance |
| DataSourceName | string | no | The name of data soruce |
| DataSourceDescription | string | no | Data source description |
| DataSourceType | string | no | The type of the data source |
| DBInstanceId | string | yes | The instance ID |
| JDBCConnectionString | string | no | The JDBC connection string |
| JDBCUserName | string | no | The name of the database account |
| JDBCPassword | string | no | The password of the database account |

### Creates a model creation operator API key
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-model-operator-api-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Description | string | yes | The description. Spaces are not allowed, and the value cannot exceed 256 characters |

### Creates a model service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-model-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the IDs of all AnalyticDB for… |
| ModelName | string | yes | The model name |
| Description | string | no | The description |
| SecurityIPList | string | no | The IP whitelist. The value 127.0.0.1 indicates that no external IP addresses are allowed to access the instance. After the instance is… |
| AiNodes | string | yes | The list of AI nodes used for model deployment (JSON-encoded) |
| ModelParams | string | no | The model parameters. This parameter is not supported (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group to which the instance belongs. For information about how to obtain the resource group ID, see… |
| ClientToken | string | no | The idempotency check. For more information, see https://help.aliyun.com/document_detail/327176.html |
| Replicas | integer | no | The number of model service replicas |
| InferenceEngine | string | no | The inference engine. Currently, only vllm is supported |
| EnablePublicConnection | string | no | Specifies whether to enable public network access |

### Creates a namespace for vector data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-namespace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | no | The instance ID. You can call the https://help.aliyun.com/document_detail/196830.html operation to view the details of all instances in… |
| ManagerAccount | string | yes | The name of the administrator account that has the rds_superuser permission. You can create an account in the console by navigating to… |
| ManagerAccountPassword | string | yes | The password of the administrator account |
| Namespace | string | no | The name of the namespace to create, which is used for tenant isolation (the backend performs automatic creation of a user account with… |
| NamespacePassword | string | yes | The password for the namespace |
| RegionId | string | yes | The region ID of the instance |
| WorkspaceId | string | no | The ID of the workspace that consists of multiple database instances. This parameter and the DBInstanceId parameter cannot be left empty… |

### Create Homogeneous Data Source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-remote-adbdata-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| LocalDBInstanceId | string | yes | Instance ID of the data being used (required) |
| LocalDatabase | string | yes | Database name of the data being used (required) |
| RemoteDBInstanceId | string | yes | Instance ID providing the data (required) |
| RemoteDatabase | string | yes | Database name providing the data (required) |
| UserName | string | yes | Account name of the data-providing instance used for user mapping (required) |
| UserPassword | string | yes | Password of the data-providing instance account used for user mapping |
| ManagerUserName | string | yes | Management account of the data-using instance |
| ManagerUserPassword | string | yes | Password of the management account of the data-using instance |
| DataSourceName | string | no | Customer-specified DataSourceName |

### Creates a SaaS service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-saas-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID of the instance |
| WorkspaceId | string | yes | The workspace of the SaaS service |
| ServiceType | string | yes | The service type. Valid values: memroy drama |
| PayType | string | no | The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription. If you leave this parameter empty, a Free type is… |
| UsedTime | string | no | The duration for which you want to purchase the resource. Valid values: If Period is set to Month, the valid values are 1 to 11. If Period… |
| Period | string | no | The unit of the duration for which you want to purchase the resource. Valid values: Month: month. Year: year. This parameter is required… |
| Cu | integer | no | The compute resources of the SaaS service |
| Plan | string | no | Deprecated |

### Creates a sample dataset for an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-sample-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/2361776.html operation to query the IDs of all AnalyticDB… |

### Creates a credential for accessing an instance by using a username and password
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | no | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the details of all AnalyticDB for… |
| WorkspaceId | string | no | The ID of the workspace that consists of multiple database instances. This parameter and the DBInstanceId parameter cannot be left empty… |
| RegionId | string | yes | The region ID of the instance |
| Username | string | yes | The username for database access. Limits: The username can contain lowercase letters, digits, and underscores (_), and must start with a… |
| Password | string | yes | The password for database access |
| Description | string | no | The description of the credential. The description can be up to 255 characters in length |
| SecretName | string | no | The name of the credential. The name can contain letters, digits, and underscores (_), and must be 1 to 16 characters in length. If this… |
| TestConnection | string | no | Specifies whether to test the instance connection by using the username and password |

### Creates a service-linked role
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-service-linked-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The ID of the region |

### Creates a snapshot for a Supabase project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. Specifies the region in which to perform the operation |
| ProjectId | string | yes | The Supabase project ID |
| SnapshotTimestamp | string | no | The point in time for the snapshot. You must specify either this parameter or Lsn. If this parameter is specified, the snapshot is created… |
| Lsn | string | no | The LSN for the snapshot. You must specify either this parameter or SnapshotTimestamp. If this parameter is specified, the snapshot is… |
| ClientToken | string | no | The idempotence token. Ensures that repeated requests do not result in duplicate operations |

### Create External Data Source Configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-streaming-data-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/86912.html operation to query the most recent list of regions |
| ServiceName | string | yes | The name of the service |
| DBInstanceId | string | yes | The instance ID |
| ServiceSpec | string | yes | The specifications of the service |
| ServiceDescription | string | no | The description of the service |

### Creates a real-time data source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-streaming-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | Region ID. You can view available region IDs through the https://help.aliyun.com/document_detail/86912.html interface |
| DataSourceName | string | yes | Data source name |
| DataSourceType | string | yes | Data source type. Values: kafka |
| DataSourceDescription | string | no | Data source description |
| DBInstanceId | string | yes | Instance ID |
| DataSourceConfig | string | yes | Data source configuration information |
| ServiceId | integer | yes | Real-time data service ID |

### Create External Data Source Configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-streaming-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | Region ID. You can call the https://help.aliyun.com/document_detail/86912.html API to view available region IDs |
| DBInstanceId | string | yes | Instance ID |
| DataSourceId | string | yes | Data source ID |
| JobDescription | string | no | Job description |
| JobName | string | yes | Job name |
| Mode | string | no | Configuration mode Basic mode requires specifying some configuration fields Professional mode supports submitting a YAML file |
| SrcColumns | string | no | Source data field list (JSON-encoded) |
| DestColumns | string | no | Target data table mapping field list (JSON-encoded) |
| Account | string | no | Target database account |
| Password | string | no | Target database password |
| DestDatabase | string | no | Target database name |
| DestSchema | string | no | Target namespace |
| DestTable | string | no | Target table name |
| WriteMode | string | no | Write mode |
| TryRun | string | no | Whether to test the real-time task, values: true false Default value: false |
| JobConfig | string | no | Job configuration file, required for professional mode |
| GroupName | string | no | Kafka group name |
| FallbackOffset | string | no | FallbackOffset, fallback offset The FallbackOffset parameter defines the behavior when the consumer does not request a specific offset or… |
| MatchColumns | string | no | Match columns, usually all primary key columns of the target table. If all column values in this configuration are the same, the two rows… |
| UpdateColumns | string | no | Update columns, usually all non-primary key columns of the target table. When data is determined to be duplicate through MatchColumns,… |
| ErrorLimitCount | integer | no | When data in Kafka does not match the ADBPG target table, it will cause a write failure. This value is the number of error rows allowed;… |
| Consistency | string | no | Delivery guarantee |

### Creates a backup job for a specified Supabase instance and returns the backup job ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-supabase-backup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/86912.html operation to query available region IDs |
| ProjectId | string | yes | Instance ID of the Supabase instance. You can obtain instance ID on the Supabase page in the console |

### Creates a Supabase project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-supabase-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| ProjectName | string | yes | The name of the Supabase project. Naming rules: The name must be 1 to 128 characters in length. The name can contain only letters, digits,… |
| ZoneId | string | yes | The zone ID. The zone of the vSwitch specified by VSwitchId must be the same as the value of this parameter |
| AccountPassword | string | yes | The initial account password. Password rules: The password must be 8 to 32 characters in length. The password must contain at least three… |
| SecurityIPList | string | yes | The IP address whitelist. Separate multiple IP addresses or CIDR blocks with commas (,). If you do not specify this parameter, the default… |
| VpcId | string | yes | The ID of the virtual private cloud (VPC). This parameter is required |
| VSwitchId | string | yes | The vSwitch ID. This parameter is required. The zone of the vSwitch must be the same as the value of ZoneId |
| ProjectSpec | string | yes | The specifications of the Supabase project. The free billing method uses the free specifications. For paid billing methods, the… |
| StorageSize | integer | no | The storage capacity. Unit: GB. If you do not specify this parameter for a non-free billing method, the default value is 1 |
| DiskPerformanceLevel | string | no | The performance level of the cloud disk. If you do not specify this parameter, the default value is PL0. Valid values: PL0 PL1 PL2 PL3 |
| ClientToken | string | no | The client token. It is used to ensure idempotence and prevent duplicate requests from executing the same operation |
| PayType | string | no | The billing method. If you do not specify this parameter, the default value is Free. Valid values: Free: the free billing method.… |
| UsedTime | string | no | The subscription duration of the resource. This parameter takes effect only when PayType is set to Prepaid. If you do not specify this… |
| Period | string | no | The unit of the subscription duration. This parameter takes effect only when PayType is set to Prepaid. If you do not specify this… |
| AutoScale | string | no | Specifies whether to enable auto-start and auto-stop. If you do not specify this parameter, the default value is false |
| EngineVersion | string | no | The DPI engine version. If you do not specify this parameter, the default value is PG15. PostgreSQL 17 and later versions support the data… |
| Tags | string | no | The list of tags (JSON-encoded) |
| Lightweight | string | no | Specifies whether the project is the lightweight edition |
| CreateOptions | string | no | The optional creation parameters. The default value is empty |
| BackupId | string | no | The backup set ID. You can call https://help.aliyun.com/document_detail/3064623.html to view the IDs of all backup sets under the target… |
| SrcProjectId | string | no | The ID of the Supabase project to which the backup set belongs |

### Creates an index for a vector collection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-vector-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the details of all AnalyticDB for… |
| Collection | string | yes | The collection name. You can call the https://help.aliyun.com/document_detail/2401503.html operation to query the list |
| Dimension | integer | no | The vector dimensions. This parameter is required for dense vectors. The value must be the same as the length of the vector data… |
| ManagerAccount | string | yes | The name of the management account that has the rds_superuser permission. You can create an account in the console by navigating to… |
| ManagerAccountPassword | string | yes | The password of the management account |
| Metrics | string | no | The distance metric used to build the vector index. Valid values: l2: Euclidean distance. ip: inner product. cosine: cosine similarity.… |
| Namespace | string | no | The namespace. Default value: public. You can call the https://help.aliyun.com/document_detail/2401502.html operation to query the list |
| RegionId | string | yes | The region ID of the instance |
| PqEnable | integer | no | Specifies whether to enable product quantization (PQ) algorithm acceleration for the index. We recommend that you enable this feature when… |
| HnswM | integer | no | The maximum number of neighbors in the HNSW algorithm. The operation automatically sets this value based on the vector dimensions. You do… |
| HnswEfConstruction | integer | no | The size of the candidate set when the HNSW algorithm builds the index. Valid values: 4 to 1000. Default value: 64. This parameter is… |
| ExternalStorage | integer | no | Specifies whether to use mmap to build the HNSW index. Default value: 0. If data does not need to be deleted and you have high… |
| Type | string | no | The vector type. Valid values: Dense: dense vector (default). Sparse: sparse vector |
| Algorithm | string | no | The vector index algorithm. Valid values: hnswflat: HNSW index without quantization compression (default). novam: graph index without… |
| Nlist | integer | no | The number of lists (partitions) for Novad. Valid values: 2 to 1073741824. Default value: 256 |
| RabitqBits | integer | no | The number of bits for RaBitQ compression. Valid values: 1 to 8. Default value: 3 |

### Creates a SaaS workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/create-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| WorkspaceName | string | yes | The workspace name |
| RegionId | string | no | The region ID. Currently, only four units are supported |

### Delete AI Node
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-ainode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| AINodePoolId | string | no | The ID of the AINode resource pool |
| AINodeNum | integer | yes | The number of AINodes to be deleted |
| NodeNames | string | no | The list of AINodes to be deleted (JSON-encoded) |

### Deletes an AI service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-aiservice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the details of all AnalyticDB for… |
| Type | string | yes | The service type. Currently, only drama is supported |
| ServiceId | string | yes | The service ID |

### Deletes a database account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |
| AccountName | string | yes | The name of the database account. The privileged account cannot be deleted |

### Deletes an API key
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-api-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| KeyId | string | yes | API KEY ID |
| RegionId | string | no | The region ID |

### Deletes a backup set. You can call this operation to delete only physical backup sets that are manually…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-backup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| BackupId | string | yes | The backup set ID. You can call the https://help.aliyun.com/document_detail/210093.html operation to query the IDs of all backup sets in… |

### Deletes a Supabase branch
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-branch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. This parameter is required when you create a primary branch. When you create a child branch, the region is inherited from… |
| BranchId | string | yes | The branch ID, which uniquely identifies a Supabase branch |

### Deletes chunks from a document collection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-chunks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. Call the https://help.aliyun.com/document_detail/86911.html operation to view details for all AnalyticDB for PostgreSQL… |
| RegionId | string | yes | The region ID of the instance |
| Namespace | string | no | The name of the namespace. The default value is public. Call the https://help.aliyun.com/document_detail/2401502.html operation to view a… |
| NamespacePassword | string | yes | The password for the namespace. This password is set when you call the https://help.aliyun.com/document_detail/2401495.html operation |
| Collection | string | yes | The name of the document collection. You create this document collection by calling the… |
| ChunkIds | string | yes | A list of chunk IDs (JSON-encoded) |

### Deletes a vector collection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | no | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| Namespace | string | no | The name of the namespace. You can call the https://help.aliyun.com/document_detail/2401502.html operation to query a list of namespaces |
| NamespacePassword | string | yes | The password of the namespace |
| Collection | string | yes | The name of the collection |
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/86912.html operation to query the most recent… |
| WorkspaceId | string | no | The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and… |

### Deletes a vector dataset
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-collection-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | no | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to view the IDs of all AnalyticDB for… |
| Namespace | string | no | The namespace. Default value: public. You can call the https://help.aliyun.com/document_detail/2401502.html operation to view the list |
| Collection | string | yes | The collection name. You can call the https://help.aliyun.com/document_detail/2401503.html operation to view the list |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/86912.html operation to view the available region IDs |
| NamespacePassword | string | yes | The password for the namespace |
| CollectionData | string | no | The data fields and values to delete. The value is a JSON string in dictionary format, where the key is the field name and the value is a… |
| CollectionDataFilter | string | no | The filter condition for the data to delete. The format is SQL WHERE syntax |
| WorkspaceId | string | no | The ID of the workspace that consists of multiple database instances. This parameter and the DBInstanceId parameter cannot be empty at the… |

### Releases a pay-as-you-go AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceGroupId | string | no | This parameter is no longer used |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. For more information, see… |
| DBInstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the details of all… |

### Deletes an IP whitelist group from an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-dbinstance-iparray` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| IPArrayName | string | yes | The name of the IP whitelist group |

### Deletes a plan from an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-dbinstance-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PlanId | string | yes | The ID of the plan. You can call the https://help.aliyun.com/document_detail/449398.html operation to query the details of plans,… |
| DBInstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the details of all… |

### Deletes a resource group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-dbresource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/196830.html operation to query the information about all… |
| ResourceGroupName | string | yes | The name of the resource group |

### Deletes a database from an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the IDs of all AnalyticDB for… |
| DatabaseName | string | yes | The name of the queried database |

### Delete Document
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | Instance ID. You can call the https://help.aliyun.com/document_detail/86911.html API to view details of all AnalyticDB PostgreSQL… |
| Namespace | string | no | The name of the namespace. Default value: public. You can call the https://help.aliyun.com/document_detail/2401495.html operation to… |
| Collection | string | yes | Document collection name. Created by the https://help.aliyun.com/document_detail/2618448.html API. You can use the… |
| RegionId | string | yes | Region ID where the instance is located |
| NamespacePassword | string | yes | Password for the namespace. This value is specified in the https://help.aliyun.com/document_detail/2401495.html API |
| FileName | string | yes | File name. The name of an uploaded file. You can query the list of files using the https://help.aliyun.com/document_detail/2618453.html API |

### Delete Knowledge Base
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-document-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | Instance ID. You can call the https://help.aliyun.com/document_detail/86911.html API to view details of all AnalyticDB PostgreSQL… |
| Namespace | string | no | The name of the namespace. Default value: public. You can call the https://help.aliyun.com/document_detail/2401495.html operation to… |
| Collection | string | yes | The name of the document collection to be deleted |
| RegionId | string | yes | The ID of the region where the instance is located |
| NamespacePassword | string | yes | Password for the namespace. This value is specified by the https://help.aliyun.com/document_detail/2401495.html API |

### Uninstalls extensions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-extension` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID of the instance |
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the IDs of all AnalyticDB for… |
| Extension | string | yes | The name of the extension |
| DBNames | string | yes | The name of the database |

### Delete External Data Service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-external-data-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | Region ID. You can call the https://help.aliyun.com/document_detail/86912.html API to view available region IDs |
| ServiceId | string | yes | Service ID |
| DBInstanceId | string | yes | Instance ID |

### Delete a Hadoop external data source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-hadoop-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. You can invoke the https://help.aliyun.com/document_detail/86912.html API to view available region IDs |
| DBInstanceId | string | yes | The instance ID |
| DataSourceId | string | yes | The service ID |

### Deletes an index
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/86912.html operation to query the available region… |
| DBInstanceId | string | no | The cluster ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| WorkspaceId | string | no | The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. This parameter and DBInstanceId cannot both be… |
| Namespace | string | yes | The namespace name. You can call the https://help.aliyun.com/document_detail/2401502.html operation to query a list of namespaces |
| NamespacePassword | string | yes | The password of the namespace. The value of this parameter is specified when you call the… |
| Collection | string | yes | The name of the collection. You can call the https://help.aliyun.com/document_detail/2401503.html operation to query a list of collections |
| IndexName | string | yes | The name of the Elasticsearch index |

### Delete JDBC data source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-jdbcdata-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | Region ID. You can call the https://help.aliyun.com/document_detail/86912.html interface to view available region IDs |
| DBInstanceId | string | yes | Instance ID |
| DataSourceId | string | yes | Data source ID |

### Delete Model Service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-model-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID |
| ModelServiceId | string | yes | The ID of the model service to be deleted |

### Deletes a namespace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-namespace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | no | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| ManagerAccount | string | yes | The name of the manager account that has the rds_superuser permission. You can create an account on the Account Management page of the… |
| ManagerAccountPassword | string | yes | The password of the manager account |
| Namespace | string | yes | The name of the namespace. You can call the https://help.aliyun.com/document_detail/2401502.html operation to query a list of namespaces |
| RegionId | string | yes | The region ID of the instance |
| WorkspaceId | string | no | The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and… |

### Deletes a private RAG service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-private-ragservice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |

### Deletes a remote AnalyticDB data source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-remote-adbdata-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| LocalDBInstanceId | string | yes | The ID of the instance that uses the data provided by another instance |
| DataSourceId | string | yes | The service ID |

### Deletes a SaaS service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-saas-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| ServiceId | string | yes | The service ID |

### Deletes the access credentials of an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | no | The instance ID. You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances… |
| WorkspaceId | string | no | The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and… |
| RegionId | string | yes | The region ID of the instance |
| SecretArn | string | no | The Alibaba Cloud Resource Name (ARN) of the access credential for the created Data API account. Format:… |
| SecretName | string | no | The name of the access credential. You must specify one of the SecretArn and SecretName parameters |

### Deletes a snapshot of a Supabase project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. Specifies the region in which to query or perform the operation |
| ProjectId | string | yes | The Supabase project ID |
| Lsn | string | yes | The LSN of the snapshot to delete |

### Delete a real-time data service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-streaming-data-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID of the instance |
| ServiceId | string | yes | The service ID |
| DBInstanceId | string | yes | The instance ID |

### Delete a real-time data source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-streaming-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. You can invoke the https://help.aliyun.com/document_detail/86912.html API to view available region IDs |
| DBInstanceId | string | yes | The instance ID |
| DataSourceId | integer | yes | The data source ID |

### Delete a real-time data synchronization task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-streaming-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. You can invoke the https://help.aliyun.com/document_detail/86912.html API to view available region IDs |
| JobId | integer | yes | The job ID |
| DBInstanceId | string | yes | The instance ID |

### Deletes a Supabase project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-supabase-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID |
| ProjectId | string | yes | The Supabase project ID. You can go to the Supabase page in the AnalyticDB for PostgreSQL console to obtain the workspace ID |

### Deletes a vector index
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-vector-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to view the details of all AnalyticDB for… |
| Collection | string | yes | The collection name. You can call the https://help.aliyun.com/document_detail/2401503.html operation to view the list |
| ManagerAccount | string | yes | The name of the management account that has the rds_superuser permission. You can create an account on the Accounts page in the console or… |
| ManagerAccountPassword | string | yes | The password of the management account |
| Namespace | string | no | The namespace. Default value: public. You can call the https://help.aliyun.com/document_detail/2401502.html operation to view the list |
| RegionId | string | yes | The region ID of the instance |
| Type | string | no | The vector type. Valid values: Dense: dense vector. This is the default value. Sparse: sparse vector |

### Deletes a SaaS workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/delete-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID of the instance |
| WorkspaceId | string | yes | The workspace ID |

### Deploy a private RAG service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/deploy-private-ragservice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| ZoneId | string | yes | The zone ID. You can call the https://help.aliyun.com/document_detail/86912.html operation to query the available regions and zones |
| VSwitchId | string | yes | The vSwitch ID. The zone where the vSwitch resides must be the same as the zone that is specified by ZoneId |

### Retrieves the details of an AI service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-aiservice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/196830.html operation to query the details of all instances in a… |
| Type | string | yes | The service type. Currently, only drama is supported |
| ServiceId | string | yes | The service ID |

### Queries the information about database accounts for an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| AccountName | string | no | The name of the database account |
| AccountType | string | no | The type of the database account that you want to query. Valid values: Super, Normal, and All. Default value: Super. If you set this… |

### Queries active SQL records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-active-sqlrecords` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| Database | string | no | The name of the database |
| User | string | no | The name of the database account |
| StartTime | string | no | The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC |
| EndTime | string | no | The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The end time must be later than the start time |
| Keyword | string | no | The keyword used to filter queries |
| MinDuration | string | no | The minimum amount of time consumed by traces. Unit: milliseconds |
| MaxDuration | string | no | The maxmum amount of time consumed by traces. Unit: milliseconds |
| Order | string | no | The field used to sort lock diagnostics records and the sorting order. Default value: `{"Field":"StartTime","Type":"Desc"}`, which… |

### Gets the purchasable resources for AnalyticDB for PostgreSQL
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-available-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region ID. Call the https://help.aliyun.com/document_detail/86912.html API to query available region IDs |
| ZoneId | string | yes | The availability zone ID. Call the https://help.aliyun.com/document_detail/86912.html API to query available zone IDs |
| ChargeType | string | no | The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription |

### Queries the information about a backup job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-backup-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| BackupJobId | integer | yes | The backup job ID |

### Queries the backup policy of an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the details of all… |

### Queries the details of a Supabase branch
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-branch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region ID. This parameter is required when you create a primary branch. When you create a child branch, the region of the primary… |
| BranchId | string | yes | The branch ID, which uniquely identifies a Supabase branch |

### Queries vector dataset information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | no | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the details of all AnalyticDB for… |
| Namespace | string | no | The namespace. You can call the https://help.aliyun.com/document_detail/2401502.html operation to query the list |
| NamespacePassword | string | yes | The password for the namespace |
| Collection | string | yes | The collection name. You can call the https://help.aliyun.com/document_detail/2401503.html operation to query the list |
| RegionId | string | yes | The region ID of the instance |
| WorkspaceId | string | no | The ID of the workspace that consists of multiple database instances. This parameter and the DBInstanceId parameter cannot be left empty… |

### Queries the information about an index creation job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-create-index-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID of the cluster. You can call the https://help.aliyun.com/document_detail/86912.html operation to query the available region… |
| DBInstanceId | string | no | The cluster ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| WorkspaceId | string | no | The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. You must specify one of the WorkspaceId and… |
| Namespace | string | yes | The namespace name. You can call the https://help.aliyun.com/document_detail/2401502.html operation to query a list of namespaces |
| NamespacePassword | string | yes | The password for the namespace. The value of this parameter is specified by the https://help.aliyun.com/document_detail/2401495.html… |
| Collection | string | yes | The name of the collection. You can call the https://help.aliyun.com/document_detail/2401503.html operation to query a list of collections |
| JobId | string | yes | The ID of the index creation job, which is returned from the `CreateIndex` operation |

### Queries a list of nodes in an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbcluster-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query details about all AnalyticDB for… |
| NodeType | string | no | The node type. Valid values: master: coordinator node. segment: compute node. If you do not specify this parameter, the information about… |

### View the Performance Monitoring of an AnalyticDB for PostgreSQL instance over a specified time period.
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbcluster-performance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query details about all AnalyticDB for… |
| Key | string | yes | The performance metric that you want to query. Separate multiple values with commas (,). For more information, see… |
| StartTime | string | yes | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDTHH:mmZ` format. You can query… |
| EndTime | string | yes | The end of the time range to query. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDTHH:mmZ` format. The end time must be… |
| Nodes | string | no | The nodes for which you want to query performance metrics. Separate multiple values with commas (,). Example:… |
| NodeType | string | no | The node type. Valid values: master: coordinator node. segment: compute node. If you do not specify this parameter, the performance… |
| ResourceGroupName | string | no | The name of the resource group |

### Queries the details of an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbinstance-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceGroupId | string | no | This parameter is deprecated. You do not need to specify this parameter |
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the instance IDs of all AnalyticDB… |

### Queries the information about data bloat for an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbinstance-data-bloat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the details of all… |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 30 50 100 Default value: 30 |
| PageNumber | integer | no | The number of the page to return. The value must be an integer that is greater than 0. Default value: 1 |
| Database | string | no | The name of the database |
| OrderBy | string | no | The sorting order |

### Queries the information about data skew for an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbinstance-data-skew` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the details of all… |
| PageSize | integer | no | The number of entries per page. Valid values: 30 50 100 Default value: 30 |
| PageNumber | integer | no | The number of the page to return. The value must be an integer that is greater than 0. Default value: 1 |
| Database | string | no | The name of the database |
| OrderBy | string | no | order by condition |

### Queries the information about nodes in an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbinstance-diagnosis-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query details about all AnalyticDB for… |
| PageSize | integer | no | The number of entries per page. Valid values: 20 50 100 Default value: 20 |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| StartStatus | string | no | The running state of the node. Valid values: UP: The node is running. DOWN: The node is faulty. If you do not specify this parameter, the… |
| SyncMode | string | no | The data synchronization state of the node. Valid values: synced: The node data is synchronized. notSyncing: The node data is not… |
| RolePreferd | string | no | The role state of the node. It specifies whether a primary/secondary switchover occurs. Valid values: normal: The node role is normal. No… |

### Queries the error logs of an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbinstance-error-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| PageSize | integer | no | The number of entries per page. Valid values: 20 50 100 Default value: 20 |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC |
| EndTime | string | no | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.… |
| LogLevel | string | no | The level of the logs to query. Valid values: ALL: queries all error logs. PANIC: queries only abnormal logs. FATAL: queries only critical… |
| User | string | no | The username |
| Database | string | no | The name of the database |
| Host | string | no | This parameter is not supported in Alibaba Cloud public cloud |
| Keywords | string | no | One or more keywords that are used to query error logs |

### Queries the whitelists of IP addresses that are allowed to access an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbinstance-iparray-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceGroupId | string | no | The ID of the resource group to which the instance belongs. For information about how to obtain the ID of a resource group, see… |
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query details about all AnalyticDB for… |
| DBInstanceIPArrayName | string | no | The name of the IP address whitelist. If you do not specify this parameter, the default whitelist is queried. Each instance supports up to… |

### Queries the index usage of an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbinstance-index-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| PageSize | integer | no | The number of entries per page. Valid values: 30 50 100 Default value: 30 |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| Database | string | no | The name of the database |
| OrderBy | string | no | order by search condition |

### Queries the connection information of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbinstance-net-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| ConnectionString | string | no | The endpoint that is used to connect to the instance. If you do not specify this parameter, the information about all endpoints of the… |

### Queries the information about performance metrics of an AnalyticDB for PostgreSQL instance within a time range
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbinstance-performance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceGroupId | string | no | This parameter is no longer used |
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the IDs of all AnalyticDB for… |
| Key | string | yes | The performance metric. Separate multiple values with commas (,). For more information, see… |
| StartTime | string | yes | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC |
| EndTime | string | yes | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.… |

### Queries the information about plans for an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbinstance-plans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| PlanDesc | string | no | The description of the plan |
| PlanType | string | no | The type of the plan. Valid values: PauseResume: pauses and resumes an instance. Resize: scales an instance. ModifySpec: changes compute… |
| PlanScheduleType | string | no | The execution mode of the plan. Valid values: Postpone: The plan is executed later. Regular: The plan is executed periodically |
| PlanId | string | no | The plan ID. You can call the https://help.aliyun.com/document_detail/449398.html operation to query the information about plans,… |
| PlanCreateDate | string | no | The time that is used to filter plans. If you specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format, the plans that… |

### Queries the SSL information about an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbinstance-ssl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the instance |

### Queries the maximum throughput of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbinstance-support-max-performance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |

### Lists AnalyticDB for PostgreSQL instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbinstances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/86912.html operation to query the available region… |
| DBInstanceDescription | string | no | The instance description |
| InstanceNetworkType | string | no | The instance network type. Valid values: VPC: VPC Classic: classic network If you omit this parameter, the operation returns instances of… |
| DBInstanceIds | string | no | The instance IDs. Separate multiple IDs with commas (,) |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 30 50 100 Default value: 30 |
| PageNumber | integer | no | The page number. The value must be an integer that is greater than 0. Default value: 1 |
| Tag | string | no | The tags of the instance (JSON-encoded) |
| InstanceDeployTypes | string | no | This parameter is deprecated. Do not specify this parameter (JSON-encoded) |
| DBInstanceStatuses | string | no | The state of the instance (JSON-encoded) |
| DBInstanceCategories | string | no | The instance edition. You can specify multiple editions. Separate multiple editions with a comma (,) (JSON-encoded) |
| DBInstanceModes | string | no | The resource type of the instance. You can specify multiple resource types. Separate multiple resource types with a comma (,) (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group to which the instance belongs |
| VpcId | string | no | The VPC ID. You can specify this parameter to query instances in a VPC |

### Retrieves the details of one or more resource groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbresource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the instance IDs of all AnalyticDB… |
| ResourceGroupName | string | no | The name of the resource group. If this parameter is omitted, details for all resource groups are returned. Otherwise, only details for… |

### Queries the resource management mode of an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbresource-management-mode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |

### Queries the kernel update version information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbversion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID |

### Queries the information about minor versions of AnalyticDB for PostgreSQL instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-dbversion-infos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceGroupId | string | no | The ID of the resource group to which the instance belongs. For information about how to obtain the ID of a resource group, see… |
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/86912.html operation to query the most recent… |
| DBInstanceMode | string | no | The resource type of the instance. Valid values: StorageElastic: elastic storage mode. Serverless: Serverless mode |
| DBVersion | string | no | The minor version number that does not include the prefix |

### Queries a list of backup sets of full backup or point-in-time backup for an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-data-backups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| BackupId | string | no | The ID of the backup set. If you specify BackupId, the details of the backup set are returned. You can call the… |
| StartTime | string | no | The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC |
| EndTime | string | no | The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mmZ format. The… |
| PageSize | integer | no | The number of entries per page. Valid values: 30 50 100 Default value: 30 |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| DataType | string | no | The backup type. Valid values: DATA: full backup. RESTOREPOI: point-in-time recovery backup. If you do not specify this parameter, the… |
| BackupMode | string | no | The backup mode. Valid values: Automated Manual If you do not specify this parameter, all backup sets are returned |
| BackupStatus | string | no | The state of the backup set. Valid values: Success Failed If you do not specify this parameter, all backup sets are returned |

### Queries the data redistribution information about an AnalyticDB for PostgreSQL V6.0 instance in elastic…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-data-re-distribute-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the IDs of all AnalyticDB for… |

### Queries the status of data sharing for AnalyticDB for PostgreSQL instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-data-share-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceGroupId | string | no | The ID of the resource group to which the instance belongs. For information about how to obtain the ID of a resource group, see… |
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/86912.html operation to query the most recent… |
| SearchValue | string | no | The keyword used to filter instances, which can be an instance ID or instance description. You can call the… |
| PageSize | integer | no | The number of entries per page. Valid values: 30 50 100 Default value: 30 |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |

### Queries the performance metrics of data sharing
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-data-share-performance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceGroupId | string | no | This parameter is deprecated |
| Key | string | yes | The name of the performance metric. To specify multiple metrics, separate the metric names with a comma (,). Valid values:… |
| StartTime | string | no | The start of the time range to query. The time must be in UTC and in the yyyy-MM-ddTHH:mmZ format |
| EndTime | string | no | The end of the time range to query. The time must be later than the start time, in UTC, and in the y*\**dTHH:mm*Z format |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/86912.html operation to query the available region IDs |

### Describes the basic information about an AnalyticDB for PostgreSQL database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The cluster ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| DatabaseName | string | yes | The name of the database that you want to query |

### Queries all databases and database accounts of an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-diagnosis-dimensions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |

### Queries the details of query execution on an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-diagnosis-monitor-performance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the details of all… |
| StartTime | string | no | The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC |
| EndTime | string | no | The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. The end time must be later… |
| User | string | no | The name of the database account |
| Database | string | yes | The name of the database |
| QueryCondition | string | no | The filter condition on queries. Specify the value in the JSON format. Valid values: `{"Type":"maxCost", "Value":"100"}`: filters the top… |

### Queries the information about SQL queries for an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-diagnosis-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the information about all… |
| PageSize | integer | no | The number of entries per page. Valid values: 30 50 100 Default value: 30 |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC |
| EndTime | string | no | The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. The end time must be later… |
| User | string | no | The name of the database account |
| Database | string | yes | The name of the database |
| QueryCondition | string | no | The filter condition on queries. Specify the value in the JSON format. Valid values: `{"Type":"maxCost", "Value":"100"}`: filters the top… |
| Keyword | string | no | The keyword of the SQL statement |
| Order | string | no | The order of fields in the console. You do not need to specify this parameter |

### Queries the information about a query for an AnalyticDB for PostgreSQL instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-diagnosis-sqlinfo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query details about all AnalyticDB for… |
| QueryID | string | yes | The query ID. It is a unique identifier of the query. You can call the https://help.aliyun.com/document_detail/450511.html operation to… |
| Database | string | yes | The name of the database |

### Retrieves the details of a document
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/describe-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DBInstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/86911.html operation to query the details of all AnalyticDB for… |
| Namespace | string | no | The namespace. Default value: public. You can call the https://help.aliyun.com/document_detail/2401495.html operation to create a… |
| NamespacePassword | string | yes | The password for the namespace. This value is specified when you call the https://help.aliyun.com/document_detail/2401495.html operation |
| Collection | string | yes | The name of the document collection. The document collection is created by calling the… |
| RegionId | string | yes | The region ID of the instance |
| FileName | string | yes | The document name. You can call the https://help.aliyun.com/document_detail/2618453.html operation to view the document list |

…and 182 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/add-ainode" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud AnalyticDB for PostgreSQL API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-gpdb/add-ainode with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud AnalyticDB for PostgreSQL API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud AnalyticDB for PostgreSQL itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud AnalyticDB for PostgreSQL API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-gpdb.

### What is the status of the Alibaba Cloud AnalyticDB for PostgreSQL API?
Needs your own provider key (bring your own key)