RAG Service
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| 管理命名空间 | ||
| CreateNamespace | 创建向量数据的命名空间 | 查看文档去调试 |
| DescribeNamespace | 查询命名空间信息 | 查看文档去调试 |
| ListNamespaces | 查询命名空间列表 | 查看文档去调试 |
| DeleteNamespace | 删除命名空间 | 查看文档去调试 |
| 管理向量集 | ||
| CreateCollection | 创建向量数据集 | 查看文档去调试 |
| DescribeCollection | 查询向量数据集信息 | 查看文档去调试 |
| ListCollections | 查询向量数据集列表 | 查看文档去调试 |
| GrantCollection | 向量数据集授权 | 查看文档去调试 |
| DeleteCollection | 删除向量数据集 | 查看文档去调试 |
| 管理文档 | ||
| 管理文档库 | ||
| CreateDocumentCollection | 创建知识库 | 查看文档去调试 |
| ListDocumentCollections | 查询文档库列表 | 查看文档去调试 |
| DeleteDocumentCollection | 删除文档库 | 查看文档去调试 |
| 上传文档 | ||
| UpsertChunks | 将切分后的文档列表向量化并上传到文档库 | 查看文档去调试 |
| UploadDocumentAsync | 异步上传文档 | 查看文档去调试 |
| GetUploadDocumentJob | 通过JobId获取异步上传文档的任务的进度和结果 | 查看文档去调试 |
| CancelUploadDocumentJob | 通过JobId取消异步上传文档的任务 | 查看文档去调试 |
| 检索 | ||
| QueryContent | 用自然语句从指定文档库检索向量和元数据 | 查看文档去调试 |
| 查看和删除文档 | ||
| ListDocuments | 查询文档库中的文档列表 | 查看文档去调试 |
| DescribeDocument | 查看文档详细信息 | 查看文档去调试 |
| DeleteDocument | 删除文档库中的文档 | 查看文档去调试 |
| 管理向量 | ||
| 上传向量数据 | ||
| UpsertCollectionData | 上传向量数据到指定的向量集中 | 查看文档去调试 |
| UpsertCollectionDataAsync | 使用本地文件或公网可免密访问的文件链接异步上传向量数据，最大支持200MB | 查看文档去调试 |
| GetUpsertCollectionDataJob | 通过JobId获取异步上传向量数据的任务的进度和结果 | 查看文档去调试 |
| CancelUpsertCollectionDataJob | 通过JobId取消异步上传向量数据的任务 | 查看文档去调试 |
| 检索 | ||
| QueryCollectionData | 召回向量数据 | 查看文档去调试 |
| 管理向量数据 | ||
| UpdateCollectionDataMetadata | 更新向量数据中的Metadata数据 | 查看文档去调试 |
| DeleteCollectionData | 删除向量数据集 | 查看文档去调试 |
| 索引管理 | ||
| CreateVectorIndex | 创建向量集的索引 | 查看文档去调试 |
| DeleteVectorIndex | 删除向量索引 | 查看文档去调试 |
| CreateIndex | 创建索引。 说明： 1. 只支持创建标量索引。 2. 创建索引期间禁写表。 3. 在单表数据量大的情况下创建索引，过程中会占用实例CPU、IO资源，如果影响实例可用性请调用CancelCreateIndexJob取消创建索引 | 查看文档去调试 |
| DescribeCreateIndexJob | 获取创建索引任务 | 查看文档去调试 |
| CancelCreateIndexJob | 取消创建索引任务 | 查看文档去调试 |
| DeleteIndex | 删除索引 | 查看文档去调试 |
| ListIndices | 获取索引列表 | 查看文档去调试 |
| DescribeIndex | 获取索引详情 | 查看文档去调试 |
| Embedding | ||
| TextEmbedding | 通过模型对文本文档进行向量化 | 查看文档去调试 |
| Rerank | ||
| Rerank | Rerank能够解决向量检索和全文检索结果排序不精准的问题，通过语义理解对召回数据重新打分排序，显著提升结果的相关性与准确性。 AnalyticDB for PostgreSQL版支持调用Rerank模型对检索结果做重排，但不提供模型 | 查看文档去调试 |
| InitVectorDatabase | 初始化向量检索数据库 | 查看文档去调试 |
实时数据消费
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| 实时数据源 | ||
| CreateStreamingDataSource | 创建实时数据源 | 查看文档去调试 |
| ListStreamingDataSources | 查询所有实时服务数据源 | 查看文档去调试 |
| DescribeStreamingDataSource | 查询实时数据源 | 查看文档去调试 |
| ModifyStreamingDataSource | 修改实时数据服务数据源 | 查看文档去调试 |
| DeleteStreamingDataSource | 删除实时数据源 | 查看文档去调试 |
| 实时数据服务 | ||
| CreateStreamingDataService | 创建实时数据服务 | 查看文档去调试 |
| ListStreamingDataServices | Create External Data Source Configuration. | 查看文档去调试 |
| DescribeStreamingDataService | 查询实时数据服务 | 查看文档去调试 |
| ModifyStreamingDataService | 修改实时数据服务 | 查看文档去调试 |
| DeleteStreamingDataService | 删除实时数据服务 | 查看文档去调试 |
| 实时数据同步任务 | ||
| CreateStreamingJob | 创建实时数据同步任务 | 查看文档去调试 |
| DescribeStreamingJob | 查询实时数据同步服务 | 查看文档去调试 |
| ListStreamingJobs | 查询所有实时数据同步任务 | 查看文档去调试 |
| ModifyStreamingJob | 修改实时数据同步任务 | 查看文档去调试 |
| DeleteStreamingJob | 删除实时数据同步任务 | 查看文档去调试 |
外部数据管理
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| 异构数据源管理 | ||
| 外部数据服务 | ||
| CreateExternalDataService | 创建外部数据服务 | 查看文档去调试 |
| DescribeExternalDataService | 获取外部数据服务详情 | 查看文档去调试 |
| ListExternalDataServices | 获取外部数据服务列表 | 查看文档去调试 |
| DescribeHadoopClustersInSameNet | 获取同VPC的EMR集群实例 | 查看文档去调试 |
| ModifyExternalDataService | 修改外部数据服务 | 查看文档去调试 |
| DeleteExternalDataService | 删除外部数据服务 | 查看文档去调试 |
| Hadoop数据源 | ||
| CreateHadoopDataSource | 创建hadoop数据源配置 | 查看文档去调试 |
| DescribeHadoopConfigs | 获取Hadoop集群配置信息 | 查看文档去调试 |
| DescribeHadoopDataSource | 获取hadoop数据源配置信息 | 查看文档去调试 |
| ModifyHadoopDataSource | 修改hadoop数据源配置 | 查看文档去调试 |
| DeleteHadoopDataSource | 删除hadoop外部数据源 | 查看文档去调试 |
| CheckHadoopDataSource | 检查hadoop数据源配置 | 查看文档去调试 |
| CheckHadoopNetConnection | 检测hadoop外部数据源网络联通性 | 查看文档去调试 |
| JDBC数据源 | ||
| CreateJDBCDataSource | 创建JDBC数据源 | 查看文档去调试 |
| DescribeJDBCDataSource | 获取jdbc数据源配置信息 | 查看文档去调试 |
| ModifyJDBCDataSource | 修改JDBC数据源配置 | 查看文档去调试 |
| DeleteJDBCDataSource | 删除jdbc数据源 | 查看文档去调试 |
| CheckJDBCSourceNetConnection | 检查jdbc连接串网络连通性 | 查看文档去调试 |
| 其他数据源 | ||
| ListExternalDataSources | 获取数据源列表 | 查看文档去调试 |
实例管理
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| ModifyDBInstanceDescription | 修改AnalyticDB PostgreSQL版实例的备注 | 查看文档去调试 |
| ModifyDBInstanceMaintainTime | 修改AnalyticDB PostgreSQL版实例的可维护时间 | 查看文档去调试 |
| ModifyDBInstanceResourceGroup | 将AnalyticDB PostgreSQL版实例移动到指定资源组 | 查看文档去调试 |
| ModifyVectorConfiguration | 修改实例向量引擎优化配置 | 查看文档去调试 |
| PauseInstance | 暂停AnalyticDB PostgreSQL版实例 | 查看文档去调试 |
| DeleteDBInstance | 释放按量付费的AnalyticDB PostgreSQL版实例 | 查看文档去调试 |
| RebalanceDBInstance | 对AnalyticDB PostgreSQL版实例进行部署平衡 | 查看文档去调试 |
| RestartDBInstance | 重启AnalyticDB PostgreSQL版实例 | 查看文档去调试 |
| ResumeInstance | 启动AnalyticDB PostgreSQL版实例 | 查看文档去调试 |
| UpgradeDBVersion | 为指定AnalyticDB PostgreSQL版实例升级内核小版本 | 查看文档去调试 |
| ModifyDBInstanceDeploymentMode | 修改实例部署模式 | 查看文档去调试 |
查询实例
备份管理
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| DescribeBackupPolicy | 查看AnalyticDB PostgreSQL版实例的备份策略 | 查看文档去调试 |
| DescribeDataBackups | 查看AnalyticDB PostgreSQL版实例的数据备份列表和可恢复点 | 查看文档去调试 |
| DescribeLogBackups | 查看日志备份列表 | 查看文档去调试 |
| ModifyBackupPolicy | 设置AnalyticDB PostgreSQL版实例的备份策略 | 查看文档去调试 |
| CreateBackup | 创建备份 | 查看文档去调试 |
| DeleteBackup | 删除备份。说明：只支持删除物理手动备份 | 查看文档去调试 |
| ListBackupJobs | 获取备份任务列表 | 查看文档去调试 |
| DescribeBackupJob | 获取备份任务详情 | 查看文档去调试 |
| CloneDBInstance | 恢复数据至指定实例 | 查看文档去调试 |
诊断与优化
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| DescribeDBClusterPerformance | 查看AnalyticDB PostgreSQL版实例在指定时间段的性能监控 | 查看文档去调试 |
| DescribeDBInstanceDataBloat | 获取AnalyticDB PostgreSQL版实例的数据膨胀情况 | 查看文档去调试 |
| DescribeDBInstanceDataSkew | 获取AnalyticDB PostgreSQL版实例的数据倾斜情况 | 查看文档去调试 |
| DescribeDBInstanceDiagnosisSummary | 获取AnalyticDB PostgreSQL版实例的节点详情 | 查看文档去调试 |
| DescribeDBInstanceIndexUsage | 获取AnalyticDB PostgreSQL版实例中索引的使用情况 | 查看文档去调试 |
| DescribeDBInstancePerformance | 查看某个AnalyticDB PostgreSQL存储预留模式实例在某个时间段内指定性能参数的性能监控数据 | 查看文档去调试 |
| DescribeDiagnosisMonitorPerformance | 本接口用于查看指定时间段的AnalyticDB PostgreSQL版存储弹性模式实例的SQL执行信息 | 查看文档去调试 |
| DescribeDiagnosisRecords | 获取AnalyticDB PostgreSQL版实例SQL查询列表 | 查看文档去调试 |
| DescribeDiagnosisSQLInfo | 获取AnalyticDB PostgreSQL版实例中指定查询语句的详细信息 | 查看文档去调试 |
| DescribeDownloadRecords | 获取AnalyticDB PostgreSQL版查询诊断信息的下载记录 | 查看文档去调试 |
| DescribeDownloadSQLLogs | 获取AnalyticDB PostgreSQL版慢查询信息的最近五条下载记录 | 查看文档去调试 |
| DescribeHealthStatus | 查看实例和节点的健康状态 | 查看文档去调试 |
| DescribeWaitingSQLInfo | 获取AnalyticDB PostgreSQL版实例锁等待详情信息 | 查看文档去调试 |
| DescribeWaitingSQLRecords | 获取AnalyticDB PostgreSQL版实例锁诊断列表 | 查看文档去调试 |
| DownloadDiagnosisRecords | 下载AnalyticDB PostgreSQL的实例的查询诊断记录 | 查看文档去调试 |
| DownloadSQLLogsRecords | 下载AnalyticDB PostgreSQL的实例的慢SQL记录 | 查看文档去调试 |
安全管理
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateServiceLinkedRole | 创建服务关联角色（SLR） | 查看文档去调试 |
| DescribeDBInstanceIPArrayList | 查询允许访问AnalyticDB PostgreSQL版实例的IP白名单 | 查看文档去调试 |
| DescribeDBInstanceSSL | 获取AnalyticDB PostgreSQL版实例的SSL信息 | 查看文档去调试 |
| DescribeUserEncryptionKeyList | 获取用户开通的KMS密钥列表 | 查看文档去调试 |
| ModifyDBInstanceSSL | 开启、关闭或更新SSL加密 | 查看文档去调试 |
| ModifySecurityIps | 修改AnalyticDB PostgreSQL版实例的IP白名单 | 查看文档去调试 |
| CheckServiceLinkedRole | 检查是否创建了服务关联角色 | 查看文档去调试 |
网络管理
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| DescribeDBInstanceNetInfo | 查询实例的连接信息 | 查看文档去调试 |
| DescribeRdsVpcs | 获取VPC列表 | 查看文档去调试 |
| DescribeRdsVSwitchs | 获取虚拟交换机（vSwitch）列表 | 查看文档去调试 |
| ModifyDBInstanceConnectionString | 修改AnalyticDB PostgreSQL版实例的连接地址 | 查看文档去调试 |
| AllocateInstancePublicConnection | 分配实例外网链接地址 | 查看文档去调试 |
| ReleaseInstancePublicConnection | 释放AnalyticDB PostgreSQL版的外网地址 | 查看文档去调试 |
| SwitchDBInstanceNetType | 切换AnalyticDB PostgreSQL版实例的内外网地址 | 查看文档去调试 |
资源组
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateDBResourceGroup | 创建资源组 | 查看文档去调试 |
| DescribeDBResourceGroup | 获取资源组详情 | 查看文档去调试 |
| DescribeDBResourceManagementMode | 获取实例资源管理模式 | 查看文档去调试 |
| EnableDBResourceGroup | 为AnalyticDB PostgreSQL版存储弹性模式6.0实例开启资源组管理，开启后实例的资源管理模式会从资源队列切换到资源组 | 查看文档去调试 |
| DisableDBResourceGroup | 为AnalyticDB PostgreSQL版存储弹性模式6.0实例关闭资源组管理，关闭后实例的资源管理模式会从资源组切换到资源队列 | 查看文档去调试 |
| ModifyDBResourceGroup | 修改资源组 | 查看文档去调试 |
| DeleteDBResourceGroup | 删除资源组 | 查看文档去调试 |
| BindDBResourceGroupWithRole | 将资源组与数据库角色进行绑定 | 查看文档去调试 |
| UnbindDBResourceGroupWithRole | 将资源组与数据库角色解绑 | 查看文档去调试 |
其他
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| DescribeSQLLogs | 查询SQL执行记录 | 查看文档去调试 |
| DescribeDBInstanceSupportMaxPerformance | 查看实例的最大吞吐 | 查看文档去调试 |
| DescribeIMVInfos | 查询AnalyticDB PostgreSQL版实例的实时物化视图详情 | 查看文档去调试 |
| DescribeActiveSQLRecords | 查询活跃SQL记录 | 查看文档去调试 |
| ModifyMasterSpec | 修改master规格 | 查看文档去调试 |
| HandleActiveSQLRecord | 处理某个或多个活跃查询 | 查看文档去调试 |
| ResetIMVMonitorData | 重置IMV统计信息 | 查看文档去调试 |
| ModifyDBInstancePayType | 包年包月/按量付费转换改造 | 查看文档去调试 |
| DeleteAccount | 删除数据库账号 | 查看文档去调试 |
| GetAccount | 获取特定的账号信息 | 查看文档去调试 |
| ModifyDBInstanceNetworkType | 切换实例的网络类型 | 查看文档去调试 |
| DeleteRemoteADBDataSource | 删除同构数据源 | 查看文档去调试 |
| CreateRemoteADBDataSource | 创建同构数据源 | 查看文档去调试 |
| ListRemoteADBDataSources | 获取同构数据源 | 查看文档去调试 |
| ModifyRemoteADBDataSource | 修改同构数据源 | 查看文档去调试 |