文档中心
简体
文档
备案
控制台
云数据库 MySQL 版
文档指南
云数据库 MySQL 版
云数据库 MySQL 版
文档指南
请输入
产品动态
新功能发布记录
产品公告
升级数据库代理服务的公告
升级白名单和参数模板功能的公告
更新《服务等级协议》的公告
关于云数据库 MySQL 版规格类型名称变更的公告
2024 年 11 月 20 日起对备份存储空间与代理服务进行计费
2024 年 06 月 06 日面向个人用户开放
2023 年 08 月 09 日升级实例的网络方案 TTGW 为 Inner PLB
2022 年 05 月 17 日上线版本所涉及 API 的改动及兼容说明
产品简介
什么是云数据库 MySQL 版
应用场景
产品规格
约束与限制
术语表
产品计费
概述
计费项与价格
资源包
计费方式
按量计费
包年包月
转包年包月
转按量计费
欠费或到期说明
续费实例
批量续费实例
退订或变配说明
内核功能
内核功能概览
内核小版本发布记录
功能
MDL 锁视图 / DDL 进度显示
设置定时和周期性任务
Sequence Engine
隐藏主键
Flashback Query
存储引擎自动转换为 InnoDB
支持 NOWAIT 语法
向量类型
在线扩展 varchar 字段长度
向量索引
RETURNING
并行 DDL
秒级加列
Recycle Bin
表级并行回放
稳定性
异步删除大表
空闲事务清理
线程池
并发控制
Statement Outline
性能
热点高并发更新
Hotcache
大事务提交 binlog 优化
Buffer pool 初始化流程性能优化
分页查询性能优化
invisible index
支持使用 fdatasync
IN 谓词性能优化
配置 InnoDB 索引的默认合并阈值（merge threshold）
逻辑预读
Buffered Scan
Binlog 并发 Flush
Inplace DDL 性能优化
快速入门
使用流程
创建实例
创建数据库和账号
创建白名单
绑定实例到白名单
连接实例
用户指南
功能概览
实例管理
创建实例
创建相同配置实例
只读节点概述
查看实例列表
查看实例信息
自定义实例列表
查看实例拓扑
变更数据同步方式
迁移可用区
重启实例
批量重启实例
删除或退订实例
变更配置
变更规格
增加节点
删除节点
临时升配
批量变更规格
批量增加节点
变更实例类型
升级版本
手动升级实例内核小版本
修改实例内核小版本升级策略
升级实例数据库大版本
升级实例数据库大版本预检查项
搜索实例
导出实例列表
标签管理
概述
绑定标签
编辑标签
解绑标签
根据标签筛选实例
根据标签为实例分账
将实例加入项目
设置可维护时间段
批量设置可维护时间段
开启或关闭全局只读
暂停与启动实例
设置实例删除保护
有序实例名称设置规则
灾备实例管理
创建灾备实例
创建灾备同步链路
重建灾备实例数据
切换灾备实例为主实例
蓝绿部署管理
创建蓝绿部署
创建蓝绿部署同步链路
查看蓝绿实例差异
重建数据
切换蓝绿实例
蓝绿切换预检查项
删除蓝绿部署
数据迁移
数据迁移方案概览
准备工作
创建并启动迁移任务
查看迁移进度
结束迁移任务
连接管理
数据库代理
关于数据库代理
开启数据库代理
关闭数据库代理
变更代理配置
连接实例
连接地址类型
通用客户端程序连接实例
通过命令行连接实例
管理连接终端
关于连接终端
创建连接终端
查看连接终端
编辑连接终端
删除连接终端
开启或关闭公网访问
开启或关闭读写分离
设置读写分离策略
设置只读节点延迟复制
开启或关闭公网解析
开启或关闭过载保护
开启或关闭事务拆分
开启或关闭连接保持
配置 SQL 转发规则
连接诊断
添加检测项
查看诊断结果
删除检测项
常见网络连接异常及处理
管理连接池模式
关于连接池模式
切换连接池模式
管理实例连接信息
查看实例连接信息
修改连接地址前缀和端口
修改私网 IP 地址
变更实例私有网络和子网
变更实例网络协议类型
使用 Hint 语法
数据库管理
创建数据库
删除数据库
账号与访问授权
账号权限说明
创建账号
重置账号密码
修改账号权限
生成临时 Token
删除账号
跨服务访问授权
通过子用户使用 MySQL 服务
备份恢复
备份数据
关于备份
查看备份列表
修改备份策略
批量修改基础备份策略
批量修改日志备份策略
手动创建数据备份
修改数据备份名称
批量创建数据备份
查看数据备份进度
下载数据备份文件
删除数据备份文件
导出数据备份信息
手动备份 Binlog
下载 Binlog 备份
批量下载 Binlog 备份
下载备份文件密钥
解密备份文件
恢复数据
按备份集恢复到新实例
按时间点恢复到新实例
按备份集恢复到原实例
按时间点恢复到原实例
从物理备份文件恢复到自建数据库
批量回档
按备份集跨地域恢复到新实例
按时间点跨地域恢复到新实例
服务可用性
切换主节点
日志管理
查看日志
数据安全管理
白名单管理
查看当前地域下的白名单列表
查看实例绑定的白名单列表
查看实例绑定的所有 IP 地址
查看白名单详情
创建白名单
修改白名单
删除白名单
绑定实例到白名单
从白名单解绑实例
绑定白名单到实例
从实例解绑白名单
同步安全组
同步白名单
复制白名单
升级白名单
变更白名单所属的项目
清理非白会话
设置 TDE 数据加密
配置 SSL 加密
开启 SSL 加密
下载 CA 证书
更新 SSL 证书
关闭 SSL 加密
参数管理
表达式参数
参数修改规则
修改参数
批量修改参数
修改最大连接数
查看参数修改历史
导出参数配置
创建参数模板
应用参数模板
批量应用参数模板
将参数导出为模板
可修改参数列表（MySQL 5.7）
可修改参数列表（MySQL 8.0）
比较参数
查看实例节点参数差异
比较参数模板
管理参数模板
变更参数模板所属的项目
监控告警
监控指标说明
查看监控信息
创建告警策略
查看事件
创建事件规则
数据库工作台
任务中心
关于任务
查看任务
提前执行任务
修改任务执行时间
取消任务
运维事件
关于运维事件
查看运维事件
提前执行运维事件
修改运维事件的切换时间
已删除实例备份管理
查看已删除实例备份列表
下载已删除实例备份
修改已删除实例备份的保留策略
重建实例
续费解锁
清除已删除实例备份
跨地域备份管理
查看跨地域备份实例列表
修改跨地域备份设置
API 参考
API 说明
V2（2022-01-01）
API 发布历史
API 列表
调用方式
请求结构
公共参数
签名机制
返回结果
全局管理
DescribeRegions - 查看地域列表
DescribeAvailabilityZones - 查看可用区列表
实例管理
CreateDBInstance - 创建实例
DescribeDBInstances - 查看实例列表
DescribeDBInstanceDetail - 查看实例详情
DescribeDBInstanceAttribute - 查询实例的属性
DescribeDBInstanceEndpoints - 查询实例的连接地址列表
DescribeResourceUsage - 查询实例的资源使用情况
DescribeDBInstanceChargeDetail - 查询实例的计费信息
DescribeDBInstanceHAConfig - 查询实例的高可用配置
DescribeDBDisasterRecoveryInstances - 查询实例的灾备实例信息
DescribeDBProxy - 查询实例的代理配置
DescribeDBInstanceSpecs - 查询支持的规格
DescribeDBInstancePriceDetail - 查询例的价格详情
ModifyDBInstanceChargeType - 修改实例的计费方式
ModifyDBInstanceName - 修改实例名称
ModifyDBInstanceMaintenanceWindow - 修改实例的可维护时间窗口
ModifyDBInstanceSpec - 修改实例配置
ModifyDBNodeTemporarySpec - 为实例进行临时升配
ModifyDBNodeSpec - 变更实例的节点规格
CreateDBNodes - 为实例增加节点
DeleteDBNodes - 为实例移除节点
ModifyDBInstanceSyncMode - 修改实例的数据同步方式
ModifyDBInstanceType - 修改指定例的实例类型
SwitchDBInstanceHA - 手动切换指定 MySQL 实例的主备节点
MigrateToOtherZone - 将指定实例的节点迁移至同一地域下的其他可用区
RestartDBInstance - 重启实例
RebuildDBInstance - 通过已删除实例备份重建实例
DeleteDBInstance - 删除实例
DescribeTagsByResource - 查询实例的标签
AddTagsToResource - 为实例绑定标签
RemoveTagsFromResource - 为实例解绑标签
DescribeDBInstanceEngineMinorVersions - 查询实例可升级的内核小版本
UpgradeDBInstanceEngineMinorVersion - 升级实例的内核小版本
ModifyDBInstanceAutoUpgradeEngineMinorVersion - 修改实例内核小版本的升级策略
CreateDrDBInstance - 为指定实例创建灾备实例
SwitchDrInstanceToMaster - 将灾备实例升级为主实例
RebuildDrInstance - 重建灾备实例数据
DescribeDisasterRecoveryRegions - 查看可创建灾备实例的地域列表
ModifyDBInstanceDeletionProtectionPolicy - 设置实例的删除保护功能
UpgradeDBInstanceEngineMajorVersionPrecheck - 对实例进行升级大版本前的预检查
DescribeUpgradeEngineMajorVersionPrecheckResult - 查询升级实例大版本的预检查结果
UpgradeDBInstanceEngineMajorVersion - 升级实例的大版本
StopDBInstance - 暂停实例
StartDBInstance - 启动已暂停的实例
DescribeDBInstanceNodes - 查询实例节点的详细信息
DescribeDBProxyPriceDetail - 查询实例数据库代理服务的计费信息
CreateDBBlueGreenInstance - 为实例创建蓝绿部署
DescribeDBBlueGreenInstance - 查询实例的蓝绿部署信息
SwitchDBPrecheckBlueGreen - 发起蓝绿部署切换的预检查
DescribeDBSwitchBlueGreenPrecheck - 查询蓝绿部署切换的预检查结果
DescribeDBBlueGreenDifferences - 查询蓝绿部署中蓝色实例和绿色实例的差异
SwitchDBBlueGreen - 切换蓝绿部署
RebuildDBGreenInstance - 重建蓝绿部署中的绿色实例
DeleteDBBlueGreenRelation - 删除蓝绿部署
连接管理
CreateDBEndpoint - 创建连接终端
ModifyDBEndpoint - 修改连接终端
ModifyDBEndpointAddress - 修改连接地址的前缀或端口
ModifyDBEndpointDNS - 修改私网地址的解析方式
CreateDBEndpointPublicAddress - 创建公网地址
DeleteDBEndpointPublicAddress - 删除公网地址
DescribeDBProxyConfig - 查询指定 MySQL 实例的数据库代理信息
ModifyDBProxyConfig - 修改指定 MySQL 实例的连接池模式
DeleteDBEndpoint - 删除连接终端
DescribeReadOnlyNodeDelay - 查询只读节点的延迟复制配置
ModifyReadOnlyNodeDelayReplicationTime - 配置只读节点的延迟复制功能
ModifyDBProxy - 开启或关闭数据库代理功能
ModifyDBProxySpec - 变更实例的代理配置
ModifyDBInstanceGlobalReadOnly - 为实例开启或关闭全局只读功能
CreateDiagnosticsTask - 为实例进行连接诊断
DescribeDiagnosticsInfos - 查询实例的连接诊断结果
RemoveDiagnosticsEntity - 为实例移除连接诊断记录
AddDiagnosticsEntity - 为实例添加连接诊断的诊断项
ModifyDBEndpointConnectionMode - 修改连接终端的类型
账号管理
CreateDBAccount - 创建数据库账号
DeleteDBAccount - 删除账号
ResetDBAccount - 重置账号密码
DescribeDBAccounts - 查看账号列表
DescribeDbAccountTableColumnInfo - 查询实例下某个数据库中的表列权限信息
ModifyDBAccountHost - 修改普通数据库账号可访问数据库的 IP 地址
ModifyDBAccountDescription - 修改账号的描述信息
GrantDBAccountPrivilege - 为指定数据库账号赋予数据库权限
RevokeDBAccountPrivilege - 撤销数据库账号的权限
数据库管理
CreateDatabase - 创建数据库
DeleteDatabase - 删除数据库
DescribeDatabases - 查看数据库列表
GrantDatabasePrivilege - 为指定数据库添加授权数据库账号
RevokeDatabasePrivilege - 撤销对数据库账号的授权
ModifyDatabaseDescription - 修改数据库的描述信息
安全加密
接口说明
DescribeAllowLists - 查看白名单列表
DescribeAllowListDetail - 查看白名单详情
CreateAllowList - 创建白名单
ModifyAllowList - 修改白名单
DeleteAllowList - 删除白名单
AssociateAllowList - 绑定白名单
DisassociateAllowList - 解绑白名单
SyncAllowList - 同步白名单中绑定的安全组的 IP
UpgradeAllowListVersion - 升级白名单版本
DescribeDBInstanceSSL - 查询指定 MySQL 实例的 SSL 设置
ModifyDBInstanceSSL - 修改指定 MySQL 实例的 SSL 配置
DownloadSSLCertificate - 下载指定 MySQL 实例的 SSL 证书
DescribeDBInstanceTDE - 查询实例透明数据加密功能的开启状态
ModifyDBInstanceTDE - 开启实例的透明数据加密 TDE 功能
DescribeNonWhiteSessionList - 查询实例的非白会话
CleanNonWhiteSession - 清理实例的非白会话
备份与恢复
CreateBackup - 创建备份
DescribeBackups - 查询数据备份列表
ModifyBackupName - 修改备份名称
DescribeBinlogFiles - 查询 Binlog 备份文件
ModifyBackupPublicAccessPolicy - 修改实例备份的公网下载策略
DownloadBackup - 下载备份
GetBackupDownloadLink - 获取备份下载链接
RestoreToNewInstance - 将数据恢复到一个新实例
RestoreToExistedInstance - 将数据恢复到一个已有数据库实例
DescribeRecoverableTime - 查看可恢复时间范围
DescribeBackupPolicy - 查询指定实例的备份策略
ModifyBackupPolicy - 修改实例的备份策略
CreateBinlogBackup - 创建日志备份
DescribeCrossBackupPolicy - 查看跨地域备份配置
DescribeAvailableCrossRegion - 查询可进行跨地域备份的目的地域
ModifyCrossBackupPolicy - 修改跨地域备份策略
RestoreToCrossRegionInstance - 将跨地域备份恢复到一个新实例
DeleteDataBackup - 删除手动创建的数据备份
ModifyBackupEncryptionPolicy - 修改备份加密设置
DescribeBackupEncryptionStatus - 查询实例的备份加密策略
DescribeBackupDecryptionKey - 查询备份加密的密钥
DescribeBackupStats - 查询备份文件对实例存储空间的使用信息
DescribeDeletedDBInstances - 查询已删除实例列表
DescribeCrossRegionBackupDBInstances - 查询开启过和开启了跨地域备份功能的实例列表
参数管理
DescribeDBInstanceParameters - 查询实例参数
ModifyDBInstanceParameters - 修改实例参数
DescribeDBInstanceParametersLog - 查询实例参数修改历史
CreateParameterTemplate - 创建参数模板
ModifyParameterTemplate - 修改参数模板
CopyParameterTemplate - 复制参数模板
DeleteParameterTemplate - 删除参数模板
DescribeParameterTemplate - 查询指定的参数模板详情
ListParameterTemplates - 查询例的参数模板列表
DescribeApplyParameterTemplate - 查询为指定的 MySQL 实例应用某参数模板时的参数变化
SaveAsParameterTemplate - 将指定实例的参数配置保存为参数模板
DescribeDBNodeParameterDifferences - 查询实例的节点参数差异信息
任务管理
DescribeTasks - 查询任务
DescribeTaskDetail - 查询任务详情
ModifyTask - 编辑任务
事件管理
DescribePlannedEvents - 查询运维事件
ModifyPlannedEventExecuteTime - 推迟运维事件的执行时间
日志管理
DescribeFailoverLogs - 查询 MySQL 实例的主备切换日志
资源包管理
DescribeResourcePackageDetail - 查询资源包详情
CreateResourcePackage - 创建资源包
ListResourcePackages - 查询资源包列表
DescribeResourcePackagePrice - 查询资源包价格
DescribeResourcePackageSpec - 查询资源包的规格
附录
公共错误码
SDK 参考
V2（2022-01-01）
SDK 发布历史
概述
Python SDK
下载与安装
初始化客户端
代码示例
Go SDK
下载与安装
初始化客户端
代码示例
Java SDK
下载与安装
初始化客户端
代码示例
开发者工具
Terraform
概述
安装 Terraform
使用 Terraform 创建 MySQL 实例
Pulumi
最佳实践
MySQL 压缩技术使用方法
基于 MySQL 使用 LangChain 框架搭建一个 RAG 应用
使用 OpenClaw 管理云数据库 MySQL 版资源
性能白皮书
测试方法
测试环境
测试工具
测试模型
测试方法
测试指标
MySQL 5.7测试结果
MySQL 8.0测试结果
常见问题
故障排查
如何解决 CPU 使用率过高的问题
如何解决内存使用率过高的问题
如何解决主从复制延迟过高的问题
如何解决实例磁盘满问题
如何处理隐藏主键相关报错
相关协议
数据库产品和服务条款
服务等级协议
附录
禁用词列表
预置告警模板列表
文档首页
云数据库 MySQL 版
API 参考
V2（2022-01-01）
连接管理
ModifyDBProxy - 开启或关闭数据库代理功能
复制全文
下载 pdf
我的收藏
连接管理
ModifyDBProxy - 开启或关闭数据库代理功能
复制全文
下载 pdf
我的收藏
ModifyDBProxy - 开启或关闭数据库代理功能
文档反馈
问问助手
最近更新时间：2026.04.09 11:58:30
这个页面对您有帮助吗？
有用
有用
无用
无用
文档反馈
问问助手