UpdateInstanceCtl - 更新实例访问控制策略开关--Web应用防火墙-火山引擎

文档中心

立即注册

导航

UpdateInstanceCtl - 更新实例访问控制策略开关

最近更新时间：2025.02.17 14:35:51首次发布时间：2025.02.17 14:35:51

调用 UpdateInstanceCtl 接口，可以修改实例的访问管控策略开关，支持分别设置禁止访问名单开关和允许访问名单开关。

使用说明

本接口需要传入地域信息来修改对应地域下的实例。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=UpdateInstanceCtl&Version=2023-12-25

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateInstanceCtl	要执行的操作，取值：UpdateInstanceCtl。
Version	String	是	2023-12-25	API的版本，取值：2023-12-25。

Body

参数	类型	是否必填	示例值	描述
AllowEnable	Integer	否	1	是否开启当前地域对应实例的允许访问名单策略： 0：关闭 1：启用
BlockEnable	Integer	否	1	是否开启当前地域对应实例的禁止访问名单策略 0：关闭 1：启用
ProjectName	String	否	default	当前资源关联的项目名称。项目名称获取方式参考ListProjectResources - 获取项目资源列表。不传入项目名称参数，也可根据地域信息判断对应的实例。
Region	String	是	cn-beijing	云 WAF 实例所在区域。华北 2（北京）：cn-beijing 华东 2（上海）：cn-shanghai 华南 1（广州）：cn-guangzhou 亚太东南（柔佛）：ap-southeast-1

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=UpdateInstanceCtl&Version=2023-12-25 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241205T115131Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241205/cn-beijing/waf/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "AllowEnable": 1,
  "BlockEnable": 1,
  "ProjectName": "default",
  "Region": "cn-beijing"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241205195147209180165050D5BF67",
    "Action": "UpdateInstanceCtl",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": {}
}

错误码

您可访问公共错误码，获取更多错误码信息。