You need to enable JavaScript to run this app.
导航

API 概览

最近更新时间2024.04.11 22:47:24

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

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

说明

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

全局管理

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

实例管理

API
描述
CreateDBInstance调用 CreateDBInstance 接口创建实例。
DescribeDBInstances调用 DescribeDBInstances 接口查看实例列表。
DescribeDBInstanceDetail调用 DescribeDBInstanceDetail 接口查看实例详情。
DescribeDBInstanceSpecs 调用 DescribeDBInstanceSpecs 接口查询 MySQL 支持的实例规格代码。
DescribeDBInstancePriceDetail调用 DescribeDBInstancePriceDetail 接口查询包年包月和按量付费实例的购买价格,以及按量付费实例的变更配置的新价格。
ModifyDBInstanceChargeType调用 ModifyDBInstanceChargeType 接口修改按量计费实例的计费方式为包年包月。
ModifyDBInstanceName调用 ModifyDBInstanceName 接口修改实例名称。
ModifyDBInstanceMaintenanceWindow调用 ModifyDBInstanceMaintenanceWindow 接口修改指定 MySQL 实例的可维护时间段。
ModifyDBInstanceSpec调用 ModifyDBInstanceSpec 接口修改实例配置。
ModifyDBInstanceSyncMode调用 ModifyDBInstanceSyncMode 接口修改实例的数据同步方式。
SwitchDBInstanceHA调用 SwitchDBInstanceHA 接口手动切换指定 MySQL 实例的主备节点。
MigrateToOtherZone调用 MigrateToOtherZone 接口将指定实例的节点迁移至同一地域下的其他可用区。
RestartDBInstance调用 RestartDBInstance 接口重启实例。
DeleteDBInstance调用 DeleteDBInstance 接口删除实例。
RebuildDBInstance调用 RebuildDBInstance 接口对已删除实例备份中的 MySQL 备份进行重建。
AddTagsToResource调用 AddTagsToResource 接口为一个或多个 MySQL 实例绑定标签。
DescribeTagsByResource调用 DescribeTagsByResource 接口查询一个或多个 MySQL 实例的标签。
RemoveTagsFromResource调用 RemoveTagsFromResource 接口为一个或多个 MySQL 实例解绑标签。

连接管理

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 接口配置只读节点的延迟复制功能。

账号管理

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

数据库管理

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

安全加密

API
描述
CreateAllowList调用 CreateAllowList 接口创建白名单。
DescribeAllowLists调用 DescribeAllowLists 接口查看白名单列表。
DescribeAllowListDetail调用 DescribeAllowListDetail 接口查看白名单详情。
ModifyAllowList调用 ModifyAllowList 接口修改白名单。
AssociateAllowList调用 AssociateAllowList 接口绑定白名单。
DisassociateAllowList调用 DisassociateAllowList 接口解绑白名单。
UpgradeAllowListVersion调用 UpgradeAllowListVersion 接口升级白名单版本。
DeleteAllowList调用 DeleteAllowList 接口删除白名单。
DescribeDBInstanceSSL调用 DescribeDBInstanceSSL 接口查询指定 MySQL 实例的 SSL 设置。
ModifyDBInstanceSSL调用 ModifyDBInstanceSSL 接口修改指定 MySQL 实例的 SSL 设置。
DownloadSSLCertificate调用 DownloadSSLCertificate 接口下载指定 MySQL 实例的 SSL 证书。
DescribeDBInstanceTDE调用 DescribeDBInstanceTDE 接口查询实例透明数据加密功能的开启状态。
ModifyDBInstanceTDE调用 ModifyDBInstanceTDE 接口开启实例的透明数据加密 TDE 功能。

备份与恢复

API
描述
CreateBackup调用 CreateBackup 接口创建备份。
CreateBinlogBackup调用 CreateBinlogBackup 接口手动上传 Binlog 到 TOS。
DescribeBackups调用 DescribeBackups 接口查看备份文件列表。
DescribeBinlogFiles调用 DescribeBinlogFiles 接口查询 Binlog 备份文件。
DescribeBackupPolicy调用 DescribeBackupPolicy 接口查询指定 MySQL 实例的数据备份和日志备份策略。
DescribeCrossBackupPolicy调用 DescribeCrossBackupPolicy 接口查看实例的跨地域备份配置。
DescribeAvailableCrossRegion调用 DescribeAvailableCrossRegion 接口查询可以进行跨地域备份的目的地域。
ModifyBackupPolicy调用 ModifyBackupPolicy 接口修改 MySQL 实例的数据备份和日志备份策略。
ModifyCrossBackupPolicy调用 ModifyCrossBackupPolicy 接口修改跨地域备份配置。
DownloadBackup调用 DownloadBackup 接口下载备份。
GetBackupDownloadLink调用 GetBackupDownloadLink 接口获取备份下载链接。
DeleteDataBackup调用 DeleteDataBackup 接口删除指定 MySQL 实例的手动备份文件。
DescribeRecoverableTime调用 DescribeRecoverableTime 接口查看可恢复时间范围。
RestoreToNewInstance调用 RestoreToNewInstance 接口将数据恢复到一个新实例。
RestoreToExistedInstance调用 RestoreToExistedInstance 接口将数据恢复到一个已有数据库实例。

参数管理

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

任务管理

API
描述
DescribeTasks调用 DescribeTasks 接口查询任务。
ModifyTask调用 ModifyTask 接口编辑任务。

事件管理

API
描述
DescribePlannedEvents调用 DescribePlannedEvents 接口查询计划内事件的列表信息。
ModifyPlannedEventExecuteTime调用 ModifyPlannedEventExecuteTime 接口推迟计划内运维事件执行的时间。

日志管理

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