# Alibaba Cloud ApsaraDB for POLARDB API

> Alibaba Cloud ApsaraDB for POLARDB API on Apizie: 400 endpoints (Aborts an upgrade or migration task, Grants permissions to a role, Adds SQL firewall rules, Adds an MCP server to a specified PolarClaw application, …) 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-polardb/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for ApsaraDB for POLARDB (polardb, version 2017-08-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Aborts an upgrade or migration task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/abort-dbcluster-migration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| ResourceGroupId | string | no | The resource group ID |

### Grants permissions to a role
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/add-encryption-dbrole-privilege` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| RolePrivilegeName | string | no | The name of the role-based permission |
| RolePrivilegeConfig | string | no | The access policy for the role |

### Adds SQL firewall rules
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/add-firewall-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| RuleName | string | no | The name of the firewall rule. You can specify only one rule name. Call the https://help.aliyun.com/document_detail/212573.html operation… |
| RuleConfig | string | no | A JSON string that contains the configuration parameters and their values for the firewall rule to add. All parameter values must be… |
| ResourceGroupId | string | no | The resource group ID |

### Adds an MCP server to a specified PolarClaw application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/add-polar-claw-mcpserver` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The application ID |
| ServerName | string | yes | The unique identifier of the MCP server |
| ServerConfig | string | no | The MCP server configuration object (JSON-encoded) |

### Adds a transparent acceleration path
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/add-polar-fs-path-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| PolarFsInstanceId | string | yes | The PolarFS instance ID |
| DBClusterId | string | yes | The cluster ID |
| CustomBucketPathList | string | no | The bucket and corresponding path information (JSON-encoded) |

### Adds a new directory quota rule to a Polarlakebase instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/add-polar-fs-quota` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| PolarFsInstanceId | string | yes | The ID of the Polarlakebase instance |
| Quotas | string | yes | The details of the quota rules (JSON-encoded) |
| DBClusterId | string | no | The ID of the PolarDB instance on which the application depends |

### Adds authorized accounts for cold storage
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/add-polar-ossauthorized-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| PfsInstanceId | string | yes | The cold storage instance ID |
| DBClusterId | string | no | The ID of the PolarDB cluster |
| RegionId | string | no | The region ID |
| AuthorizedUserIds | string | yes | The list of authorized accounts to add. Separate multiple accounts with commas. You can specify a mix of UIDs and RAM role ARNs |

### Adds SQL throttling rules
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/add-sqlrate-limiting-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| RuleName | string | yes | The name of the SQL throttling rule. You can specify only one rule name at a time. Call the… |
| RuleConfig | string | yes | The configuration of the SQL throttling rule to add or modify, specified as a JSON string. The values of the parameters must be strings.… |

### Answers a single-turn question based on a knowledge base
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/answer-knowledge-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| KnowledgeBaseId | string | yes | The unique identifier of the knowledge base. To obtain the ID, first call CreateKnowledgeSpace to create a knowledge space, use the… |
| QueryText | string | yes | The user question |
| TopK | integer | no | The number of results to recall |
| ScoreThreshold | number | no | The similarity score threshold |
| RerankEnabled | string | no | Specifies whether to enable reranking. Default value: false |
| SearchMode | string | no | The search mode. Valid values: knn, rrf, precise, semantic, and balanced |
| ReturnSources | string | no | Specifies whether to return reference sources. Default value: true |
| SystemPrompt | string | no | The system prompt |
| UserInstructions | string | no | The additional user instructions |
| MaxContextChars | integer | no | The maximum number of characters in the context. Valid values: 1000 to 32000 |

### Applies prompts to an application instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/apply-application-prompts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The ID of the application |
| EnabledPromptIds | string | no | An array of prompt IDs to enable (JSON-encoded) |
| DisabledPromptIds | string | no | An array of prompt IDs to disable (JSON-encoded) |

### Applies a parameter template to Lakebase
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/apply-lakebase-mount-parameter-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| PolarFsInstanceId | string | yes | The PolarFS instance ID |
| ParameterGroupId | string | yes | The parameter template ID. The ID starts with pagp- |

### Approves PolarClaw device pairing
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/approve-polar-claw-device-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The application ID |
| PairRequestId | string | yes | The pairing request ID |

### Attaches a specified PolarLakeBase cold-storage instance to a PolarDB application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/attach-application-polar-fs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | Application ID |
| PolarFSInstanceId | string | yes | PolarLakeBase cold-storage instance ID Only the following applications support cold-storage instances: Supabase |
| PolarFSAccessKeyId | string | no | AccessKey ID of the Alibaba Cloud account or RAM user. Ensure that you granted permissions to this account or user when you created the… |
| PolarFSAccessKeySecret | string | no | AccessKey secret of the Alibaba Cloud account or RAM user |

### Associates a specified channel with a specific PolarClaw agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/bind-polar-claw-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The application ID. You can call the DescribeApplications operation to obtain the application ID from the returned Items list |
| AgentId | string | yes | The ID of the agent to associate |
| Channel | string | yes | The channel plugin ID |
| ChannelAccountId | string | no | The channel account ID. If you do not specify this parameter, the default value is default |

### Binds a specified resource control rule to a user, database, query, or connection in a PolarDB for MySQL…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/bind-resource-control` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the PolarDB cluster. You can call the https://help.aliyun.com/document_detail/98041.html operation to query available… |
| DBClusterId | string | yes | The PolarDB cluster ID |
| ResourceControlName | string | yes | The name of the resource control rule. The name must be 1 to 63 ASCII bytes in length, start with a letter, and can contain only letters,… |
| TargetType | string | yes | The type of the binding target. Valid values: USER, DATABASE, QUERY, CONNECTION. The value is case-insensitive |
| TargetValue | string | yes | The value of the binding target. The format depends on the value of TargetType. For more information, see the table below |

### Cancels O\\&M events at a time
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/cancel-active-operation-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/98041.html operation to query the region information about all… |
| TaskIds | string | yes | The IDs of O\&M events that are canceled at a time. Separate multiple IDs with commas (,) |

### Cancels an auto triggered task policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/cancel-cron-job-policy-serverless` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | no | The cluster ID |
| RegionId | string | no | The region ID |
| JobId | string | no | The scheduled task ID |

### Deletes quota rules for one or more file paths within a specified Polarlakebase instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/cancel-polar-fs-file-quota` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| PolarFsInstanceId | string | yes | The ID of the Polarlakebase instance |
| FilePathIds | string | yes | The file paths. Separate multiple paths with a comma (`,`) |
| DBClusterId | string | no | The ID of the PolarDB cluster that the application depends on |

### Cancels scheduled tasks that have not started
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/cancel-schedule-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. Call the https://help.aliyun.com/document_detail/98094.html operation to view information about all clusters in the… |
| TaskId | string | yes | The ID of the scheduled task to cancel. Call the https://help.aliyun.com/document_detail/199648.html operation to view information about… |
| ResourceGroupId | string | no | The resource group ID |

### Checks whether an account name is valid or unique in a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/check-account-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the cluster. You can call the https://help.aliyun.com/document_detail/98094.html operation to query information about all… |
| AccountName | string | yes | The name of the account |

### Checks the PolarDB account name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/check-account-name-zonal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. Note: This parameter accepts only edge cluster IDs, which you can obtain by calling the DescribeDBClustersZonal operation.… |
| AccountName | string | yes | The account name |

### Checks the connection string of a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/check-connection-string` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the cluster. Call the https://help.aliyun.com/document_detail/98094.html operation to view the details of all clusters in your… |
| ConnectionStringPrefix | string | yes | The prefix of the new connection string. The prefix must meet the following requirements: It must consist of lowercase letters, digits,… |

### Checks whether a database name is valid or if a database with the same name already exists in the current…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/check-dbname` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. Call the https://help.aliyun.com/document_detail/98094.html operation to query the details of all clusters in a… |
| DBName | string | yes | The database name |

### Checks the ApsaraDB database name for PolarDB on ENS
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/check-dbname-zonal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. Note: This parameter accepts only edge cluster IDs obtained by calling DescribeDBClustersZonal. Regular PolarDB cluster… |
| DBName | string | yes | The database name |

### Checks whether a user is authorized to use Key Management Service (KMS)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/check-kmsauthorized` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. Call the https://help.aliyun.com/document_detail/2319134.html operation to query information about the available regions of… |
| DBClusterId | string | yes | The cluster ID. Call the https://help.aliyun.com/document_detail/2319131.html operation to query information about all clusters in the… |
| TDERegion | string | no | The region where the transparent data encryption (TDE) key is located |

### Checks the consistency of quota settings in a PolarFS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/check-polar-fs-quota-consistency` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| PolarFsInstanceId | string | yes | The ID of the PolarFS instance |
| Path | string | no | The directory path |
| EnableRepair | string | no | Specifies whether to repair an inconsistent quota. Valid values: false true |
| EnableStrictCalculate | string | no | Specifies whether to calculate the total usage of the directory in strict mode. Valid values: false true |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |

### Clones a snapshot of a file or folder for a Basic Edition instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/clone-polar-fs-basic-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| PolarFsInstanceId | string | no | The ID of the Polarlakebase instance |
| DBClusterId | string | no | The ID of the database cluster |
| SourcePath | string | no | The source path of the file resource. This parameter is empty if the type is local |
| TargetPath | string | no | The destination path |

### Disables the PolarDB for AI feature
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/close-aitask` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region |
| DBClusterId | string | yes | The ID of the cluster |

### Cancels or completes the migration task that upgrades an RDS cluster to a PolarDB cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/close-dbcluster-migration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the cluster |
| ContinueEnableBinlog | string | no | Specifies whether to continue to enable binary logging. Valid values: True: continues to enable binary logging. False: disables binary… |

### Continues the current migration or upgrade task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/continue-dbcluster-migration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The ID of the region. For more information, see https://help.aliyun.com/document_detail/98041.html |
| DBClusterId | string | yes | The ID of the cluster. Call the https://help.aliyun.com/document_detail/98094.html operation to query information about all clusters in… |
| ForceSwitch | string | no | Specifies whether to skip the current error. Valid values: true: Skips the error. false: Does not skip the error |
| ResourceGroupId | string | no | The ID of the resource group |

### Creates an AI cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-aidbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ZoneId | string | no | The zone ID |
| DBNodeClass | string | no | The node specifications |
| DBClusterDescription | string | no | The description of the cluster. Fuzzy match is supported |
| PayType | string | yes | The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: enables auto-renewal. false: disables auto-renewal. Default value: false.… |
| Period | string | no | This parameter is required when the PayType parameter is set to Prepaid. Specifies the billing cycle of the subscription cluster. Valid… |
| UsedTime | string | no | The subscription duration. This parameter is required when the PayType parameter is set to Prepaid. If the Period parameter is set to… |
| VPCId | string | yes | The ID of the VPC |
| VSwitchId | string | yes | The ID of the vSwitch |
| SecurityGroupId | string | no | The ID of the security group |
| StorageType | string | no | The storage type |
| StorageSpace | integer | no | The storage space |
| Password | string | no | The password |
| KubeConfig | string | no | The Kubernetes configuration |
| KubeClusterId | string | no | The ID of the ACK cluster |
| KubeType | string | no | aideploy |
| AckAdmin | string | no | Specifies whether the cluster is managed by an ACK cluster |
| ManagementMode | string | no | The management mode |
| KubeManagement | string | no | The management mode of the Kubernetes cluster |
| ModelName | string | no | The name of the model |
| Extension | string | no | The extension |
| InferenceEngine | string | no | The inference engine |
| Capacity | integer | no | The initial model capacity of the instance. The value must be a positive integer. A capacity unit of 1000 is equivalent to one L20N card |
| TimeSlices | string | no | The pay-as-you-go time ranges (JSON-encoded) |
| DBClusterId | string | no | The PolarDB instance ID on which the application depends |
| KubernetesConfig | string | no | The Kubernetes configuration |
| AutoUseCoupon | string | no | Specifies whether to automatically use coupons. Valid values: true (default): uses coupons. false: does not use coupons |
| PromotionCode | string | no | The coupon code. If you do not specify this parameter, the default coupon is used |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can generate the token on… |
| ModelSpace | string | no | The model operator space |
| CreatePublicEndpoint | string | no | Specifies whether to create a public endpoint |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/98041.html operation to query the region information of all… |
| Description | string | no | The description |
| ModelSpaceName | string | no | The model space ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| DBClusterId | string | no | The ID of the PolarDB database cluster |
| DatasetType | string | no | The type of the dataset. Valid values: train: training set eval: evaluation set |
| TrainMode | string | no | The training mode for the dataset. The dataset format depends on the mode. Valid values: sft: supervised fine-tuning. For training sets… |
| ImportMode | string | no | The import method. Valid values: LocalImport: local import |
| DatasetName | string | no | The dataset name |

### Creates a model creation operator instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-aidbcluster-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| DBClusterId | string | yes | The cluster ID |
| ModelSource | string | yes | The source of the model. Valid values: public: preset model. custom: custom model |
| ModelType | string | no | The type of the custom model |
| ModelName | string | yes | The name of the model. For a preset model, specify the name of the selected model. For a custom model, specify the path of the model (the… |
| DatasetPath | string | no | The ID of the training dataset. This parameter is required for fine-tuning |
| EvalDatasetPath | string | no | The ID of the validation dataset. This parameter is required for evaluation |
| RunningParameter | string | yes | The runtime parameters. The value is a JSON string |
| KubeType | string | yes | The type of the model service. Valid values: aitrain: model operator fine-tuning |
| TaskName | string | no | The description of the model service |
| ZoneId | string | no | The zone ID |
| VPCId | string | no | The VPC ID |
| VSwitchId | string | no | The ID of the vSwitch |
| SecurityGroupId | string | no | The security group ID |
| DBInstanceClass | string | no | The instance type |
| TuneArch | string | no | The model fine-tuning architecture |
| DataserviceMode | string | no | The data service mode. A value of custom indicates that custom OSS is used, and a value of cold_storage indicates that cold storage is used |
| CustomOssBucketName | string | no | The name of the custom OSS bucket |

### Creates AI nodes
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-ainodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | no | The cluster ID. Call the DescribeAIDBClusters (https://api.aliyun.com/api/polardb/2017-08-01/DescribeAIDBClusters) operation to query… |
| DBNodes | string | no | The information about the nodes to add (JSON-encoded) |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| AccountName | string | yes | The account name. The name must meet the following requirements: Starts with a lowercase letter and ends with a letter or digit. Contains… |
| AccountPassword | string | yes | The account password. The password must meet the following requirements: Contains at least three of the following character types:… |
| AccountType | string | no | The account type. Valid values: Normal: standard account. Super: privileged account. DynamoDB: DynamoDB account. If this parameter is left… |
| AccountDescription | string | no | The description of the account. The description must meet the following requirements: Cannot start with `http://` or `https://`. Is 2 to… |
| DBName | string | no | The name of the database that the account is authorized to access. You can specify multiple database names separated by commas (,). This… |
| AccountPrivilege | string | no | The permissions of the account. Valid values: ReadWrite: read and write ReadOnly: read-only DMLOnly: DML only DDLOnly: DDL only ReadIndex:… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value. Make sure that the… |
| PrivForAllDB | string | no | Specifies whether to grant permissions on all existing databases and all new databases in the current cluster. Valid values: 0 or empty:… |
| NodeType | string | no | The node type. Valid values: Search: required when creating an account for a PolarDB Search node |

### Creates an account for an edge cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-account-zonal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. Note: Only edge cluster (Zonal) IDs are supported. You can query them by calling the DescribeDBClustersZonal operation.… |
| AccountName | string | yes | The name of the account. The name must meet the following requirements: It must start with a lowercase letter and end with a letter or a… |
| AccountPassword | string | yes | The password of the account. The password must meet the following requirements: It must contain at least three of the following character… |
| AccountType | string | no | The type of the account. Valid values: Normal: standard account Super: privileged account |
| AccountDescription | string | no | The description of the account. The description must meet the following requirements: It cannot start with `http://` or `https://`. It… |
| DBName | string | no | The names of the databases that the account is authorized to access. You can specify multiple database names separated by commas (,) |
| AccountPrivilege | string | no | The permissions of the account. Valid values: ReadWrite: read and write permissions ReadOnly: read-only permissions DMLOnly: DML-only… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can generate the value of… |
| PrivForAllDB | string | no | Specifies whether to grant the account permissions on all existing databases and all databases to be created in the cluster. Valid values:… |
| NodeType | string | no | The node type |

### Generates an activation code for the lightweight edition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-activation-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| AliyunOrderId | string | yes | The Alibaba Cloud order ID, including virtual order IDs. If you use a virtual order, you can call CreateOrGetVirtualLicenseOrder and… |
| MacAddress | string | yes | The MAC address |
| SystemIdentifier | string | no | The unique identifier of the database. This field is required if the AllowEmptySystemIdentifier parameter of the order is set to false |
| Description | string | no | The description of the activation code |
| Name | string | yes | The name of the activation code. The name can contain only letters, digits, underscores (_), and hyphens (-). This name is used to… |

### Creates an AgenticDB branch
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-agentic-dbbranch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBClusterId | string | yes | The AgenticDB cluster ID |
| TenantId | string | yes | The tenant ID |
| ProjectId | string | yes | The project ID |
| BranchName | string | yes | The name of the branch |
| ParentBranchId | string | no | The ID of the parent branch. By default, the branch is derived from the main branch |
| Description | string | no | The description |
| ParentTimestamp | string | no | Creates the branch based on the data of the parent branch at the specified point in time. If you do not specify this parameter, the latest… |

### Creates an AgenticDB project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-agentic-dbproject` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBClusterId | string | yes | The ID of the AgenticDB cluster |
| TenantId | string | yes | The ID of the tenant |
| ProjectName | string | yes | The name of the project. The name must be unique within the tenant |
| DefaultBranchName | string | no | The name of the default branch. Default value: main |
| Description | string | no | The description of the project |
| HistoryRetentionSeconds | integer | no | The retention period for historical data to support creating branches at specific points in time. Default value: 604800 seconds (7 days).… |

### Creates an AgenticDB tenant
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-agentic-dbtenant` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBClusterId | string | yes | The AgenticDB cluster ID |
| TenantName | string | yes | The name of the tenant. It must be 1 to 64 characters in length, start with a letter, and contain only letters, digits, underscores (_),… |
| Description | string | no | The description of the tenant. The description can be up to 256 characters in length |

### Creates an AgenticDB tenant API key
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-agentic-dbtenant-api-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBClusterId | string | yes | The AgenticDB cluster ID |
| TenantName | string | yes | The name of the tenant. The name must be unique within the same cluster and be 2 to 64 characters in length |
| Description | string | no | The description of the purpose |
| ExpireTime | string | no | The expiration time in ISO 8601 format. If this parameter is not specified, the API key never expires |

### Creates an application attached to a PolarDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| Description | string | no | The description or remark of the application |
| Parameters | string | no | The list of parameters (JSON-encoded) |
| AgenticDBBranchSpec | string | no | The AgenticDB branch specifications (JSON-encoded) |
| Storages | string | no | The list of application storages (JSON-encoded) |
| ApplicationType | string | yes | The application type. Valid values: supabase: Specify this value to create a managed Supabase application. raycluster: Specify this value… |
| DBClusterId | string | no | The ID of the PolarDB instance on which the application depends |
| RegionId | string | no | The region ID. Default value: the region of the instance |
| ZoneId | string | no | The zone ID. Default value: the primary zone of the instance |
| VSwitchId | string | no | The vSwitch ID. Default value: the current vSwitch in the primary zone of the instance |
| Architecture | string | yes | The CPU architecture. Valid values: x86 |
| SecurityIPList | string | no | The IP address whitelist. If you do not specify this parameter, the default value `127.0.0.1` is used |
| SecurityIPType | string | no | The type of the IP address |
| SecurityIPArrayName | string | no | The name of the IP address whitelist group. Default value: `default` |
| Endpoints | string | no | The list of custom service endpoints. By default, a VPC endpoint is created (JSON-encoded) |
| Components | string | no | The list of custom application subcomponents (JSON-encoded) |
| PayType | string | no | The billing method |
| AutoRenew | string | no | Specifies whether to enable auto-renewal |
| Period | string | no | The subscription period unit |
| UsedTime | string | no | The subscription period |
| ResourceGroupId | string | no | The ID of the resource group |
| DryRun | string | no | Specifies whether to perform a dry run. Default value: `false`. If you set this parameter to `true`, only parameter and resource… |
| PolarFSInstanceId | string | no | The ID of the Polarlakebase cold storage or high-performance edition instance. Default value: empty. If you specify this parameter, the… |
| VpcId | string | no | The ID of the virtual private cloud (VPC) |
| AutoCreatePolarFs | string | no | Specifies whether to automatically create a Polarlakebase cold storage edition instance. Valid values: false (default): Do not… |
| AutoUseCoupon | string | no | Specifies whether to automatically use coupons. Valid values: true (default): Use coupons. false: Do not use coupons |
| PromotionCode | string | no | The coupon code. If you do not specify this parameter, the default coupon is used |
| SecurityGroupId | string | no | The ID of the security group |
| MemApplicationSpec | string | no | The Mem0 application specification. This parameter is required for mem0 applications (JSON-encoded) |
| KnowledgeApplicationSpec | string | no | The knowledge application specification. This parameter is required for knowledge applications (JSON-encoded) |
| ModelFrom | string | no | The source of the model. Valid values: bailian: Model Studio model. custom: Custom model. maas: PolarDB model operator |
| AIDBClusterId | string | no | The ID of the associated existing model operator instance. This parameter takes effect only when ApplicationType is set to polarclaw |
| ModelApiKey | string | no | The API key of the model. This parameter takes effect only when ApplicationType is set to polarclaw |
| ModelBaseUrl | string | no | The base URL of the model. This parameter takes effect only when ApplicationType is set to polarclaw |
| ModelApi | string | no | The API of the model. This parameter takes effect only when ApplicationType is set to polarclaw |
| ModelName | string | no | The name of the model. This parameter takes effect only when ApplicationType is set to polarclaw |
| AutoAllocatePublicEip | string | no | Specifies whether the automatic creation is enabled and whether to attach and associate with an EIP |
| Tag | string | no | The tag (JSON-encoded) |
| TargetVersion | string | no | The target version |
| AuthProvider | string | no | The authentication provider |
| AuthProviderConfig | string | no | The authentication provider configuration |
| SkillTemplateId | string | no | The skill template ID |
| VpcNatGatewayId | string | no | The VPC NAT gateway ID for NAT mapping. If you specify this parameter, NAT mapping is enabled when the instance is created. The gateway… |
| DnatIpAddress | string | no | The dedicated NAT IP address allocated for DNAT, which is separate from the SNAT IP address. The IP address must belong to the specified… |
| DnatEntries | string | no | The list of expected DNAT entries for NAT mapping. This parameter must be specified together with VpcNatGatewayId. You can leave this… |
| AgenticDBClusterId | string | no | The ID of the AgenticDB cluster |

### Binds an Agent to a Squad
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-application-agent-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The ID of the Squad application |
| AgentId | string | yes | The instance ID of the Agent to attach |
| Token | string | yes | The authentication token |

### Creates a connection address for a specified application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-application-endpoint-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The application ID |
| EndpointId | string | yes | The service endpoint ID |
| NetType | string | yes | The network type of the new connection address. The value must be `Public`, which indicates an Internet address |

### Creates a Prompt for an Application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-application-prompt` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The ID of the Application |
| PromptName | string | yes | The name of the Prompt |
| PromptType | string | yes | The type of the Prompt |
| PromptValue | string | yes | The content of the Prompt |

### Creates a full snapshot backup for a PolarDB cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-backup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. The value is generated by the… |
| Comment | string | no | The description of the backup set |

### Creates multiple API keys
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-batch-consumer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| GwClusterId | string | yes | The gateway instance ID |
| Count | integer | no | The number of user API keys |
| ConsumerGroupId | string | no | The ID of the consumer group |
| ClientToken | string | no | Ensures the idempotency of the request and prevents duplicate submissions. The value is generated by the client and must be unique across… |
| CreditToken | string | no | The redemption code. If this parameter is specified, the recharge-based activation branch is used, and the count and quota are populated… |
| Description | string | no | The description prefix of the consumer |
| RegionId | string | yes | The region ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/98041.html operation to view the region information of all… |
| TaskName | string | yes | The description of the model service |
| TaskType | string | yes | The task type |
| InstanceIds | string | yes | The instance IDs (JSON-encoded) |
| Param | string | no | The archive parameters |
| ApplicationType | string | no | The target application type of the batch task |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| GwClusterId | string | yes | The gateway instance ID |
| BudgetType | string | yes | The budget type. Valid values: GlobalTotal: Global total budget. ConsumerGroupTotal: Total budget for a consumer group.… |
| BudgetDimensionRefId | string | no | The ID of the dimension object. This parameter is required when BudgetType is set to ConsumerGroupTotal or Consumer |
| ResetDayOfMonth | string | yes | The day of the month when the budget is reset (1 to 28) |
| BudgetPoints | string | yes | The budget points |
| AlertThresholdPct | string | no | The alert threshold percentage (0 to 100) |
| RegionId | string | no | The region ID |

### Creates a cold storage instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-cold-storage-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The ID of the resource group |
| DBClusterId | string | yes | The cluster ID. Call the https://help.aliyun.com/document_detail/98094.html operation to query the details of all clusters in your… |
| ColdStorageInstanceDescription | string | no | The description of the cold storage instance. The description can be up to 256 characters in length |
| ClientToken | string | no | A client token to ensure the idempotence of a request. This token is generated by the client and must be unique among different requests.… |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| GwClusterId | string | yes | The gateway instance ID. You can obtain the ID from the GwClusterId parameter returned by the CreateGateway operation |
| Name | string | yes | The username |
| ConsumerGroupName | string | no | The consumer group ID. You can obtain the ID from the ConsumerGroupId parameter returned by the CreateConsumerGroup operation |
| NickName | string | no | The nickname |
| KeyType | string | no | The key type. Default value: ApiKey. Valid values: ApiKey |
| RegionId | string | no | The region ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| GwClusterId | string | yes | The ID of the gateway instance |
| ConsumerGroupName | string | yes | The name of the consumer group |
| NickName | string | no | The nickname of the consumer group |
| IsDefault | string | no | Indicates whether the consumer group is the default group. Valid values: 0: No 1: Yes |
| RegionId | string | no | The ID of the region where the consumer group will be created |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| GwClusterId | string | yes | The gateway instance ID |
| ModelName | string | yes | The name of the model, such as gpt-4 or qwen-turbo |
| ModelServiceId | string | yes | The ID of the model service |
| InputCostPointsPerMillion | string | no | The input cost points per million tokens. Default value: 0 |
| EffectiveTargetType | string | no | The effective target type. Valid values: global, consumerGroup, and consumer. Default value: global |
| EffectiveTargetValue | string | no | The effective target value. This parameter is required when the effective target type is not global |
| OutputCostPointsPerMillion | string | no | The output cost points per million tokens. Default value: 0 |
| CacheCostPointsPerMillion | string | no | The cache read cost points per million tokens. Default value: 0 |
| ExplicitCacheCostPointsPerMillion | string | no | The explicit cache read cost points per million tokens |
| CacheCreationCostPointsPerMillion | string | no | The cache creation cost points per million tokens |
| ImageCostPointsPerCount | string | no | The image input cost points per image |
| VideoCostPointsPerSecond | string | no | The video input cost points per second |
| InputTokenTiers | string | no | The tiered price for input tokens (non-cumulative). The value is a JSON array character string. Each element contains Tier and… |
| EffectiveStartTime | string | no | The effective start time in the yyyy-MM-dd HH:mm:ss format. If this parameter is not specified, the rule takes effect immediately |
| RegionId | string | no | The region ID |

### Creates a scheduled task policy for a serverless cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-cron-job-policy-serverless` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| RegionId | string | yes | The region ID |
| CronExpression | string | yes | The Cron expression |
| ScaleMin | string | no | The minimum number of PolarDB Capacity Units (PCUs). The value must be from 0.25 to 32 and must be less than or equal to the value of… |
| ScaleMax | string | no | The maximum number of PCUs. The value must be from 1 to 32 |
| ScaleRoNumMin | string | no | The minimum number of read-only nodes. Valid values: 0 to 15 |
| ScaleRoNumMax | string | no | The maximum number of read-only nodes. Valid values: 0 to 15. The value must be greater than or equal to the value of ScaleRoNumMin |
| AllowShutDown | string | no | Specifies whether to enable no-activity suspension. Valid values: true: Enables the feature. false (default): Disables the feature |
| SecondsUntilAutoPause | string | no | The period of inactivity in minutes before the cluster is automatically paused. The value must be a multiple of 5 and range from 5 to 1440 |
| ScaleApRoNumMin | string | no | The minimum number of read-only column store nodes. Valid values: 0 to 15 |
| ScaleApRoNumMax | string | no | The maximum number of read-only column store nodes. Valid values: 0 to 15 |
| ServerlessRuleCpuEnlargeThreshold | string | no | The CPU utilization percentage that triggers a scale-up. Valid values: 40 to 100 |
| ServerlessRuleCpuShrinkThreshold | string | no | The CPU utilization percentage that triggers a scale-down. Valid values: 10 to 100. The value of ServerlessRuleCpuEnlargeThreshold minus… |
| ServerlessRuleMode | string | no | The scaling sensitivity. Valid values: normal: standard flexible: flexible |
| StartTime | string | no | The start time of the task. Use the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in Coordinated Universal Time (UTC) |
| EndTime | string | yes | The end time of the task. Use the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC |

### Creates a PolarDB cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-dbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/98041.html operation to query available regions |
| ZoneId | string | no | The zone ID. You can call the https://help.aliyun.com/document_detail/98041.html operation to query available zones |
| Architecture | string | no | The CPU architecture. Valid values: X86 ARM |
| DBType | string | yes | The type of the database engine. Valid values: MySQL PostgreSQL Oracle |
| DBVersion | string | yes | The database DPI engine version number. Valid values for MySQL version number: * 5.6 * 5.7 * 8.0 Valid values for PostgreSQL version… |
| DBNodeClass | string | no | The node specification. For more information, see the following topics: PolarDB for MySQL:… |
| ClusterNetworkType | string | no | The network type of the cluster. Only virtual private clouds (VPCs) are supported. Set the value to VPC |
| DBClusterDescription | string | no | The name of the cluster. The name must meet the following requirements: It cannot start with `http://` or `https://`. It must be 2 to 256… |
| PayType | string | yes | The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: enables auto-renewal. false: disables auto-renewal. Default value: false.… |
| Period | string | no | This is a required parameter to pass when PayType is set to Prepaid. Specifies the subscription type of the subscription cluster. Year:… |
| UsedTime | string | no | This parameter is required when PayType is set to Prepaid. If Period is set to Month, UsedTime is an integer that ranges from `[1-9]`. If… |
| VPCId | string | no | The VPC ID |
| VSwitchId | string | no | The vSwitch ID. If you specify VPCId, you must also specify VSwitchId |
| CreationOption | string | no | The method used to create the cluster. Valid values: Normal: creates a new PolarDB cluster. For more information about console operations,… |
| SourceResourceId | string | no | Instance ID of the source ApsaraDB RDS instance or the source PolarDB cluster. This parameter is required only when CreationOption is set… |
| CloneDataPoint | string | no | The point in time at which data is cloned. Valid values: LATEST: the latest point in time. BackupID: a historical backup set ID. Set this… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. The token is generated by the client and must be unique among… |
| ResourceGroupId | string | no | The ID of the resource group |
| SecurityIPList | string | no | The IP whitelist of the PolarDB cluster. You can configure multiple IP addresses in the whitelist. Separate multiple IP addresses with… |
| TDEStatus | string | no | Specifies whether to enable Transparent Data Encryption (TDE). Valid values: true: enables TDE. false: disables TDE (default). This… |
| GDNId | string | no | The ID of the Global Database Network (GDN). This parameter is required when CreationOption is set to CreateGdnStandby |
| CreationCategory | string | no | The edition of the cluster. Valid values: Normal: Cluster Edition (default). Basic: Single Node Edition. ArchiveNormal: PolarDB X-Engine… |
| DefaultTimeZone | string | no | The default time zone of the cluster (UTC). The value can be any time frame within the range of -12:00 to +13:00, such as 00:00. Default… |
| LowerCaseTableNames | string | no | Specifies whether table names are case-sensitive. Valid values: 1: Table names are case-insensitive. 0: Table names are case-sensitive.… |
| BackupRetentionPolicyOnClusterDeletion | string | no | The data retention policy applied when the cluster is deleted. Valid values: ALL: long-term retention (LTR) of all backups. LATEST:… |
| StorageSpace | integer | no | The storage space for subscription (pay-by-space) billing. Unit: GB. Valid values for PolarDB for MySQL Enterprise Edition: 10 to 50000.… |
| DBMinorVersion | string | no | The minor version of the database engine. Valid values: 8.0.2 8.0.1 This parameter takes effect only when DBType is set to MySQL and… |
| ParameterGroupId | string | no | The ID of the parameter template. You can call the https://help.aliyun.com/document_detail/207178.html operation to query the list of… |
| Tag | string | no | The list of tags (JSON-encoded) |
| ServerlessType | string | no | The serverless type. Set the value to AgileServerless (agile). Only serverless clusters support this parameter |
| ScaleMin | string | no | The minimum scaling limit for a single node. Valid values: 1 PCU to 31 PCU. Only serverless clusters support this parameter |
| ScaleMax | string | no | The maximum scaling limit for a single node. Valid values: 1 PCU to 32 PCU. Only serverless clusters support this parameter |
| AllowShutDown | string | no | Specifies whether to enable No-activity Suspension. Valid values: true: enables No-activity Suspension. false: disables No-activity… |
| ScaleRoNumMin | string | no | The minimum number of read-only nodes for scaling. Valid values: 0 to 15. Only serverless clusters support this parameter |
| ScaleRoNumMax | string | no | The maximum number of read-only nodes for scaling. Valid values: 0 to 15. Only serverless clusters support this parameter |
| StorageType | string | no | Valid values for Enterprise Edition storage type: PSL5 PSL4 Valid values for Standard Edition storage type: ESSDPL0 ESSDPL1 ESSDPL2… |
| DBNodeNum | integer | no | The number of nodes for Standard Edition and Enterprise Edition. Valid values: Standard Edition: 1 to 8 (supports 1 read/write node and 7… |
| HotStandbyCluster | string | no | Specifies whether to enable the hot standby cluster. Valid values: ON (default): enables the hot standby storage cluster. OFF: disables… |
| StrictConsistency | string | no | Specifies whether multi-zone strong data consistency is enabled for the cluster. Valid values: ON: Multi-zone strong data consistency is… |
| StandbyAZ | string | no | The zone of the hot standby cluster. This parameter takes effect only when the hot standby cluster or multi-zone strong data consistency… |
| ProxyType | string | no | The type of the database proxy. Valid values: EXCLUSIVE: Dedicated Enterprise Edition. GENERAL: Standard Enterprise Edition. The proxy… |
| ProxyClass | string | no | The specification of the database proxy for Standard Edition. Valid values: polar.maxscale.g2.medium.c: 2 cores.… |
| LoosePolarLogBin | string | no | Specifies whether to enable the Binlog feature. Valid values: ON: enables the Binlog feature for the cluster. OFF: disables the Binlog… |
| LooseXEngine | string | no | Specifies whether to enable the X-Engine storage engine. Valid values: ON: enables the X-Engine storage engine for the cluster. OFF:… |
| LooseXEngineUseMemoryPct | string | no | The percentage of memory allocated to the X-Engine storage engine. Valid values: integers from 10 to 90. This parameter takes effect only… |
| StoragePayType | string | no | The billing method for storage. Valid values: Postpaid: pay-by-capacity (pay-as-you-go). Prepaid: pay-by-space (subscription) |
| StorageAutoScale | string | no | Specifies whether to enable automatic storage scaling for Standard Edition clusters. Valid values: Enable: enables automatic storage… |
| StorageUpperBound | integer | no | The upper limit for automatic storage scaling of Standard Edition clusters. Unit: GB. The maximum value is 32000 |
| ProvisionedIops | integer | no | The provisioned read/write IOPS for ESSD AutoPL cloud disks. Valid values: 0 to min{50,000, 1000 × capacity - baseline performance}.… |
| BurstingEnabled | string | no | Specifies whether to enable I/O performance burst for ESSD AutoPL cloud disks. Valid values: true: enables I/O performance burst. false:… |
| TargetMinorVersion | string | no | The target minor engine version |
| StorageEncryption | string | no | Specifies whether to enable cloud disk encryption. Valid values: true: Enabled. false: Disabled (default). This parameter takes effect… |
| StorageEncryptionKey | string | no | The ID of a custom encryption key for cloud disk encryption in the same region as the instance. If you specify this parameter, cloud disk… |
| SourceUid | integer | no | The UID of the account that owns the source backup set in a cross-account backup restoration scenario |
| CloudProvider | string | no | The cloud service provider to which the instance belongs |
| EnsRegionId | string | no | The ID of the Edge Node Service (ENS) node. This parameter is required when you create an ENS database |
| AutoUseCoupon | string | no | Specifies whether to automatically use coupons. Valid values: true (default): Uses coupons. false: Does not use coupons |
| PromotionCode | string | no | The coupon code. If you do not specify this parameter, the default coupon is used |
| AgenticDbType | string | no | The Agentic database engine type. Valid values: dedicated |
| AgenticDbClusterId | string | no | The Agentic cluster ID |
| AgenticDbClusterDescription | string | no | The Agentic cluster description |

### Creates a custom cluster endpoint for a PolarDB cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-dbcluster-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| EndpointType | string | yes | The type of the custom cluster endpoint. Valid values: Custom: custom cluster endpoint. DynamoDB: DynamoDB endpoint |
| Nodes | string | no | The read load nodes to add to the endpoint. Separate multiple nodes with commas (,). By default, all nodes are added. For PolarDB for… |
| ReadWriteMode | string | no | The read/write mode. Valid values: ReadWrite: read/write (automatic read/write splitting). ReadOnly (default): read-only |
| AutoAddNewNodes | string | no | Specifies whether new nodes are automatically added to this endpoint. Valid values: Enable: New nodes are automatically added to this… |
| EndpointConfig | string | no | The advanced configurations of the cluster endpoint in JSON format. You can configure the consistency level, transaction splitting,… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| DBEndpointDescription | string | no | The name of the custom cluster endpoint |
| VPCId | string | no | The VPC ID |
| VSwitchId | string | no | The vSwitch ID |
| SccMode | string | no | Specifies whether to enable the global consistency (high-performance mode) feature for the node. Valid values: ON: Enabled. OFF: Disabled |
| PolarSccWaitTimeout | string | no | The timeout period for global consistency |
| PolarSccTimeoutAction | string | no | The timeout policy for global consistency. Valid values: 0: sends the request to the primary node. 2: timeout degradation. After a global… |
| PolarFsInstanceId | string | no | The PolarFs instance ID |

### Creates a custom cluster endpoint for a PolarDB on ENS cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-dbcluster-endpoint-zonal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| EndpointType | string | yes | The type of the custom cluster endpoint. Set the value to Custom |
| Nodes | string | no | The read load nodes to add to the endpoint. Separate multiple nodes with commas (,). By default, all nodes are included |
| ReadWriteMode | string | no | The read/write mode. Valid values: ReadWrite: read/write (automatic read/write splitting). ReadOnly (default): read-only |
| AutoAddNewNodes | string | no | Specifies whether new nodes are automatically added to this endpoint. Valid values: Enable: New nodes are automatically added to this… |
| EndpointConfig | string | no | The advanced configurations of the cluster endpoint in JSON format. You can configure the consistency level, transaction splitting,… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent repeated submissions. The token is generated by the… |
| DBEndpointDescription | string | no | The name of the custom cluster endpoint |
| SccMode | string | no | Specifies whether to enable global consistency (high-performance mode) for the node. Valid values: ON: Enabled. OFF: Disabled |
| PolarSccWaitTimeout | string | no | The timeout period for global consistency |
| PolarSccTimeoutAction | string | no | The timeout policy for global consistency. Valid values: 0: Sends the request to the primary node. 2: Timeout degradation. When a global… |

### Creates a public endpoint for the primary endpoint, the default cluster endpoint, or a custom cluster…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-dbendpoint-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| DBEndpointId | string | no | The endpoint ID. For more information, see https://help.aliyun.com/document_detail/98205.html |
| ConnectionStringPrefix | string | no | The prefix of the new endpoint. The prefix must meet the following requirements: Consist of lowercase letters, digits, and hyphens (-).… |
| NetType | string | yes | The network type of the new endpoint. Set the value to Public |
| VPCId | string | no | The ID of the virtual private cloud (VPC) |
| SecurityGroupId | string | no | The ID of the ECS security group |
| ZoneInfo | string | no | The zone information (JSON-encoded) |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The ID of the resource group |
| DBClusterId | string | yes | The ID of the source cluster for the DBLink. You can call the https://help.aliyun.com/document_detail/173433.html operation to query the… |
| DBLinkName | string | yes | The name of the DBLink. It must contain lowercase letters, and can also contain digits and underscores (_). It must start with a letter… |
| TargetDBInstanceName | string | no | The ID of the destination cluster for the DBLink. If the destination is a self-managed Oracle database that runs on an ECS instance, set… |
| TargetDBAccount | string | yes | The account of the destination database. You can call the https://help.aliyun.com/document_detail/173549.html operation to query the… |
| TargetDBPasswd | string | yes | The password for the destination database account |
| TargetDBName | string | yes | The name of the destination database. You can call the https://help.aliyun.com/document_detail/173558.html operation to query information… |
| SourceDBName | string | yes | The name of the source database. You can call the https://help.aliyun.com/document_detail/173558.html operation to query information about… |
| TargetIp | string | no | The IP address of the self-managed Oracle database that runs on an ECS instance |
| TargetPort | string | no | The port number of the self-managed Oracle database that runs on an ECS instance |
| VpcId | string | no | The ID of the virtual private cloud (VPC). You can call the https://help.aliyun.com/document_detail/35739.html operation to query the… |
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/98041.html operation to query the details of regions |
| ClientToken | string | no | A client token that is used to ensure the idempotence of the request. The client generates the token, but you must make sure that the… |

### Adds read-only nodes to a PolarDB cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-dbnodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The resource group ID |
| DBClusterId | string | yes | The cluster ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value. Make sure that the… |
| EndpointBindList | string | no | The ID of the cluster endpoint to which you want to add the new node. If you want to add the node to multiple endpoints, separate the… |
| PlannedStartTime | string | no | The earliest time to start running the scheduled task for adding nodes. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format (UTC). The… |
| PlannedEndTime | string | no | The latest time to start running the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format (UTC). The latest time must be… |
| DBNode | string | yes | The information about the new node (JSON-encoded) |
| DBNodeType | string | no | The node type. Valid values: RO STANDBY DLNode |
| ImciSwitch | string | no | Specifies whether to enable In-Memory Column Index (IMCI). Valid values: ON: enabled. OFF: disabled. This is the default value. PolarDB… |
| CloudProvider | string | no | The cloud service provider to which the node belongs |
| AutoUseCoupon | string | no | Specifies whether to automatically use coupons. Valid values: true (default): Use coupons. false: Do not use coupons |
| PromotionCode | string | no | The coupon code. If you do not specify this parameter, the default coupon is used |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of cluster |
| DBName | string | yes | The name of the database. The name must meet the following requirements: The name can contain lowercase letters, digits, hyphens (-), and… |
| CharacterSetName | string | yes | The character set that is used by the cluster. For more information, see https://help.aliyun.com/document_detail/99716.html |
| DBDescription | string | no | The description of the database. The description must meet the following requirements: It cannot start with `http://` or `https://`. It… |
| AccountName | string | no | The name of the account that is authorized to access the database. You can call the https://help.aliyun.com/document_detail/98107.html… |
| AccountPrivilege | string | no | The permissions that are granted to the account. Valid values: ReadWrite: read and write permissions. ReadOnly: read-only permissions.… |
| Collate | string | no | The language that defines the collation rules in the database. The language must be compatible with the character set that is specified by… |
| Ctype | string | no | The language that indicates the character type of the database. The language must be compatible with the character set that is specified… |

### Creates a database of an edge cluster for PolarDB on ENS
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-database-zonal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| DBName | string | yes | The name of the database. The name must meet the following requirements: It must consist of lowercase letters, digits, hyphens (-), and… |
| CharacterSetName | string | yes | The character set |
| DBDescription | string | no | The description of the database. The description must meet the following requirements: It cannot start with `http://` or `https://`. It… |
| AccountName | string | no | The name of the account that is authorized to access the database |
| AccountPrivilege | string | no | The permissions of the account. Valid values: ReadWrite: read and write permissions. ReadOnly: read-only permissions. DMLOnly: DML… |
| Collate | string | no | The locale setting. This specifies the collation for the new database |
| Ctype | string | no | The locale setting. This specifies the character classification for the database |
| ClientToken | string | no | A client token to ensure request idempotence. The client generates this token. The token must be unique across requests. It is… |

### Creates one or more extensions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-extensions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The ID of the resource group |
| DBClusterId | string | yes | The ID of the source instance |
| Extensions | string | no | The extensions to create. Separate multiple extensions with a comma (,) |
| DBNames | string | yes | The name of the database |
| AccountName | string | yes | The name of the database account associated with the instance |
| SourceDBName | string | no | The name of the source database |
| Version | string | no | 插件版本 |
| VpcId | string | no | The ID of the virtual private cloud (VPC) where the endpoint is located |
| RegionId | string | no | The region ID |
| ClientToken | string | no | A client token to ensure the idempotence of the request. This token is generated by the client and must be unique for each request. The… |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterClass | string | no | The cluster specification |
| RegionId | string | yes | The region ID |
| ZoneId | string | no | The availability zone ID |
| PayType | string | yes | The billing method. Valid values: Postpaid: pay-as-you-go Prepaid: subscription |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: enables auto-renewal. false: disables auto-renewal. Default value: false.… |
| Period | string | no | The unit of the subscription duration. This parameter is required when PayType is set to Prepaid. Year: The subscription duration is… |
| UsedTime | string | no | The subscription duration. This parameter is required when PayType is set to Prepaid. If Period is set to Month, the value must be an… |
| VPCId | string | yes | The ID of the virtual private cloud (VPC) |
| VSwitchId | string | yes | The vSwitch ID |
| SecurityGroupId | string | no | The security group ID |
| DBType | string | no | The database engine type. Valid values: MySQL PostgreSQL |

### Create a new PolarLakeBase Global Data Network (GDN)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-global-data-network` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| Description | string | no | The description or remarks for the GDN |
| SourceId | string | no | Source PolarFileSystem (PolarFS) instance |
| DestinationId | string | no | Target PolarFileSystem (PolarFS) instance |
| SourceFileSystemPath | string | no | The source path |
| DestinationFileSystemPath | string | no | Destination path |
| SourceType | string | no | The type of the source instance. Valid values: pfs: PolarFS High-Performance Edition. pcs: PolarFS Cold Storage Edition |
| DestinationType | string | no | The type of the destination instance. Valid values: pfs: PolarFS High-Performance Edition. pcs: PolarFS Cold Storage Edition |
| SourceRegion | string | no | The region of the source PolarFS instance |
| DestinationRegion | string | no | The region of the destination PolarFS instance |
| FreezeSourceDuringSync | string | no | Whether to freeze the source path during transmission. Valid values: true: Freeze. false: Do not freeze. Currently only supports oss source |

### Creates a new global database network (GDN)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-global-database-network` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the primary cluster |
| GDNDescription | string | no | The description of the GDN. The description must meet the following requirements: It cannot start with http\:// or https\://. It must… |
| ResourceGroupId | string | no | The ID of the resource group |
| GDNVersion | string | no | The GDN version |
| EnableGlobalDomainName | string | no | Specifies whether to create a global domain name |

### Creates a global IP whitelist template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-global-security-ipgroup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The ID of the resource group |
| RegionId | string | yes | The region ID |
| GlobalIgName | string | yes | The name of the IP whitelist template. The name must meet the following requirements: It can contain lowercase letters, digits, and… |
| GIpList | string | yes | The IP addresses in the whitelist template. Separate multiple IP addresses with commas (,). You can add a total of up to 1,000 IP… |

### Places an order to purchase a token resource plan and activates a redemption code
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-gw-consumer-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| GatewayId | string | yes | The ID of the AI gateway instance |
| PackageSpec | string | yes | The number of credits per API key. The value is a positive integer string |
| KeyCount | integer | yes | The number of API keys to generate, which is the number of capacity plans to order. Valid values: 1 to 30 |
| ExpireTime | string | no | The expiration time of the API key in ISO 8601 format. The value must be later than the current time |
| ClientToken | string | no | The idempotency token |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/98041.html operation to query region information |

### Creates a knowledge base synchronization link
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-kbsync-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| KnowledgeBaseId | string | yes | The unique identifier of the knowledge base |
| LinkName | string | yes | The name of the link |
| SourceType | string | yes | The data source type. Valid values: FEISHU and SHAREPOINT |
| TenantId | string | no | The tenant ID. This parameter is required when SourceType is set to SHAREPOINT |
| UserId | string | no | The ID of the DingTalk operator |
| FeishuChatMemberStaleTtlSeconds | integer | no | The validity period of the Lark group member snapshot for fallback reuse, in seconds. This parameter can be explicitly set only for FEISHU… |
| ClientId | string | yes | The client ID |
| ClientSecret | string | yes | The client secret |
| UserAccessToken | string | no | The Lark user access token. This token is used only when the application identity cannot retrieve group members because the bot is not in… |
| UserRefreshToken | string | no | The Lark user refresh token. This token must be provided together with UserAccessToken to automatically rotate the fallback identity for… |
| McpEndpoint | string | no | The endpoint of the DingTalk document MCP server |
| SheetMcpEndpoint | string | no | The endpoint of the DingTalk sheet MCP server |
| SourceDir | string | yes | The source directory address for synchronization |
| Description | string | no | The description of the synchronization link |
| SyncIntervalMinutes | integer | no | The synchronization interval, in minutes |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| KnowledgeSpaceId | string | yes | The unique identifier of the knowledge space |
| Name | string | yes | The name of the knowledge base |
| Description | string | no | The description of the knowledge base |
| SearchMode | string | no | The search mode. Valid values: balanced (default): balanced mode precise: precise mode semantic: semantic mode knn: KNN mode rrf:… |
| KnowledgeBaseType | string | no | The type of the knowledge base: PERSONAL or PUBLIC |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ZoneId | string | yes | The active zone for automatic creation of the database |
| Name | string | yes | The name of the knowledge space. The name must be 1 to 128 characters in length |
| Description | string | no | The description of the knowledge space. The description can be up to 512 characters in length |
| EmbeddingModel | string | yes | The name of the embedding model |
| EmbeddingDimension | integer | yes | The vector dimensions |
| RerankModel | string | no | The name of the reranking model |
| LLMModel | string | no | The name of the large language model |
| EnforceAcl | string | no | Specifies whether to enable ACL-based authentication for the knowledge space |
| ShardingStrategy | string | yes | The sharding strategy. Valid values: hierarchical (default) hybrid |
| ShardingSize | integer | yes | The shard size, in tokens |
| OSSBucket | string | yes | The name of an existing OSS bucket in the same region |
| OSSAccessKey | string | yes | OSS AK |
| OSSSecretKey | string | yes | OSS SK |
| VpcId | string | yes | The VPC for automatic creation of the database |
| VSwitchId | string | yes | The vSwitch for automatic creation of the database |
| DBType | string | no | The database engine type |
| SecurityGroupId | string | yes | The security group ID |

### Creates a PolarFS S3 account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-lakebase-s3-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| PfsInstanceId | string | yes | The PolarFS instance ID. You can obtain the ID from the PolarFsInstanceId parameter returned by the CreatePolarFs operation |
| UserAccAk | string | yes | The access key of the S3 account. The account name supports only uppercase and lowercase letters and digits, and can be up to 32… |
| UserAccSk | string | yes | The secret key of the S3 account (@sensitive, encryption in transit). The value must contain both uppercase and lowercase letters and… |
| UserAccPolicy | string | no | The policy document in JSON format that defines the permissions of the S3 account. If this parameter is not specified, the default policy… |

### Creates a routing rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-model-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| GwClusterId | string | yes | The gateway instance ID. You can obtain the ID from the GwClusterId returned by CreateGateway |
| Name | string | yes | The name of the model API |
| ModelCategory | string | yes | The category. Valid values: text embedding rerank |
| PathPrefix | string | yes | The API path prefix |
| Protocol | string | yes | The protocol. Valid values: openai anthropic bailian vllm |
| RecordInput | string | no | The number of input tokens |
| RecordOutput | string | no | The number of output tokens |
| RouteRules | string | yes | The list of routing rules, which is a JSON array string |
| Config | string | no | The gateway retry configuration |
| ForceModel | string | no | The forced model |
| RegionId | string | no | The region ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| GwClusterId | string | yes | The gateway instance ID |
| Name | string | yes | The model service name |
| ModelCategory | string | yes | The model category |
| Protocol | string | yes | The protocol type |
| BaseUrl | string | yes | The URL of the upstream service |
| ApiKey | string | yes | The API key for the model service |
| InputCostPointsPerMillion | string | no | The billing cost for input, measured in points per one million tokens |
| OutputCostPointsPerMillion | string | no | The billing cost for output, measured in points per one million tokens |
| RequestCostPoints | string | no | The billing cost per request, measured in points |
| Vendor | string | yes | The model service provider. The example value `bailian` is a pinyin-based identifier that corresponds to the product name Model Studio |
| RegionId | string | no | The region ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The resource group ID |
| DBClusterId | string | yes | The source instance name |
| ChannelName | string | yes | The name of the network channel. The name can contain lowercase letters, digits, and underscores (_). It must start and end with a letter… |
| TargetDBClusterId | string | no | The target instance name |
| TargetIp | string | no | The IP address of the target instance |
| TargetPort | string | no | The port of the target instance |
| Notes | string | no | The remarks |
| VpcId | string | no | The ID of the VPC where the access endpoint resides |
| SecurityGroupId | string | no | The security group associated when creating a reverse endpoint for the first time in the VPC |
| RegionId | string | no | The region ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. The token is generated by the… |

### Creates or retrieves a virtual certificate order
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-or-get-virtual-license-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| Engine | string | yes | The engine type. Valid values: PG, Oracle, and MySQL |

### Creates a PolarDB parameter template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-parameter-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the parameter template is located. You can call the https://help.aliyun.com/document_detail/98041.html… |
| DBType | string | yes | The type of the database engine. Only MySQL is supported |
| DBVersion | string | yes | The version of the database engine. Valid values: 5.6 5.7 8.0 |
| ParameterGroupName | string | yes | The name of the parameter template. The name must meet the following requirements: It must start with a letter and can contain letters,… |
| ParameterGroupDesc | string | no | The description of the parameter template. It must be 0 to 199 characters in length |
| Parameters | string | yes | A JSON string that consists of parameters and their values. The values of the parameters must be strings. For example:… |
| ResourceGroupId | string | no | The ID of the resource group |

### Creates a new PolarClaw agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-polar-claw-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The application ID |
| AgentId | string | yes | The agent name |
| Workspace | string | yes | The absolute path of the agent working directory |
| Emoji | string | no | The emoji character |
| Avatar | string | no | The avatar URL or path |
| Restart | string | no | Specifies whether to restart the gateway after creation. Default value: true |

### Creates a new communication channel in PolarClaw
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-polar-claw-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The application ID |
| ChannelId | string | yes | The unique identifier of the channel |
| PluginId | string | yes | The channel plugin name |
| NpmPackage | string | yes | The npm package name of the channel plugin, including the version number |
| ChannelConfig | string | no | The channel configuration (JSON-encoded) |
| Restart | string | no | Specifies whether to restart the gateway after creation. Default value: true |

### Creates a PolarClaw scheduled task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-polar-claw-cron-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The application ID |
| Name | string | yes | The unique name of the task |
| Schedule | string | yes | The schedule configuration (JSON-encoded) |
| SessionTarget | string | yes | The session target. Valid values: main, isolated, current |
| WakeMode | string | yes | The wake mode. Valid values: now, next-heartbeat |
| Payload | string | yes | The execution payload configuration (JSON-encoded) |
| AgentId | string | no | The ID of the specified execution agent |
| SessionKey | string | no | The session routing key |
| Description | string | no | The task description |
| Enabled | string | no | Specifies whether the task is enabled. Default value: true |
| DeleteAfterRun | string | no | Specifies whether to automatically delete the task after the first execution. Default value: false |
| Delivery | string | no | The result delivery configuration (JSON-encoded) |
| FailureAlert | string | no | The failure alert configuration (JSON-encoded) |
| RunImmediately | string | no | Specifies whether to run it once immediately after creation. Default value: false |
| Restart | string | no | Specifies whether to restart the gateway after creation. Default value: true |

### Enables PolarFS support
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-polar-fs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/98041.html operation to query the region ID |
| StorageType | string | no | Valid values for the high-performance storage type: ESSDPL0 ESSDPL1 Valid values for the Basic Edition storage type: city_redundancy… |
| AuthorizedUserIds | string | no | The list of authorized account IDs for the Cold Storage Edition instance, separated by commas (,) |
| DBType | string | no | The database engine. Valid values: MySQL PostgreSQL |
| VPCId | string | no | The virtual private cloud (VPC) ID |
| VSwitchId | string | no | The vSwitch ID |
| ZoneId | string | no | The zone ID |
| StorageSpace | integer | no | The storage space. Unit: GB |
| DBClusterId | string | no | The cluster ID |
| PayType | string | no | The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription |
| Period | string | no | The unit of the subscription duration. This parameter is required if PayType is set to Prepaid. Specifies whether the subscription cluster… |
| UsedTime | string | no | The subscription duration. This parameter is required when PayType is set to Prepaid. If Period is set to Month, valid values of UsedTime… |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: Auto-renewal is enabled. false: Auto-renewal is disabled. Default value:… |
| AccelerateSwitch | string | no | The acceleration mode. Valid values: ONLY: enables acceleration only. ON: enables cold data storage and acceleration |
| AccelerateStorageSize | integer | no | The acceleration storage space for the Basic Edition with acceleration enabled. Unit: GB |
| CreationCategory | string | no | The edition. Valid values: basic: Basic Edition (default). cold: Cold Storage Edition. high_performance: High-performance Edition |
| CustomBucketCount | integer | no | The number of buckets. This parameter is required only when acceleration (file system acceleration) is enabled |
| CustomBucketPath | string | no | The bucket path. This parameter is required only when acceleration (file system acceleration) is enabled |
| CustomOssAk | string | no | The custom AccessKey ID |
| CustomOssSk | string | no | The custom AccessKey secret |
| AutoUseCoupon | string | no | Specifies whether to automatically use coupons. Valid values: true: Coupons are automatically used (default). false: Coupons are not used |
| PromotionCode | string | no | The coupon code. If this parameter is not specified, the default coupon is used |
| AccelerateType | string | no | The acceleration type. Valid values: juice: file system acceleration. alluxio: transparent acceleration |
| CustomBucketPathList | string | no | The bucket and path information. This parameter is required for the transparent acceleration scenario (JSON-encoded) |

### Creates a new directory in a specified PolarFS instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-polar-fs-object` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| PolarFsInstanceId | string | yes | The PolarFS instance ID |
| Path | string | yes | The destination path |

### Creates a rate limiting policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-rate-limit-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| GwClusterId | string | yes | The gateway instance ID |
| ScopeType | string | yes | The rate limiting dimension. Valid values: ConsumerGroup: Consumer group Consumer: Consumer |
| ScopeRefId | string | yes | The ID of the consumer group or consumer |
| RateLimitRpm | string | yes | The maximum number of requests per minute |
| RateLimitTpm | string | yes | The maximum number of tokens per minute |
| RegionId | string | no | The ID of the region |

### Creates a resource control rule for a specified PolarDB for MySQL cluster. You can use MaxCpu to specify the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-resource-control` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the PolarDB cluster. You can call the https://help.aliyun.com/document_detail/98041.html operation to query available… |
| DBClusterId | string | yes | The ID of the PolarDB cluster |
| ResourceControlName | string | yes | The name of the resource control rule. The name must be 1 to 63 ASCII characters in length, start with a letter, and contain only letters,… |
| MaxCpu | integer | no | The maximum CPU quota percentage that the resource control rule can use. Valid values: 1 to 100. You must specify exactly one of the… |
| CpuCount | integer | no | The maximum number of CPU cores that the resource control rule can use. The minimum value is 1, and the maximum value is determined by the… |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |

### Purchases a storage plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/create-storage-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotency of the request. You can use the client to generate the token, but you must make… |
| Period | string | yes | The unit of the storage plan duration. Valid values: Month: month. Year: year |
| UsedTime | string | yes | The duration of the storage plan. If Period is set to Month, the value ranges from 1 to 9. If Period is set to Year, valid values are 1,… |
| StorageClass | string | yes | The capacity of the storage plan. Unit: GB. Valid values: 50, 100, 200, 300, 500, 1000, 2000, 3000, 5000, 10000, 15000, 20000, 25000,… |
| StorageType | string | yes | The type of the storage plan. Valid values: Mainland: general-purpose, applicable in the Chinese mainland. Overseas: general-purpose,… |
| AutoUseCoupon | string | no | Specifies whether to automatically use coupons. Valid values: true (default): Uses coupons. false: Does not use coupons |
| PromotionCode | string | no | The coupon code. If this parameter is not specified, the default coupon is used |

### Deletes an AI cluster instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-aidbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The AI cluster ID |
| ModelSpace | string | no | The model operator space |

### Deletes an API key for a model service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-aidbcluster-api-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/98041.html operation to query available region IDs |
| ApiKey | string | yes | The API key of the model service |
| ModelSpaceName | string | no | The model space ID |

### Deletes a custom model registration for an AI cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-aidbcluster-custom-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ModelName | string | yes | The key of the custom model registration to delete |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | no | The cluster ID |
| DatasetId | string | yes | The dataset ID |
| RegionId | string | no | The region ID |

### Deletes a task instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-aidbcluster-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| DBClusterId | string | no | The task ID |
| RelativeDBClusterId | string | no | The ID of the PolarDB database instance for the AI model service |

### Deletes child nodes of an AI instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-ainodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | no | The cluster ID. Call the DescribeAIDBClusters (https://api.aliyun.com/api/polardb/2017-08-01/DescribeAIDBClusters) operation to view the… |
| DBNodeId | string | no | The IDs of the nodes to delete (JSON-encoded) |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| AccountName | string | yes | The account name |

### Deletes an account for a PolarDB on ENS cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-account-zonal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. Note: This parameter accepts only the ID of a PolarDB on ENS cluster (CloudProvider=ENS). For standard cloud clusters, use… |
| AccountName | string | yes | The name of the account |

### Deletes an AgenticDB branch
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-agentic-dbbranch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBClusterId | string | yes | The AgenticDB cluster ID |
| TenantId | string | yes | The tenant ID |
| ProjectId | string | yes | The project ID |
| BranchId | string | yes | The branch ID |

### Deletes an AgenticDB compute cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-agentic-dbcompute-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBClusterId | string | yes | The AgenticDB cluster ID |
| ComputeClusterId | string | no | The branch compute cluster ID |
| TenantId | string | no | The tenant ID |
| ProjectId | string | no | The project ID |
| BranchId | string | no | The branch ID |

### Deletes an AgenticDB project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-agentic-dbproject` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBClusterId | string | yes | The AgenticDB cluster ID |
| TenantId | string | yes | The tenant ID |
| ProjectId | string | yes | The target project ID |

### Deletes an AgenticDB tenant
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-agentic-dbtenant` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBClusterId | string | yes | The ID of the AgenticDB cluster |
| TenantId | string | yes | The ID of the tenant |

### Deletes an API key of an AgenticDB tenant
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-agentic-dbtenant-api-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBClusterId | string | yes | The ID of the AgenticDB cluster |
| TenantId | string | yes | The tenant ID, which is used for secondary verification on the backend |
| ApiKeyId | string | yes | The ID of the API key to delete |

### Deletes the specified PolarDB application. This operation does not delete the associated PolarDB instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | Application ID |

### Deletes a specified connection address for a PolarDB application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-application-endpoint-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The application ID |
| EndpointId | string | yes | The ID of the server-side endpoint to delete |
| NetType | string | yes | The network type of the connection address to delete. The value is fixed to `Public` |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ApplicationId | string | yes | The Application ID |
| PromptId | string | yes | The Prompt ID |

### Deletes the backup sets of a PolarDB cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-backup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| BackupId | string | yes | The backup ID. If you need to specify multiple backup IDs, separate the backup IDs with commas (,). You can call the… |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| BudgetPolicyId | string | yes | The ID of the budget policy to delete. You can obtain the ID from the BudgetPolicyId returned by CreateBudgetPolicy |
| GwClusterId | string | yes | The ID of the gateway instance. You can obtain the ID from the GwClusterId returned by CreateGateway |
| RegionId | string | no | The region ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| GwClusterId | string | yes | The gateway instance ID |
| ConsumerId | string | yes | The consumer ID |
| RegionId | string | no | The region ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| GwClusterId | string | yes | The ID of the gateway instance. You can obtain the ID from the GwClusterId parameter returned by the CreateGateway operation |
| ConsumerGroupName | string | yes | The ID of the consumer group to delete. You can obtain the ID from the ConsumerGroupId parameter returned by the CreateConsumerGroup… |
| RegionId | string | no | The region ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| CostRuleId | string | yes | The ID of the cost rule |
| GwClusterId | string | yes | The ID of the gateway instance |
| RegionId | string | no | The ID of the region |

### Releases a pay-as-you-go PolarDB cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-dbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| CloudProvider | string | no | The cloud service provider to which the instance belongs |
| DBClusterId | string | yes | The cluster ID |
| BackupRetentionPolicyOnClusterDeletion | string | no | The backup data retention policy when the cluster is deleted. Valid values: ALL: Long-term retention (LTR) of all backups. LATEST:… |

### Releases a custom cluster endpoint of a PolarDB cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-dbcluster-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| DBEndpointId | string | yes | The custom cluster endpoint ID |
| PolarFsInstanceId | string | no | The PolarFs instance ID |

### Deletes a cluster endpoint of a PolarDB for Edge cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-dbcluster-endpoint-zonal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| DBEndpointId | string | yes | The custom cluster endpoint ID |

### Releases the public endpoints of a PolarDB cluster, including the primary endpoint, default cluster…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-dbendpoint-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the cluster. You can call the https://help.aliyun.com/document_detail/98094.html operation to query the details of all clusters… |
| DBEndpointId | string | no | The ID of the endpoint. You can call the https://help.aliyun.com/document_detail/98205.html operation to query the endpoints of a… |
| NetType | string | yes | The network type of the endpoint. Set the value to Public (public network) |

### Deletes a DBLink from a PolarDB for PostgreSQL (Compatible with Oracle) cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-dblink` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The ID of the source cluster that contains the DBLink you want to delete. Call the https://help.aliyun.com/document_detail/173433.html… |
| DBLinkName | string | yes | The name of the DBLink to delete |

### Deletes read-only nodes from a PolarDB cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-dbnodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. The client generates this value, which must be unique for each… |
| DBNodeType | string | no | The node type. Valid values: RO STANDBY DLNode |
| DBNodeId | string | yes | The IDs of the nodes to be deleted. Call the https://help.aliyun.com/document_detail/185342.html operation to query the details of all… |
| CloudProvider | string | no | The service provider of the node |

### Deletes a database from a PolarDB cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-database` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| DBName | string | yes | The name of the database |

### Deletes a database in a PolarDB on ENS cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-database-zonal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. Note: The DBClusterId must be the ID of a PolarDB on ENS cluster created by calling CreateDBCluster(CloudProvider=ENS,… |
| DBName | string | yes | The name of the database |

### Deletes a role
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-encryption-dbrole-privilege` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID. Call the https://help.aliyun.com/document_detail/98094.html operation to query the details of all clusters in your… |
| RolePrivilegeNameList | string | no | The name of the role permission |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The ID of the resource group |
| DBClusterId | string | yes | The ID of the cluster |
| Extensions | string | yes | The extensions to uninstall. Separate multiple extension names with a comma (,) |
| DBNames | string | yes | The name of the database |
| VpcId | string | no | The ID of the virtual private cloud (VPC) where the endpoint is located |
| RegionId | string | no | The ID of the region |
| ClientToken | string | no | A client-generated token to ensure that the request is idempotent. The token must be unique for each request. It is case-sensitive and can… |

### Deletes the specified SQL firewall rules
`POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/delete-firewall-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardb.ap-southeast-1.aliyuncs.com |
| DBClusterId | string | yes | The cluster ID |
| RuleNameList | string | yes | The names of the firewall rules to delete. You can specify multiple rule names. Separate the names with commas (,). Call the… |

…and 280 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-polardb/abort-dbcluster-migration" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud ApsaraDB for POLARDB API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-polardb/abort-dbcluster-migration with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud ApsaraDB for POLARDB 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-polardb.

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