开启或关闭远端备份 - SetRemoteBackupInfo
功能介绍
为已开启网页防篡改的服务器，开启或关闭远端备份功能，仅限Linux服务器
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/wtp/{host_id}/set-remote-backup
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
host_id |
是 |
String |
服务器id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
remote_backup |
是 |
Boolean |
参数解释: 是否开启远端备份 约束限制: 不涉及 取值范围:
默认取值: false |
|
backup_addr |
否 |
String |
参数解释: 远端备份地址，需包含IP和端口，格式为IP:端口 约束限制: 不涉及 取值范围: 字符长度0-256位 默认取值: 不涉及 |
|
backup_host_id |
否 |
String |
参数解释: 远端备份服务器的服务器ID，填写的远端备份服务器ID必须是已运行中的备份服务器ID 约束限制: 需要使用 ListBackupHostsInfo 接口查询已运行中的远端备份服务器，在 ListBackupHostsInfo 接口的响应体中，backup_host_status 等于 1 的 backup_host_id 是已运行的远端备份服务器ID 取值范围: 字符长度0-256位 默认取值: 不涉及 |
响应参数
状态码：200
请求已成功
无
请求示例
开启或关闭远端备份。
POST https://{endpoint}/v5/{project_id}/wtp/{host_id}/set-remote-backup
{
"remote_backup" : false
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
