You need to enable JavaScript to run this app.
文档中心
云数据库 MySQL 版

云数据库 MySQL 版

复制全文
下载 pdf
备份与恢复
CreateBackup - 创建备份
复制全文
下载 pdf
CreateBackup - 创建备份
调用 CreateBackup 接口创建备份。​
请求类型​
异步请求。​
注意事项​
  • 同一时间一个实例只能执行一个备份任务。​
  • 不支持调用该接口创建日志备份。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
InstanceId​
String​
是​
mysql-e26822cf****​
实例 ID。​
BackupMethod​
String​
否​
Physical​
实例的存储类型不同时,支持的备份类型不同:​
  • 如实例的存储类型为本地盘,可选择物理备份 Physical(默认值) 或逻辑备份 Logical。​
  • 如实例的存储类型为云盘,仅可选择快照备份 Snapshot。​
BackupType​
String​
否​
Full​
备份方式。​
  • 取值范围:​
  • 如备份类型为物理备份 Physical 或快照备份 Snapshot时,备份方式选择为全量备份 Full(默认值)或增量备份 HighFrequencyIncrement。​
  • 如选择备份类型为逻辑备份 Logical,备份方式则应选择为全库备份 DumpAll;为指定库表备份的备份集时,无需传入该参数,仅需在 BackupMeta 参数中指定数据库和表。​
BackupMeta​
Array of BackupMeta​
否​
请参见请求示例。​
创建逻辑备份类型的库表备份时,用于指定要备份的库表信息。​
说明​
  • 进行逻辑备份(BackupMethod=Logical),且备份方式为指定库表备份(BackupType 参数未传入值)时,该参数必填。其他备份类型和备份方式,该参数取值无效。​
  • 数量限制:创建指定库表备份时,库的数量上限为 5000,每个库的表的数量上限为 5000。​
BackupName​
String​
否​
手动备份001​
设置备份的名称。命名规则如下:​
  • 不能以中划线(-)开头。​
  • 只能包含中文、字母、数字、下划线(_)和中划线(-)。​
  • 长度需要在 1~128 个字符之间。​
说明​
如不设置,则采用备份 ID 作为备份名称。​
​
BackupMeta​
​
参数​
类型​
是否必选​
示例值​
描述​
DBName​
String​
是​
db1​
指定需要备份的数据库。​
TableNames​
Array of String​
否​
["table1","table2"]​
指定数据库中需要备份的表。该字段为空时默认为全库备份。​
​
返回参数​
​
参数​
类型​
示例值​
描述​
BackupId​
String​
2c587b3e5b6e409ca38a2c99462a****​
新创建的备份的 ID。​
​
示例​
请求示例 1​
创建备份方式为全量备份的物理备份​
​
POST /?Action=CreateBackup&Version=2022-01-01 HTTP/1.1​
Accept: application/json​
Content-Type: application/json​
Host: rds-mysql.cn-beijing.volcengineapi.com​
X-Date: 20211202T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
"InstanceId": "mysql-ce48081d****",​
"BackupType": "Full",​
"BackupMethod": "Physical"​
}​
​
返回示例 1​
​
{​
"ResponseMetadata": {​
"RequestId": "20230111114312146C48B77B8FB071C1FD",​
"Action": "CreateBackup",​
"Version": "2022-01-01",​
"Service": "rds_mysql",​
"Region": "cn-beijing"​
},​
"Result": {​
"BackupId": "986533aae3ac4e27af6ec1cd2aeeca1d"​
}​
}​
​
请求示例 2​
创建备份方式为全库备份的逻辑备份​
​
POST /?Action=CreateBackup&Version=2022-01-01 HTTP/1.1​
Accept: application/json​
Content-Type: application/json​
Host: rds-mysql.cn-beijing.volcengineapi.com​
X-Date: 20211202T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
"InstanceId": "mysql-ce48081d****",​
"BackupMethod": "Logical",​
"BackupType": "DumpAll"​
}​
​
返回示例 2​
​
{​
"ResponseMetadata": {​
"RequestId": "20230111114312146C48B77B8FB071C1FD",​
"Action": "CreateBackup",​
"Version": "2022-01-01",​
"Service": "rds_mysql",​
"Region": "cn-beijing"​
},​
"Result": {​
"BackupId": "2c587b3e5b6e409ca38a2c99462a****"​
}​
}​
​
请求示例 3​
创建备份方式为库表备份的逻辑备份​
​
POST /?Action=CreateBackup&Version=2022-01-01 HTTP/1.1​
Accept: application/json​
Content-Type: application/json​
Host: rds-mysql.cn-beijing.volcengineapi.com​
X-Date: 20211202T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
"InstanceId": "mysql-ce48081d****",​
"BackupMethod": "Logical",​
"BackupMeta": [​
{​
"DBName": "testdb",​
"Tables": [​
""​
]​
}​
]​
}​
​
返回示例 3​
​
{​
"ResponseMetadata": {​
"RequestId": "20230111114312146C48B77B8FB071C1FD",​
"Action": "CreateBackup",​
"Version": "2022-01-01",​
"Service": "rds_mysql",​
"Region": "cn-beijing"​
},​
"Result": {​
"BackupId": "e2a7f1ea55fb43b281b5fcaf3f5e****"​
}​
}​
​
错误码​
更多详情,请参见错误码。​
​
最近更新时间:2026.06.10 10:58:16
这个页面对您有帮助吗?
有用
有用
无用
无用