AnalyticDB PostgreSQL版提供丰富的API接口供您使用,本文为您提供API接口的汇总以便查阅。

表 1. 实例管理
API 描述
CreateDBInstance 创建实例。
CreateECSDBInstance 创建存储弹性模式实例。
DeleteDBInstance 释放按量付费实例。
DescribeDBInstanceAttribute 获取实例的详细信息。
DescribeDBClusterNode 获取节点信息。
DescribeDBInstances 获取实例列表。
DescribeRegions 获取可用的地域和可用区。
DescribeResourceUsage 获取存储预留模式实例的存储空间使用情况。
ModifyDBInstanceConnectionMode 修改存储预留模式实例的访问模式。
ModifyDBInstanceDescription 修改实例的备注。
ModifyDBInstanceMaintainTime 修改实例的可维护时间。
ModifyDBInstanceResourceGroup 移动实例到指定资源组。
RestartDBInstance 重启实例。
UpgradeDBInstance 变更实例规格。
UpgradeDBVersion 升级实例内核小版本。
DescribeDBInstanceOnECSAttribute 获取存储弹性模式实例详细信息。
DescribeModifyParameterLog 获取实例配置参数修改历史。
DescribeAvailableResources 获取指定地域及可用区下的可用实例资源信息。
DescribeParameters 获取实例的配置参数信息。
DescribeSpecification 获取存储预留模式实例的规格信息。
ModifyParameters 修改实例的配置参数。
表 2. 账号管理
API 描述
CreateAccount 创建初始账号。
DescribeAccounts 获取初始账号详细信息。
DescribeDiagnosisDimensions 获取实例中所有用户和数据库。
ModifyAccountDescription 修改账号名称。
ResetAccountPassword 重置账号密码。
表 3. 数据共享
API 描述
DescribeDataShareInstances 获取数据共享的运行状态。
DescribeDataSharePerformance 获取数据共享的使用情况。
SetDataShareInstance 将Serverless实例加入共享或从共享中移除。
表 4. 备份管理
API 描述
DescribeBackupPolicy 获取实例的备份策略。
DescribeDataBackups 获取实例的备份列表和可恢复点。
DescribeLogBackups 获取日志备份列表。
ModifyBackupPolicy 修改实例的备份策略。
表 5. 手动启停
API 描述
PauseInstance 暂停实例。
ResumeInstance 启动已暂停的实例。
表 6. 诊断与优化
API 描述
DescribeDBClusterPerformance 获取实例在指定时间段的性能监控。
DescribeDBInstanceDataBloat 获取实例的数据膨胀的情况。
DescribeDBInstanceDataSkew 获取实例的数据倾斜情况。
DescribeDBInstanceDiagnosisSummary 获取实例中节点详细信息。
DescribeDBInstanceIndexUsage 获取实例中索引的使用情况。
DescribeDBInstancePerformance 获取实例的性能监控数据。
DescribeDiagnosisMonitorPerformance 获取查询语句的执行信息。
DescribeDiagnosisRecords 获取查询语句列表。
DescribeDiagnosisSQLInfo 获取指定查询语句的详细信息。
DescribeDownloadRecords 获取查询诊断信息的下载记录以及下载链接。
DescribeHealthStatus 查看实例和节点的健康状态。
DescribeWaitingSQLInfo 查询锁等待的查询的具体信息。
DescribeWaitingSQLRecords 获取锁诊断列表。
DownloadDiagnosisRecords 下载实例的查询诊断记录。
表 7. 计划管理
API 描述
CreateDBInstancePlan 创建定时计划。
DeleteDBInstancePlan 删除定时计划。
DescribeDBInstancePlans 获取实例的计划详情。
SetDBInstancePlanStatus 启用或禁用定时计划。
UpdateDBInstancePlan 修改定时计划。
表 8. 标签管理
API 描述
DescribeTags 获取标签信息。
ListTagResources 获取实例的标签信息。
TagResources 创建并绑定标签。
UntagResources 解绑标签。
表 9. 安全管理
API 描述
CheckServiceLinkedRole 查询是否开启了服务关联角色(SLR)。
CreateServiceLinkedRole 创建服务关联角色(SLR)。
DescribeDBInstanceIPArrayList 获取允许访问实例的IP白名单。
DescribeDBInstanceSecurityIps 获取白名单信息。
DescribeDBInstanceSSL 获取SSL信息。
DescribeUserEncryptionKeyList 获取开通的KMS密钥列表。
ModifyDBInstanceSecurityIps 修改实例白名单列表。
ModifyDBInstanceSSL 开启、关闭或更新SSL。
ModifySecurityIps 修改IP白名单。
表 10. 日志管理
API 描述
DescribeSQLCollectorPolicy 获取SQL采集功能是否打开。
DescribeSQLLogFiles 获取SQL审计文件列表。
DescribeSQLLogRecords 获取实例的SQL审计日志。
ModifySQLCollectorPolicy 开启或关闭指定实例的SQL采集功能。
表 11. 网络管理
API 描述
AllocateInstancePublicConnection 申请外网连接地址。
DescribeDBInstanceNetInfo 获取实例的连接信息。
DescribeRdsVpcs 获取VPC信息。
DescribeRdsVSwitchs 获取vSwitch信息。
ModifyDBInstanceConnectionString 修改连接地址的前缀。
ModifyDBInstanceNetworkType 切换网络类型。
ReleaseInstancePublicConnection 释放外网连接地址。
表 12. 样本数据集
API 描述
CreateSampleData 加载样本数据集。
DescribeSampleData 查询是否加载了样本数据集。
UnloadSampleData 释放样本数据集。