接口说明
适用引擎
RDS MySQL
说明
仅支持本地盘实例。
相关功能文档
注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。
关于如何在实例释放后保留备份,请参见自动备份。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI
Explorer可以自动生成SDK代码示例。
调试调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:DescribeDetachedBackups | READ |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 否 |
实例ID。可调用DescribeDBInstances获取。 |
rm-uf6wjk5**** |
BackupId | string | 否 |
备份集ID。 |
327**** |
BackupStatus | string | 否 |
备份集状态,取值:
|
Success |
BackupMode | string | 否 |
备份模式,取值:
|
Automated |
StartTime | string | 否 |
查询开始时间。 格式:yyyy-MM-ddTHH:mmZ(UTC时间)。 |
2021-03-01T16:00Z |
EndTime | string | 否 |
查询结束时间,需要大于查询开始时间。 格式:yyyy-MM-ddTHH:mmZ(UTC时间)。 |
2021-03-15T16:00Z |
PageSize | integer | 否 |
每页记录数,取值:
说明 | 30 |
PageNumber | integer | 否 | 页码,取值:大于0且不超过Integer的最大值。 说明 | 1 |
Region | string | 是 | 实例所在的地域。 |
cn-hangzhou |
ResourceGroupId | string | 否 |
资源组ID。 |
rg-acfmy**** |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object |
返回参数详情。 |
||
PageNumber | string |
页码。 |
1 |
RequestId | string |
请求ID。 |
1A6D328C-84B8-40DC-BF49-6C73984D7494 |
PageRecordCount | string |
本页备份集个数。 |
30 |
TotalRecordCount | string |
总记录数。 |
100 |
Items | object [] |
备份集列表。 |
|
ConsistentTime | long |
备份集的一致性时间点。返回值为时间戳。 说明 | 1576506856 |
StoreStatus | string | 该数据备份是否可删除,返回值:
|
Disabled |
BackupStatus | string |
备份集状态,返回值:
|
Success |
BackupType | string |
备份类型,返回值:
|
FullBackup |
BackupStartTime | string |
本次备份开始时间。 格式:yyyy-MM-ddTHH:mmZ(UTC时间)。 |
2019-02-03T12:20:00Z |
BackupDownloadURL | string |
公网下载地址,若当前不可下载,则为空串。 |
http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/**** |
IsAvail | integer |
备份集是否可用,返回值:
|
1 |
MetaStatus | string |
库表恢复的备份集状态,返回值:
|
OK |
BackupEndTime | string |
本次备份结束时间。 格式:yyyy-MM-ddTHH:mmZ(UTC时间)。 |
2019-02-13T12:20:00Z |
BackupId | string |
备份集ID。 |
32102**** |
HostInstanceID | string |
产生备份集的实例编号,用于区分该备份集产生于主实例或备实例。 |
588**** |
BackupIntranetDownloadURL | string |
内网下载地址,若当前不可下载,则为空串。 |
http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/**** |
BackupSize | long |
备份文件大小,单位:Byte。 |
2167808 |
BackupMode | string |
备份模式,返回值:
|
Automated |
DBInstanceId | string |
实例ID。 |
rm-uf6wjk5**** |
DBInstanceComment | string |
实例备注。 |
test |
BackupMethod | string |
备份方式,返回值:
|
Physical |
示例
正常返回示例
JSON
格式
{
"PageNumber": "1",
"RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
"PageRecordCount": "30",
"TotalRecordCount": "100",
"Items": {
"Backup": [
{
"ConsistentTime": 1576506856,
"StoreStatus": "Disabled",
"BackupStatus": "Success",
"BackupType": "FullBackup",
"BackupStartTime": "2019-02-03T12:20:00Z",
"BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****",
"IsAvail": 1,
"MetaStatus": "OK",
"BackupEndTime": "2019-02-13T12:20:00Z",
"BackupId": "32102****",
"HostInstanceID": "588****",
"BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/****",
"BackupSize": 2167808,
"BackupMode": "Automated",
"DBInstanceId": "rm-uf6wjk5****",
"DBInstanceComment": "test",
"BackupMethod": "Physical"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2022-08-04 | OpenAPI 入参发生变更 | 看变更集 | ||||
|
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/156519.html