文档中心

API 概览

最近更新时间：2024.04.08 15:20:51

首次发布时间：2022.04.12 19:05:30

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

说明

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

全局

API	描述
DescribeRegions	调用 DescribeRegions 接口查询云数据库 veDB MySQL 实例可用的地域资源。
DescribeAvailabilityZones	调用 DescribeAvailabilityZones 接口查询当前地域下 veDB MySQL 实例支持的可用区资源。
DescribeDBInstanceSpecs	调用 DescribeDBInstanceSpecs 接口查询指定可用区支持的节点规格代码。

实例管理

API	描述
CreateDBInstance	调用 CreateDBInstance 接口创建 veDB MySQL 实例。
DescribeDBInstances	调用 DescribeDBInstances 接口查询 veDB MySQL 实例列表。
DescribeDBInstanceDetail	调用 DescribeDBInstanceDetail 接口查询 veDB MySQL 实例的详细信息。
DeleteDBInstance	调用 DeleteDBInstance 接口释放 veDB MySQL 实例。
RestartDBInstance	调用 RestartDBInstance 接口重启 veDB MySQL 实例。
ModifyDBInstanceName	调用 ModifyDBInstanceName 接口修改实例名称。
ModifyDBInstanceSpec	调用 ModifyDBInstanceSpec 接口修改指定 veDB MySQL 实例的节点配置。
ModifyDBInstanceChargeType	调用 ModifyDBInstanceChargeType 接口将 veDB MySQL 实例的计费类型由按量计费转换为包月包月。

标签管理

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

连接管理

API	描述
CreateDBEndpointPublicAddress	调用 CreateDBEndpointPublicAddress 接口为指定的实例创建公网连接地址，即开启实例的公网访问功能。
DeleteDBEndpointPublicAddress	调用 DeleteDBEndpointPublicAddress 接口删除指定实例的公网连接地址，即关闭公网访问功能。
CreateDBEndpoint	调用 CreateDBEndpoint 接口创建连接终端。
ModifyDBEndpoint	调用 ModifyDBEndpoint 接口修改连接终端。
DescribeDBEndpoint	调用 DescribeDBEndpoint 接口查询指定 veDB MySQL 实例连接终端的详细信息。
DeleteDBEndpoint	调用 DeleteDBEndpoint 接口删除连接终端。

数据库

API	描述
CreateDatabase	调用 CreateDatabase 接口创建 veDB MySQL 实例的数据库。
DescribeDatabases	调用 DescribeDatabases 接口查询实例的数据库信息。
DeleteDatabase	调用 DeleteDatabase 接口删除 veDB MySQL 实例的数据库。

账号

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

安全

API	描述
CreateAllowList	调用 CreateAllowList 接口创建一个新的 IP 白名单。
DescribeAllowLists	调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息。
DescribeAllowListDetail	调用 DescribeAllowListDetail 接口查询目标白名单的详细信息，例如 IP 地址和绑定的实例详情。
ModifyAllowList	调用 ModifyAllowList 接口修改目标白名单设置，例如白名单名称、IP 白名单地址等。
AssociateAllowList	调用 AssociateAllowList 接口将目标实例绑定到指定 IP 白名单中。
DisassociateAllowList	调用 DisassociateAllowList 接口将目标实例从指定 IP 白名单中解绑。
DeleteAllowList	调用 DeleteAllowList 接口删除目标白名单。

备份恢复

API	描述
CreateBackup	调用 CreateBackup 接口为指定 veDB MySQL 实例创建数据备份。
DescribeBackups	调用 DescribeBackups 接口查询指定 veDB MySQL 实例的备份文件列表信息。
DescribeBackupPolicy	调用 DescribeBackupPolicy 接口查询指定 veDB MySQL 实例的自动备份策略。
DeleteBackup	调用 DeleteBackup 接口删除指定 veDB MySQL 实例的手动备份文件。
ModifyBackupPolicy	调用 ModifyBackupPolicy 接口修改指定 veDB MySQL 实例的自动备份策略。
DescribeRecoverableTime	调用 DescribeRecoverableTime 接口查询实例备份可恢复的时间范围。
RestoreToNewInstance	调用 RestoreToNewInstance 接口将已有实例的备份数据恢复至一个新的实例中。
DescribeRecoverableTables	调用 DescribeRecoverableTables 接口查询指定实例可恢复的库和表。
RestoreTable	调用 RestoreTable 接口将 veDB MySQL 实例的历史数据库和表恢复至原实例中。

全局

实例管理

标签管理

连接管理

数据库

账号

安全

备份恢复