Tenant Cloud
Security
Cloud Workload Protection Platform
Advanced Defense APIs
ModifyWebPageProtectDir
1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
This API is used to create or modify a protected directory.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-05-20 15:12:33.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: ModifyWebPageProtectDir |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-02-28 |
| Region | No | No | String | Public parameter,Regional information This interface does not need to pass this parameter. |
| HostConfig | Yes | No | Array of ProtectHostConfig | Protected server information. Example:View |
| ProtectDirAddr | Yes | No | String | URL of the protected directory. Example: /var/www |
| ProtectDirName | Yes | No | String | Name of the protected directory. Example: Web protection |
| ProtectFileType | Yes | No | String | Protected file types, separated with semicolons (:). Example: .html;.php |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InvalidParameter.ParsingError | Parameter parsing error. |
| InvalidParameter.MissingParameter | Missing parameter. |
| InvalidParameter.InvalidFormat | Incorrect parameter format. |
| MissingParameter | Missing parameter. |
| InvalidParameter.IllegalRequest | Invalid request. |
| FailedOperation.AgentOffline | The agent is offline. |
| FailedOperation.APIServerFail | Failed to call the API service. |
| FailedOperation.LicenseExceeded | The number of available licenses is insufficient, and one more license is required. Please purchase a new license. |
| InvalidParameter | Invalid parameter. |
| OperationDenied | Operation denied. |
| InvalidParameterValue | The parameter value is invalid. |
| FailedOperation | Operation failed. |
| FailedOperation.ProtectStartFail | Failed to enable protection. |