API overview

更新时间:
复制 MD 格式

API standards and multilingual preset SDKs

The OpenAPI of this product (gpdb/2016-05-03) 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.

AI screenwriting assistant

API

Title

Description

CreateAIService CreateAIService Creates an AI service.
DeleteAIService DeleteAIService Deletes an AI service.
ModifyAIServiceSecurityIps ModifyAIServiceSecurityIps Modifies the IP address whitelist for an AI service.
ListAIServices ListAIServices Lists AI services.
DescribeAIService DescribeAIService Retrieves the details of an AI service.

Model service

API

Title

Description

DescribeModelService DescribeModelService Queries the information about a model service.
DeleteModelService DeleteModelService Delete Model Service
ListSupportModels ListSupportModels Get the list of supported models
ListModelServices ListModelServices Queries all model services.
CreateModelService CreateModelService Creates a model service.

AINode

API

Title

Description

DeleteAINode DeleteAINode Delete AI Node
ListAINodePools ListAINodePools Queries a list of AINode resource pools.
AddAINode AddAINode Adds AI nodes to the cluster.

Supabase

API

Title

Description

Branch management Branch management
CreateBranch Create a branch Creates a Supabase project branch.
ListBranches List Branches Query the branch list of a Supabase project.
GetBranchSchema Get branch schema Retrieves the database schema of a Supabase branch.
DescribeBranch Query branch details Queries the details of a Supabase branch.
DeleteBranch Delete a branch Deletes a Supabase branch.
DeleteSupabaseProject DeleteSupabaseProject Deletes a Supabase project.
PauseSupabaseProject PauseSupabaseProject Pauses a Supabase instance.
ListSupabaseProjectTags ListSupabaseProjectTags Lists the tags of Supabase instances.
ModifySupabaseProjectDescription ModifySupabaseProjectDescription Change the Supabase project description
TagSupabaseProject TagSupabaseProject Adds tags to Supabase project instances.
UntagSupabaseProject UntagSupabaseProject Removes tags from one or more Supabase instances.
ResumeSupabaseProject ResumeSupabaseProject Resumes a Supabase instance.
ListSupabaseProjects ListSupabaseProjects Returns a list of Supabase instances.
GetSupabaseProject GetSupabaseProject Retrieves details of a Supabase instance.
GetSupabaseProjectDashboardAccount GetSupabaseProjectDashboardAccount Retrieves the username and password for the dashboard of a specific Supabase project.
GetSupabaseProjectApiKeys GetSupabaseProjectApiKeys Queries the API keys and JWT secrets for a Supabase instance.
ModifySupabaseProjectSecurityIps ModifySupabaseProjectSecurityIps Modifies the IP address whitelist for a Supabase project.
ModifySupabaseProjectResource ModifySupabaseProjectResource Scales the compute resource or expands the storage resource (cloud disk size) for a Supabase project.
ResetSupabaseProjectPassword ResetSupabaseProjectPassword Reset the password of a Supabase database
ModifySupabaseAutoScalePolicy ModifySupabaseAutoScalePolicy Modifies the auto-scaling policy of an ADBPG Supabase instance.
GetSupabaseProjectApiKeys GetSupabaseProjectApiKeys Queries the API keys and JWT secrets for a Supabase instance.
ModifySupabaseProjectSecurityIps ModifySupabaseProjectSecurityIps Modifies the IP address whitelist for a Supabase project.
ModifySupabaseProjectResource ModifySupabaseProjectResource Scales the compute resource or expands the storage resource (cloud disk size) for a Supabase project.
ResetSupabaseProjectPassword ResetSupabaseProjectPassword Reset the password of a Supabase database
ModifySupabaseAutoScalePolicy ModifySupabaseAutoScalePolicy Modifies the auto-scaling policy of an ADBPG Supabase instance.

Context service

API

Title

Description

ExecuteStatement Execute SQL statement Execute an SQL statement.
DescribeTable View table details View table details.
ListSaasService SaaS Service List Query SaaS Service List
ListWorkspaces List workspaces Queries the list of SaaS workspaces.
DeleteSaasService Delete a saaS service Deletes a SaaS service.

Data API

API

Title

Description

ExecuteStatement Execute SQL statement Execute an SQL statement.
DescribeTable View table details View table details.
ListTables ListTables Queries a list of tables in a database.
ListDatabases ListDatabases Queries a list of databases.

RAG Service

API

Title

Description

InitVectorDatabase InitVectorDatabase Initializes vector databases.
Manage namespaces Manage namespaces
ModifyStreamingDataService Modify a real-time data service Modify a real-time data service.
DeleteStreamingDataService Delete a real-time data service Delete a real-time data service.
ListNamespaces ListNamespaces Queries a list of namespaces.
DeleteNamespace DeleteNamespace Deletes a namespace.
Manage vector collections Manage vector collections
DeleteStreamingJob Delete a real-time data synchronization task Delete a real-time data synchronization task.
DescribeCollection DescribeCollection Queries the information about a vector collection.
ListCollections ListCollections Queries a list of vector collections.
ModifyCollection ModifyCollection Updates a vector collection.
DeleteCollection DeleteCollection Deletes a vector collection.
GrantCollection GrantCollection Grants vector collection permissions to a namespace.
Manage documents Manage documents
Upload documents Upload documents
UpsertChunks UpsertChunks Splits a document into chunks and uploads the vectorized chunks to a document collection.
UploadDocumentAsync UploadDocumentAsync Asynchronous Document Upload
GetUploadDocumentJob GetUploadDocumentJob Queries the progress and result of an asynchronous document upload job based on the job ID.
CancelUploadDocumentJob CancelUploadDocumentJob Cancels an asynchronous document upload job based on the job ID.
GetGraphRAGJob GetGraphRAGJob Retrieves a task to build a knowledge graph.
Search Search
QueryKnowledgeBasesContent QueryKnowledgeBasesContent Retrieve vectors and metadata from specified knowledge bases using a natural-language query, returning the merged results from a multi-channel recall.
QueryContent QueryContent Query a document collection with natural language to retrieve vectors and metadata.
Knowledge base Q&A Knowledge base Q&A
ChatWithKnowledgeBaseStream ChatWithKnowledgeBaseStream This service combines a knowledge base with a large model to provide intelligent Q&A. You can access the streaming interface using Server-Sent Events (SSE) or the Java asynchronous SDK.
ChatWithKnowledgeBase ChatWithKnowledgeBase Combines a knowledge base with a large language model for intelligent Q&A.
View and delete documents View and delete documents
ListDocuments ListDocuments Queries a list of documents in a collection.
ListChunks ListChunks Get document chunk details
DescribeDocument DescribeDocument Queries the information about a document.
DeleteDocument DeleteDocument Delete Document
DeleteChunks DeleteChunks Deletes chunks from a document collection.
Manage document libraries Manage document libraries
CreateDocumentCollection Create Document Library Create a knowledge base
ListDocumentCollections ListDocumentCollections Lists document collections.
DeleteDocumentCollection DeleteDocumentCollection Delete Knowledge Base
EnableCollectionGraphRAG EnableCollectionGraphRAG Enables knowledge graph construction for the knowledge base.
Manage vectors Manage vectors
Upload vector data Upload vector data
UpsertCollectionData UpsertCollectionData Uploads vector data to a vector collection.
UpsertCollectionDataAsync UpsertCollectionDataAsync Uploads vector data in an asynchronous manner by using an on-premises file or a password-free Internet-accessible file URL. The vector data can be up to 200 MB in size.
GetUpsertCollectionDataJob GetUpsertCollectionDataJob Queries the progress and result of an asynchronous vector data upload job by using a job ID.
CancelUpsertCollectionDataJob CancelUpsertCollectionDataJob Cancels an asynchronous vector data upload job by using a job ID.
Search Search
QueryCollectionData Recall Vector Data Retrieving vector data.
Manage vector data Manage vector data
UpdateCollectionDataMetadata UpdateCollectionDataMetadata Update Metadata of Collection Data
DeleteCollectionData DeleteCollectionData Deletes vector data.
Index management Index management
CreateVectorIndex Create Vector Index Creates an index for a vector collection.
DeleteVectorIndex DeleteVectorIndex Deletes a vector index.
DescribeCreateIndexJob DescribeCreateIndexJob Queries the information about an index creation job.
CancelCreateIndexJob CancelCreateIndexJob Cancels an index creation job.
ListIndices ListIndices Queries a list of indexes.
DescribeIndex DescribeIndex Retrieves the information about an index.
Embedding Embedding
TextEmbedding TextEmbedding Generates text embeddings using an embedding model.
Rerank Rerank
Rerank Rerank The Rerank operation can resolve the issue of inaccurate ranking of vector and full-text search results. It re-scores and reranks the retrieved data through semantic understanding to significantly improve the relevance and accuracy of the results. AnalyticDB for PostgreSQL allows you to rerank search results by using Rerank models, but does not provide models.
RAG service privatization RAG service privatization
DescribeZonesPrivateRAGService DescribeZonesPrivateRAGService Obtains the deployable zone of the private RAG service.
DeployPrivateRAGService DeployPrivateRAGService Deploy a private RAG service.
DescribePrivateRAGService DescribePrivateRAGService Obtains the details of a private RAG service.
DeletePrivateRAGService DeletePrivateRAGService Deletes a private RAG service.

Real-time data consumption

API

Title

Description

Real-time data sources Real-time data sources
ListStreamingDataSources ListStreamingDataSources Queries a list of real-time service data sources.
DeleteStreamingDataSource Delete Real-time Data Source Delete a real-time data source.
ModifyStreamingDataSource ModifyStreamingDataSource Modifies a real-time service data source.
CreateStreamingDataSource CreateStreamingDataSource Creates a real-time data source.
DescribeStreamingDataSource Query Real-time Data Source Get external data source configuration information
Real-time data services Real-time data services
ListStreamingDataServices ListStreamingDataServices Create External Data Source Configuration
CreateStreamingDataService CreateStreamingDataService Create External Data Source Configuration
ModifyStreamingDataService Modify a real-time data service Modify a real-time data service.
DescribeStreamingDataService DescribeStreamingDataService Queries a real-time data service.
DeleteStreamingDataService Delete a real-time data service Delete a real-time data service.
Real-time data synchronization tasks Real-time data synchronization tasks
ModifyStreamingJob ModifyStreamingJob Create External Data Source Configuration
DescribeStreamingJob DescribeStreamingJob Queries a real-time data synchronization job.
CreateStreamingJob CreateStreamingJob Create External Data Source Configuration
DeleteStreamingJob Delete a real-time data synchronization task Delete a real-time data synchronization task.
ListStreamingJobs ListStreamingJobs Queries real-time data synchronization jobs.

Plugin management

API

Title

Description

ListDatabaseExtensions ListDatabaseExtensions List all extensions installed in the instance.
DescribeExtension DescribeExtension Describes the extension information.
UpgradeExtensions UpgradeExtensions Updates extensions.
ListInstanceExtensions ListInstanceExtensions Queries a list of extensions.
CreateExtensions CreateExtensions Installs extensions.
DeleteExtension DeleteExtension Uninstalls extensions.

External data management

API

Title

Description

Heterogeneous data source management Heterogeneous data source management
External data services External data services
DescribeExternalDataService DescribeExternalDataService Queries the information about an external data service.
DeleteExternalDataService Delete External Data Service Delete External Data Service
ListExternalDataServices ListExternalDataServices Queries a list of external data services.
CreateExternalDataService Create External Data Service Create External Data Service
ModifyExternalDataService ModifyExternalDataService Modify External Data Service
DescribeHadoopClustersInSameNet DescribeHadoopClustersInSameNet Retrieves E-MapReduce (EMR) clusters in the same Virtual Private Cloud (VPC).
Hadoop data sources Hadoop data sources
DescribeHadoopConfigs DescribeHadoopConfigs Queries the configuration information about a Hadoop cluster.
CreateHadoopDataSource Create Hadoop External Data Source Create Hadoop data source configuration
DescribeHadoopDataSource DescribeHadoopDataSource Obtains the configurations of a Hadoop data source.
ModifyHadoopDataSource ModifyHadoopDataSource Modifies the configurations of a Hadoop data source.
CheckHadoopDataSource CheckHadoopDataSource Checks the configurations of a Hadoop data source.
DeleteHadoopDataSource Delete a Hadoop external data source Delete a Hadoop external data source.
CheckHadoopNetConnection CheckHadoopNetConnection Checks the network connectivity of a Hadoop external data source.
JDBC data sources JDBC data sources
CreateJDBCDataSource CreateJDBCDataSource Creates a JDBC data source.
ModifyJDBCDataSource ModifyJDBCDataSource Modifies the configurations of a Java Database Connectivity (JDBC) data source.
CheckJDBCSourceNetConnection CheckJDBCSourceNetConnection Check the network connectivity of the JDBC connection string
DescribeJDBCDataSource DescribeJDBCDataSource Queries the configurations of a Java Database Connectivity (JDBC) data source.
DeleteJDBCDataSource Delete JDBC Data Source Configuration Delete JDBC data source
Other data sources Other data sources
ListExternalDataSources ListExternalDataSources Queries a list of data sources.

Create instances

API

Title

Description

ModifyDBInstanceDeploymentMode ModifyDBInstanceDeploymentMode Changes the development mode of an instance.

Instance management

API

Title

Description

UpgradeDBInstance UpgradeDBInstance Changes the specifications of an AnalyticDB for PostgreSQL instance.
ModifyDBInstanceDescription ModifyDBInstanceDescription Changes the description of an AnalyticDB for PostgreSQL instance.
ModifyDBInstanceMaintainTime ModifyDBInstanceMaintainTime Modifies the maintenance window of an AnalyticDB for PostgreSQL instance.
ModifyDBInstanceResourceGroup ModifyDBInstanceResourceGroup Moves an AnalyticDB for PostgreSQL instance to a resource group.
ModifyVectorConfiguration ModifyVectorConfiguration Modifies the vector search engine optimization configuration of an AnalyticDB for PostgreSQL instance.
PauseInstance PauseInstance Pauses an AnalyticDB for PostgreSQL instance.
RebalanceDBInstance RebalanceDBInstance Rebalances an AnalyticDB for PostgreSQL instance.
RestartDBInstance RestartDBInstance Restarts an AnalyticDB for PostgreSQL instance.
ResumeInstance ResumeInstance Resumes an AnalyticDB for PostgreSQL instance.
UpgradeDBVersion UpgradeDBVersion Upgrades the minor version of an AnalyticDB for PostgreSQL instance.
ModifyDBInstanceDeploymentMode ModifyDBInstanceDeploymentMode Changes the development mode of an instance.

Instance specification change

API

Title

Description

DescribeDBInstanceAttribute Query instance details Query the details of an AnalyticDB for PostgreSQL instance.
DescribeDBInstances DescribeDBInstances Lists AnalyticDB for PostgreSQL instances.
UpgradeDBInstance UpgradeDBInstance Changes the specifications of an AnalyticDB for PostgreSQL instance.
PauseDataRedistribute PauseDataRedistribute Pauses data redistribution.
ResumeDataRedistribute ResumeDataRedistribute Resumes data redistribution.

Query instances

API

Title

Description

CreateBackup CreateBackup Creates a backup set.
DeleteBackup DeleteBackup Deletes a backup set. You can call this operation to delete only physical backup sets that are manually backed up.
ListBackupJobs ListBackupJobs Queries a list of backup jobs.
DescribeBackupJob DescribeBackupJob Queries the information about a backup job.
CloneDBInstance CloneDBInstance Restores data to a new AnalyticDB for PostgreSQL instance.

Parameter management

API

Title

Description

GetAccount GetAccount Queries the information about a database account.
DescribeParameters DescribeParameters Queries the information about configuration parameters for an AnalyticDB for PostgreSQL instance.
ModifyParameters ModifyParameters Modifies the configuration parameters of an AnalyticDB for PostgreSQL instance.

Backup management

API

Title

Description

DescribeDataSharePerformance View performance metrics for data sharing Queries the performance metrics of data sharing.
SetDataShareInstance Add or remove an instance from data sharing Add or remove an AnalyticDB for PostgreSQL instance from data sharing.
DescribeLogBackups DescribeLogBackups Queries a list of log backups.
ModifyBackupPolicy ModifyBackupPolicy Configures the backup policy of an AnalyticDB for PostgreSQL instance.
CreateBackup CreateBackup Creates a backup set.
DeleteBackup DeleteBackup Deletes a backup set. You can call this operation to delete only physical backup sets that are manually backed up.
ListBackupJobs ListBackupJobs Queries a list of backup jobs.
DescribeBackupJob DescribeBackupJob Queries the information about a backup job.
CloneDBInstance CloneDBInstance Restores data to a new AnalyticDB for PostgreSQL instance.

Account management

API

Title

Description

DescribeDBClusterPerformance View instance Performance Data View the Performance Monitoring of an AnalyticDB for PostgreSQL instance over a specified time period.
DescribeDownloadRecords DescribeDownloadRecords Queries the download records for query diagnostic information for AnalyticDB for PostgreSQL.
GetAccount GetAccount Queries the information about a database account.
DeleteAccount DeleteAccount Deletes a database account.
DescribeDiagnosisDimensions DescribeDiagnosisDimensions Queries all databases and database accounts of an AnalyticDB for PostgreSQL instance.
ModifyAccountDescription ModifyAccountDescription Modifies the description of a database account for an AnalyticDB for PostgreSQL instance.
ResetAccountPassword ResetAccountPassword Resets the password of a database account for an AnalyticDB for PostgreSQL instance.
DescribeRoles DescribeRoles Queries a list of roles.

Data sharing

API

Title

Description

DescribeDataShareInstances DescribeDataShareInstances Queries the status of data sharing for AnalyticDB for PostgreSQL instances.
DescribeDataSharePerformance View performance metrics for data sharing Queries the performance metrics of data sharing.
SetDataShareInstance Add or remove an instance from data sharing Add or remove an AnalyticDB for PostgreSQL instance from data sharing.

Diagnostics and optimization

API

Title

Description

DescribeSQLLogCount Obtain the Quantity of SQL Audit Logs Obtain the quantity of audit logs for an AnalyticDB for PostgreSQL instance.
DescribeDBInstanceDataBloat DescribeDBInstanceDataBloat Queries the information about data bloat for an AnalyticDB for PostgreSQL instance.
DescribeDBInstanceDataSkew DescribeDBInstanceDataSkew Queries the information about data skew for an AnalyticDB for PostgreSQL instance.
DescribeDBInstanceDiagnosisSummary DescribeDBInstanceDiagnosisSummary Queries the information about nodes in an AnalyticDB for PostgreSQL instance.
DescribeDBInstanceIndexUsage DescribeDBInstanceIndexUsage Queries the index usage of an AnalyticDB for PostgreSQL instance.
DescribeDBInstancePerformance DescribeDBInstancePerformance Queries the information about performance metrics of an AnalyticDB for PostgreSQL instance within a time range.
DescribeDiagnosisMonitorPerformance DescribeDiagnosisMonitorPerformance Queries the details of query execution on an AnalyticDB for PostgreSQL instance.
DescribeDiagnosisRecords DescribeDiagnosisRecords Queries the information about SQL queries for an AnalyticDB for PostgreSQL instance.
DescribeDiagnosisSQLInfo DescribeDiagnosisSQLInfo Queries the information about a query for an AnalyticDB for PostgreSQL instance.
DescribeDownloadRecords DescribeDownloadRecords Queries the download records for query diagnostic information for AnalyticDB for PostgreSQL.
DescribeDownloadSQLLogs DescribeDownloadSQLLogs Queries the last five download records of slow query logs for an AnalyticDB for PostgreSQL instance.
DescribeHealthStatus DescribeHealthStatus Queries the health status of an AnalyticDB for PostgreSQL instance and its nodes.
DescribeWaitingSQLInfo DescribeWaitingSQLInfo Queries the information about a lock-waiting query for an AnalyticDB for PostgreSQL instance.
DescribeWaitingSQLRecords DescribeWaitingSQLRecords Queries the lock diagnostic records of an AnalyticDB for PostgreSQL instance.
DownloadDiagnosisRecords DownloadDiagnosisRecords Downloads the query diagnostic information of an AnalyticDB for PostgreSQL instance.
DownloadSQLLogsRecords DownloadSQLLogsRecords Download the slow query logs of an AnalyticDB for PostgreSQL instance.

Plan management

API

Title

Description

DescribeAvailableResources DescribeAvailableResources Gets the purchasable resources for AnalyticDB for PostgreSQL.
DeleteDBInstancePlan DeleteDBInstancePlan Deletes a plan from an AnalyticDB for PostgreSQL instance.
DescribeDBInstancePlans DescribeDBInstancePlans Queries the information about plans for an AnalyticDB for PostgreSQL instance.
SetDBInstancePlanStatus SetDBInstancePlanStatus Enables or disables a plan for an AnalyticDB for PostgreSQL instance.
UpdateDBInstancePlan UpdateDBInstancePlan Modifies a plan for an AnalyticDB for PostgreSQL instance.

Tag management

API

Title

Description

DescribeDBResourceGroup DescribeDBResourceGroup Retrieves the details of one or more resource groups.

Security management

API

Title

Description

Whitelist management Whitelist management
CreateDBInstanceIPArray CreateDBInstanceIPArray Adds an IP whitelist group.
DescribeDBInstanceIPArrayList DescribeDBInstanceIPArrayList Queries the whitelists of IP addresses that are allowed to access an AnalyticDB for PostgreSQL instance.
ModifySecurityIps ModifySecurityIps Modifies the IP address whitelist of an AnalyticDB for PostgreSQL instance.
DeleteDBInstanceIPArray DeleteDBInstanceIPArray Deletes an IP whitelist group from an instance.
CreateDatabase CreateDatabase Creates a database.
DownloadSlowSQLRecords DownloadSlowSQLRecords Downloads slow SQL records.
DeleteDatabase DeleteDatabase Deletes a database from an instance.
DescribeDatabase DescribeDatabase Describes the basic information about an AnalyticDB for PostgreSQL database.

Log management

API

Title

Description

AllocateInstancePublicConnection AllocateInstancePublicConnection Allocates a public endpoint for an AnalyticDB for PostgreSQL instance.
BindDBResourceGroupWithRole BindDBResourceGroupWithRole Binds a resource group to a database role.
CancelUploadDocumentJob CancelUploadDocumentJob Cancels an asynchronous document upload job based on the job ID.
ChatWithKnowledgeBase ChatWithKnowledgeBase Combines a knowledge base with a large language model for intelligent Q&A.

Network management

API

Title

Description

AllocateInstancePublicConnection AllocateInstancePublicConnection Allocates a public endpoint for an AnalyticDB for PostgreSQL instance.
DescribeDBInstanceNetInfo DescribeDBInstanceNetInfo Queries the connection information of an instance.
DescribeRdsVpcs DescribeRdsVpcs Queries a list of VPCs.
DescribeRdsVSwitchs DescribeRdsVSwitchs Queries a list of vSwitches.
ModifyDBInstanceConnectionString ModifyDBInstanceConnectionString Changes the endpoint of an AnalyticDB for PostgreSQL instance.
ReleaseInstancePublicConnection ReleaseInstancePublicConnection Releases the public endpoint of an AnalyticDB for PostgreSQL instance.
SwitchDBInstanceNetType SwitchDBInstanceNetType Switches between the internal and public endpoints of an AnalyticDB for PostgreSQL instance.

Resource management

API

Title

Description

DescribeAvailableResources DescribeAvailableResources Gets the purchasable resources for AnalyticDB for PostgreSQL.

Sample datasets

API

Title

Description

CreateSampleData CreateSampleData Creates a sample dataset for an AnalyticDB for PostgreSQL instance.
DescribeSampleData DescribeSampleData Queries whether a sample dataset is loaded to an AnalyticDB for PostgreSQL instance.
UnloadSampleData UnloadSampleData Releases the sample dataset from an AnalyticDB for PostgreSQL instance.

Resource groups

API

Title

Description

EnableDBResourceGroup EnableDBResourceGroup Enables resource group management for an AnalyticDB for PostgreSQL V6.0 instance in elastic storage mode. After resource group management is enabled, the resource management mode of the instance is changed from resource queue to resource group.
DisableDBResourceGroup DisableDBResourceGroup Disables resource group management for an AnalyticDB for PostgreSQL V6.0 instance in elastic storage mode. After you disable resource group management, the resource management method of the instance switches from resource group management to resource queue management.
CreateDBResourceGroup CreateDBResourceGroup Creates a resource group.
DeleteDBResourceGroup DeleteDBResourceGroup Deletes a resource group.
ModifyDBResourceGroup ModifyDBResourceGroup Modifies the configurations of a resource group.
DescribeDBResourceGroup DescribeDBResourceGroup Retrieves the details of one or more resource groups.
BindDBResourceGroupWithRole BindDBResourceGroupWithRole Binds a resource group to a database role.
UnbindDBResourceGroupWithRole UnbindDBResourceGroupWithRole Unbinds database roles from a resource group.
DescribeDBResourceManagementMode DescribeDBResourceManagementMode Queries the resource management mode of an AnalyticDB for PostgreSQL instance.

Others

API

Title

Description

ModifyMasterSpec ModifyMasterSpec Changes the specifications of coordinator node resources for an AnalyticDB for PostgreSQL instance.
DescribeSQLLogs DescribeSQLLogs Queries the SQL execution logs of an AnalyticDB for PostgreSQL instance.
HandleActiveSQLRecord HandleActiveSQLRecord Processes active queries.
DescribeDBInstanceSupportMaxPerformance DescribeDBInstanceSupportMaxPerformance Queries the maximum performance of an AnalyticDB for PostgreSQL instance.
ResetIMVMonitorData ResetIMVMonitorData Resets the IMV statistics.
DescribeIMVInfos DescribeIMVInfos Queries the information about real-time materialized views of an AnalyticDB for PostgreSQL instance.
DescribeActiveSQLRecords DescribeActiveSQLRecords Queries active SQL records.
ModifyDBInstancePayType ModifyDBInstancePayType Switches between billing methods for an AnalyticDB for PostgreSQL instance.
ModifyDBInstanceNetworkType ModifyDBInstanceNetworkType Changes the network type of an AnalyticDB for PostgreSQL instance.
DeleteRemoteADBDataSource DeleteRemoteADBDataSource Deletes a remote AnalyticDB data source.
CreateRemoteADBDataSource CreateRemoteADBDataSource Create Homogeneous Data Source
ListRemoteADBDataSources ListRemoteADBDataSources Queries remote AnalyticDB data sources.
ModifyRemoteADBDataSource ModifyRemoteADBDataSource Modifies a remote AnalyticDB data source.
GetStatementResult GetStatementResult Get Asynchronous SQL Execution Result
CreateDatabase CreateDatabase Creates a database.
ListSlowSQLRecords ListSlowSQLRecords Queries slow SQL queries.
DownloadSlowSQLRecords DownloadSlowSQLRecords Downloads slow SQL records.
DeleteDatabase DeleteDatabase Deletes a database from an instance.
DescribeRebalanceStatus DescribeRebalanceStatus Queries the rebalance status of an AnalyticDB for PostgreSQL instance.
DescribeDatabase DescribeDatabase Describes the basic information about an AnalyticDB for PostgreSQL database.
ListInstanceDatabases ListInstanceDatabases List all databases in an AnalyticDB for PostgreSQL instance.
CreateIndex CreateIndex Creates an index. Note: 1. Only scalar indexes are supported. 2. The table is write-locked during index creation. 3. When creating an index on a table with a large volume of data, the process consumes significant CPU and I/O resources of the instance. If this impacts instance availability, call CancelCreateIndexJob to cancel the index creation.
CreateSecret CreateSecret Creates an access credential for an AnalyticDB for PostgreSQL instance by using the name and password of a database account.
CreateServiceLinkedRole CreateServiceLinkedRole Creates a service-linked role.
DeleteIndex DeleteIndex Deletes an index.
DeleteSecret DeleteSecret Deletes the access credentials of an AnalyticDB for PostgreSQL instance.
DescribeRegions DescribeRegions Queries the regions and zones where you can create AnalyticDB for PostgreSQL instances.
GetSecretValue GetSecretValue Queries the information about an access credential.
ListSchemas ListSchemas Queries a list of schemas.
ListSecrets View the access credential list View the access credential list.
ListTagResources Query tags attached to instances List all tag resources.
TagResources Create and attach tags Create and attach tags.
UntagResources UntagResources Removes tags from AnalyticDB for PostgreSQL instances. If the tags that you remove are not added to other instances, the tags are automatically deleted.