# Alibaba Cloud Cloud Native Distribute Database API

> Alibaba Cloud Cloud Native Distribute Database API on Apizie: 229 endpoints (Aligns the primary zone of the storage nodes of a PolarDB-X instance, Calls the AllocateColdDataVolume operation, Enables public network connections for a specified physical ReplicaSet of the context service, Enables a public network connection for a ContextDB-X service ReplicaSet, …) 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://apizie.tech/v1/cloud:aliyun-polardbx/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-polardbx`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/polardbx
- Page: https://apizie.tech/api/cloud/aliyun-polardbx
- OpenAPI: https://apizie.tech/api/cloud/aliyun-polardbx/openapi.json

Alibaba Cloud OpenAPI for Cloud Native Distribute Database (polardbx, version 2020-02-02). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Aligns the primary zone of the storage nodes of a PolarDB-X instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/align-storage-primary-azone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The name of the PolarDB-X instance |
| StorageInstanceName | string | no | The name of the storage instance whose primary node zone needs to be aligned |
| SwitchTime | string | no | The start time of the switch for the storage primary node, in the UTC time format YYYY-MM-DDThh:mm:ssZ |
| SwitchTimeMode | string | no | The switchover mode. Valid values: 0: immediate switchover 1: switchover during the O&M window 2: switchover at a specified time |

### Calls the AllocateColdDataVolume operation
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/allocate-cold-data-volume` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The name of the instance |
| RegionId | string | yes | The region in which the instance resides |

### Enables public network connections for a specified physical ReplicaSet of the context service
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/allocate-context0-public-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The instance name |
| ConnectionStringPrefix | string | no | The prefix of the public network connection string |
| Port | string | no | The port number |
| NodeType | string | no | The target node type. Valid values: service and dashboard |

### Enables a public network connection for a ContextDB-X service ReplicaSet
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/allocate-context-dbpublic-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region in which the instance resides |
| DBInstanceName | string | yes | The instance ID |
| ConnectionStringPrefix | string | no | The prefix of the public network connection string |
| Port | string | no | The port |
| NodeType | string | no | The type of the target node. Valid values: service and dashboard |

### Calls the AllocateInstancePublicConnection operation to create a public IP address
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/allocate-instance-public-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The instance name |
| ConnectionStringPrefix | string | yes | The prefix of the public endpoint |
| Port | string | yes | The port of the public endpoint |
| RegionId | string | no | The region in which the instance resides |
| InstanceClusterName | string | no | The name of the instance CN cluster, such as default |

### Enables the public domain name for a Mem0 instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/allocate-mem0-public-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the instance resides |
| DBInstanceName | string | yes | The name of the instance |
| ConnectionStringPrefix | string | yes | The prefix of the public network connection string |
| Port | string | yes | The port |

### Enables public network connection for PXFS
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/allocate-pxfs-public-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The PolarDB-X instance ID |

### Mounts a columnar instance to a specified primary database instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/attach-columnar-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region in which the instance resides |
| DBInstanceName | string | yes | The instance ID |

### Cancels active O&M event tasks
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/cancel-active-operation-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| Ids | string | yes | The event IDs, separated by commas |

### Modifies the resource group of an instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ResourceType | string | yes | The resource type. Currently, only PolarDB-X 2.0 instances are supported |
| ResourceId | string | yes | The resource ID |
| NewResourceGroupId | string | yes | The new resource group ID |

### Queries whether a PolarDB-X instance is authorized to use Key Management Service (KMS)
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/check-cloud-resource-authorized` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region in which the instance resides |
| DBInstanceName | string | yes | The instance ID |
| RoleArn | string | no | The global resource descriptor ARN (Alibaba Cloud Resource Name) of the authorized role. After the authorization of the role is complete,… |

### Performs a service health check
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/check-health` (byok)

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

### Checks whether SQL audit logs of a specified database instance have been successfully connected to Simple…
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/check-sql-audit-sls-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region in which the instance resides. > You can call the https://help.aliyun.com/document_detail/196841.html operation to query the… |

### Closes the database engine migration process for a specified instance. After a user starts a data migration…
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/close-engine-migration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The instance name |
| RegionId | string | no | The region ID |
| ContinueEnableBinlog | string | no | Specifies whether to keep binlog enabled. Valid values: true: Keeps binlog enabled. false: Disables binlog. Default value: true. Disabling… |

### Confirms that no active connections exist before performing a rollback switchover
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/confirm-no-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | no | The instance name |
| SlinkTaskId | string | yes | The unique ID of the short-link task, which is used to identify the task to be rolled back |

### Creates an account by calling the CreateAccount operation
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the instance resides |
| DBInstanceName | string | yes | The name of the instance |
| AccountName | string | yes | The name of the account to be created |
| AccountPassword | string | yes | The password of the account to be created |
| DBName | string | no | The name of the database to be authorized |
| AccountPrivilege | string | no | The permissions to be granted to the new account on the specified database. Valid values: ReadWrite ReadOnly DMLOnly DDLOnly |
| AccountDescription | string | no | The description of the account |
| SecurityAccountName | string | no | The name of the security administrator account. If the three-role mode is enabled, this parameter is required. If the three-role mode is… |
| SecurityAccountPassword | string | no | The password of the security administrator account. If the three-role mode is enabled, this parameter is required. If the three-role mode… |

### Creates a backup
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-backup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| DBInstanceName | string | yes | The name of the instance |
| BackupType | string | no | The backup type. Valid values: 0: quick backup |

### Creates a context service
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-context0` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the instance resides |
| DBInstanceName | string | yes | The instance ID |
| OpenSearchInstanceName | string | yes | The name of the PolarDB-X Search instance |

### Creates a ContextDB-X instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-context-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the instance resides. > You can call the https://help.aliyun.com/document_detail/196841.html operation to query… |
| DBInstanceName | string | yes | The name of the instance |
| OpenSearchInstanceName | string | yes | The name of the PolarDB-X Search instance |

### Creates a custom endpoint for a database instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-custom-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The instance ID |
| Name | string | yes | The name of the access control instance. The name must be 2 to 128 characters in length and must start with a letter or a Chinese… |
| VpcId | string | yes | The ID of the virtual private cloud (VPC) in which the endpoint resides |
| VSwitchId | string | yes | The vSwitch ID |
| NodeIds | string | yes | The IDs of the monitored nodes when RemindUnit (object type) is set to NODE (node). Separate multiple IDs with commas (,). A maximum of 50… |
| NodeAutoEnter | string | yes | Specifies whether the node automatically joins the cluster and starts providing services after being added or recovered |
| NodeRole | string | no | To query the metrics of a read-only node in a cloud-native read/write splitting architecture instance, specify READONLY for this parameter… |
| RegionId | string | no | The region in which the instance resides |

### Creates a database
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the instance resides |
| DBInstanceName | string | yes | The name of the instance |
| AccountName | string | yes | The name of the account to be authorized for the new database |
| Charset | string | yes | The character set. Valid values: utf8 gbk latin1 utf8mb4 |
| DbName | string | yes | The name of the database to be created |
| AccountPrivilege | string | no | The permissions granted to the new account on the database. Valid values: ReadWrite ReadOnly DMLOnly DDLOnly |
| DbDescription | string | no | The description of the database |
| SecurityAccountName | string | no | The name of the security administrator account. This parameter is required if the three-role mode is enabled. If the three-role mode is… |
| SecurityAccountPassword | string | no | The password of the security administrator account. This parameter is required if the three-role mode is enabled. If the three-role mode… |
| Mode | string | no | The mode selected when creating the database. Valid values: auto: The database supports automatic partitioning. You do not need to specify… |
| StoragePoolName | string | no | The name of the storage pool |

### Creates a PolarDB-X instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region of the instance |
| PayType | string | yes | The billing method of the instance. Valid values: PREPAY: subscription POSTPAY: pay-as-you-go |
| DBNodeCount | integer | no | The number of nodes in the instance. Valid values: Standard Edition: 1 Enterprise Edition: 2 or greater |
| DBNodeClass | string | no | Required when you create a Standard Edition instance. Not required for an Enterprise Edition instance. Local disk specifications for… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You must specify a unique token for each request |
| NetworkType | string | no | The network type of the instance. Only VPC is supported |
| VPCId | string | no | The VPC ID |
| VSwitchId | string | no | The vSwitch ID |
| UsedTime | integer | no | The subscription duration. This parameter is required when the billing method is set to subscription. If Period is set to Year, valid… |
| Period | string | no | The billing cycle. Valid values for subscription instances: Year and Month. Default value for pay-as-you-go instances: Hour |
| ResourceGroupId | string | no | The resource group ID. This parameter is not supported and can be left empty |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Default value: true. Valid values: true: Enables auto-renewal. false: Disables auto-renewal |
| EngineVersion | string | yes | The MySQL DPI engine version. Valid values: 5.7 and 8.0 |
| IsReadDBInstance | string | no | Specifies whether the instance is a read-only instance. Valid values: true: Yes. false: No |
| PrimaryDBInstanceName | string | no | The name of the primary instance. This parameter is required if the instance is a read-only instance |
| TopologyType | string | yes | The topology type. Valid values: 3azones: Three-zone deployment (three active zones). 1azone: Single active zone |
| PrimaryZone | string | no | The primary zone |
| SecondaryZone | string | no | The secondary zone |
| TertiaryZone | string | no | The third active zone in a Three-zone deployment |
| ZoneId | string | no | The zone of the instance |
| CnClass | string | no | The specifications of compute nodes. Required when you create an Enterprise Edition instance. Not required for a Standard Edition… |
| DnClass | string | no | The specifications of storage nodes. Required when you create an Enterprise Edition instance. Not required for a Standard Edition… |
| CNNodeCount | integer | no | The number of compute nodes |
| DNNodeCount | integer | no | The number of storage nodes |
| IsColumnarReadDBInstance | string | no | Specifies whether the instance to be created is a column store read-only instance |
| Series | string | no | The edition of the instance. Valid values: enterprise: Enterprise Edition standard: Standard Edition |
| DnStorageSpace | string | no | The disk space of the storage nodes |
| ExtraParams | string | no | The extra parameters (JSON-encoded) |
| Description | string | no | The description of the database |
| OriginMinorVersion | string | no | The minor engine version. This parameter is generally not required |
| StorageType | string | no | The storage type. Valid values: custom_local_ssd: local disk cloud_auto: cloud disk |

### Creates a data import task to import external data files such as SQL scripts and CSV files into a target…
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-data-import-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the instance resides. > You can call the https://help.aliyun.com/document_detail/196841.html operation to query the… |
| DBInstanceName | string | no | The instance ID. > You can call the https://help.aliyun.com/document_detail/196830.html operation to query the details of all instances in… |
| SrcResId | string | no | The ID of the source ApsaraDB RDS instance. > You can call the https://help.aliyun.com/document_detail/196830.html operation to query the… |
| SrcDb | string | no | The database information of the migration source when the source database is ApsaraDB RDS for MySQL. > The source database must be… |
| SrcUserName | string | no | The username of the source instance |
| SrcPassword | string | no | The read/write mode for executing the import task on the source instance. Valid values: * rw: read/write. * ro: read-only |
| DstResId | string | no | The migration task ID |
| DstDb | string | no | The execution status of the target SQL import. Valid values: * importing: importing. * success: import succeeded. * fail: import failed |
| DstUserName | string | no | The username of the target instance |
| DstPassword | string | no | The password of the privileged account for the target ApsaraDB RDS instance. > * You can call the… |
| SlinkTaskId | string | yes | The import task ID |

### Creates an AI gateway consumer for a PolarDB-X instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-gateway-consumer-for-polar-dbx` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| DBInstanceName | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/196830.html operation to query the details of all instances in… |

### Creates a GDN instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-gdn-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The name of the primary instance |
| RegionId | string | yes | The region where the instance resides |
| Description | string | no | The description information |
| GdnMode | string | no | The GDN mode |
| RplSyncDdl | string | no | Specifies whether to synchronize DDL statements |
| RplDmlStrategy | string | no | The DML replication policy |
| RplConflictStrategy | string | no | The conflict strategy |

### Adds a secondary instance to a global database network (GDN)
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-gdn-standby-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region in which the instance resides |
| PayType | string | yes | The billing method of the instance. PREPAY: subscription POSTPAY: pay-as-you-go |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. Make sure that the value is different for each request |
| NetworkType | string | no | The network type. Only VPC is supported |
| VPCId | string | no | VPC ID |
| VSwitchId | string | no | The vSwitch ID |
| UsedTime | integer | no | The subscription duration. Unit: months or years. If Period is set to Year, valid values of this parameter are 1, 2, and 3 |
| Period | string | no | The unit of the subscription duration. Valid values: Year Month For pay-as-you-go instances, the default value is Hour |
| ResourceGroupId | string | no | The resource group ID. This parameter can be left empty. This parameter is not supported |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Default value: true. true: Enabled. false: Disabled |
| EngineVersion | string | yes | The MySQL DPI engine version. Valid values: 5.7 and 8.0 |
| TopologyType | string | yes | The topology type. Valid values: 3azones: three-zone deployment. 1azone: single-zone deployment |
| PrimaryZone | string | no | The primary zone |
| SecondaryZone | string | no | The secondary zone |
| TertiaryZone | string | no | The zone for Three-zone deployment |
| CnClass | string | no | The compute node specifications. This parameter is required for Enterprise Edition instances and is not required for Standard Edition… |
| DnClass | string | no | The storage node specifications. This parameter is required for Enterprise Edition instances and is not required for Standard Edition… |
| CNNodeCount | string | no | The number of compute nodes |
| DNNodeCount | string | no | The number of storage nodes |
| Description | string | no | The description of the instance |
| CloneInstanceName | string | yes | The name of the source instance |
| SourceInstanceRegion | string | yes | The region in which the source instance resides |
| Series | string | no | The edition of the instance. Valid values: enterprise: Enterprise Edition. standard: Standard Edition |
| StorageType | string | no | The storage type |

### Enables the memory engine
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-mem0` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the instance is located |
| DBInstanceName | string | yes | The name of the instance |

### Creates a PolarDBX Search instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-open-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| PayType | string | yes | The billing method of the instance. Valid values: PREPAY: subscription POSTPAY: pay-as-you-go |
| ZoneId | string | yes | The zone of the instance |
| Zone2 | string | no | The secondary zone. This parameter is required when TopologyType is set to 3azones, and the value must be different from other zones |
| Zone3 | string | no | The third zone for Three-zone deployment. This parameter is required when TopologyType is set to 3azones, and the value must be different… |
| TopologyType | string | no | The active topology type. Valid values: 1azone: single-zone. 3azones: Three-zone deployment |
| VPCId | string | yes | The VPC ID |
| VSwitchId | string | yes | The vSwitch ID |
| EngineVersion | string | no | The database engine version of PolarDBX Search. The current fixed DPI engine version is 3.0. If this parameter is not specified, 3.0 is used |
| DBNodeClass | string | yes | The code for the node specifications of the PolarDBX Search data node. The active node specifications vary by region and sales… |
| NodeCount | integer | yes | The number of PolarDBX Search data nodes. The value must be a positive integer and an integer multiple of the number of selected zones |
| InstanceSpec | string | no | A compatible parameter. This parameter does not take effect. Specify the node specifications of the PolarDBX Search data node by using… |
| StorageType | string | no | The storage type. Default value: cloud_auto |
| StorageSpace | integer | no | The storage space per node, in GB. The value must be a positive integer |
| DBInstanceDescription | string | no | The description of the instance |
| ClientToken | string | no | The idempotency token. Make sure that the value is unique for each creation request |
| ResourceGroupId | string | no | The resource group ID. This parameter can be left empty and is not currently supported |
| Period | string | no | The billing cycle. For subscription instances, only Year and Month are supported. For pay-as-you-go instances, the default value is Hour |
| UsedTime | integer | no | The subscription duration. You can specify a duration in months or years for subscription instances. When Period is set to Year, valid… |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Default value: true. Valid values: true: enables auto-renewal false: disables auto-renewal |

### Creates a PolarDB-X Search instance account
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-open-search-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The name of the instance |
| AccountName | string | yes | The name of the account to be created |
| AccountPassword | string | yes | The password of the account. The password must be 6 to 32 characters in length and contain at least three of the following character… |

### Creates a whitelist group for PolarDB-X Search
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-open-search-whitelist-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/196841.html operation to query the regions… |
| DBInstanceName | string | yes | The name of the instance |
| GroupName | string | yes | The name of the whitelist group |
| IPs | string | yes | The list of source IP addresses |
| Remark | string | no | The description of the group |

### Creates a Supabase instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-polardbx-supabase-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ZoneId | string | yes | The zone ID |
| VpcId | string | yes | VPC ID |
| VSwitchId | string | yes | The vSwitch ID |
| PayType | string | yes | The billing method. Valid values: PREPAY and POSTPAY |
| DbPassword | string | yes | The database password |
| DashboardPassword | string | yes | The Dashboard password |
| TenantMode | string | no | Specifies whether to enable multi-tenant mode |
| NodeSpec | string | no | The node specifications |
| UsedTime | integer | no | The subscription duration |
| Period | string | no | The billing cycle. Valid values: Year, Month, and Hour |
| AutoRenew | string | no | Specifies whether to enable auto-renewal |
| DbInstanceDescription | string | no | The description of the instance |
| ResourceGroupId | string | no | The resource group ID |
| ClientToken | string | no | The idempotency token |

### Creates an Agent file service instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-pxfs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The PolarDB-X instance ID |
| NodeCount | integer | no | The number of nodes |
| ClassCode | string | no | The node specifications |
| StorageSize | integer | no | The storage capacity |
| SecurityIPList | string | no | The IP whitelist |

### Issues an access token for the Agent file service
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-pxfs-access-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The PolarDB-X instance ID |
| TenantId | string | yes | The tenant ID |
| IdentityName | string | yes | The name of the identity |
| TtlSeconds | integer | no | The validity period of the token |
| Label | string | no | The label of the token |

### Creates an Agent file service tenant
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-pxfs-tenant` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The PolarDB-X instance ID |
| TenantId | string | yes | The ID of the tenant |
| TenantName | string | yes | The name of the tenant |
| QuotaBytes | integer | yes | The capacity quota |
| QuotaFiles | integer | yes | The file count quota |
| RateLimitRps | integer | no | The request rate limit |
| RateLimitWbps | integer | no | The write bandwidth limit |

### Creates a tenant identity for the Agent file service
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-pxfs-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The instance ID of the PolarDB-X instance |
| TenantId | string | yes | The tenant ID |
| IdentityName | string | yes | The identity name |
| Role | string | yes | The identity role |
| PosixUid | integer | yes | POSIX UID |
| PosixGid | integer | yes | POSIX GID |

### Creates a PXFuse node
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-pxfuse` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the instance resides |
| DBInstanceName | string | yes | The instance ID |

### Performs a health check on a replication task during data migration
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-rpl-inspection-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| SlinkTaskId | string | yes | The switchover task ID |
| RegionId | string | yes | The region ID. > You can call the https://help.aliyun.com/document_detail/196841.html operation to query the regions supported by… |
| SrcUserName | string | no | The username used to connect to the source instance (source database) |
| SrcPassword | string | no | The password of the source ApsaraDB RDS instance. > You can call the https://help.aliyun.com/document_detail/196830.html operation to… |
| DstResId | string | no | The destination task ID |
| DstDb | string | no | The ID of the ApsaraDB RDS instance to which the migration object belongs in the target instance. > You can invoke the… |
| DstUserName | string | no | The username used to connect to the target instance |
| DstPassword | string | no | The password of the privileged user for the destination ApsaraDB RDS instance. > * The password must be 8 to 32 characters in length. *… |

### Creates a SQL statement assessment task. You submit SQL statements through this operation, and the system…
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-sqlevaluate-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. > You can call the https://help.aliyun.com/document_detail/196841.html operation to query the regions… |
| DBInstanceName | string | yes | The instance ID. > You can call the https://help.aliyun.com/document_detail/196830.html operation to query the details of all instances in… |
| SlinkTaskDesc | string | no | The description of the target SQL statement |
| SrcResId | string | no | The ID of the source ApsaraDB RDS instance. > You can call the https://help.aliyun.com/document_detail/196836.html operation to query the… |
| SrcDb | string | no | Specifies whether to enable the source ApsaraDB RDS instance. Valid values: enable: enables the source ApsaraDB RDS instance. disabled:… |
| SrcUserName | string | no | The username of the source instance |
| SrcPassword | string | no | The port number of the source instance. Valid values: 3200 to 3999. > This parameter is available and required only when… |
| DstResId | string | no | The ID of the target SQL statement. > You can call the https://help.aliyun.com/document_detail/196830.html operation to query the details… |
| DstDb | string | no | The ID of the instance on which the target SQL statement is executed. > You can call the… |
| DstUserName | string | no | The username of the destination instance |
| DstPassword | string | no | The password of the target SQL statement. > You can call the https://help.aliyun.com/document_detail/196830.html operation to query the… |
| SlinkTaskId | string | no | The task ID for executing the target SQL statement. > You can call the https://help.aliyun.com/document_detail/196830.html operation to… |
| SrcResType | string | no | The type of the source instance. Valid values: RDS_MYSQL, POLARX1, POLARX2_STANDARD, POLARX2_ENTERPRISE, and POLARDB_M |

### Creates a service account
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-service-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region in which the instance resides |
| DBInstanceName | string | yes | The instance ID |
| ServiceAccountType | string | yes | The type of the service account |

### Creates a resource storage pool
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-storage-pool` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| DBInstanceName | string | yes | The instance ID |
| ResourceGroupId | string | no | The resource group ID |
| StoragePoolName | string | no | The storage pool name |
| StoragePoolDNList | string | no | The list of storage pool DNs |

### Creates a database schema import task. This operation imports SQL script files or text content that contains…
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-structure-import-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region in which the instance resides |
| DBInstanceName | string | no | The instance ID. > You can call the https://help.aliyun.com/document_detail/196830.html operation to query the details of all instances in… |
| SlinkTaskId | string | yes | The ID of the target task. > You can call the https://help.aliyun.com/document_detail/196830.html operation to query the execution status… |
| Config | string | no | The configuration information |

### Creates a custom endpoint
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-sub-cninstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The instance ID. > You can call the https://help.aliyun.com/document_detail/196830.html operation to query the details of all instances in… |
| IsAutoCreate | string | no | Specifies whether to automatically calculate compute resource parameters. Valid values: true: |
| ReadType | string | no | The read/write type. Valid values: ReadWrite: row store read/write. ColumnarRead: column store read-only |

### Enables the public endpoint for Supabase
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-supabase-net-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The instance name |
| ConnectionString | string | no | The custom endpoint prefix |

### Creates a privileged user. Each instance can have only one privileged user
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-super-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| DBInstanceName | string | yes | The instance name |
| AccountName | string | yes | The account name |
| AccountPassword | string | yes | The account password |
| AccountDescription | string | no | The account description |

### Creates a conversion task to change a specific status or configuration of an instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/create-transform-operation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The ID of the region where the instance resides. > You can call the https://help.aliyun.com/document_detail/196841.html operation to query… |
| DBInstanceName | string | no | The instance ID |
| Operation | string | no | The type of the operation |

### Calls the DeleteAccount operation to delete an account
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The instance name |
| AccountName | string | yes | The name of the account to delete |
| RegionId | string | yes | The region where the instance resides |
| SecurityAccountName | string | no | The name of the security administrator account. If three-role mode is enabled, this parameter is required. If three-role mode is not… |
| SecurityAccountPassword | string | no | The password of the security administrator account. If three-role mode is enabled, this parameter is required. If three-role mode is not… |

### Deletes a context service
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-context0` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region in which the instance resides. > You can call the https://help.aliyun.com/document_detail/196841.html operation to query the… |
| DBInstanceName | string | yes | The name of the instance |

### Deletes a ContextDB-X
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-context-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region in which the instance resides |
| DBInstanceName | string | yes | The instance ID |

### Deletes a custom endpoint domain name
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-custom-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region in which the instance resides |
| DBInstanceName | string | no | The name of the instance |
| CustomEndpointId | string | no | The ID of the custom endpoint |

### Calls the DeleteDB operation to delete a database
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the instance resides |
| DBInstanceName | string | yes | The name of the instance |
| DbName | string | yes | The name of the database to delete |

### Calls the DeleteDBInstance operation to delete an instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region in which the instance resides |
| DBInstanceName | string | yes | The name of the instance |

### Deletes an assessment import task
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-evaluate-and-import-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the instance resides. > You can call the https://help.aliyun.com/document_detail/196841.html operation to query… |
| SlinkTaskId | string | no | The ID of the switch task |

### Deletes a global database network (GDN) instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-gdn-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| GdnInstanceName | string | yes | The name of the GDN instance |
| RegionId | string | no | The region ID |

### Disables the memory engine
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-mem0` (byok)

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

### Releases a PolarDB-X Search instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-open-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The instance name |

### Deletes a PolarDB-X Search instance account
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-open-search-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The instance name |
| AccountName | string | yes | The name of the account to delete |

### Deletes a PolarDB-X Search whitelist group
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-open-search-whitelist-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the instance resides. > You can call the https://help.aliyun.com/document_detail/196841.html operation to query… |
| DBInstanceName | string | yes | The name of the instance |
| GroupId | string | yes | The ID of the service group |

### Deletes a Supabase instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-polardbx-supabase-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The instance name |

### Deletes an Agent file service instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-pxfs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The ID of the PolarDB-X instance |

### Deletes an Agent file service tenant identity
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-pxfs-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The PolarDB-X instance ID |
| TenantId | string | yes | The tenant ID |
| IdentityName | string | yes | The identity name |

### Deletes a PXFuse node
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-pxfuse` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region in which the instance resides |
| DBInstanceName | string | yes | The instance name |

### Deletes a service account
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-service-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region in which the instance resides |
| DBInstanceName | string | yes | The name of the instance |
| ServiceAccountType | string | yes | The type of the service account |

### Deletes a custom address
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-sub-cninstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The instance ID |
| RegionId | string | yes | The region where the instance resides |
| InstanceClusterName | string | no | The InstanceClusterName |

### Releases the public endpoint of a Supabase instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/delete-supabase-net-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The instance name |

### Queries the list of accounts by calling the DescribeAccountList operation
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-account-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the instance resides |
| DBInstanceName | string | yes | The name of the instance |
| AccountName | string | no | The name of the account. Specify this parameter to query a specific account |
| AccountType | string | no | The type of the account. Specify this parameter to query accounts of a specific type. If you set this parameter to null, all accounts are… |

### Queries the O&M time configuration
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-active-operation-maintain-conf` (byok)

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

### Retrieves the total number of O&M events
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-active-operation-task-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| Product | string | no | The product. Default value: polarx |
| Category | string | no | A reserved parameter. You do not need to specify this parameter |

### Queries O&M events
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-active-operation-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| Region | string | no | The region |
| TaskType | string | no | The task type. Set the value to all to query all tasks under the current account |
| ProductId | string | no | The product name. Default value: polarx |
| DbType | string | no | The database type. Set the value to polarx |
| InsName | string | no | The instance name. Default value: an empty string |
| ChangeLevel | string | no | The change level. Default value: all. Valid values: all: all exception fix and system O&M levels S0: exception fix S1: system O&M |
| PageSize | integer | no | The number of entries per page. Default value: 25 |
| PageNumber | integer | no | The page number. The value must be greater than 0. Default value: 1 |
| Status | integer | no | The task status. Valid values: -1: all pending and running tasks 3: pending 4: running |
| AllowChange | integer | no | Specifies whether the time can be modified. Valid values: -1: The time of all O&M events can be modified. 0: The time cannot be modified.… |
| AllowCancel | integer | no | Specifies whether the event can be canceled. Valid values: -1: All O&M events can be canceled. 0: The event cannot be canceled. 1: The… |
| RegionId | string | yes | The region ID |

### Lists cold storage tables
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-archive-table-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The name of the PolarDB-X instance |
| RegionId | string | yes | The region ID |
| PageSize | integer | yes | The number of tables to return on each page. Default value: 20 |
| PageIndex | integer | yes | The page number, starting from 1 |
| SchemaName | string | no | The database name used to filter archived tables |
| TableName | string | no | The table name used to filter archived tables |
| Status | string | no | The archiving status used to filter tables. Valid values: SUCCESS, PAUSE, and RUNNING |

### Queries the list of available regions that support cross-region operations, typically used for multi-region…
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-available-cross-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | no | The instance name |
| RegionId | string | no | The region in which the instance resides |

### Queries the backup settings of an instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the instance resides |
| DBInstanceName | string | yes | The name of the instance |

### Queries the details of a backup set by calling the DescribeBackupSet operation
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-backup-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The name of the PolarDB-X instance |
| BackupSetId | string | yes | The backup set ID |
| RegionId | string | no | The region ID |
| DestCrossRegion | string | no | The destination region for cross-region backup |

### Queries the list of backup sets by calling the DescribeBackupSetList operation
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-backup-set-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the instance resides |
| DBInstanceName | string | yes | The name of the instance |
| StartTime | integer | no | The start time timestamp, in milliseconds |
| EndTime | integer | no | The end time timestamp, in milliseconds |
| PageSize | integer | no | The number of entries per page |
| PageNumber | integer | no | The page number, starting from 1 |
| DestCrossRegion | string | no | The region where the backup set resides. After you specify this parameter, backup sets in the specified region are returned. Only one… |

### Queries binary logs
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-binary-log-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 30 |
| DBInstanceName | string | yes | The name of the instance |
| StartTime | string | yes | The start time of the query. Specify the time in the YYYY-MM-DD HH:mm:ss format |
| EndTime | string | yes | The end time of the query. Specify the time in the YYYY-MM-DD HH:mm:ss format |
| InstanceName | string | no | The name of the instance |

### Queries the list of instance specifications
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-cdc-class-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The instance ID |
| RegionId | string | yes | The region where the instance resides |
| InstanceName | string | no | The instance name |

### Queries CDC information
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-cdc-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the instance resides |
| DBInstanceName | string | yes | The instance name |

### Retrieves a list of CDC versions
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-cdc-version-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The ID of the region where the instance resides |
| DBInstanceName | string | no | The name of the instance |
| InstanceName | string | no | The name of the CDC instance. This parameter specifies the CDC instance for which to query versions |

### Invokes the DescribeCharacterSet operation to query the character set types supported by databases in a…
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-character-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The instance ID |
| RegionId | string | yes | The ID of the region where the instance resides |

### Queries the basic information of cold storage
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-cold-data-basic-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The name of the PolarDB-X instance |
| RegionId | string | yes | The region ID |

### Queries the list of column store specifications for an instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-columnar-class-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | yes | The instance ID |
| RegionId | string | yes | The region in which the instance resides |
| InstanceName | string | no | The instance name |

### Queries column store information
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-columnar-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/196841.html operation to query the regions… |
| DBInstanceName | string | yes | The instance ID |

### Queries the column store version information
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-columnar-version-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region where the instance resides |
| DBInstanceName | string | no | The name of the instance |

### Retrieves the property information of a specified component, including property names and types
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-component-propeties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the instance resides. > You can call the https://help.aliyun.com/document_detail/196841.html operation to query the… |
| CommodityCode | string | yes | The commodity code |
| ComponentName | string | yes | The resource group ID |
| StorageType | string | no | The storage type |

### Queries the management credentials of the context service
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-context0-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region in which the instance resides. > You can call the https://help.aliyun.com/document_detail/196841.html operation to query the… |
| DBInstanceName | string | yes | The name of the instance |

### Queries the information about a context service instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-context0-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the instance resides |
| DBInstanceName | string | yes | The instance name |

### Queries the whitelist for the context service
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-context0-security-ips` (byok)

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

### Queries the management credentials of ContextDB-X
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-context-dbconfig` (byok)

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

### Queries the information of a ContextDB-X instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-context-dbinfo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The instance name |

### Queries the whitelist of a ContextDB-X instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-context-dbsecurity-ips` (byok)

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

### Queries the list of user-defined custom domain names
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-custom-endpoint-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region where the instance resides |
| DBInstanceName | string | yes | The name of the instance |
| CustomEndpointIds | string | no | The custom endpoint IDs |
| CheckDeleteCN | string | no | Specifies whether to check if the CN node has been deleted |

### Queries the attributes of an instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-dbinstance-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The name of the instance |
| ResourceGroupId | string | no | The resource group ID |

### Calls the DescribeDBInstanceConfig operation to retrieve instance configuration parameters
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-dbinstance-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the instance resides |
| DBInstanceName | string | yes | The instance ID |
| ConfigName | string | yes | The configuration identifier. Default value: htap |

### Queries custom endpoints
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-dbinstance-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region in which the instance resides |
| DBInstanceName | string | yes | The instance ID |
| MaxResults | integer | no | The number of entries per page for a paged query. Maximum value: 100. Default value: If the value is not specified or is less than 10, the… |
| NextToken | string | no | The token for the next query |

### Queries the high availability information of an instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-dbinstance-ha` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The name of the PolarDB-X instance |

### Retrieves SSL information
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-dbinstance-ssl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| DBInstanceName | string | no | The instance ID |
| RegionId | string | no | The region ID |

### Queries the details of Transparent Data Encryption (TDE) for an instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-dbinstance-tde` (byok)

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

### Retrieves the topology information of an instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-dbinstance-topology` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| DBInstanceName | string | yes | The instance ID |
| StartTime | string | no | The start time of the historical instance range for the topology query, in the yyyy-MM-dd HH:mm:ss format |
| EndTime | string | no | The end time of the historical instance range for the topology query, in the yyyy-MM-dd HH:mm:ss format |
| MinuteSimple | string | no | Specifies whether to query the historical topology |

### Retrieves the basic information of an instance by using the endpoint of the instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-dbinstance-via-endpoint` (byok)

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

### Queries a list of database instances
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-dbinstances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| PageNumber | integer | no | The page number. Pages start from 1 |
| PageSize | integer | no | The number of entries per page. Valid values: 30 50 100 |
| ResourceGroupId | string | no | The ID of the resource group |
| Tags | string | no | The list of tags |
| InstanceId | string | no | The instance ID |
| Series | string | no | The instance edition. Valid values: enterprise: Enterprise Edition standard: Standard Edition |
| MustHasCdc | string | no | Specifies whether a log engine is required |
| DbVersion | string | no | The database version |
| Description | string | no | The description or remark of the database |

### Queries the performance data of an instance
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-dbnode-performance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| Key | string | yes | The metric names. Separate multiple names with commas (,). You can specify up to 6 metrics. For more information, see… |
| StartTime | string | yes | The start time of the query. Format: YYYY-MM-ddTHH:mmZ (UTC) |
| DBInstanceName | string | yes | The name of the PolarDB-X instance |
| DBNodeIds | string | yes | The node names. Separate multiple names with commas (,). You can specify up to 10 CDC nodes or compute nodes at a time, and up to 1 data… |
| CharacterType | string | yes | The node type. Valid values: polarx_cn, polarx_dn, polarx_cdc, polarx_gms, and polarx_columnar |
| DBNodeRole | string | no | The node role. Valid values: master: primary node. slave: secondary node. Applies to DN and GMS nodes. standby: secondary node. Applies to… |
| RegionId | string | yes | The region ID |
| EndTime | string | yes | The end time of the query. Format: YYYY-MM-ddTHH:mmZ (UTC) |

### Queries the execution details of a data import task
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-data-import-task-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the instance resides |
| FailPageNumber | integer | no | The page number of the failed records |
| FailPageSize | integer | no | The number of failed records to display per page |
| SuccessPageNumber | integer | no | The page number of the successful records |
| SuccessPageSize | integer | no | The number of successful records to display per page |
| SlinkTaskId | string | yes | The task ID |

### Queries the list of databases by calling the DescribeDbList operation
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-db-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| DBInstanceName | string | yes | The instance name |
| DBName | string | no | The database name |

### Queries the list of database tables by calling the DescribeDistributeTableList operation
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-distribute-table-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| DBInstanceName | string | yes | The name of the instance |
| DbName | string | yes | The name of the database |

### Queries the currently enabled cross-zone configurations
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-enabled-cross-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the instance |
| DBInstanceName | string | no | The instance name |

### Queries the list of PolarDB-X assessment import tasks. (single)
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-evaluate-and-import-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the instance resides |
| SlinkTaskId | string | no | The ID of the link task |

### Queries a list of assessment import tasks for PolarDB-X
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-evaluate-and-import-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region in which the instance resides. > You can call the https://help.aliyun.com/document_detail/196841.html operation to query the… |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |

### Retrieves historical events
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| StartTime | string | no | The start time. Specify the time in the YYYY-MM-DDTHH:mm:ssZ format in UTC |
| EndTime | string | no | The end time. Specify the time in the YYYY-MM-DDTHH:mm:ssZ format in UTC |
| PageSize | integer | no | The page size |
| PageNumber | integer | no | The page number |

### Queries the list of global database network (GDN) instances
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-gdn-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| PageSize | string | no | The page size |
| PageNum | string | no | The page number. Valid values: an integer greater than 0 and less than or equal to the maximum value of the Integer data type. Default… |
| FilterType | string | no | The message filter type |
| FilterValue | string | no | The filter value used when querying resources. This parameter is used in conjunction with FilterKey |
| GDNId | string | no | The GDN ID |
| RegionId | string | no | The region ID |

### View Memory Engine Information
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-mem0-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | Region |
| DBInstanceName | string | yes | Instance Name |

### Queries the whitelist of a memory engine
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-mem0-security-ips` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the instance resides |
| DBInstanceName | string | yes | The name of the instance |

### Exposes instance topology information and download links for commercial backup sets to support offline…
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-open-backup-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the instance |
| DBInstanceName | string | yes | The instance name |
| RestoreTime | string | no | The point in time to which you want to restore the instance. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC) |

### Queries the account information of PolarDB-X Search
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-open-search-account-info` (byok)

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

### Queries the connection information of PolarDB-X Search, including internal, public, and Dashboard endpoints…
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-open-search-connection-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The instance name |

### Queries the details of PolarDB-X Search instances
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-open-search-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the instance resides. > You can call the https://help.aliyun.com/document_detail/196841.html operation to query the… |
| DBInstanceName | string | yes | The name of the instance |

### Queries the list of PolarDBX Search instances
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-open-search-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| DBInstanceName | string | no | The instance name |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The page size |
| MaxResults | integer | no | The maximum number of entries per page for a paging query. Maximum value: 100. Default value: If you do not specify a value or the value… |
| NextToken | string | no | The token for the next query |

### Queries the list of PolarDB-X Search nodes
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-open-search-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| DBInstanceName | string | yes | The name of the PolarDB-X instance |

### Queries the resource usage of a PolarDB-X Search cluster
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-open-search-resource-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region in which the instance resides. You can call the https://help.aliyun.com/document_detail/196841.html operation to… |
| DBInstanceName | string | yes | The instance ID |

### Queries the node topology of a PolarDB-X Search cluster
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-open-search-topology` (byok)

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

### Queries the whitelist of a PolarDB-X Search instance. You can filter the results by network type
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-open-search-whitelists` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBInstanceName | string | yes | The instance name |

### Queries the list of database parameter templates created by users or supported by the system, including…
`POST https://apizie.tech/v1/cloud:aliyun-polardbx/describe-parameter-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://polardbx.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region where the instance resides |

…and 109 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-polardbx/align-storage-primary-azone" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Cloud Native Distribute Database API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-polardbx/align-storage-primary-azone with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud Cloud Native Distribute Database API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-polardbx.

### What is the status of the Alibaba Cloud Cloud Native Distribute Database API?
Needs your own provider key (bring your own key)