文档中心

云数据库 veDB MySQL 版

API 参考

API 列表

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

说明

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

v1（2022-01-01）

全局

API	说明
DescribeRegions	调用 DescribeRegions 接口查询实例可用的地域资源。
DescribeAvailabilityZones	调用 DescribeAvailabilityZones 接口查询当前地域下实例支持的可用区资源。
DescribeDBInstanceSpecs	调用 DescribeDBInstanceSpecs 接口查询可用区支持的节点规格代码。

实例管理

API	说明
CreateDBInstance	调用 CreateDBInstance 接口创建新实例。
DescribeDBInstances	调用 DescribeDBInstances 接口查询实例列表。
DescribeDBInstanceDetail	调用 DescribeDBInstanceDetail 接口查询实例的详情信息。
DeleteDBInstance	调用 DeleteDBInstance 接口删除实例。
RestartDBInstance	调用 RestartDBInstance 接口重启实例。
ModifyDBInstanceName	调用 ModifyDBInstanceName 接口修改实例名称。
ModifyDBInstanceSpec	调用 ModifyDBInstanceSpec 接口修改实例的节点配置。
ModifyDBInstanceChargeType	调用 ModifyDBInstanceChargeType 接口修改实例的计费类型。
ModifyDBInstanceDeletionProtectionPolicy	调用 ModifyDBInstanceDeletionProtectionPolicy 接口开启或关闭实例删除保护功能。
ModifyDBNodeConfig	调用 ModifyDBNodeConfig 接口设置指定节点在主备切换时被选为主节点的优先级。
ModifyDBInstanceMaintenanceWindow	调用 ModifyDBInstanceMaintenanceWindow 接口修改实例的可维护时间段。
ChangeMaster	调用 ChangeMaster 接口切换主节点。
DescribeDBInstanceVersion	调用 DescribeDBInstanceVersion 接口查询目标实例的版本。
DescribeStoragePayablePrice	调用 DescribeStoragePayablePrice 接口查询存储价格。
DescribeDBInstancePriceDetail	调用 DescribeDBInstancePriceDetail 接口查询指定配置实例的价格详情。
DescribeExistDBInstancePrice	调用 DescribeExistDBInstancePrice 接口查询已存在实例的价格详情。
ModifyDBInstanceStorageType	调用 ModifyDBInstanceStorageType 接口修改存储类型。
ModifyConnectionPersistence	调用 ModifyConnectionPersistence 接口开启或关闭实例的连接保持功能。

标签管理

API	说明
AddTagsToResource	调用 AddTagsToResource 接口为一个或多个实例绑定标签。
RemoveTagsFromResource	调用 RemoveTagsFromResource 接口为一个或多个实例解绑标签。

连接管理

API	说明
CreateDBEndpointPublicAddress	调用 CreateDBEndpointPublicAddress 接口开启实例的公网访问功能。
DeleteDBEndpointPublicAddress	调用 DeleteDBEndpointPublicAddress 接口关闭公网访问功能。
CreateDBEndpoint	调用 CreateDBEndpoint 接口为实例创建连接终端。
ModifyDBEndpoint	调用 ModifyDBEndpoint 接口修改连接终端。
DescribeDBEndpoint	调用 DescribeDBEndpoint 接口查询实例连接终端的详细信息。
DeleteDBEndpoint	调用 DeleteDBEndpoint 接口删除连接终端。
ModifyDBEndpointAddress	调用 ModifyDBEndpointAddress 接口修改连接地址端口或前缀。
ModifyDBEndpointDNS	调用 ModifyDBEndpointDNS 接口修改私网地址的解析方式。

数据库

API	说明
CreateDatabase	调用 CreateDatabase 接口创建数据库。
DescribeDatabases	调用 DescribeDatabases 接口查询数据库列表。
DeleteDatabase	调用 DeleteDatabase 接口删除数据库。
ModifyDatabaseDescription	调用 ModifyDatabaseDescription 接口修改数据库的描述信息。

账号

API	说明
CreateDBAccount	调用 CreateDBAccount 接口创建数据库账号。
DeleteDBAccount	调用 DeleteDBAccount 接口删除数据库账号。
DescribeDBAccounts	调用 DescribeDBAccounts 接口查询实例的账号信息。
ResetDBAccount	调用 ResetDBAccount 接口修改账号密码。
ResetAccount	调用 ResetAccount 接口将高权限账号的权限重置到初始状态。
ModifyDBAccountDescription	调用 ModifyDBAccountDescription 接口修改账号的描述信息。
GrantDBAccountPrivilege	调用 GrantDBAccountPrivilege 接口为账号赋予指定数据库的权限。
RevokeDBAccountPrivilege	调用 RevokeDBAccountPrivilege 接口为账号撤销对数据库的权限。

安全

API	说明
CreateAllowList	调用 CreateAllowList 接口创建一个新的白名单。
DescribeAllowLists	调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有白名单信息。
DescribeAllowListDetail	调用 DescribeAllowListDetail 接口查询白名单的详细信息。
DescribeInstanceAllowLists	调用 DescribeInstanceAllowLists 接口查询实例绑定的白名单信息。
ModifyAllowList	调用 ModifyAllowList 接口修改白名单信息。
AssociateAllowList	调用 AssociateAllowList 接口绑定实例与白名单。
DisassociateAllowList	调用 DisassociateAllowList 接口解绑实例与白名单。
DeleteAllowList	调用 DeleteAllowList 接口删除白名单。

备份恢复

API	说明
CreateBackup	调用 CreateBackup 接口手动创建数据备份。
DescribeBackups	调用 DescribeBackups 接口查询实例的备份文件列表。
DescribeBackupPolicy	调用 DescribeBackupPolicy 接口查询实例的数据备份策略。
DeleteBackup	调用 DeleteBackup 接口删除实例的手动备份文件。
ModifyBackupPolicy	调用 ModifyBackupPolicy 接口修改实例的数据备份策略。
DescribeRecoverableTime	调用 DescribeRecoverableTime 接口查询实例备份可恢复的时间范围。
RestoreToNewInstance	调用 RestoreToNewInstance 接口将已有实例的备份数据恢复至一个新的实例中。
DescribeRecoverableTables	调用 DescribeRecoverableTables 接口查询实例可恢复的库和表。
RestoreTable	调用 RestoreTable 接口将实例的历史数据库和表恢复至原实例中。
DescribeCrossRegionBackupPolicy	调用 DescribeCrossRegionBackupPolicy 接口查询实例的跨地域备份策略。
ModifyCrossRegionBackupPolicy	调用 ModifyCrossRegionBackupPolicy 接口设置跨地域备份策略。
DescribeCrossRegionBackupDBInstances	调用 DescribeCrossRegionBackupDBInstances 接口查询当前地域下已开启跨地域备份的实例列表。

参数管理

API	说明
DescribeDBInstanceParameters	调用 DescribeDBInstanceParameters 接口查询实例的参数列表。
ModifyDBInstanceParameters	调用 ModifyDBInstanceParameters 接口修改实例参数。
DescribeParameterTemplates	调用 DescribeParameterTemplates 接口查询参数模板列表。
DescribeParameterTemplateDetail	调用 DescribeParameterTemplateDetail 接口查询参数模板详情。
CreateParameterTemplate	调用 CreateParameterTemplate 接口创建参数模板。
ApplyParameterTemplate	调用 ApplyParameterTemplate 接口应用参数模板。
DeleteParameterTemplate	调用 DeleteParameterTemplate 接口删除参数模板。
SaveAsParameterTemplate	调用 SaveAsParameterTemplate 接口将实例的参数配置保存为参数模板。
DescribeDBInstanceParameterChangeHistory	调用 DescribeDBInstanceParameterChangeHistory 接口查询实例参数修改历史。
DescribeModifiableParameters	调用 DescribeModifiableParameters 接口查询可修改参数列表。
CopyParameterTemplate	调用 CopyParameterTemplate 接口将指定参数模板复制为新的参数模板。
ModifyParameterTemplate	调用 ModifyParameterTemplate 接口编辑参数模板。

计划内事件

API	说明
DescribeScheduleEvents	调用 DescribeScheduleEvents 接口查看当前账号下的计划内事件。
CancelScheduleEvents	调用 CancelScheduleEvents 接口取消待执行的计划内事件。
ModifyScheduleEvents	调用 ModifyScheduleEvents 接口修改待执行事件的执行时间。

v2（2024-01-01）

实例管理

API	说明
ModifyDBInstanceSpec	调用 ModifyDBInstanceSpec 接口修改实例的节点配置。

最近更新时间：2026.07.31 10:06:26

这个页面对您有帮助吗？

有用

无用