本产品（
云原生数据仓库 AnalyticDB PostgreSQL版/2016-05-03）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
Data API
| API | 标题 | API概述 |
|---|---|---|
| ExecuteStatement | 执行SQL语句 | 执行SQL语句。 |
| DescribeTable | 查看表详情 | 查看表详情。 |
| ListTables | 查看数据表列表 | 查看数据表列表。 |
| ListSchemas | 查看Schema列表 | 查看Schema列表。 |
| ListDatabases | 查看数据库列表 | 查看数据库列表。 |
Secret
| API | 标题 | API概述 |
|---|---|---|
| ListSecrets | 查看访问凭证列表 | 查看访问凭证列表。 |
| GetSecretValue | 获取凭证里信息 | 获取凭据详细信息。 |
| DeleteSecret | 删除访问凭证 | 删除实例的访问凭证。 |
| CreateSecret | 创建访问凭证 | 通过用户名密码创建访问实例的凭证。 |
RAG Service
| API | 标题 | API概述 |
|---|---|---|
| InitVectorDatabase | 初始化向量数据库 | 初始化向量检索数据库。 |
| 管理命名空间 | 管理命名空间 | |
| CreateNamespace | 创建命名空间 | 创建向量数据的命名空间。 |
| DescribeNamespace | 查询命名空间信息 | 查询命名空间信息。 |
| ListNamespaces | 查询命名空间列表 | 查询命名空间列表。 |
| DeleteNamespace | 删除命名空间 | 删除命名空间。 |
| 管理向量集 | 管理向量集 | |
| CreateCollection | 创建向量数据集 | 创建向量数据集。 |
| DescribeCollection | 查询向量集信息 | 查询向量集信息。 |
| ListCollections | 查询向量集列表 | 查询向量集列表。 |
| DeleteCollection | 删除向量集 | 删除向量数据集。 |
| GrantCollection | 向量集授权 | 向量集授权。 |
| 管理文档 | 管理文档 | |
| 管理文档库 | 管理文档库 | |
| CreateDocumentCollection | 创建文档库 | 创建知识库。 |
| ListDocumentCollections | 查询文档库列表 | 查询文档库列表。 |
| DeleteDocumentCollection | 删除文档库 | 删除文档库。 |
| 上传文档 | 上传文档 | |
| UpsertChunks | 上传切分后的文档 | 将切分后的文档列表向量化并上传到文档库。 |
| UploadDocumentAsync | Asynchronous Document Upload | Asynchronous Document Upload。 |
| GetUploadDocumentJob | 获取上传文档任务 | 通过JobId获取异步上传文档的任务的进度和结果。 |
| CancelUploadDocumentJob | 取消上传文档任务 | 通过JobId取消异步上传文档的任务。 |
| 检索 | 检索 | |
| QueryContent | 查询文档内容 | 用自然语句从指定文档库检索向量和元数据。 |
| 查看和删除文档 | 查看和删除文档 | |
| ListDocuments | 查询文档列表 | 查询文档库中的文档列表。 |
| DescribeDocument | 查看文档详细信息 | 查看文档详细信息。 |
| DeleteDocument | 删除文档 | 删除文档库中的文档。 |
| 管理向量 | 管理向量 | |
| 上传向量数据 | 上传向量数据 | |
| UpsertCollectionData | 上传向量数据 | 上传向量数据到指定的向量集中。 |
| UpsertCollectionDataAsync | 异步上传向量数据 | 使用本地文件或公网可免密访问的文件链接异步上传向量数据，最大支持200MB。 |
| GetUpsertCollectionDataJob | 获取异步上传向量数据任务 | 通过JobId获取异步上传向量数据的任务的进度和结果。 |
| CancelUpsertCollectionDataJob | 取消异步上传向量数据任务 | 通过JobId取消异步上传向量数据的任务。 |
| 检索 | 检索 | |
| QueryCollectionData | 召回向量数据 | 召回向量数据。 |
| 管理向量数据 | 管理向量数据 | |
| UpdateCollectionDataMetadata | 更新向量数据中的Metadata值 | 更新向量数据中的Metadata数据。 |
| DeleteCollectionData | 删除向量数据 | 删除向量数据。 |
| 索引管理 | 索引管理 | |
| CreateVectorIndex | 创建向量索引 | 创建向量集的索引。 |
| DeleteVectorIndex | 删除向量索引 | 删除向量索引。 |
| Embedding | Embedding | |
| TextEmbedding | 文本向量化 | 通过模型对文本文档进行向量化。 |
| Rerank | Rerank | |
| Rerank | 精排 | 通过模型对文档进行打分和重排序 |
实时数据消费
| API | 标题 | API概述 |
|---|---|---|
| 实时数据源 | 实时数据源 | |
| ListStreamingDataSources | 查询所有实时服务数据源 | 查询所有实时服务数据源。 |
| DeleteStreamingDataSource | 删除实时数据源 | 删除实时数据源。 |
| ModifyStreamingDataSource | 修改实时数据服务数据源 | 修改实时数据服务数据源。 |
| CreateStreamingDataSource | 创建实时数据源 | 创建实时数据源。 |
| DescribeStreamingDataSource | 查询实时数据源 | 查询实时数据源。 |
| 实时数据服务 | 实时数据服务 | |
| ListStreamingDataServices | Query All Real-time Data Services | Create External Data Source Configuration. |
| CreateStreamingDataService | 创建实时数据服务 | 创建实时数据服务。 |
| ModifyStreamingDataService | 修改实时数据服务 | 修改实时数据服务。 |
| DescribeStreamingDataService | 查询实时数据服务 | 查询实时数据服务。 |
| DeleteStreamingDataService | 删除实数数据服务 | 删除实时数据服务。 |
| 实时数据同步任务 | 实时数据同步任务 | |
| ModifyStreamingJob | 修改实时数据同步任务 | 修改实时数据同步任务。 |
| DescribeStreamingJob | 查询实时数据同步任务 | 查询实时数据同步服务。 |
| CreateStreamingJob | 创建实时数据同步任务 | 创建实时数据同步任务。 |
| DeleteStreamingJob | 删除实时数据同步任务 | 删除实时数据同步任务。 |
| ListStreamingJobs | 查询所有实时数据同步任务 | 查询所有实时数据同步任务。 |
插件管理
| API | 标题 | API概述 |
|---|---|---|
| UpgradeExtensions | 插件升级 | 插件升级。 |
| ListInstanceExtensions | 获取插件列表 | 获取插件列表。 |
| CreateExtensions | 安装插件 | 安装插件。 |
| DeleteExtension | 卸载插件 | 卸载插件。 |
外部数据管理
| API | 标题 | API概述 |
|---|---|---|
| 异构数据源管理 | 异构数据源管理 | |
| 外部数据服务 | 外部数据服务 | |
| DescribeExternalDataService | 获取外部数据服务详情 | 获取外部数据服务详情。 |
| DeleteExternalDataService | 删除外部数据服务 | 删除外部数据服务。 |
| ListExternalDataServices | 获取外部数据服务列表 | 获取外部数据服务列表。 |
| CreateExternalDataService | 创建外部数据服务 | 创建外部数据服务。 |
| ModifyExternalDataService | 修改外部数据服务 | 修改外部数据服务。 |
| DescribeHadoopClustersInSameNet | 获取同VPC的EMR集群实例 | 获取同VPC的EMR集群实例。 |
| Hadoop数据源 | Hadoop数据源 | |
| DescribeHadoopConfigs | 获取Hadoop集群配置信息 | 获取Hadoop集群配置信息。 |
| CreateHadoopDataSource | 创建hadoop外部数据源 | 创建hadoop数据源配置。 |
| DescribeHadoopDataSource | 获取hadoop数据源详情 | 获取hadoop数据源配置信息。 |
| ModifyHadoopDataSource | 修改hadoop数据源配置 | 修改hadoop数据源配置。 |
| CheckHadoopDataSource | 检查hadoop数据源配置 | 检查hadoop数据源配置。 |
| DeleteHadoopDataSource | 删除hadoop外部数据源 | 删除hadoop外部数据源。 |
| CheckHadoopNetConnection | 检测hadoop外部数据源网络联通性 | 检测hadoop外部数据源网络联通性。 |
| JDBC数据源 | JDBC数据源 | |
| CreateJDBCDataSource | 创建JDBC数据源 | 创建JDBC数据源。 |
| ModifyJDBCDataSource | 修改JDBC数据源配置 | 修改JDBC数据源配置。 |
| CheckJDBCSourceNetConnection | 检查JDBC连接串网络连通性 | 检查jdbc连接串网络连通性。 |
| DescribeJDBCDataSource | 获取JDBC数据源配置信息 | 获取jdbc数据源配置信息。 |
| DeleteJDBCDataSource | 删除JDBC数据源配置 | 删除jdbc数据源。 |
| 其他数据源 | 其他数据源 | |
| ListExternalDataSources | 获取数据源列表 | 获取数据源列表。 |
创建实例
| API | 标题 | API概述 |
|---|---|---|
| CreateDBInstance | 创建实例 | 创建AnalyticDB PostgreSQL版实例。 |
实例管理
| API | 标题 | API概述 |
|---|---|---|
| DeleteDBInstance | 释放按量付费实例 | 释放按量付费的AnalyticDB PostgreSQL版实例。 |
| ModifyDBInstanceDescription | 修改实例备注 | 修改AnalyticDB PostgreSQL版实例的备注。 |
| ModifyDBInstanceMaintainTime | 修改实例可运维时间 | 修改AnalyticDB PostgreSQL版实例的可维护时间。 |
| ModifyDBInstanceResourceGroup | 修改实例所属资源组 | 将AnalyticDB PostgreSQL版实例移动到指定资源组。 |
| ModifyVectorConfiguration | 修改实例向量引擎优化配置 | 修改实例向量引擎优化配置。 |
| PauseInstance | 暂停实例 | 暂停AnalyticDB PostgreSQL版实例。 |
| RebalanceDBInstance | 实例部署平衡 | 对AnalyticDB PostgreSQL版实例进行部署平衡。 |
| RestartDBInstance | 重启实例 | 重启AnalyticDB PostgreSQL版实例。 |
| ResumeInstance | 启动实例 | 启动AnalyticDB PostgreSQL版实例。 |
| UpgradeDBVersion | 升级内核小版本 | 为指定AnalyticDB PostgreSQL版实例升级内核小版本。 |
实例变配
| API | 标题 | API概述 |
|---|---|---|
| DescribeDataReDistributeInfo | 查询数据重分布进度 | 查询存储弹性模式6.0版实例在节点扩缩容过程中，数据重分布的进度。 |
| ModifyDBInstanceConfig | 修改计算资源阈值 | 修改AnalyticDB PostgreSQL版Serverless自动调度模式实例的计算资源阈值和空闲释放等待时长。 |
| UpgradeDBInstance | 变更实例规格 | 变更AnalyticDB PostgreSQL版实例的规格。 |
| PauseDataRedistribute | 暂停数据重分布 | 暂停数据重分布。 |
| ResumeDataRedistribute | 恢复数据重分布 | 恢复数据重分布。 |
查询实例
| API | 标题 | API概述 |
|---|---|---|
| DescribeDBClusterNode | 查询节点信息 | 查询AnalyticDB PostgreSQL版实例中的节点信息。 |
| DescribeDBInstanceAttribute | 查询实例详情 | 查询AnalyticDB PostgreSQL版实例详情。 |
| DescribeDBInstances | 查询数据库实例列表 | 查询AnalyticDB PostgreSQL版数据库实例列表。 |
| DescribeDBVersionInfos | 查询内核版本信息 | 查询内核版本信息。 |
| DescribeSupportFeatures | 查询实例支持的功能特性 | 查询当前AnalyticDB PostgreSQL版实例支持的功能特性。 |
参数管理
| API | 标题 | API概述 |
|---|---|---|
| DescribeModifyParameterLog | 查询参数修改历史 | 获取AnalyticDB PostgreSQL版实例的参数修改历史。 |
| DescribeParameters | 获取配置参数信息 | 获取AnalyticDB PostgreSQL版实例的配置参数信息。 |
| ModifyParameters | 修改配置参数 | 修改AnalyticDB PostgreSQL版实例的配置参数。 |
备份管理
| API | 标题 | API概述 |
|---|---|---|
| DescribeBackupPolicy | 查看实例备份策略 | 查看AnalyticDB PostgreSQL版实例的备份策略。 |
| DescribeDataBackups | 查看实例的数据备份列表和可恢复点 | 查看AnalyticDB PostgreSQL版实例的数据备份列表和可恢复点。 |
| DescribeLogBackups | 查看日志备份列表 | 查看日志备份列表。 |
| ModifyBackupPolicy | 设置实例备份策略 | 设置AnalyticDB PostgreSQL版实例的备份策略。 |
账号管理
| API | 标题 | API概述 |
|---|---|---|
| CreateAccount | 创建初始账号 | 创建AnalyticDB PostgreSQL版实例的初始账号。 |
| DescribeAccounts | 查询账号信息 | 查询AnalyticDB PostgreSQL版数据库的账号信息。 |
| DescribeDiagnosisDimensions | 查询所有数据库和用户 | 获取AnalyticDB PostgreSQL版实例中所有数据库和用户。 |
| ModifyAccountDescription | 修改账号备注 | 修改数据库账号的备注信息。 |
| ResetAccountPassword | 重置账号密码 | 重置账户密码。 |
| DescribeRoles | 获取角色列表 | 获取角色列表。 |
数据共享
| API | 标题 | API概述 |
|---|---|---|
| DescribeDataShareInstances | 查看数据共享详细信息 | 查看数据共享的状态。 |
| DescribeDataSharePerformance | 查看数据共享的性能指标 | 查看数据共享的性能指标。 |
| SetDataShareInstance | 将实例加入或移出数据共享 | 将AnalyticDB PostgreSQL版实例加入数据共享或从数据共享中移除。 |
诊断与优化
| API | 标题 | API概述 |
|---|---|---|
| DescribeDBClusterPerformance | 查看实例性能数据 | 查看AnalyticDB PostgreSQL版实例在指定时间段的性能监控。 |
| DescribeDBInstanceDataBloat | 查看数据膨胀相关信息 | 获取AnalyticDB PostgreSQL版实例的数据膨胀情况。 |
| DescribeDBInstanceDataSkew | 查看数据倾斜的相关信息 | 获取AnalyticDB PostgreSQL版实例的数据倾斜情况。 |
| DescribeDBInstanceDiagnosisSummary | 查看节点详情 | 获取AnalyticDB PostgreSQL版实例的节点详情。 |
| DescribeDBInstanceIndexUsage | 查看索引的使用情况 | 获取AnalyticDB PostgreSQL版实例中索引的使用情况。 |
| DescribeDBInstancePerformance | 查询指定性能参数的监控数据 | 查看某个AnalyticDB PostgreSQL存储预留模式实例在某个时间段内指定性能参数的性能监控数据。 |
| DescribeDiagnosisMonitorPerformance | 查看SQL执行信息 | 本接口用于查看指定时间段的AnalyticDB PostgreSQL版存储弹性模式实例的SQL执行信息。 |
| DescribeDiagnosisRecords | 获取SQL查询列表 | 获取AnalyticDB PostgreSQL版实例SQL查询列表。 |
| DescribeDiagnosisSQLInfo | 查看SQL语句的详细信息 | 获取AnalyticDB PostgreSQL版实例中指定查询语句的详细信息。 |
| DescribeDownloadRecords | 获取查询诊断信息的下载记录 | 获取AnalyticDB PostgreSQL版查询诊断信息的下载记录。 |
| DescribeDownloadSQLLogs | 查询慢SQL信息下载记录 | 获取AnalyticDB PostgreSQL版慢查询信息的最近五条下载记录。 |
| DescribeHealthStatus | 查看实例和节点的健康状态 | 查看实例和节点的健康状态。 |
| DescribeWaitingSQLInfo | 获取锁诊断详细信息 | 获取AnalyticDB PostgreSQL版实例锁等待详情信息。 |
| DescribeWaitingSQLRecords | 获取锁诊断列表 | 获取AnalyticDB PostgreSQL版实例锁诊断列表。 |
| DownloadDiagnosisRecords | 下载查询诊断记录 | 下载AnalyticDB PostgreSQL的实例的查询诊断记录。 |
| DownloadSQLLogsRecords | 下载慢SQL记录 | 下载AnalyticDB PostgreSQL的实例的慢SQL记录。 |
计划管理
| API | 标题 | API概述 |
|---|---|---|
| CreateDBInstancePlan | 创建定时计划 | 创建定时计划。 |
| DeleteDBInstancePlan | 删除定时计划 | 删除AnalyticDB PostgreSQL版实例的计划。 |
| DescribeDBInstancePlans | 查询计划详情 | 查看AnalyticDB PostgreSQL版实例的计划详情。 |
| SetDBInstancePlanStatus | 启用或禁用计划 | 启用或禁用AnalyticDB PostgreSQL版实例的计划。 |
| UpdateDBInstancePlan | 修改定时计划 | 修改AnalyticDB PostgreSQL版的定时计划。 |
标签管理
| API | 标题 | API概述 |
|---|---|---|
| DescribeTags | 查询标签列表 | 查询AnalyticDB PostgreSQL版实例的标签列表。 |
| ListTagResources | 查询实例绑定的标签 | 列出所有标签资源。 |
| TagResources | 创建并绑定标签 | 创建并绑定标签。 |
| UntagResources | 解绑标签 | 为指定的AnalyticDB PostgreSQL实例列表统一解绑标签。解绑后，如果该标签没有绑定其他任何实例，会被自动删除。 |
安全管理
| API | 标题 | API概述 |
|---|---|---|
| CheckServiceLinkedRole | 查询服务关联角色 | 检查是否创建了服务关联角色。 |
| CreateServiceLinkedRole | 创建服务关联角色 | 创建服务关联角色（SLR）。 |
| DescribeDBInstanceIPArrayList | 查看实例IP白名单 | 查询允许访问AnalyticDB PostgreSQL版实例的IP白名单。 |
| DescribeDBInstanceSSL | 查询实例SSL设置详情 | 获取AnalyticDB PostgreSQL版实例的SSL信息。 |
| DescribeUserEncryptionKeyList | 查询实例自定义KMS密钥列表 | 获取用户开通的KMS密钥列表。 |
| ModifyDBInstanceSSL | 修改SSL加密状态 | 开启、关闭或更新SSL加密。 |
| ModifySecurityIps | 修改IP白名单 | 修改AnalyticDB PostgreSQL版实例的IP白名单。 |
日志管理
| API | 标题 | API概述 |
|---|---|---|
| DescribeDBInstanceErrorLog | 查询实例的错误日志 | 获取AnalyticDB PostgreSQL版实例的错误日志。 |
| DescribeSQLLogCount | 获取SQL审计日志数量 | 获取AnalyticDB PostgreSQL版实例的审计日志数量。 |
| DescribeSQLLogsV2 | 查询SQL执行记录 | 调用DescribeSQLLogs接口查询指定时间段的SQL执行记录。 |
| ModifySQLCollectorPolicy | 开启或关闭SQL洞察功能 | 开启或关闭指定实例的SQL洞察功能。 |
网络管理
| API | 标题 | API概述 |
|---|---|---|
| AllocateInstancePublicConnection | 申请外网地址 | 分配实例外网链接地址。 |
| DescribeDBInstanceNetInfo | 查看实例的连接地址信息 | 查询实例的连接信息。 |
| DescribeRdsVpcs | 获取VPC列表 | 获取VPC列表。 |
| DescribeRdsVSwitchs | 获取虚拟交换机列表 | 获取虚拟交换机（vSwitch）列表。 |
| ModifyDBInstanceConnectionString | 修改连接地址 | 修改AnalyticDB PostgreSQL版实例的连接地址。 |
| ReleaseInstancePublicConnection | 释放外网地址 | 释放AnalyticDB PostgreSQL版的外网地址。 |
| SwitchDBInstanceNetType | 切换内外网地址 | 切换AnalyticDB PostgreSQL版实例的内外网地址。 |
资源管理
| API | 标题 | API概述 |
|---|---|---|
| DescribeAvailableResources | 获取可用资源信息 | 获取AnalyticDB PostgreSQL版的可用售卖资源。 |
| DescribeRegions | 查看可选的地域和可用区 | 查询创建AnalyticDB PostgreSQL版实例时用户可选的地域和可用区。 |
样本数据集
| API | 标题 | API概述 |
|---|---|---|
| CreateSampleData | 创建样本数据集 | 为AnalyticDB PostgreSQL版实例创建样本数据集。 |
| DescribeSampleData | 查询是否加载样本数据集 | 查询AnalyticDB PostgreSQL版实例中是否加载了样本数据集。 |
| UnloadSampleData | 卸载样本数据集 | 释放AnalyticDB PostgreSQL版的样本数据集。 |
资源组
| API | 标题 | API概述 |
|---|---|---|
| EnableDBResourceGroup | 开启资源组管理 | 为AnalyticDB PostgreSQL版存储弹性模式6.0实例开启资源组管理，开启后实例的资源管理模式会从资源队列切换到资源组。 |
| DisableDBResourceGroup | 关闭资源组管理 | 为AnalyticDB PostgreSQL版存储弹性模式6.0实例关闭资源组管理，关闭后实例的资源管理模式会从资源组切换到资源队列。 |
| CreateDBResourceGroup | 创建资源组 | 创建资源组。 |
| DeleteDBResourceGroup | 删除资源组 | 删除资源组。 |
| ModifyDBResourceGroup | 修改资源组 | 修改资源组。 |
| DescribeDBResourceGroup | 获取资源组详情 | 获取资源组详情。 |
| BindDBResourceGroupWithRole | 将资源组与数据库角色进行绑定 | 将资源组与数据库角色进行绑定。 |
| UnbindDBResourceGroupWithRole | 将资源组与数据库角色解绑 | 将资源组与数据库角色解绑。 |
| DescribeDBResourceManagementMode | 获取实例资源管理模式 | 获取实例资源管理模式。 |
其他
| API | 标题 | API概述 |
|---|---|---|
| ModifyMasterSpec | 变更master资源 | 修改master规格 |
| DescribeSQLLogs | 获取SQL执行记录 | 查询SQL执行记录。 |
| HandleActiveSQLRecord | 处理某个活跃查询 | 处理某个或多个活跃查询。 |
| DescribeDBInstanceSupportMaxPerformance | 查看实例的最大吞吐 | 查看实例的最大吞吐。 |
| ResetIMVMonitorData | 重置IMV统计信息 | 重置IMV统计信息。 |
| DescribeIMVInfos | 查询实时物化视图详情 | 查询AnalyticDB PostgreSQL版实例的实时物化视图详情。 |
| DescribeActiveSQLRecords | 查询活跃SQL记录 | 查询活跃SQL记录。 |
| ModifyDBInstancePayType | ModifyDBInstancePayType | 包年包月/按量付费转换改造。 |
| DeleteAccount | DeleteAccount | 删除数据库账号。 |
| GetAccount | GetAccount | 获取特定的账号信息。 |
| ModifyDBInstanceNetworkType | 切换实例网络类型 | 切换实例的网络类型。 |
| DeleteRemoteADBDataSource | 删除同构数据源 | 删除同构数据源 |
| CreateRemoteADBDataSource | 创建同构数据源 | 创建同构数据源 |
| ListRemoteADBDataSources | 获取同构数据源列表 | 获取同构数据源 |
| ModifyRemoteADBDataSource | 修改同构数据源 | 修改同构数据源 |