API 概览

最近更新时间：2023.09.05 15:04:02

首次发布时间：2023.02.02 17:41:20

本文汇总云数据库 MySQL 版提供的 API 接口。

全局

API	描述
DescribeRegions	调用 DescribeRegions 接口查看 Region 列表。
DescribeAvailabilityZones	调用 DescribeAvailabilityZones 接口查看 Zone 列表。

实例

API	描述
CreateDBInstance	调用 CreateDBInstance 接口创建实例。
DeleteDBInstance	调用 DeleteDBInstance 接口删除实例。
RestartDBInstance	调用 RestartDBInstance 接口重启实例。
ModifyDBInstanceSpec	调用 ModifyDBInstanceSpec 接口修改实例配置。
DescribeDBInstances	调用 DescribeDBInstances 接口查看实例列表。
DescribeDBInstanceDetail	调用 DescribeDBInstanceDetail 接口查看实例详情。
ModifyDBInstanceChargeType	调用 ModifyDBInstanceChargeType 接口修改按量计费实例的计费方式为包年包月。
ModifyDBInstanceName	调用 ModifyDBInstanceName 接口修改实例名称。
DescribeTagsByResource	调用 DescribeTagsByResource 接口查询一个或多个 MySQL 实例的标签。
AddTagsToResource	调用 AddTagsToResource 接口为一个或多个 MySQL 实例绑定标签。
RemoveTagsFromResource	调用 RemoveTagsFromResource 接口为一个或多个 MySQL 实例解绑标签。
RebuildDBInstance	调用 RebuildDBInstance 接口对回收站中的 MySQL 实例进行重建。
SwitchDBInstanceHA	调用 SwitchDBInstanceHA 接口手动切换指定 MySQL 实例的主备节点。
DescribeDBInstanceSpecs	调用 DescribeDBInstanceSpecs 接口查询 MySQL 支持的实例规格代码。
DescribeDBInstancePriceDetail	调用 DescribeDBInstancePriceDetail 接口查询包年包月和按量付费实例的购买价格，以及按量付费实例的变更配置的新价格。
ModifyDBInstanceType	调用 ModifyDBInstanceType 接口修改指定 MySQL 实例的实例类型。

连接地址

API	描述
CreateDBEndpoint	调用 CreateDBEndpoint 接口创建 Endpoint。
DeleteDBEndpoint	调用 DeleteDBEndpoint 接口删除 Endpoint。
ModifyDBEndpoint	调用 ModifyDBEndpoint 接口修改 Endpoint。
CreateDBEndpointPublicAddress	调用 CreateDBEndpointPublicAddress 接口创建公网地址。
DeleteDBEndpointPublicAddress	调用 DeleteDBEndpointPublicAddress 接口删除公网地址。
ModifyDBEndpointAddress	调用 ModifyDBEndpointAddress 接口修改地址。
ModifyDBEndpointDNS	调用 ModifyDBEndpointDNS 接口修改 DNS 地址。
DescribeDBProxyConfig	调用 DescribeDBProxyConfig 接口查询指定 MySQL 实例的数据库代理信息。
ModifyDBProxyConfig	调用 ModifyDBProxyConfig 接口修改指定 MySQL 实例的连接池模式。

账号

API	描述
CreateDBAccount	调用 CreateDBAccount 接口创建账号。
DeleteDBAccount	调用 DeleteDBAccount 接口删除账号。
ModifyDBAccountDescription	调用 ModifyDBAccountDescription 接口修改账号的描述信息。
ResetDBAccount	调用 ResetDBAccount 接口重置账号。
DescribeDBAccounts	调用 DescribeDBAccounts 接口查看账号列表。
GrantDBAccountPrivilege	调用 GrantDBAccountPrivilege 接口赋予数据库账号权限。
RevokeDBAccountPrivilege	调用 RevokeDBAccountPrivilege 接口撤销数据库账号权限。

数据库

API	描述
CreateDatabase	调用 CreateDatabase 接口创建数据库。
DeleteDatabase	调用 DeleteDatabase 接口删除数据库。
DescribeDatabases	调用 DescribeDatabases 接口查看数据库列表。
ModifyDatabaseDescription	调用 ModifyDatabaseDescription 接口修改数据库的描述信息。
GrantDatabasePrivilege	调用 GrantDatabasePrivilege 接口赋予数据库对应的账号权限。
RevokeDatabasePrivilege	调用 RevokeDatabasePrivilege 接口撤销数据库账号权限。

安全加密

API	描述
DescribeAllowLists	调用 DescribeAllowLists 接口查看白名单列表。
DescribeAllowListDetail	调用 DescribeAllowListDetail 接口查看白名单详情。
CreateAllowList	调用 CreateAllowList 接口创建白名单。
ModifyAllowList	调用 ModifyAllowList 接口修改白名单。
DeleteAllowList	调用 DeleteAllowList 接口删除白名单。
AssociateAllowList	调用 AssociateAllowList 接口绑定白名单。
DisassociateAllowList	调用 DisassociateAllowList 接口解绑白名单。
UpgradeAllowListVersion	调用 UpgradeAllowListVersion 接口升级白名单版本。
DescribeDBInstanceSSL	调用 DescribeDBInstanceSSL 接口查询指定 MySQL 实例的 SSL 设置。
ModifyDBInstanceSSL	调用 ModifyDBInstanceSSL 接口修改指定 MySQL 实例的 SSL 设置。
DownloadSSLCertificate	调用 DownloadSSLCertificate 接口下载指定 MySQL 实例的 SSL 证书。

备份

API	描述
CreateBackup	调用 CreateBackup 接口创建备份。
DescribeBackups	调用 DescribeBackups 接口查看备份文件列表。
DescribeBinlogFiles	调用 DescribeBinlogFiles 接口查询 Binlog 备份文件。
DownloadBackup	调用 DownloadBackup 接口下载备份。
GetBackupDownloadLink	调用 GetBackupDownloadLink 接口获取备份下载链接。
ModifyBackupPolicy	调用 ModifyBackupPolicy 接口修改 MySQL 实例的数据备份和日志备份策略。
DescribeBackupPolicy	调用 DescribeBackupPolicy 接口查询指定 MySQL 实例的数据备份和日志备份策略。
CreateBinlogBackup	调用 CreateBinlogBackup 接口手动上传 Binlog 到 TOS。
DescribeCrossBackupPolicy	调用 DescribeCrossBackupPolicy 接口查看实例的跨地域备份配置。
DescribeAvailableCrossRegion	调用 DescribeAvailableCrossRegion 接口查询可以进行跨地域备份的目的地域。
ModifyCrossBackupPolicy	调用 ModifyCrossBackupPolicy 接口修改跨地域备份配置。

恢复

API	描述
RestoreToNewInstance	调用 RestoreToNewInstance 接口将数据恢复到一个新实例。
DescribeRecoverableTime	调用 DescribeRecoverableTime 接口查看可恢复时间范围。
RestoreToExistedInstance	调用 RestoreToNewInstance 接口将数据恢复到一个已有数据库实例。

参数

API	描述
DescribeDBInstanceParameters	调用 DescribeDBInstanceParameters 接口查询实例参数。
ModifyDBInstanceParameters	调用 ModifyDBInstanceParameters 接口修改实例参数。
DescribeDBInstanceParametersLog	调用 DescribeDBInstanceParametersLog 接口查询实例参数修改历史。
CreateParameterTemplate	调用 CreateParameterTemplate 接口创建 MySQL 实例的参数模板。
ModifyParameterTemplate	调用 ModifyParameterTemplate 接口修改 MySQL 实例的参数模板。
CopyParameterTemplate	调用 CopyParameterTemplate 接口复制 MySQL 实例的参数模板。
DeleteParameterTemplate	调用 DeleteParameterTemplate 接口删除 MySQL 实例的参数模板。
DescribeApplyParameterTemplate	调用 DescribeApplyParameterTemplate 接口为指定的 MySQL 实例应用参数模板。
SaveAsParameterTemplate	调用 SaveAsParameterTemplate 接口将指定实例的参数配置保存为参数模板。

全局

实例

连接地址

账号

数据库

安全加密

备份

恢复

参数