API standards and multilingual preset SDKs
The OpenAPI of this product (polardbx/2020-02-02) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Instance management
|
API |
Title |
Description |
| CreateDBInstance | Create an instance | Creates a PolarDB-X instance. |
| DeleteDBInstance | Delete an instance | Calls the DeleteDBInstance operation to delete an instance. |
| DescribeDBInstanceAttribute | Retrieve instance attributes | Retrieves the attributes of an instance. |
| DescribeDBInstanceConfig | Query instance configuration parameters | Calls the DescribeDBInstanceConfig operation to retrieve instance configuration parameters. |
| DescribeDBInstances | List database instances | Queries a list of database instances. |
| DescribeDBInstanceSSL | View SSL information | Retrieves SSL information. |
| DescribeDBInstanceTDE | Query TDE details of an instance | Queries the details of Transparent Data Encryption (TDE) for an instance. |
| DescribeDBInstanceTopology | DescribeDBInstanceTopology | Retrieves the topology information of an instance. |
| DescribeDBInstanceViaEndpoint | Retrieve instance information by endpoint | Retrieves the basic information of an instance by using the endpoint of the instance. |
| ModifyDBInstanceConfig | Modify instance configuration item | Calls the ModifyDBInstanceConfig operation to modify an instance configuration item. |
| ModifyDBInstanceDescription | Modify instance description | Calls the ModifyDBInstanceDescription operation to modify the description of an instance. |
| ReleaseInstancePublicConnection | Release the public endpoint of an instance | Releases the public network connection of an instance. |
| RestartDBInstance | Restart an instance | Restarts an instance by calling the RestartDBInstance operation. |
| UpgradeDBInstanceKernelVersion | Upgrade the kernel version of a database instance | Invokes the UpgradeDBInstanceKernelVersion operation to update the kernel version of an instance. |
| ModifyDBInstanceClass | Modify instance specifications | Modifies the specifications of an instance. |
| DescribeDBInstanceHA | Query instance high availability information | Queries the high availability information of an instance. |
| UpdatePolarDBXInstanceNode | Update nodes | Changes the number of nodes for a PolarDB-X instance, including scaling out and scaling in. This request generates an order. |
| ChangeResourceGroup | Modify instance resource group | Modifies the resource group of an instance. |
| DescribeTransformStatus | Query instance upgrade status | Queries the current status of a task that upgrades or converts a standard instance to an Enterprise instance. |
| DescribePolarxDataNodes | View data node information | Queries the details of all data nodes (Data Nodes) in a PolarDB-X instance, including node status, storage usage, and network addresses, to facilitate operations management and monitoring. |
| ModifyDBInstanceMaintainTime | Modify instance maintenance window | Modifies the maintenance window of an instance. |
| ModifyDBInstanceVip | Modify the virtual IP address of an instance | Modifies the virtual IP address or network properties of a database instance. This operation supports changing the internal IP address, adjusting the subnet, and migrating across zones. |
| DescribeRdsVpcs | Query VPC list | Queries the list of VPCs for PolarDB-X. |
| DescribeRdsVswitches | Query vSwitch list | Queries the list of available vSwitches in a virtual private cloud (VPC) for an ApsaraDB RDS instance. |
| DescribeShowStorageInfo | Query storage space information | Queries the storage usage details of an instance, including total capacity, used space, and remaining space. |
| DescribeStoragePoolInfo | Query storage pool information | Queries the details of a storage pool, including capacity, usage, and status. |
| CreateStoragePool | Create a storage pool | Creates a resource storage pool. |
| CreateCustomEndpoint | Create a custom endpoint | Creates a custom endpoint for a database instance. |
| DescribeCustomEndpointList | Query user-defined domain name list | Queries the list of user-defined custom domain names. |
| ModifyCustomEndpointNet | Modify custom network endpoint | Modifies the network configurations of a custom network endpoint, such as the subnet, security group, and public network access settings. |
| DeleteCustomEndpoint | Delete a custom endpoint domain name | Deletes a custom endpoint domain name. |
| ModifyCustomEndpoint | Modify custom endpoint | Modifies the configuration of a custom endpoint. |
| ModifyDBInstanceConnectionString | Modify instance connection string | Modifies the connection string of an instance endpoint. |
| AllocateInstancePublicConnection | Apply for a public endpoint | Calls the AllocateInstancePublicConnection operation to create a public IP address. |
| AllocateColdDataVolume | AllocateColdDataVolume | Calls the AllocateColdDataVolume operation. |
| ReleaseColdDataVolume | ReleaseColdDataVolume | Calls the ReleaseColdDataVolume operation. |
| DescribeColdDataBasicInfo | Query basic information of cold data | Queries the basic information of cold storage. |
Monitoring and logging
|
API |
Title |
Description |
| DescribeSlowLogRecords | Query slow log details | Queries the details of slow SQL statements on compute nodes and storage nodes of a PolarDB-X instance. |
| DescribeDBNodePerformance | Query instance performance data | Queries the performance data of an instance. |
| DescribeSqlAuditInfo | Query SQL audit information | Queries SQL audit information. |
| EnableSqlAudit | Enable SQL audit | Enables the SQL audit feature. |
| DisableSqlAudit | Disable SQL audit | Disables the SQL audit feature. |
| CheckSqlAuditSlsStatus | Check audit status | Checks whether SQL audit logs of a specified database instance have been successfully connected to Simple Log Service (SLS). After the call, the system returns the connection status between the SQL audit feature and SLS for the current instance, the project and Logstore configuration information, and whether synchronization is normal. |
| DescribeEvents | Retrieve historical events | Retrieves historical events. |
| DescribeActiveOperationMaintainConf | Show O&M time configuration | Queries the O&M time configuration. |
| DescribeActiveOperationTasks | Retrieve O&M events | Queries O&M events. |
| DescribeActiveOperationTaskCount | Retrieve the total number of O&M events | Retrieves the total number of O&M events. |
| ModifyActiveOperationMaintainConf | Modify O&M event time configuration | Modifies the time configuration for O&M events. |
Task management
|
API |
Title |
Description |
| DescribeTasks | Retrieve the list of tasks for an instance | Retrieves the list of tasks for an instance. |
| DescribeScaleOutMigrateTaskList | Display data migration task progress | Retrieves the progress of a scale-out migration task. |
| CreateTransformOperation | Create a conversion task | Creates a conversion task to change a specific status or configuration of an instance. |
| DescribeRplInspectionTask | Get instance inspection task | Queries the details of the replication lag inspection task for an instance. |
| SkipCurrentStep | Skip current step | Skips the current step. |
| CreateRplInspectionTask | Replication task health check | Performs a health check on a replication task during data migration. |
| CancelActiveOperationTasks | Cancel active O&M event tasks | Cancels active O&M event tasks. |
| ModifyActiveOperationTasks | Modify O&M event execution time | Modifies the execution time of O&M events. |
SSL encryption
|
API |
Title |
Description |
| UpdateDBInstanceSSL | Update instance SSL configuration | Updates the SSL configuration of an instance. |
Parameter management
|
API |
Title |
Description |
| ModifyParameter | Modify instance parameters | Modifies the parameters of an instance, including the compute and storage layer parameters. |
| DescribeParameterTemplates | View parameter template details | Queries the instance parameter templates. |
| DescribeParameters | Retrieve parameter list | Queries the parameters of an instance. |
| DescribeParameterGroups | Query parameter template information | Queries the list of database parameter templates created by users or supported by the system, including basic information, associated engine types, and modification times of each parameter template. |
Backup management
|
API |
Title |
Description |
| CreateBackup | Create a backup | Creates a backup. |
| DescribeBackupPolicy | Query instance backup settings | Queries the backup settings of an instance. |
| DescribeBackupSetList | Query backup set list | Queries the list of backup sets by calling the DescribeBackupSetList operation. |
| DescribeBinaryLogList | Query binary logs | Queries binary logs. |
| UpdateBackupPolicy | Modify instance backup policy | Modifies the backup policy of an instance. |
| DescribeOpenBackupSet | Retrieve backup set information for offline restoration | Exposes instance topology information and download links for commercial backup sets to support offline restoration of cloud instances. |
| DescribeBackupSet | DescribeBackupSet | Queries the details of a backup set by calling the DescribeBackupSet operation. |
Data security
|
API |
Title |
Description |
| UpdateDBInstanceTDE | Enable instance TDE | Enables Transparent Data Encryption (TDE) for an instance. |
| ModifySecurityIps | Modify instance whitelist | Calls the ModifySecurityIps operation to modify the whitelist of an instance. |
| DescribeUserEncryptionKeyList | Retrieve user TDE key list | Calls the DescribeUserEncryptionKeyList operation to retrieve the list of Transparent Data Encryption (TDE) keys for a user. |
| DescribeSecurityIps | View instance whitelist information | Queries the IP whitelist of an instance. |
| CheckCloudResourceAuthorized | Check KMS key authorization | Queries whether a PolarDB-X instance is authorized to use Key Management Service (KMS). |
| EnableRightsSeparation | Enable three-role mode | Enables three-role mode. |
| DisableRightsSeparation | DisableRightsSeparation | Disables three-role mode. |
Account management
|
API |
Title |
Description |
| ResetAccountPassword | ResetAccountPassword | Resets the password of an account. |
| CreateAccount | Create a standard account | Creates an account by calling the CreateAccount operation. |
| CreateSuperAccount | Create a privileged user | Creates a privileged user. Each instance can have only one privileged user. |
| DeleteAccount | Delete an instance account | Calls the DeleteAccount operation to delete an account. |
| DescribeAccountList | Query instance account information | Queries the list of accounts by calling the DescribeAccountList operation. |
| ModifyAccountDescription | Modify account description of an instance | Modifies the description of an account by calling the ModifyAccountDescription operation. |
| ResetAccountPasswordRestrict | Reset account password | Resets the password of an account. |
| ModifyAccountPrivilege | ModifyAccountPrivilege | Modifies the permissions of a standard account. |
Regions
|
API |
Title |
Description |
| DescribeRegions | View available regions and zones | Calls the DescribeRegions operation to retrieve the list of regions. |
| MigrateDBInstance | Migrate an instance across zones | Migrates an instance from one zone to another. |
| DescribeAvailableCrossRegions | Query cross-zone regions | Queries the list of available regions that support cross-region operations, typically used for multi-region deployment or data replication scenarios. |
| DescribeEnabledCrossRegions | Query enabled cross-zone configurations | Queries the currently enabled cross-zone configurations. |
| AlignStoragePrimaryAzone | Align the primary zone of storage nodes | Aligns the primary zone of the storage nodes of a PolarDB-X instance. |
| SwitchDBInstanceHA | Switch the primary node for high availability | Switches the zone of the primary node for a PolarDB-X instance. |
Database management
|
API |
Title |
Description |
| CreateDB | Create a database | Creates a database. |
| DeleteDB | Delete a database | Calls the DeleteDB operation to delete a database. |
| DescribeCharacterSet | Query character sets | Invokes the DescribeCharacterSet operation to query the character set types supported by databases in a target instance. |
| DescribeDbList | Query database information of an instance | Queries the list of databases by calling the DescribeDbList operation. |
| DescribeDistributeTableList | Query database table list | Queries the list of database tables by calling the DescribeDistributeTableList operation. |
| ModifyDatabaseDescription | Modify database description | Modifies the description of a database. |
| StartSwitchDatabase | Start database cutover | Starts a database cutover for a database migration or synchronization task. |
| DescribeComponentPropeties | Query component properties | Retrieves the property information of a specified component, including property names and types. |
| ModifyEngineMigration | Modify engine migration | Modifies the configuration or migration parameters of a database engine migration task, such as the source database, destination database, migration objects, or migration mode. |
| DescribeArchiveTableList | List cold storage tables | Lists cold storage tables. |
CDC management
|
API |
Title |
Description |
| UpgradeCDCVersion | Upgrade CDC version | Upgrades the CDC node version of a PolarDB-X instance. |
| DescribeCdcInfo | Query CDC instance information | Queries CDC information. |
| DescribeCdcVersionList | Retrieve CDC versions | Retrieves a list of CDC versions. |
| DescribeCdcClassList | List instance specifications | Queries the list of instance specifications. |
| ModifyCdcClass | Modify CDC configuration | Modifies the CDC configuration. |
Column store management
|
API |
Title |
Description |
| AttachColumnarInstance | Mount column store | Mounts a columnar instance to a specified primary database instance. |
| UpgradeColumnarVersion | Update column store version | Updates the column store version. |
| ModifyColumnarClass | Modify column store specifications | Modifies the column store specifications. |
| DescribeColumnarVersionList | Query column store version information | Queries the column store version information. |
| DescribeColumnarInfo | Query column store information | Queries column store information. |
| DescribeColumnarClassList | Query column store specifications | Queries the list of column store specifications for an instance. |
Data migration and synchronization
|
API |
Title |
Description |
| DescribeEvaluateAndImportTask | Query assessment import task list | Queries the list of PolarDB-X assessment import tasks. (single) |
| DescribeEvaluateAndImportTasks | Query assessment import task list | Queries a list of assessment import tasks for PolarDB-X. |
| DeleteEvaluateAndImportTask | Delete an assessment import task | Deletes an assessment import task. |
| CreateSQLEvaluateTask | SQL assessment | Creates a SQL statement assessment task. You submit SQL statements through this operation, and the system performs static analysis and risk assessment to identify execution risks and compatibility issues on the target database instance. |
| CreateStructureImportTask | Create a data schema import task | Creates a database schema import task. This operation imports SQL script files or text content that contains DDL statements into a target database instance and automatically executes structured operations such as creating tables, indexes, views, and stored procedures. |
| DescribeDataImportTaskInfo | Retrieve data import task information | Queries the execution details of a data import task. |
| CloseEngineMigration | Close engine migration | Closes the database engine migration process for a specified instance. After a user starts a data migration task from another database (such as a self-managed MySQL or ApsaraDB RDS instance) to PolarDB-X, this operation can be called to safely stop the migration process if the migration needs to be terminated or the migration state needs to be cleaned up. |
| ConfirmNoConnection | Confirm no connections before rollback switchover | Confirms that no active connections exist before performing a rollback switchover. |
| RestartDataImportTask | Restart a data import task | Restarts a data import task. |
| StopDataImportTask | Stop a data import task | Stops a data import task. |
| CreateDataImportTask | Create a data import task | Creates a data import task to import external data files such as SQL scripts and CSV files into a target database instance. |
| DescribeStructureImportTaskInfo | Query data import task information | Queries the details of a database schema import task. |
| RefreshImportMeta | Refresh import metadata | Refreshes the metadata of an import task. |
GDN management
|
API |
Title |
Description |
| DeleteGdnInstance | Delete a GDN instance | Deletes a global database network (GDN) instance. |
| DescribeGdnInstances | Retrieve GDN instance list | Queries the list of global database network (GDN) instances. |
| SwitchGdnMemberRole | Perform primary/secondary switchover for a GDN | Performs a primary/secondary switchover for a global database network (GDN). |
| CreateGdnInstance | Create a GDN instance | Creates a GDN instance. |
SQL flashback
|
API |
Title |
Description |
| SubmitSqlFlashbackTask | Create a SQL flashback task | Creates a SQL flashback task by calling the SubmitSqlFlashbackTask operation. |
| PreCheckSqlFlashbackTask | Check SQL flashback recovery | Performs a pre-check and feasibility assessment on a recovery task before executing SQL flashback recovery. |
| DescribeSqlFlashbackTaskList | Query SQL flashback task list | Queries the list of SQL flashback tasks by calling the DescribeSqlFlashbackTaskList operation. |
Tag management
|
API |
Title |
Description |
| DescribeTags | Retrieve tag information | Retrieves tag information. |
| ListTagResources | Retrieve label list | Retrieves a list of labels. |
| TagResources | Add tags to resources | Calls the TagResources operation to add tags to resources. |
| UntagResources | Delete tags from a resource | Deletes tags from a resource. |
Others
|
API |
Title |
Description |
| CheckHealth | Check health | Performs a service health check. |
| RestoreDBInstance | Restore an instance | Clones a PolarDB-X instance. |
| CreateMem0 | Enable the memory engine | Enables the memory engine. |
| DescribeMem0Info | View Memory Engine Information | View Memory Engine Information |
| DeleteMem0 | Disable the memory engine | Disables the memory engine. |
| CreateGdnStandbyMember | Add a GDN secondary instance | Adds a secondary instance to a global database network (GDN). |
| CreateSubCNInstance | Create a custom endpoint | Creates a custom endpoint. |
| UpdateCustinsParam | Update instance tags | Updates instance labels. |
| DescribeDBInstanceEndpoint | Query custom endpoints | Queries custom endpoints. |
| DeleteSubCNInstance | Delete a custom address | Deletes a custom address. |
| CreateGatewayConsumerForPolarDBX | Enable AI capabilities for an instance | Creates an AI gateway consumer for a PolarDB-X instance. |
| ResetMem0AccountPassword | Reset the API key of the memory engine | Resets the API key of the memory engine. |
| DescribeMem0SecurityIps | View Memory Engine Whitelist | Queries the whitelist of a memory engine. |
| ModifyMem0SecurityIps | ModifySecurityIps | Modifies the whitelist of a memory engine. |
| AllocateMem0PublicConnection | Enable the public endpoint for the memory engine | Enables the public domain name for a Mem0 instance. |
| ReleaseMem0PublicConnection | Release the public endpoint of the memory engine | Releases the public domain name for a Mem0 instance. |
| DescribeSupabaseInstanceAttribute | Query supabase instance details | Queries the details of a Supabase instance. |
| DescribeSupabaseIpWhitelist | Query supabase IP whitelist | Queries the Supabase IP whitelist. |
| DeleteSupabaseNetType | Disable supabase public network access | Releases the public endpoint of a Supabase instance. |
| CreatePolardbxSupabaseInstance | Create a supabase instance | Creates a Supabase instance. |
| ModifySupabaseDashboardPassword | Modify supabase dashboard password | Modifies the Supabase Dashboard password. |
| RestartSupabaseInstance | Restart a supabase instance | Restarts a Supabase instance. |
| CreateSupabaseNetType | Enable supabase public endpoint | Enables the public endpoint for Supabase. |
| DescribeSupabaseApiKey | Retrieve supabase API key | Queries the Supabase API key. |
| ModifySupabaseSecurityIPList | Modify the supabase IP whitelist | Modifies the IP whitelist for Supabase. |
| DescribeSupabaseInstances | List supabase instances | Queries a list of Supabase instances. |
| DeletePolardbxSupabaseInstance | Delete a supabase instance | Deletes a Supabase instance. |
| AllocateContext0PublicConnection | Enable public network connections for the context service | Enables public network connections for a specified physical ReplicaSet of the context service. |
| AllocateContextDBPublicConnection | Enable public network access for context service | Enables a public network connection for a ContextDB-X service ReplicaSet. |
| AllocatePxfsPublicConnection | Enable public network connection for agent file service | Enables public network connection for PXFS. |
| CreateContext0 | Create a context service | Creates a context service. |
| CreateContextDB | Create a context service | Creates a ContextDB-X instance. |
| CreateOpenSearch | Create a polarDBX search instance | Creates a PolarDBX Search instance. |
| CreateOpenSearchAccount | Create a polarDB-X search instance account | Creates a PolarDB-X Search instance account. |
| CreateOpenSearchWhitelistGroup | Create a whitelist group for polarDB-X search | Creates a whitelist group for PolarDB-X Search. |
| CreatePxfs | Create an agent file service instance | Creates an Agent file service instance. |
| CreatePxfsAccessToken | Issue an access token for the agent file service | Issues an access token for the Agent file service. |
| CreatePxfsTenant | Create an agent file service tenant | Creates an Agent file service tenant. |
| CreatePxfsUser | Create a tenant identity for the agent file service | Creates a tenant identity for the Agent file service. |
| CreatePxfuse | Create an agent observability service | Creates a PXFuse node. |
| CreateServiceAccount | Create a service account | Creates a service account. |
| DeleteContext0 | Delete context service | Deletes a context service. |
| DeleteContextDB | Delete context service | Deletes a ContextDB-X. |
| DeleteOpenSearch | Release a polarDB-X search instance | Releases a PolarDB-X Search instance. |
| DeleteOpenSearchAccount | Delete a polarDB-X search instance account | Deletes a PolarDB-X Search instance account. |
| DeleteOpenSearchWhitelistGroup | Delete a polarDB-X search whitelist group | Deletes a PolarDB-X Search whitelist group. |
| DeletePxfs | Delete an agent file service instance | Deletes an Agent file service instance. |
| DeletePxfsUser | Delete an agent file service tenant identity | Deletes an Agent file service tenant identity. |
| DeletePxfuse | Delete agent observation service | Deletes a PXFuse node. |
| DeleteServiceAccount | Delete a service account | Deletes a service account. |
| DescribeContext0Config | Query context service configuration | Queries the management credentials of the context service. |
| DescribeContext0Info | Query context service instance information | Queries the information about context service instances. |
| DescribeContext0SecurityIps | Query the whitelist for the context service | Queries the whitelist for the context service. |
| DescribeContextDBConfig | View context service configuration | Queries the management credentials of ContextDB-X. |
| DescribeContextDBInfo | View context service | Queries the information of a ContextDB-X instance. |
| DescribeContextDBSecurityIps | View context service whitelist | Queries the whitelist of a ContextDB-X instance. |
| DescribeOpenSearchAccountInfo | Query polarDB-X search account information | Queries the account information of PolarDB-X Search. |
| DescribeOpenSearchConnectionInfo | Query polarDB-X search connection information | Queries the connection information of PolarDB-X Search, including internal, public, and Dashboard endpoints and protocols. |
| DescribeOpenSearchInfo | Query polarDB-X search instance details | Queries the details of PolarDB-X Search instances. |
| DescribeOpenSearchInstances | Query polarDBX search instances | Queries the list of PolarDBX Search instances. |
| DescribeOpenSearchNodes | Query polarDB-X search node list | Queries the list of PolarDB-X Search nodes. |
| DescribeOpenSearchResourceUsage | Query polarDB-X search cluster resource usage | Queries the resource usage of a PolarDB-X Search cluster. |
| DescribeOpenSearchTopology | Query polarDB-X search cluster node topology | Queries the node topology of a PolarDB-X Search cluster. |
| DescribeOpenSearchWhitelists | Query polarDB-X search whitelist | Queries the whitelist of a PolarDB-X Search instance. You can filter the results by network type. |
| DescribePxfsAccessTokens | Query agent file service access token | Queries the access token for the Agent file service. |
| DescribePxfsInfo | Query agent file service instance information | Queries the information about an Agent file service instance. |
| DescribePxfsSecurityIps | Query the whitelist for the agent file service | Queries the whitelist for the Agent file service. |
| DescribePxfsTenant | Query agent file service tenant | Queries the Agent file service tenant. |
| DescribePxfsUsers | Query agent file service tenant identity | Queries the tenant identity of the Agent file service. |
| DescribePxfuseInfo | View agent observation service information | Queries PXFuse instance information. |
| DescribePxfuseSecurityIps | Query agent observability service whitelist | Queries the whitelist of a PXFuse instance. |
| DescribeServiceAccount | Query service account status | Queries the status of a service account. |
| DisableOpenSearchPublicEndpoint | Disable public network access to polarDB-X search | Disables public network access to PolarDB-X Search. |
| EnableOpenSearchPublicEndpoint | Enable polarDBX search public network access | Enables public network access for PolarDBX Search. |
| ExecuteMetaQuery | Execute a read-only metadata query | Executes a metadata query. |
| ModifyContext0SecurityIps | Modify the context service whitelist | Synchronously modifies the whitelists for the context service and dashboard. |
| ModifyContextDBSecurityIps | Modify context service whitelist | Modifies the whitelist of a ContextDB-X service ReplicaSet. |
| ModifyOpenSearchAccessProtocol | Modify polarDB-X search access protocol | Switches the access protocol (HTTP/HTTPS) for PolarDB-X Search. |
| ModifyOpenSearchClass | Modify the specifications of a polarDBX search instance | Modifies the specifications of a PolarDBX Search instance. |
| ModifyOpenSearchWhitelistGroup | Modify a polarDB-X search whitelist group | Modifies a PolarDB-X Search whitelist group. |
| ModifyPxfsSecurityIps | Modify agent file service whitelist | Modifies the whitelist of the Agent file service. |
| ModifyPxfuseSecurityIps | Modify agent observability service whitelist | Modifies the PXFuse node whitelist. |
| QueryColumnarLog | Query column store audit logs | Queries column store audit logs. |
| QueryColumnarLogSSE | Query column store audit logs by streaming | Queries full column store audit logs by using streaming. |
| ReleaseContext0PublicConnection | Release context service public endpoint | Shuts down the public network connection of a specified physical ReplicaSet for the context service. |
| ReleaseContextDBPublicConnection | Release context service public endpoint | Shuts down the public network connection for a ContextDB-X service ReplicaSet. |
| ReleasePxfsPublicConnection | Disable agent file service public network connection | Disables the public network connection for the Agent file service. |
| ResetOpenSearchPassword | Reset polarDB-X search instance account password | Resets the password of a PolarDB-X Search instance without requiring the old password (RAM permission check required). |
| RestartOpenSearch | Restart a polarDB-X search instance | Restarts a PolarDB-X Search instance. |
| RestartPxfs | Restart an agent file service instance | Restarts an Agent file service instance. |
| RevokePxfsAccessToken | Revoke an agent file service access token | Revokes an access token for the Agent file service. |
| ScaleInOpenSearch | Scale in a polarDB-X search instance | Scales in nodes of a PolarDB-X Search cluster. |
| ScaleOutOpenSearch | Scale out a polarDB-X search instance | Scales out nodes in a PolarDB-X Search cluster. |
| UpgradePxfsVersion | Upgrade agent file service minor version | Upgrades the minor version of the Agent file service. |