开启关闭网页防篡改防护 - SetWtpProtectionStatusInfo
功能介绍
开启关闭网页防篡改防护
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/webtamper/static/status
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
region |
否 |
String |
参数解释: 区域ID,用于查询目的区域内的资产。获取方式请参见获取区域ID。 约束限制: 不涉及 取值范围: 字符长度1-128位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
status |
是 |
Boolean |
参数解释: 防护状态 约束限制: 不涉及 取值范围:
默认取值: False |
|
host_id_list |
是 |
Array of strings |
参数解释: 需要开启或关闭防护的服务器ID列表。 约束限制 : 开启防护时,需要使用 ListWtpProtectHost 接口查询网页防篡改主机防护状态列表信息,在 ListWtpProtectHost 接口的响应体中,protect_status 等于 closed 且 agent_status 等于 online 的 host_id 是符合开启防护的服务器ID。 取值范围: 最少1条,最多20000条 默认取值 : 不涉及 |
|
charging_mode |
否 |
String |
参数解释: 计费模式 约束限制: 不涉及 取值范围:
默认取值: on_demand |
|
resource_id |
否 |
String |
参数解释: 资源ID,即网页防篡改配额的配额ID,当charging_mode选择packet_cycle时可填写该字段,表示使用一个指定配额,也可不填写该字段,表示随机选择符合的配额。 约束限制 : 不涉及 取值范围: 字符长度0-64位 默认取值 : 不涉及 |
响应参数
状态码:200
请求已成功
无
请求示例
开启网页防篡改防护,目标服务器ID为96ae7317-b5c4-4bc8-aa90-eda53f23e99e,计费模式为包年/包月。
POST https://{endpoint}/v5/{project_id}/webtamper/static/status
{
"status" : true,
"host_id_list" : [ "96ae7317-b5c4-4bc8-aa90-eda53f23e99e" ],
"resource_id" : "",
"charging_mode" : "packet_cycle"
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。