文档中心

云数据库 MySQL 版

V2（2022-01-01）

API 列表

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

说明

单个地域下，云数据库 MySQL 版的 API 流控限制为 20 次/秒，即单个火山引擎账号每秒钟调用单个 API 接口的次数不可超过 20。若超过该限制，会导致 API 请求执行失败，并提示 AccountFlowLimitExceeded 报错。

云数据库 MySQL 版 API 调用的超时时间为 30 秒。

全局管理

API	说明
DescribeRegions	调用 DescribeRegions 接口查看地域列表。
DescribeAvailabilityZones	调用 DescribeAvailabilityZones 接口查看可用区列表。

实例管理

API	说明
CreateDBInstance	调用 CreateDBInstance 接口创建实例。
DescribeDBInstances	调用 DescribeDBInstances 接口查看实例列表。
DescribeDBInstanceAttribute	调用 DescribeDBInstanceAttribute 接口查询实例的属性。
DescribeDBInstanceEndpoints	调用 DescribeDBInstanceEndpoints 接口查询实例的连接地址列表。
DescribeResourceUsage	调用 DescribeResourceUsage 接口查询实例的资源使用情况。
DescribeDBInstanceChargeDetail	调用 DescribeDBInstanceChargeDetail 接口查询实例的计费信息。
DescribeDBInstanceHAConfig	调用 DescribeDBInstanceHAConfig 接口查询实例的高可用配置。
DescribeDBDisasterRecoveryInstances	调用 DescribeDBDisasterRecoveryInstances 接口查询实例的灾备实例信息。
DescribeDBProxy	调用 DescribeDBProxy 接口查询实例的代理配置。
DescribeDBInstanceSpecs	调用 DescribeDBInstanceSpecs 接口查询 MySQL 支持的规格。
DescribeDBInstancePriceDetail	调用 DescribeDBInstancePriceDetail 接口查询 MySQL 实例的价格详情。
ModifyDBInstanceChargeType	调用 ModifyDBInstanceChargeType 接口修改实例的计费方式。
ModifyDBInstanceName	调用 ModifyDBInstanceName 接口修改实例名称。
ModifyDBInstanceMaintenanceWindow	调用 ModifyDBInstanceMaintenanceWindow 接口修改实例的可维护时间窗口。
ModifyDBNodeTemporarySpec	调用 ModifyDBNodeTemporarySpec 接口为实例进行临时升配。
ModifyDBNodeSpec	调用 ModifyDBNodeSpec 接口变更实例的节点规格。
CreateDBNodes	调用 CreateDBNodes 接口为实例增加节点。
DeleteDBNodes	调用 DeleteDBNodes 接口为实例移除节点。
ModifyDBInstanceSyncMode	调用 ModifyDBInstanceSyncMode 接口修改实例的数据同步方式。
ModifyDBInstanceType	调用 ModifyDBInstanceType 接口修改指定 MySQL 实例的实例类型。
SwitchDBInstanceHA	调用 SwitchDBInstanceHA 接口手动切换指定 MySQL 实例的主备节点。
MigrateToOtherZone	调用 MigrateToOtherZone 接口将指定实例的节点迁移至同一地域下的其他可用区。
RestartDBInstance	调用 RestartDBInstance 接口重启实例。
RebuildDBInstance	调用 RebuildDBInstance 接口通过已删除实例备份重建实例。
DeleteDBInstance	调用 DeleteDBInstance 接口删除实例。
DescribeTagsByResource	调用 DescribeTagsByResource 接口查询一个或多个 MySQL 实例的标签。
AddTagsToResource	调用 AddTagsToResource 接口为一个或多个 MySQL 实例绑定标签。
RemoveTagsFromResource	调用 RemoveTagsFromResource 接口为一个或多个 MySQL 实例解绑标签。
DescribeDBInstanceEngineMinorVersions	调用 DescribeDBInstanceEngineMinorVersions 接口查询实例可升级的内核小版本。
UpgradeDBInstanceEngineMinorVersion	调用 UpgradeDBInstanceEngineMinorVersion 接口升级实例的内核小版本。
ModifyDBInstanceAutoUpgradeEngineMinorVersion	调用 ModifyDBInstanceAutoUpgradeEngineMinorVersion 接口修改实例内核小版本的升级策略。
CreateDrDBInstance	调用 CreateDrDBInstance 接口为指定实例创建灾备实例。
SwitchDrInstanceToMaster	调用 SwitchDrInstanceToMaster 接口将灾备实例升级为主实例。
RebuildDrInstance	调用 RebuildDrInstance 接口重建灾备实例数据。
DescribeDisasterRecoveryRegions	调用 DescribeDisasterRecoveryRegions 接口查看可创建灾备实例的地域列表。
ModifyDBInstanceDeletionProtectionPolicy	调用 ModifyDBInstanceDeletionProtectionPolicy 接口设置实例的删除保护功能。
UpgradeDBInstanceEngineMajorVersionPrecheck	调用 UpgradeDBInstanceEngineMajorVersionPrecheck 接口对实例进行升级大版本前的预检查。
DescribeUpgradeEngineMajorVersionPrecheckResult	调用 DescribeUpgradeEngineMajorVersionPrecheckResult 接口查询升级实例大版本的预检查结果。
UpgradeDBInstanceEngineMajorVersion	调用 UpgradeDBInstanceEngineMajorVersion 接口升级实例的大版本。
StopDBInstance	调用 StopDBInstance 接口暂停实例。
StartDBInstance	调用 StartDBInstance 接口启动已暂停的实例。
DescribeDBInstanceNodes	调用 DescribeDBInstanceNodes 接口查询实例节点的详细信息。
DescribeDBProxyPriceDetail	调用 DescribeDBProxyPriceDetail 接口查询实例数据库代理服务的计费信息。
CreateDBBlueGreenInstance	调用 CreateDBBlueGreenInstance 接口为实例创建蓝绿部署。
DescribeDBBlueGreenInstance	调用 DescribeDBBlueGreenInstance 接口查询实例的蓝绿部署信息。
SwitchDBPrecheckBlueGreen	调用 SwitchDBPrecheckBlueGreen 接口发起蓝绿部署切换的预检查。
DescribeDBSwitchBlueGreenPrecheck	调用 DescribeDBSwitchBlueGreenPrecheck 接口查询蓝绿部署切换的预检查结果。
DescribeDBBlueGreenDifferences	调用 DescribeDBBlueGreenDifferences 接口查询蓝绿部署中蓝色实例和绿色实例的差异。
SwitchDBBlueGreen	调用 SwitchDBBlueGreen 接口切换蓝绿部署。
RebuildDBGreenInstance	调用 RebuildDBGreenInstance 接口重建蓝绿部署中的绿色实例。
DeleteDBBlueGreenRelation	调用 DeleteDBBlueGreenRelation 接口删除蓝绿部署。

连接管理

API	说明
CreateDBEndpoint	调用 CreateDBEndpoint 接口创建连接终端（Endpoint）。
ModifyDBEndpoint	调用 ModifyDBEndpoint 接口修改 Endpoint。
ModifyDBEndpointAddress	调用 ModifyDBEndpointAddress 接口修改连接地址的前缀或端口。
ModifyDBEndpointDNS	调用 ModifyDBEndpointDNS 接口修改私网地址的解析方式。
CreateDBEndpointPublicAddress	调用 CreateDBEndpointPublicAddress 接口创建公网地址。
DeleteDBEndpointPublicAddress	调用 DeleteDBEndpointPublicAddress 接口删除公网地址。
DescribeDBProxyConfig	调用 DescribeDBProxyConfig 接口查询指定 MySQL 实例的数据库代理信息。
ModifyDBProxyConfig	调用 ModifyDBProxyConfig 接口修改指定 MySQL 实例的连接池模式。
DeleteDBEndpoint	调用 DeleteDBEndpoint 接口删除 Endpoint。
DescribeReadOnlyNodeDelay	调用 DescribeReadOnlyNodeDelay 接口查询只读节点的延迟复制配置。
ModifyReadOnlyNodeDelayReplicationTime	调用 ModifyReadOnlyNodeDelayReplicationTime 接口配置只读节点的延迟复制功能。
ModifyDBProxy	调用 ModifyDBProxy 接口开启或关闭数据库代理功能。
ModifyDBProxySpec	调用 ModifyDBProxySpec 接口变更实例的代理配置。
ModifyDBInstanceGlobalReadOnly	调用 ModifyDBInstanceGlobalReadOnly 接口为实例开启或关闭全局只读功能。
CreateDiagnosticsTask	调用 CreateDiagnosticsTask 接口为实例进行连接诊断。
DescribeDiagnosticsInfos	调用 DescribeDiagnosticsInfos 接口查询实例的连接诊断结果。
RemoveDiagnosticsEntity	调用 RemoveDiagnosticsEntity 接口为实例移除连接诊断记录。
AddDiagnosticsEntity	调用 AddDiagnosticsEntity 接口为实例添加连接诊断的诊断项。
ModifyDBEndpointConnectionMode	调用 ModifyDBEndpointConnectionMode 接口修改连接终端的类型。

账号管理

API	说明
CreateDBAccount	调用 CreateDBAccount 接口创建数据库账号。
DeleteDBAccount	调用 DeleteDBAccount 接口删除账号。
ResetDBAccount	调用 ResetDBAccount 接口重置账号密码。
DescribeDBAccounts	调用 DescribeDBAccounts 接口查看账号列表。
DescribeDBAccountTableColumnInfo	调用 DescribeDBAccountTableColumnInfo 接口查询实例下某个数据库中的表列权限信息。
ModifyDBAccountHost	调用 ModifyDBAccountHost 接口修改普通数据库账号可访问数据库的 IP 地址。
ModifyDBAccountDescription	调用 ModifyDBAccountDescription 接口修改账号的描述信息。
GrantDBAccountPrivilege	调用 GrantDBAccountPrivilege 接口为指定数据库账号赋予数据库权限。
RevokeDBAccountPrivilege	调用 RevokeDBAccountPrivilege 接口撤销数据库账号的权限。

数据库管理

API	说明
CreateDatabase	调用 CreateDatabase 接口创建数据库。
DeleteDatabase	调用 DeleteDatabase 接口删除数据库。
DescribeDatabases	调用 DescribeDatabases 接口查看数据库列表。
GrantDatabasePrivilege	调用 GrantDatabasePrivilege 接口为指定数据库添加授权数据库账号。
RevokeDatabasePrivilege	调用 RevokeDatabasePrivilege 接口撤销对数据库账号的授权。
ModifyDatabaseDescription	调用 ModifyDatabaseDescription 接口修改数据库的描述信息。

安全加密

API	说明
DescribeAllowLists	调用 DescribeAllowLists 接口查看白名单列表。
DescribeAllowListDetail	调用 DescribeAllowListDetail 接口查看白名单详情。
CreateAllowList	调用 CreateAllowList 接口创建白名单。
ModifyAllowList	调用 ModifyAllowList 接口修改白名单。
DeleteAllowList	调用 DeleteAllowList 接口删除白名单。
AssociateAllowList	调用 AssociateAllowList 接口绑定白名单。
DisassociateAllowList	调用 DisassociateAllowList 接口解绑白名单。
SyncAllowList	调用 SyncAllowList 接口同步白名单中绑定的安全组的 IP。
UpgradeAllowListVersion	调用 UpgradeAllowListVersion 接口升级白名单版本。
DescribeDBInstanceSSL	调用 DescribeDBInstanceSSL 接口查询指定 MySQL 实例的 SSL 设置。
ModifyDBInstanceSSL	调用 ModifyDBInstanceSSL 接口修改指定 MySQL 实例的 SSL 配置。
DownloadSSLCertificate	调用 DownloadSSLCertificate 接口下载指定 MySQL 实例的 SSL 证书。
DescribeDBInstanceTDE	调用 DescribeDBInstanceTDE 接口查询实例透明数据加密功能的开启状态。
ModifyDBInstanceTDE	调用 ModifyDBInstanceTDE 接口开启实例的透明数据加密 TDE 功能。
DescribeNonWhiteSessionList	调用 DescribeNonWhiteSessionList 接口查询实例的非白会话。
CleanNonWhiteSession	调用 CleanNonWhiteSession 接口清理实例的非白会话。

备份与恢复

API	说明
CreateBackup	调用 CreateBackup 接口创建备份。
DescribeBackups	调用 DescribeBackups 接口查询数据备份列表。
ModifyBackupName	调用 ModifyBackupName 接口修改数据备份的名称。
DescribeBinlogFiles	调用 DescribeBinlogFiles 接口查询 Binlog 备份文件。
ModifyBackupPublicAccessPolicy	调用 ModifyBackupPublicAccessPolicy 接口修改实例备份的公网下载策略。
DownloadBackup	调用 DownloadBackup 接口下载备份。
GetBackupDownloadLink	调用 GetBackupDownloadLink 接口获取备份下载链接。
RestoreToNewInstance	调用 RestoreToNewInstance 接口将数据恢复到一个新实例。
RestoreToExistedInstance	调用 RestoreToExistedInstance 接口将数据恢复到一个已有数据库实例。
DescribeRecoverableTime	调用 DescribeRecoverableTime 接口查看可恢复时间范围。
DescribeBackupPolicy	调用 DescribeBackupPolicy 接口查询指定实例的备份策略。
ModifyBackupPolicy	调用 ModifyBackupPolicy 接口修改实例的备份策略。
CreateBinlogBackup	调用 CreateBinlogBackup 接口创建日志备份。
DescribeCrossBackupPolicy	调用 DescribeCrossBackupPolicy 接口查看跨地域备份配置。
DescribeAvailableCrossRegion	调用 DescribeAvailableCrossRegion 接口查询可以进行跨地域备份的目的地域。
ModifyCrossBackupPolicy	调用 ModifyCrossBackupPolicy 接口修改跨地域备份策略。
RestoreToCrossRegionInstance	调用 RestoreToCrossRegionInstance 接口将跨地域备份恢复到一个新实例。
DeleteDataBackup	调用 DeleteDataBackup 接口删除手动创建的数据备份。
ModifyBackupEncryptionPolicy	调用 ModifyBackupEncryptionPolicy 接口修改备份加密设置。
DescribeBackupEncryptionStatus	调用 DescribeBackupEncryptionStatus 接口查询实例的备份加密策略。
DescribeBackupDecryptionKey	调用 DescribeBackupDecryptionKey 接口查询备份加密的密钥。
DescribeBackupStats	调用 DescribeBackupStats 接口查询备份文件对实例存储空间的使用信息。
DescribeDeletedDBInstances	调用 DescribeDeletedDBInstances 接口查询已删除实例列表。
DescribeCrossRegionBackupDBInstances	调用 DescribeCrossRegionBackupDBInstances 接口查询开启过和开启了跨地域备份功能的实例列表。

参数管理

API	说明
DescribeDBInstanceParameters	调用 DescribeDBInstanceParameters 接口查询实例参数。
ModifyDBInstanceParameters	调用 ModifyDBInstanceParameters 接口修改实例参数。
DescribeDBInstanceParametersLog	调用 DescribeDBInstanceParametersLog 接口查询实例参数修改历史。
CreateParameterTemplate	调用 CreateParameterTemplate 接口创建参数模板。
ModifyParameterTemplate	调用 ModifyParameterTemplate 接口修改参数模板。
CopyParameterTemplate	调用 CopyParameterTemplate 接口复制参数模板。
DeleteParameterTemplate	调用 DeleteParameterTemplate 接口删除参数模板。
DescribeParameterTemplate	调用 DescribeParameterTemplate 接口查询指定的参数模板详情。
ListParameterTemplates	调用 ListParameterTemplates 接口查询 MySQL 实例的参数模板列表。
DescribeApplyParameterTemplate	调用 DescribeApplyParameterTemplate 接口查询为指定的 MySQL 实例应用某参数模板时的参数变化。
SaveAsParameterTemplate	调用 SaveAsParameterTemplate 接口将指定实例的参数配置保存为参数模板。
DescribeDBNodeParameterDifferences	调用 DescribeDBNodeParameterDifferences 接口查询实例的节点参数差异信息。

任务管理

API	说明
DescribeTasks	调用 DescribeTasks 接口查询任务。
DescribeTaskDetail	调用 DescribeTaskDetail 接口查询任务详情。
ModifyTask	调用 ModifyTask 接口编辑任务。

事件管理

API	说明
DescribePlannedEvents	调用 DescribePlannedEvents 接口查询运维事件。
ModifyPlannedEventExecuteTime	调用 ModifyPlannedEventExecuteTime 接口推迟运维事件的执行时间。

日志管理

API	说明
DescribeFailoverLogs	调用 DescribeFailoverLogs 接口查询 MySQL 实例的主备切换日志。

资源包管理

API	说明
DescribeResourcePackageDetail	调用 DescribeResourcePackageDetail 接口查询资源包的详细使用信息。
CreateResourcePackage	调用 CreateResourcePackage 接口创建资源包。
ListResourcePackages	调用 ListResourcePackages 接口查询资源包列表。
DescribeResourcePackagePrice	调用 DescribeResourcePackagePrice 接口查询资源包的购买价格。
DescribeResourcePackageSpec	调用 DescribeResourcePackageSpec 接口查询资源包的规格。

最近更新时间：2026.04.01 10:42:13

这个页面对您有帮助吗？

有用

无用