API概览

更新时间: 2023-11-28 14:08:20
本产品(云原生数据仓库 AnalyticDB PostgreSQL版/2016-05-03)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

向量检索

API标题API概述
CreateDocumentCollection创建文档库创建文档库。
DeleteDocument删除文档删除文档库中的文档。
DeleteDocumentCollection删除文档库删除文档库。
DescribeDocument查看文档详细信息查看文档详细信息。
ListDocumentCollections查询文档库列表查询文档库列表。
ListDocuments查询文档列表查询文档库中的文档列表。
QueryContent查询文档内容用自然语句从指定文档库检索向量和元数据。
UpsertChunks上传切分后的文档将切分后的文档列表向量化并上传到文档库。
InitVectorDatabase初始化向量数据库初始化向量检索数据库。
ListNamespaces查询命名空间列表查询命名空间列表。
ListCollections查询向量集列表查询向量集列表。
GrantCollection向量集授权向量集授权。
DeleteCollection删除向量集删除向量数据集。
DeleteNamespace删除命名空间删除命名空间。
DescribeCollection查询向量集信息查询向量集信息。
DeleteVectorIndex删除向量索引删除向量索引。
DescribeNamespace查询命名空间信息查询命名空间信息。
CreateVectorIndex创建向量索引创建向量集的索引。
DeleteCollectionData删除向量数据删除向量数据。
CreateCollection创建向量数据集创建向量数据集。
CreateNamespace创建命名空间创建向量数据的命名空间。
QueryCollectionData召回向量数据召回向量数据。
UpsertCollectionData上传向量数据上传向量数据到指定的向量集中。
UpdateCollectionDataMetadata更新向量数据中的Metadata值更新向量数据中的Metadata数据。

创建实例

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版实例的规格。

查询实例

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重置账号密码重置账户密码。

数据共享

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查询实例绑定的标签查询一个或多个AnalyticDB PostgreSQL实例已经绑定的标签列表。
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概述
ModifyMasterSpec变更master资源变更AnalyticDB PostgreSQL版实例的master资源。
DescribeSQLLogs获取SQL执行记录查询SQL执行记录。
HandleActiveSQLRecord处理某个活跃查询处理某个或多个活跃查询。
DescribeDBInstanceSupportMaxPerformance查看实例的最大吞吐查看实例的最大吞吐。
ResetIMVMonitorData重置IMV统计信息重置IMV统计信息。
DescribeIMVInfos查询实时物化视图详情查询AnalyticDB PostgreSQL版实例的实时物化视图详情。
阿里云首页 云原生数据仓库AnalyticDB PostgreSQL版 相关技术圈