5.7 备份与恢复
5.7.5 设置自动备份策略
}
自动备份策略关闭：
{ "backup_policy": { "keep_days": 0 }
}
状态码
详情请参见状态码。
错误码
详情请参见错误码。
5.7.5 设置自动备份策略
功能介绍
设置自动备份策略。
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy
● URI样例
https://dds.cn-north-1.myhuaweicloud.com/
v3/97b026aa9cc4417888c14c84a1ad9860/instances/
cc6345c64cec47499182467ea0dd432ain02/backups/policy
● 参数说明
表5-107 参数说明
名称 是否必选 描述
请求消息
● 参数说明
表5-108 参数说明
名称 是否必选 参数类型 描述
backup_policy 是 Object 备份策略对象，包括备 份保留的天数和备份开 始时间。详情请参见表 5-109。
表5-109 backup_policy 字段数据结构说明
名称 是否必选 参数类型 描述
keep_days 是 String 指定已生成的备份文件
可以保存的天数。
取值范围：0～732。取 0值，表示关闭自动备 份策略。
start_time 否 String 备份时间段。自动备份
将在该时间段内触发。
开启自动备份策略时，
该参数必选；关闭自动 备份策略时，不传该参 数。
取值范围：格式必须为 hh:mm-HH:MM，且有 效，当前时间指UTC时 间。
● HH取值必须比hh大 1。
● mm和MM取值必须 相同，且取值必须为 00。
取值示例：
23:00-00:00
名称 是否必选 参数类型 描述
period 否 String 备份周期配置。自动备
份将在每星期指定的天 进行。
取值范围：格式为半角 逗号隔开的数字，数字 代表星期。保留天数取 值不同，备份周期约束 如下：
● 0天，不传该参数。
● 1～6天，备份周期 全选，取值为：
1,2,3,4,5,6,7。
● 7～732天，备份周 期至少选择一周中的 一天。示例：
1,2,3,4。
● 请求体样例
开启或修改自动备份策略：
{ "backup_policy": { "keep_days": 9,
"start_time": "23:00-00:00", "period": "1,4,5,6,7"
} }
关闭自动备份策略：
{ "backup_policy": { "keep_days": 0 }
}
响应消息
{}
状态码
详情请参见状态码。
错误码
详情请参见错误码。
接口约束
● 该接口只支持恢复到按需计费的实例。
● 目标实例与源实例的数据库类型必须一致。
● 根据时间点恢复到新实例目前有副本集实例和4.0版本的集群实例支持该功能。
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
POST https://{Endpoint}/v3/{project_id}/instances
● URI样例
https://dds.cn-north-1.myhuaweicloud.com/
v3/97b026aa9cc4417888c14c84a1ad9860/instances
● 参数说明
表5-110 参数说明
名称 是否必选 描述
project_id 是 租户在某一region下的project ID。
请求消息
● 参数说明
表5-111 参数说明
名称 是否必选 参数类型 描述
name 是 String 实例名称。用于表示实例的
名称，允许和已有名称重 复。
取值范围：长度为4~64位，
必须以字母开头（A~Z或 a~z），区分大小写，可以 包含字母、数字（0~9）、
中划线（-）或者下划线
（_），不能包含其他特殊字 符。
availability_z
one 是 String 可用区ID。
取值：非空，请参见地区和 终端节点。
名称 是否必选 参数类型 描述
vpc_id 是 String 虚拟私有云ID。
获取方法请参见《虚拟私有 云API参考》中“VPC”的内 容。
取值：非空，字符长度校 验，严格UUID正则校验。
subnet_id 是 String 子网ID。
获取方法请参见《虚拟私有 云API参考》中“子网”的 内容。
security_grou
p_id 是 String 指定实例所属的安全组ID。
获取方法请参见《虚拟私有 云API参考》中“安全组”
的内容。
password 否 String 数据库密码。
取值范围：长度为8~32位，
on_id 否 String 磁盘加密时的密钥ID，严格
UUID正则校验。
不传该参数时，表示不进行 磁盘加密。
flavor 是 Array of
objects 实例规格详情。详情请参见 表表5-113。
获取方法请参见查询数据库 规格中参数的值。
restore_point 是 Object 恢复到新实例备份信息详 情。详情请参见表5-112。
名称 是否必选 参数类型 描述 enterprise_pr
oject_id 否 String 企业项目ID。
● 对于未开通企业多项目服 务的用户，不传该参数。
● 对于已开通企业多项目服 务的用户，不传该参数 时，表示为default企业 项目。
获取方式请参见《企业管理 API参考》的“查询企业项 目列表”响应消息表
“enterprise_project字段数 据结构说明”的“id”。
ssl_option 否 String SSL开关选项。
取值：
● 取“0”，表示DDS实例 默认不启用SSL连接。
● 取“1”，表示DDS实例 默认启用SSL连接。
不传该参数时，默认启用 SSL连接。
dss_pool_id 否 String Dec用户专属存储ID，默认 为空。仅Dec用户支持该参 数。
server_group
_policies 否 Array of strings Dec用户云服务器组关联的 策略名称列表。取值包括：
● 取“anti-affinity”，表 示DDS实例开启反亲和部 署，反亲和部署是出于高 可用性考虑，将您的 Primary、Secondary和 Hidden节点分别创建在 不同的物理机上。
DEC用户不传该参数时，默 认不开启反亲和部署。仅 DEC用户支持该参数。
表5-112 restore_point 字段数据结构说明
名称 是否必选 参数类型 描述
instance_id 否 String 实例ID，可以调用“查询实 例列表”接口获取。如果未 申请实例，可以调用“创建 实例”接口创建。
● 当type为“backup”，
为非必选。
● 当type为
“timestamp”，为必 选。
type 否 String 恢复方式，枚举值：
● “backup”，表示使用 备份文件恢复，按照此方 式恢复时，当“type”字 段为非必选时，
“backup_id”必选。
● “timestamp”，表示按 时间点恢复，按照此方式 恢复时，当“type”字段 必选时，“restore_time”必选。
backup_id 否 String 用于恢复的备份ID。当使用 备份文件恢复时需要指定该 参数。
说明当“type”字段为非必选时，
“backup_id”必选。
restore_time 否 Integer 恢复数据的时间点，格式为 UNIX时间戳，单位是毫秒，
时区为UTC。
说明当“type”字段必选时，
“restore_time”必选。
表5-113 flavor 字段数据结构说明
名称 是否必选 参数类型 描述
type 是 String 节点类型。
取值：
● 集群实例包含mongos、
shard和config节点，各
● 集群实例下“mongos”
类型的节点数量可取 2~32。
● “config”类型的组数量 只能取1。
● “replica”类型的组数量 只能取1。
● “single”类型的节点数 量只能取1。
名称 是否必选 参数类型 描述
spec_code 是 String 资源规格编码。获取方法请 参见查询数据库规格中参数
“spec_code”的值。
表5-114 backup_strategy 字段数据结构说明
名称 是否必选 参数类型 描述
start_time 是 String 备份时间段。自动备份将在 该时间段内触发。
取值范围：非空，格式必须 为hh:mm-HH:MM，且有 效，当前时间指UTC时间。
● HH取值必须比hh大1。
● mm和MM取值必须相 同，且取值必须为00。
取值示例：
23:00-00:00
keep_days 否 String 指定已生成的备份文件可以 保存的天数。
取值范围：0~732。
● 取0值，表示不设置自动备 份策略。
● 不传该参数，默认开启自 动备份策略，备份文件默 认保存7天。
说明
请求体样例中参数“region”和“availability_zone”的值为示例值。
● 请求体样例
集群根据备份文件恢复到新实例：
{ "name": "test-cluster-01", "availability_zone": "bbb",
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"spec_code": "dds.mongodb.c3.medium.4.mongos"
}, {
"type": "shard", "size": 40,
"spec_code": "dds.mongodb.c3.medium.4.shard"
}, {
"type": "config", "num": 1, "size": 20,
"spec_code": "dds.mongodb.c3.large.2.config"
} ],
"backup_strategy": {
"start_time": "23:00-00:00", "keep_days": "8"
} }
副本集根据备份文件恢复到新实例：
{ "name": "test-replicaset", "availability_zone": "bbb",
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "Test#%0_",
"restore_point": {
"backup_id": "8f643d252d834a4c916b2db4322f99552734"
}, "flavor": [ {
"type": "replica", "num": 1,
"spec_code": "dds.mongodb.s2.medium.4.repset"
} ],
"backup_strategy": {
"start_time": "23:00-00:00", "keep_days": "8"
} }
单节点根据备份文件恢复到新实例：
{ "name": "test-singlenode", "availability_zone": "bbb",
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "Test#%0_",
"restore_point": {
"backup_id": "8f643d252d834a4c916b2db4322f99552734"
}, "flavor": [ {
"type": "single", "num": 1,
"spec_code": "dds.mongodb.c3.medium.4.single"
} ],
"backup_strategy": {
"start_time": "23:00-00:00", "keep_days": "8"
}}
副本集根据时间点恢复到新实例：
{ "name": "replica-liuyunj1", "availability_zone": "az1xahz",
"vpc_id": "dcdadabc-efed-4518-8b34-4af66fcd97e7", "subnet_id": "4a9348f2-f232-4700-a440-2f1641d80960", "security_group_id": "c57b9db2-cccb-4c0d-b058-7ea51dda0c99", "flavor": [
{
"type": "replica", "num": 1, "size": 100,
"spec_code": "dds.mongodb.c3.large.2.repset"
}
], "backup_strategy": {
"start_time": "08:00-09:00", "keep_days": "8"
}, "restore_point": {
"instance_id": "d5833c2854a4486cb7960f829269e211in02", "type": "timestamp",
"restore_time": 1607689584000 }, "ssl_option": "1"
}
响应消息
● 要素说明
表5-115 要素说明
名称 参数类型 描述
id String 实例ID。
name String 实例名称，与请求参数相同。
datastore Object 数据库信息，与请求参数相
同。详情请参见表5-18。
created String 创建时间为本地时间，格式为
“yyyy-mm-dd hh:mm:ss”。
status String 实例状态，取值为
“creating”。
名称 参数类型 描述
subnet_id String 子网ID，与请求参数相同。
security_group_id String 实例所属的安全组ID，与请求 参数相同。
disk_encryption_id String 磁盘加密的密钥ID，与请求参 数相同。
mode String 实例类型，与请求参数相同。
flavor Array of objects 实例规格详情，与请求参数相 同。详情请参见表5-113。
backup_strategy Object 高级备份策略，与请求参数相 同。详情请参见表5-114。
enterprise_project_i
d String 企业项目ID。取值为“0”，表
示为default企业项目。
dss_pool_id String Dec用户专属存储ID。
job_id String 创建实例的工作流ID。
ssl_option String SSL开关选项，与请求参数相 同。
说明
响应样例中参数“region”和“availability_zone”的值为示例值。
● 响应样例 集群实例：
{ "id": "39b6a1a278844ac48119d86512e0000bin02", "name": "test-cluster-01",
"datastore": {
"type": "DDS-Community", "version": "3.4",
"storage_engine": "wiredTiger"
},
"created": "2019-01-16 09:34:36", "status": "creating",
"region": "aaa",
"availability_zone": "bbb",
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "disk_encryption_id": "",
"mode": "Sharding",
"type": "shard",
"enterprise_project_id": "", "ssl_option":"1",
"job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f"
}
副本集实例：
{ "id": "46dfadfd2b674585a430217f23606cd7in02", "name": "test-replicaset",
"datastore": {
"type": "DDS-Community", "version": "3.4",
"storage_engine": "wiredTiger"
},
"created": "2019-01-16 09:33:08", "status": "creating",
"region": "aaa",
"availability_zone": "bbb",
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "disk_encryption_id": "",
"mode": "ReplicaSet", "flavor": [
"enterprise_project_id": "", "ssl_option":"1",
"job_id": "2408417d-fd4b-40ae-bec6-e09ce594eb5f"
"version": "3.4",
"storage_engine": "wiredTiger"
},
"created": "2019-01-15 12:08:11", "status": "creating",
"region": "aaa",
"availability_zone": "bbb",
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "disk_encryption_id": "",
"mode": "Single",
"enterprise_project_id": "", "ssl_option":"1",
"job_id": "46b65a13-3d52-4c58-a29b-4085d563dc9b"
}
您可以在API Explorer中调试该接口。
URI
● URI格式
GET https://{Endpoint}/v3/{project_id}/backups/download-file?
instance_id={instance_id}&backup_id={backup_id}
● URI样例
https://dds.cn-north-1.myhuaweicloud.com/
v3/97b026aa9cc4417888c14c84a1ad9860/backups/download-file?
instance_id=befb1cfe1f96403780396b0c54f85d11in02&backup_id=bd062e1af2 d248b3bb4cd3dbb4183888br02
● 参数说明
表5-116 参数说明
名称 是否必选 说明
project_id 是 租户在某一region下的project ID。
获取方法请参见获取项目ID。
instance_id 是 实例ID，可以调用“查询实例列表”接口获 取。如果未申请实例，可以调用“创建实例”
接口创建。
backup_id 是 备份ID。
请求消息
无。
响应消息
● 要素说明
表5-117 要素说明
名称 参数类型 说明
files Array of objects 备份包含的文件列表。
详情请参见表5-118。
bucket String 文件所在的桶名。
表5-118 files 字段数据结构说明
名称 参数类型 说明
name String 文件名。
size Long 文件大小，单位：KB。
名称 参数类型 说明 link_expired_tim
e String 下载链接过期时间，格式为
“yyyy-mm-ddThh:mm:ssZ”。
其中，T指某个时间的开始，Z指 时区偏移量，例如UTC时间偏移显 示为+0000。
● 响应样例 { "files": [ {
"name": "43e4feaab48f11e89039fa163ebaa7e4br02.xxx", "size": 2803,
"download_link":"https://obs.domainname.com/rdsbucket.username.1/xxxxxx", "link_expired_time":"2018-08-016T10:15:14+0000"
} ],
"bucket": "rdsbucket.bucketname"
}
状态码
详情请参见状态码。
错误码
详情请参见错误码。
5.7.8 查询可恢复的时间段
功能介绍
查询实例的可恢复时间段。
接口约束
该接口目前支持副本集实例和4.0版本的集群实例。
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore-time
● URI样例
https://dds.cn-north-1.myhuaweicloud.com/
v3/056538411200d4cd2f79c003c7606412/instances/
d5833c2854a4486cb7960f829269e211in02/restore-time?date=2020-12-12
● 参数说明
表5-119 参数说明
名称 是否必选 描述
project_id 是 租户在某一region下的project ID。
instance_id 是 实例ID，可以调用“查询实例列表”接 口获取。如果未申请实例，可以调用
“创建实例”接口创建。
date 是 所需查询的日期，为yyyy-mm-dd字符
串格式，时区为UTC。
请求消息
无。
响应消息
● 要素说明
表5-120 要素说明
名称 参数类型 描述
restore_time Array of objects 可恢复时间段列表，请参见表
restore_time Array of objects 可恢复时间段列表，请参见表