文档中心

API 概览

最近更新时间：2023.11.06 20:56:11

首次发布时间：2021.11.25 20:23:49

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

说明

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

全局

API	描述
ListRegions	调用 ListRegions 接口查询 MySQL 实例可用的地域资源。
ListZones	调用 ListZones 接口查询 MySQL 实例可用的可用区资源。
ListVpcs	调用 ListVpcs 接口查询 MySQL 实例可用的 VPC 资源。

API	描述
CreateDBInstance	调用 CreateDBInstance 接口创建一个 MySQL 实例。
ListDBInstances	调用 ListDBInstances 接口查询 MySQL 实例列表。
DescribeDBInstance	调用 DescribeDBInstance 接口获取 MySQL 实例的详细信息。
DeleteDBInstance	调用 DeleteDBInstance 接口释放 MySQL 实例。
RestartDBInstance	调用 RestartDBInstance 接口重启 MySQL 实例。
ModifyDBInstance	调用 ModifyDBInstance 接口修改实例的节点规格、节点数量和存储空间。

API	描述
DescribeDBInstanceConnection	调用 DescribeDBInstanceConnection 接口获取 MySQL 实例的所有连接地址信息。

API	描述
CreateAccount	调用 CreateAccount 接口创建管理数据库的账号。
DeleteAccount	调用 DeleteAccount 接口删除数据库账号。
ModifyDBAccountDescription	调用 ModifyDBAccountDescription 接口修改账号的描述信息。
ResetAccountPassword	调用 ResetAccountPassword 接口重置数据库账号密码。
ListAccounts	调用 ListAccounts 接口查询实例的数据库账号信息。
GrantAccountPrivilege	调用 GrantAccountPrivilege 接口授权账号访问数据库。

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

老版本（ v1 ）

API	描述
ListDBInstanceIPLists	调用 ListDBInstanceIPLists 接口查询白名单列表。
CreateDBInstanceIPList	调用 CreateDBInstanceIPList 接口创建白名单。
ModifyDBInstanceIPList	调用 ModifyDBInstanceIPList 接口修改白名单。
DeleteDBInstanceIPList	调用 DeleteDBInstanceIPList 接口删除白名单。

新版本（ v2 ）

API	描述
DescribeAllowLists	调用 DescribeAllowLists 接口获取白名单列表。
DescribeAllowListDetail	调用 DescribeAllowListDetail 接口获取白名单详情。
CreateAllowList	调用 CreateAllowList 接口创建白名单。
ModifyAllowList	调用 ModifyAllowList 接口修改白名单。
DeleteAllowList	调用 DeleteAllowList 接口删除白名单。
AssociateAllowList	调用 AssociateAllowList 接口绑定白名单。
DisassociateAllowList	调用 DisassociateAllowList 接口解绑白名单。
UpgradeAllowListVersion	调用 UpgradeAllowListVersion 接口升级白名单版本。

API	描述
CreateBackup	调用 CreateBackup 接口创建一个 MySQL 实例的数据备份。
ListBackups	调用 ListBackups 接口查询备份集列表。

API	描述
RecoveryDBInstance	调用 RecoveryDBInstance 接口恢复一个 MySQL 实例。
DescribeRecoverableTime	调用 DescribeRecoverableTime 接口获取 MySQL 实例备份可恢复的时间范围。

API	描述
ListInstanceParams	调用 ListInstanceParams 接口查询 MySQL 实例的参数列表。
ModifyInstanceParams	调用 ModifyInstanceParams 接口修改 MySQL 实例的参数值。
ListInstanceParamsHistory	调用 ListInstanceParamsHistory 接口查询 MySQL 实例的参数修改历史。
ListParameterTemplates	调用 ListParameterTemplate 接口查询 MySQL 实例的参数模板列表。
DescribeParameterTemplate	调用 DescribeParameterTemplate 接口获取 MySQL 实例的参数模板详情。
CreateParameterTemplate	调用 CreateParameterTemplate 接口创建 MySQL 实例的参数模板。
ModifyParameterTemplate	调用 ModifyParameterTemplate 接口修改 MySQL 实例的参数模板。
DeleteParameterTemplate	调用 DeleteParameterTemplate 接口删除 MySQL 实例的参数模板。
CopyParameterTemplate	调用 CopyParameterTemplate 接口复制 MySQL 实例的参数模板。
DescribeApplyParameterTemplate	调用 DescribeApplyParameterTemplate 接口应用 MySQL 实例的参数模板。
SaveAsParameterTemplate	调用 SaveAsParameterTemplate 接口将当前参数配置保存为 MySQL 实例的参数模板。

全局

实例

连接地址

账号

数据库

安全加密

备份

恢复

参数