Docs

Web Application Firewall

Instance management

UpdateInstanceCtl

Calling the UpdateInstanceCtl interface can modify the instance access control policy switch, supporting separate settings for the blocklist switch and the allowlist switch.

Note

This interface requires passing in region information to modify instances under the corresponding region.

HTTP request

Method: POST

URL: https://waf.volcengineapi.com/?Action=UpdateInstanceCtl&Version=2023-12-25

Request parameters

Only the request parameters unique to this interface and some common parameters are listed below. For more information, please see Common parameters.

Query

Action string required Example value: UpdateInstanceCtl

Operation to be performed, value: UpdateInstanceCtl.

Version string required Example value: 2023-12-25

The version of the API, value: 2023-12-25.

Body

AllowEnable integer Optional Sample value: 1

Whether to enable the allowlist policy for the current region's corresponding instance:

0: Disabled

1: Enabled

BlockEnable integer Optional Sample value: 1

Whether to enable the blocklist policy for the corresponding instance in the current region

0: Disabled

1: Enabled

ProjectName string Optional Sample value: default

Current project name associated with the resource.

For the method of obtaining project names, refer to ListProjectResources - Get Project Resource List.

If the project name parameter is not passed, it can also determine the corresponding instance based on regional information.

Region string required Sample value: cn-beijing

Cloud WAF instance location region.

North China 2 (Beijing): cn-beijing

East China 2 (Shanghai): cn-shanghai

South China 1 (Guangzhou): cn-guangzhou

AP Southeast (Johor): ap-southeast-1

Response parameters

This interface does not have specific response parameters. For more information, please see Response Structure.

Sample request

POST /?Action=UpdateInstanceCtl&Version=2023-12-25 HTTP/1.1​
Host: waf.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"​
}​

Sample response

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

Error codes

You can visit Public Error Codes for more information on error codes.

Last updated: 2025.06.30 16:25:34