status
|
-Integer
+ | Integer
|
-Rule status. The value can be 0 or 1.
+ | Rule status. The value can be 0 or 1.
0: The rule is disabled.
1: The rule is enabled.
@@ -242,26 +241,26 @@
Status code: 400
-Table 6 Response body parametersParameter
+Table 6 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -269,26 +268,26 @@
Status code: 401
-Table 7 Response body parametersParameter
+Table 7 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -296,26 +295,26 @@
Status code: 500
-Table 8 Response body parametersParameter
+Table 8 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
diff --git a/docs/wafd/api-ref/CreateAntileakageRules.html b/docs/wafd/api-ref/CreateAntileakageRules.html
index 948e6956d..266a1d0df 100644
--- a/docs/wafd/api-ref/CreateAntileakageRules.html
+++ b/docs/wafd/api-ref/CreateAntileakageRules.html
@@ -1,7 +1,7 @@
-Creating an Information Leakage Prevention Rule
-FunctionThis API is used to create an information leakage prevention rule.
+ Creating an Information Leakage Protection Rule
+ FunctionThis API is used to create an information leakage protection rule.
URIPOST /v1/{project_id}/waf/policy/{policy_id}/antileakage
@@ -64,7 +64,6 @@
String
|
Content type.
-Default: application/json;charset=utf8
|
@@ -98,11 +97,7 @@
Sensitive information type in the information leakage prevention rule.
sensitive: The rule masks sensitive user information, such as ID code, phone numbers, and email addresses.
-code: The rule blocks returned pages of specified HTTP response code.
-
-Enumeration values:
-
|
@@ -112,8 +107,8 @@
Array of strings
|
- Content corresponding to the sensitive information type. Multiple options can be selected.
-When the value of category is code, the returned pages that contain the following HTTP response codes will be blocked: 400, 401, 402, 403, 404, 405, 500, 501, 502, 503, 504 and 507.
+Content corresponding to the sensitive information type. Multiple options can be set.
+When category is set to code, the pages that contain the following HTTP response codes will be blocked: 400, 401, 402, 403, 404, 405, 500, 501, 502, 503, 504 and 507.
When category is set to sensitive, parameters phone, id_card, and email can be set.
|
@@ -124,7 +119,7 @@
|
String
|
- Rule description.
+ | Rule description
|
@@ -133,78 +128,70 @@
Response ParametersStatus code: 200
- Table 4 Response body parametersParameter
+Table 4 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-id
+ | id
|
-String
+ | String
|
-Rule ID.
+ | Rule ID
|
-url
+ | url
|
-String
+ | String
|
-URL to which the rule applies.
+ | URL to which the rule applies.
|
-category
+ | category
|
-String
+ | String
|
-Sensitive information type in the information leakage prevention rule.
+ | Sensitive information type in the information leakage prevention rule.
sensitive: The rule masks sensitive user information, such as ID code, phone numbers, and email addresses.
-code: The rule blocks returned pages of specified HTTP response code.
-
-Enumeration values:
-
|
-contents
+ | contents
|
-Array of strings
+ | Array of strings
|
-Content corresponding to the sensitive information type. Multiple options can be selected.
-When the value of category is code, the returned pages that contain the following HTTP response codes will be blocked: 400, 401, 402, 403, 404, 405, 500, 501, 502, 503, 504 and 507.
+Content corresponding to the sensitive information type. Multiple options can be set.
+When category is set to code, the pages that contain the following HTTP response codes will be blocked: 400, 401, 402, 403, 404, 405, 500, 501, 502, 503, 504 and 507.
When category is set to sensitive, parameters phone, id_card, and email can be set.
|
|
-timestamp
+ | timestamp
|
-Long
+ | Long
|
-Timestamp the rule was created.
+ | Timestamp when the rule was created.
|
-description
+ | description
|
-String
+ | String
|
-Rule description.
+ | Rule description.
|
-status
+ | status
|
-Integer
+ | Integer
|
-Rule status. The value can be:
+ | Rule status. The value can be:
0: The rule is disabled.
1: The rule is enabled.
-Enumeration values:
-
|
@@ -212,26 +199,26 @@
Status code: 400
-Table 5 Response body parametersParameter
+Table 5 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -239,26 +226,26 @@
Status code: 401
-Table 6 Response body parametersParameter
+Table 6 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -266,26 +253,26 @@
Status code: 500
-Table 7 Response body parametersParameter
+Table 7 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
diff --git a/docs/wafd/api-ref/CreateAntitamperRule.html b/docs/wafd/api-ref/CreateAntitamperRule.html
index fa6a06dcc..0a4ccce7a 100644
--- a/docs/wafd/api-ref/CreateAntitamperRule.html
+++ b/docs/wafd/api-ref/CreateAntitamperRule.html
@@ -1,7 +1,7 @@
Creating a Web Tamper Protection Rule
-FunctionThis API is used to create a web tamper protection rule.
+ FunctionThis API is used to create a web tamper protection rule.
URIPOST /v1/{project_id}/waf/policy/{policy_id}/antitamper
@@ -64,7 +64,6 @@
String
|
Content type
-Default: application/json;charset=utf8
|
@@ -114,64 +113,64 @@
Response ParametersStatus code: 200
- Table 4 Response body parametersParameter
+Table 4 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-id
+ | id
|
-String
+ | String
|
-Rule ID.
+ | Rule ID.
|
-policyid
+ | policyid
|
-String
+ | String
|
-Policy ID
+ | Policy ID
|
-timestamp
+ | timestamp
|
-Long
+ | Long
|
-Timestamp
+ | Timestamp
|
-description
+ | description
|
-String
+ | String
|
-Rule description.
+ | Rule description.
|
-status
+ | status
|
-Integer
+ | Integer
|
-Rule status. The value can be:
+ | Rule status. The value can be:
0: The rule is disabled.
1: The rule is enabled.
|
-hostname
+ | hostname
|
-String
+ | String
|
-The domain name of the website protected with the web tamper protection rule. The domain name is in the format of xxx.xxx.com, such as www.example.com.
+ | The domain name of the website protected with the web tamper protection rule. The domain name is in the format of xxx.xxx.com, such as www.example.com.
|
-url
+ | url
|
-String
+ | String
|
-URL for the web tamper protection rule.
+ | URL for the web tamper protection rule.
|
@@ -179,26 +178,26 @@
Status code: 400
-Table 5 Response body parametersParameter
+Table 5 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -206,26 +205,26 @@
Status code: 401
-Table 6 Response body parametersParameter
+Table 6 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -233,26 +232,26 @@
Status code: 500
-Table 7 Response body parametersParameter
+Table 7 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
diff --git a/docs/wafd/api-ref/CreateCcRule.html b/docs/wafd/api-ref/CreateCcRule.html
index cc4920f7c..7348bccd5 100644
--- a/docs/wafd/api-ref/CreateCcRule.html
+++ b/docs/wafd/api-ref/CreateCcRule.html
@@ -1,7 +1,7 @@
Creating a CC Attack Protection Rule
-FunctionThis API is used to create a CC attack protection rule.
+ FunctionThis API is used to create a CC attack protection rule.
URIPOST /v1/{project_id}/waf/policy/{policy_id}/cc
@@ -64,7 +64,6 @@
String
|
Content type.
-Default: application/json;charset=utf8
|
@@ -91,10 +90,6 @@
0: standard. Only the protected paths of domain names can be specified.
1: The path, IP address, cookie, header, and params fields can all be set.
- Enumeration values:
-
url
@@ -112,7 +107,7 @@
|
Array of CcCondition objects
|
-Rate limit conditions of the CC attack protection rule. This parameter is mandatory when the CC attack protection rule is in advanced mode (i.e. the value of mode is 1).
+ | Rate limit conditions of the CC protection rule. This parameter is mandatory when the CC protection rule is in advanced mode (i.e. the value of mode is 1).
|
action
@@ -136,12 +131,6 @@
header: User-based rate limiting. Website visitors are identified by the header field.
other: Website visitors are identified by the Referer field (user-defined request source).
-Enumeration values:
-ip
-cookie
-header
-other
-
|
tag_index
@@ -150,7 +139,7 @@
|
String
|
-User tag. This parameter is mandatory when the rate limit mode is set to user (cookie or header).
+ | User identifier. This parameter is mandatory when the rate limit mode is set to user (cookie or header).
cookie: Set the cookie field name. You need to configure an attribute variable name in the cookie that can uniquely identify a web visitor based on your website requirements. This field does not support regular expressions. Only complete matches are supported. For example, if a website uses the name field in the cookie to uniquely identify a website visitor, select name.
header: Set the user-defined HTTP header you want to protect. You need to configure the HTTP header that can identify web visitors based on your website requirements.
@@ -162,7 +151,7 @@
|
tag_condition object
|
-User tag. This parameter is mandatory when the rate limit mode is set to other. - other: A website visitor is identified by the Referer field (user-defined request source).
+ | User tag. This parameter is mandatory when the rate limit mode is set to other. -other: A website visitor is identified by the Referer field (user-defined request source).
|
limit_num
@@ -198,7 +187,7 @@
|
Integer
|
-Block during, in seconds. The value ranges from 0 to 65,535. Access requests are blocked during the configured block duration, and an error page is displayed.
+ | Block duration, in seconds. The value ranges from 0 to 65,535. Specifies the period within which access is blocked. An error page is displayed in this period.
|
description
@@ -207,7 +196,7 @@
|
String
|
-Rule description.
+ | Rule description
|
@@ -231,13 +220,6 @@
String
|
Field type. The value can be url, ip, params, cookie, or header.
-Enumeration values:
-url
-ip
-params
-cookie
-header
-
|
logic_operation
@@ -251,30 +233,6 @@
If the category is ip, the optional operations are: equal, not_equal, , equal_any and not_equal_all
If the category is params, cookie and header, the optional operations are: contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, contain_any, not_contain_all, equal_any, not_equal_all, equal_any, not_equal_all, prefix_any, not_prefix_all, suffix_any, not_suffix_all, len_greater, len_less, len_equal, len_not_equal, num_greater, num_less, num_equal, num_not_equal, exist and not_exist
-Enumeration values:
-contain
-not_contain
-equal
-not_equal
-prefix
-not_prefix
-suffix
-not_suffix
-contain_any
-not_contain_all
-equal_any
-not_equal_all
-prefix_any
-not_prefix_all
-suffix_any
-not_suffix_all
-num_greater
-num_less
-num_equal
-num_not_equal
-exist
-not_exist
-
|
contents
@@ -330,12 +288,6 @@
log: WAF logs the event only.
dynamic_block: In the previous rate limit period, if the request frequency exceeds the value of Rate Limit Frequency, the request is blocked. In the next rate limit period, if the request frequency exceeds the value of Permit Frequency, the request is still blocked. Note: The dynamic_block protection action can be set only when the advanced protection mode is enabled for the CC protection rule.
-Enumeration values:
-captcha
-block
-log
-dynamic_block
-
|
detail
@@ -370,7 +322,7 @@
|
response object
|
-Returned page
+ | Returned page.
|
@@ -394,11 +346,6 @@
String
|
Content type. The value can only be application/json, text/html, or text/xml.
-Enumeration values:
-application/json
-text/html
-text/xml
-
|
content
@@ -448,300 +395,257 @@
Response ParametersStatus code: 200
- Table 9 Response body parametersParameter
+Table 9 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-id
+ | id
|
-String
+ | String
|
-Rule ID.
+ | Rule ID.
|
-policyid
+ | policyid
|
-String
+ | String
|
-Policy ID.
+ | Policy ID.
|
-url
+ | url
|
-String
+ | String
|
-When the value of mode is 0, this parameter has a return value. URL to which the rule applies, excluding a domain name.
+ | When the value of parameter mode is 0, this parameter has a return value. URL to which the rule applies, excluding a domain name.
Prefix match: A path ending with * indicates that the path is used as a prefix. For example, to protect /admin/test.php or /adminabc, you can set Path to /admin*.
Exact match: The path you enter must exactly match the path you want to protect. If the path you want to protect is /admin, set url to /admin.
|
-prefix
+ | prefix
|
-Boolean
+ | Boolean
|
-Whether a prefix is used for the path. If the protected URL ends with an asterisk (*), a path prefix is used.
+ | Whether a prefix is used for the path. If the protected URL ends with an asterisk (*), a path prefix is used.
|
-mode
+ | mode
|
-Integer
+ | Integer
|
-Mode.
+ | Mode.
0: Standard.
1: Advanced.
|
-status
+ | status
|
-Integer
+ | Integer
|
-Rule status. The value can be 0 or 1.
+ | Rule status. The value can be 0 or 1.
0: The rule is disabled.
1: The rule is enabled.
|
-conditions
+ | conditions
|
-Array of CcCondition objects
+ | Array of CcCondition objects
|
-Rate limit conditions of the CC attack protection rule. This parameter is mandatory when the CC attack protection rule is in advanced mode (i.e. the value of mode is 1).
+ | Rate limit conditions of the CC protection rule. This parameter is mandatory when the CC protection rule is in advanced mode (i.e. the value of mode is 1).
|
-action
+ | action
|
-action object
+ | action object
|
-Protection action to take if the number of requests reaches the upper limit.
+ | Protection action to take if the number of requests reaches the upper limit.
|
-tag_type
+ | tag_type
|
-String
+ | String
|
-Rate limit mode.
+ | Rate limit mode.
ip: IP-based rate limiting. Website visitors are identified by IP address.
cookie: User-based rate limiting. Website visitors are identified by the cookie key value.
other: Website visitors are identified by the Referer field (user-defined request source).
-Enumeration values:
-ip
-other
-cookie
-header
-
|
-tag_index
+ | tag_index
|
-String
+ | String
|
-User tag. This parameter is mandatory when the rate limit mode is set to user (cookie or header).
+ | User identifier. This parameter is mandatory when the rate limit mode is set to user (cookie or header).
cookie: Set the cookie field name. You need to configure an attribute variable name in the cookie that can uniquely identify a web visitor based on your website requirements. This field does not support regular expressions. Only complete matches are supported. For example, if a website uses the name field in the cookie to uniquely identify a website visitor, select name.
header: Set the user-defined HTTP header you want to protect. You need to configure the HTTP header that can identify web visitors based on your website requirements.
|
-tag_condition
+ | tag_condition
|
-tag_condition object
+ | tag_condition object
|
-User tag. This parameter is mandatory when the rate limit mode is set to other. - other: A website visitor is identified by the Referer field (user-defined request source).
+ | User tag. This parameter is mandatory when the rate limit mode is set to other. -other: A website visitor is identified by the Referer field (user-defined request source).
|
-limit_num
+ | limit_num
|
-Integer
+ | Integer
|
-Rate limit frequency based on the number of requests. The value ranges from 1 to 2,147,483,647.
+ | Rate limit frequency based on the number of requests. The value ranges from 1 to 2,147,483,647.
|
-limit_period
+ | limit_period
|
-Integer
+ | Integer
|
-Rate limit period, in seconds. The value ranges from 1 to 3,600.
+ | Rate limit period, in seconds. The value ranges from 1 to 3,600.
|
-unlock_num
+ | unlock_num
|
-Integer
+ | Integer
|
-Allowable frequency based on the number of requests. The value ranges from 0 to 2,147,483,647. This parameter is required only when the protection action type is dynamic_block.
+ | Allowable frequency based on the number of requests. The value ranges from 0 to 2,147,483,647. This parameter is required only when the protection action type is dynamic_block.
|
-lock_time
+ | lock_time
|
-Integer
+ | Integer
|
-Block during, in seconds. The value ranges from 0 to 65,535. Access requests are blocked during the configured block duration, and an error page is displayed.
+ | Block duration, in seconds. The value ranges from 0 to 65,535. Specifies the period within which access is blocked. An error page is displayed in this period.
|
-description
+ | description
|
-String
+ | String
|
-Rule description.
+ | Rule description
|
-total_num
+ | total_num
|
-Integer
+ | Integer
|
-This parameter is reserved and can be ignored currently.
+ | This parameter is reserved and can be ignored currently.
|
-unaggregation
+ | unaggregation
|
-Boolean
+ | Boolean
|
-This parameter is reserved and can be ignored currently.
+ | This parameter is reserved and can be ignored currently.
|
-aging_time
+ | aging_time
|
-Integer
+ | Integer
|
-Rule aging time. This parameter is reserved and can be ignored currently.
+ | Rule aging time. This parameter is reserved and can be ignored currently.
|
-producer
+ | producer
|
-Integer
+ | Integer
|
-Rule creation object. This parameter is reserved and can be ignored currently.
+ | Rule creation object. This parameter is reserved and can be ignored currently.
|
-timestamp
+ | timestamp
|
-Long
+ | Long
|
-Timestamp the rule was created.
+ | Timestamp when the rule was created.
|
Table 10 CcConditionParameter
+Table 10 CcConditionParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-category
+ | category
|
-String
+ | String
|
-Field type. The value can be url, ip, params, cookie, or header.
-Enumeration values:
-url
-ip
-params
-cookie
-header
-
+ | Field type. The value can be url, ip, params, cookie, or header.
|
-logic_operation
+ | logic_operation
|
-String
+ | String
|
-Logic for matching the condition.
+ | Logic for matching the condition.
If the category is url, the optional operations are contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, contain_any, not_contain_all, equal_any, not_equal_all, equal_any, not_equal_all, prefix_any, not_prefix_all, suffix_any, not_suffix_all, len_greater, len_less, len_equal and len_not_equal
If the category is ip, the optional operations are: equal, not_equal, , equal_any and not_equal_all
If the category is params, cookie and header, the optional operations are: contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, contain_any, not_contain_all, equal_any, not_equal_all, equal_any, not_equal_all, prefix_any, not_prefix_all, suffix_any, not_suffix_all, len_greater, len_less, len_equal, len_not_equal, num_greater, num_less, num_equal, num_not_equal, exist and not_exist
-Enumeration values:
-contain
-not_contain
-equal
-not_equal
-prefix
-not_prefix
-suffix
-not_suffix
-contain_any
-not_contain_all
-equal_any
-not_equal_all
-prefix_any
-not_prefix_all
-suffix_any
-not_suffix_all
-num_greater
-num_less
-num_equal
-num_not_equal
-exist
-not_exist
-
|
-contents
+ | contents
|
-Array of strings
+ | Array of strings
|
-Content of the conditions. This parameter is mandatory when the suffix of logic_operation is not any or all.
+ | Content of the conditions. This parameter is mandatory when the suffix of logic_operation is not any or all.
|
-value_list_id
+ | value_list_id
|
-String
+ | String
|
-Reference table ID. It can be obtained by calling the API Querying the Reference Table List. This parameter is mandatory when the suffix of logic_operation is any or all. The reference table type must be the same as the category type.
+ | Reference table ID. It can be obtained by calling the API Querying the Reference Table List. This parameter is mandatory when the suffix of logic_operation is any or all. The reference table type must be the same as the category type.
|
-index
+ | index
|
-String
+ | String
|
-Subfield. When category is set to params, cookie, or header, set this parameter based on site requirements. This parameter is mandatory.
+ | Subfield. When category is set to params, cookie, or header, set this parameter based on site requirements. This parameter is mandatory.
|
Table 11 actionParameter
+Table 11 actionParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-category
+ | category
|
-String
+ | String
|
-Action type:
+ | Action type:
captcha: Verification code. WAF requires visitors to enter a correct verification code to continue their access to requested page on your website.
block: WAF blocks the requests. When tag_type is set to other, the value can only be block.
log: WAF logs the event only.
dynamic_block: In the previous rate limit period, if the request frequency exceeds the value of Rate Limit Frequency, the request is blocked. In the next rate limit period, if the request frequency exceeds the value of Permit Frequency, the request is still blocked. Note: The dynamic_block protection action can be set only when the advanced protection mode is enabled for the CC protection rule.
-Enumeration values:
-captcha
-block
-log
-dynamic_block
-
|
-detail
+ | detail
|
-detail object
+ | detail object
|
-Block page information. When protection action category is set to block or dynamic_block, you need to set the returned block page.
+ | Block page information. When protection action category is set to block or dynamic_block, you need to set the returned block page.
If you want to use the default block page, this parameter can be excluded.
If you want to use a custom block page, set this parameter.
@@ -751,76 +655,71 @@
|
Table 12 detailParameter
+Table 12 detailParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-response
+ | response
|
-response object
+ | response object
|
-Block Page
+ | Block Page
|
Table 13 responseParameter
+Table 13 responseParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-content_type
+ | content_type
|
-String
+ | String
|
-Content type. The value can only be application/json, text/html, or text/xml.
-Enumeration values:
-application/json
-text/html
-text/xml
-
+ | Content type. The value can only be application/json, text/html, or text/xml.
|
-content
+ | content
|
-String
+ | String
|
-Block page information.
+ | Block page information.
|
Table 14 tag_conditionParameter
+Table 14 tag_conditionParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-category
+ | category
|
-String
+ | String
|
-User identifier. The value is fixed at referer.
+ | User identifier. The value is fixed at referer.
|
-contents
+ | contents
|
-Array of strings
+ | Array of strings
|
-Content of the user identifier field.
+ | Content of the user identifier field.
|
@@ -828,26 +727,26 @@
Status code: 400
-Table 15 Response body parametersParameter
+Table 15 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -855,26 +754,26 @@
Status code: 401
-Table 16 Response body parametersParameter
+Table 16 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -882,26 +781,26 @@
Status code: 500
-Table 17 Response body parametersParameter
+Table 17 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
diff --git a/docs/wafd/api-ref/CreateCertificate.html b/docs/wafd/api-ref/CreateCertificate.html
index ca4566758..c26a4b87d 100644
--- a/docs/wafd/api-ref/CreateCertificate.html
+++ b/docs/wafd/api-ref/CreateCertificate.html
@@ -1,7 +1,7 @@
Creating a Certificate
-FunctionThis API is used to create a certificate.
+ FunctionThis API is used to create a certificate.
URIPOST /v1/{project_id}/waf/certificate
@@ -55,7 +55,6 @@
String
|
Content type. Default value: application/json;charset=utf8
-Default: application/json;charset=utf8
|
@@ -105,47 +104,47 @@
Response ParametersStatus code: 200
- Table 4 Response body parametersParameter
+Table 4 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-id
+ | id
|
-String
+ | String
|
-Certificate ID
+ | Certificate ID
|
-name
+ | name
|
-String
+ | String
|
-Certificate name
+ | Certificate name
|
-expire_time
+ | expire_time
|
-Long
+ | Long
|
-Timestamp when the certificate expires (unit: ms).
+ | Timestamp when the certificate expires (unit: ms).
|
-timestamp
+ | timestamp
|
-Long
+ | Long
|
-Timestamp when the certificate is uploaded
+ | Timestamp when the certificate is uploaded
|
-cert_type
+ | cert_type
|
-String
+ | String
|
-Certificate type. This parameter is redundant and can be ignored.
+ | Certificate type. This parameter is redundant and can be ignored.
|
@@ -153,26 +152,26 @@
Status code: 400
-Table 5 Response body parametersParameter
+Table 5 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -180,26 +179,26 @@
Status code: 401
-Table 6 Response body parametersParameter
+Table 6 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -207,26 +206,26 @@
Status code: 500
-Table 7 Response body parametersParameter
+Table 7 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
diff --git a/docs/wafd/api-ref/CreateCloudWafPostPaidResource.html b/docs/wafd/api-ref/CreateCloudWafPostPaidResource.html
new file mode 100644
index 000000000..979aa6fbe
--- /dev/null
+++ b/docs/wafd/api-ref/CreateCloudWafPostPaidResource.html
@@ -0,0 +1,402 @@
+
+
+Enabling Pay-Per-Use Billing for Cloud WAF
+FunctionThis API is used to enable the pay-per-use billing mode for cloud WAF.
+
+ URIPOST /v1/{project_id}/waf/postpaid
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. To obtain it, go to console and hover the cursor over your username. On the displayed window, choose My Credentials. Then, in the Projects area, view Project ID of the corresponding project.
+ |
+
+
+
+
+
+ Table 2 Query ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+enterprise_project_id
+ |
+No
+ |
+String
+ |
+You can obtain the ID by calling the ListEnterpriseProject API of EPS.
+ |
+
+
+
+
+
+ Request Parameters
+
+
+
+ Table 4 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+console_area
+ |
+Yes
+ |
+String
+ |
+Website the account belongs to. The value is dt for Cloud website.
+ |
+
+
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 5 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+type
+ |
+Integer
+ |
+The edition for the cloud WAF instance.
+
+ |
+
+resources
+ |
+Array of ResourceResponse objects
+ |
+The resource list.
+ |
+
+isNewUser
+ |
+Boolean
+ |
+New user or not.
+ |
+
+
+
+
+
+ Table 6 ResourceResponseParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+resourceId
+ |
+String
+ |
+Resource ID.
+ |
+
+cloudServiceType
+ |
+String
+ |
+Cloud service type.
+ |
+
+resourceType
+ |
+String
+ |
+Cloud service resource type.
+hws.resource.type.waf: yearly/monthly cloud-mode WAF
+hws.resource.type.waf.domain: domain name expansion packages in yearly/monthly cloud-mode WAF
+hws.resource.type.waf.domain: bandwidth expansion packages in yearly/monthly cloud-mode WAF
+hws.resource.type.waf.domain: rule expansion packages in yearly/monthly cloud-mode WAF
+hws.resource.type.waf.instance: dedicated WAF instances
+hws.resource.type.waf.payperuserequest: requests to pay-per-use WAF instances
+hws.resource.type.waf.payperusedomain: domain names protected with pay-per-use WAF instances
+hws.resource.type.waf.payperuserule: rules created in pay-per-use WAF instances
+
+ |
+
+resourceSpecCode
+ |
+String
+ |
+Cloud resource specifications.
+ |
+
+status
+ |
+Integer
+ |
+Resource status. The value can be:
+0: Unfrozen/Normal.
+1: Frozen.
+2: Deleted.
+
+ |
+
+expireTime
+ |
+String
+ |
+Resource expiration time.
+ |
+
+resourceSize
+ |
+Integer
+ |
+Resource quantity of your resourceType.
+ |
+
+relativeType
+ |
+Integer
+ |
+This parameter can be ignored.
+ |
+
+
+
+
+ Status code: 400
+
+ Table 7 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code
+ |
+
+error_msg
+ |
+String
+ |
+Error message
+ |
+
+
+
+
+ Status code: 401
+
+ Table 8 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code
+ |
+
+error_msg
+ |
+String
+ |
+Error message
+ |
+
+
+
+
+ Status code: 500
+
+ Table 9 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code
+ |
+
+error_msg
+ |
+String
+ |
+Error message
+ |
+
+
+
+
+
+ Example RequestsThe following example shows how to enable pay-per-use billing for cloud WAF in a specific project. The project ID is specified by project_id.
+ POST https://{Endpoint}/v1/{project_id}/waf/postpaid?enterprise_project_id=0
+
+{
+ "console_area" : "dt"
+}
+
+ Example ResponsesStatus code: 200
+ OK
+ {
+ "type" : 22,
+ "resources" : [ {
+ "resourceId" : "71f5de5f03414225b79be43ee3dc6bae",
+ "cloudServiceType" : "hws.service.type.waf",
+ "resourceType" : "hws.resource.type.waf.payperusedomain",
+ "resourceSpecCode" : "waf.payperuse.domain",
+ "resourceSize" : null,
+ "expireTime" : null,
+ "status" : 0
+ }, {
+ "resourceId" : "eb0760007a0b43fd9e445f5ce810f4c4",
+ "cloudServiceType" : "hws.service.type.waf",
+ "resourceType" : "hws.resource.type.waf.payperuserequest",
+ "resourceSpecCode" : "waf.payperuse.request",
+ "resourceSize" : null,
+ "expireTime" : null,
+ "status" : 0
+ }, {
+ "resourceId" : "6cae8a4d8074499d8c3bda687d63c4f9",
+ "cloudServiceType" : "hws.service.type.waf",
+ "resourceType" : "hws.resource.type.waf.payperuserule",
+ "resourceSpecCode" : "waf.payperuse.rule",
+ "resourceSize" : null,
+ "expireTime" : null,
+ "status" : 0
+ } ],
+ "isNewUser" : false
+}
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+OK
+ |
+
+400
+ |
+Request failed.
+ |
+
+401
+ |
+The token does not have required permissions.
+ |
+
+500
+ |
+Internal server error.
+ |
+
+
+
+
+
+
+ Adding a Precise Protection Rule
-FunctionThis API is used to add a precise protection rule.
+ Creating a Precise Protection Rule
+ FunctionThis API is used to create a precise protection rule.
URIPOST /v1/{project_id}/waf/policy/{policy_id}/custom
@@ -64,7 +64,6 @@
String
|
Content type.
-Default: application/json;charset=utf8
|
@@ -117,7 +116,7 @@
String
|
- Rule description.
+ | Rule description
|
conditions
@@ -168,18 +167,6 @@
| String
|
Field type. The options are url, user-agent, ip, params, cookie, referer, header, request_line, method, and request.
-Enumeration values:
-url
-user-agent
-referer
-ip
-method
-request_line
-request
-params
-cookie
-header
-
|
index
@@ -188,7 +175,7 @@
|
String
|
-Subfield:
+ | Subfield
When the field type is url, user-agent, ip, refer, request_line, method, or request, index is not required.
When the field type is params, header, or cookie, and the subfield is customized, the value of index is the customized subfield.
@@ -207,30 +194,6 @@
If the category is request_line and request, the optional operations are: len_greater, len_less, len_equal and len_not_equal
If the category is params, header, and cookie, the optional operations are: contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, contain_any, not_contain_all, equal_any, not_equal_all, equal_any, not_equal_all, prefix_any, not_prefix_all, suffix_any, not_suffix_all, len_greater, len_less, len_equal, len_not_equal, num_greater, num_less, num_equal, num_not_equal, exist and not_exist
-Enumeration values:
-contain
-not_contain
-equal
-not_equal
-prefix
-not_prefix
-suffix
-not_suffix
-contain_any
-not_contain_all
-equal_any
-not_equal_all
-prefix_any
-not_prefix_all
-suffix_any
-not_suffix_all
-num_greater
-num_less
-num_equal
-num_not_equal
-exist
-not_exist
-
|
contents
@@ -276,11 +239,6 @@
pass: WAF allows requests.
log: WAF only logs detected attacks.
-Enumeration values:
-
|
followed_action_id
@@ -298,231 +256,186 @@
Response ParametersStatus code: 200
- Table 6 Response body parametersParameter
+Table 6 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-id
+ | id
|
-String
+ | String
|
-Rule ID.
+ | Rule ID.
|
-policyid
+ | policyid
|
-String
+ | String
|
-Policy ID.
+ | Policy ID.
|
-description
+ | description
|
-String
+ | String
|
-Rule description.
+ | Rule description
|
-status
+ | status
|
-Integer
+ | Integer
|
-Rule status. The value can be 0 or 1.
+ | Rule status. The value can be 0 or 1.
0: The rule is disabled.
1: The rule is enabled.
|
-conditions
+ | conditions
|
-Array of conditions objects
+ | Array of conditions objects
|
-List of matching conditions. All conditions must be met.
+ | List of matching conditions. All conditions must be met.
|
-action
+ | action
|
-CustomAction object
+ | CustomAction object
|
-Protective action of the precise protection rule.
+ | Protective action of the precise protection rule.
|
-priority
+ | priority
|
-Integer
+ | Integer
|
-Priority of a rule. A small value indicates a high priority. If two rules are assigned with the same priority, the rule added earlier has higher priority. Value range: 0 to 1000.
+ | Priority of a rule. A small value indicates a high priority. If two rules are assigned with the same priority, the rule added earlier has higher priority. Value range: 0 to 1000.
|
-timestamp
+ | timestamp
|
-Long
+ | Long
|
-Timestamp when the precise protection rule is created.
+ | Timestamp when the precise protection rule is created.
|
-start
+ | start
|
-Long
+ | Long
|
-Timestamp (ms) when the precise protection rule takes effect. This parameter is returned only when time is true.
+ | Timestamp (ms) when the precise protection rule takes effect. This parameter is returned only when time is true.
|
-terminal
+ | terminal
|
-Long
+ | Long
|
-Timestamp (ms) when the precise protection rule expires. This parameter is returned only when time is true.
+ | Timestamp (ms) when the precise protection rule expires. This parameter is returned only when time is true.
|
-action_mode
+ | action_mode
|
-Boolean
+ | Boolean
|
-This parameter is reserved and can be ignored currently.
+ | This parameter is reserved and can be ignored currently.
|
-aging_time
+ | aging_time
|
-Integer
+ | Integer
|
-Rule aging time. This parameter is reserved and can be ignored currently.
+ | Rule aging time. This parameter is reserved and can be ignored currently.
|
-producer
+ | producer
|
-Integer
+ | Integer
|
-Rule creation object. This parameter is reserved and can be ignored currently.
+ | Rule creation object. This parameter is reserved and can be ignored currently.
|
Table 7 conditionsParameter
+Table 7 conditionsParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-category
+ | category
|
-String
+ | String
|
-Field type. The options are url, user-agent, ip, params, cookie, referer, header, request_line, method, and request.
-Enumeration values:
-url
-user-agent
-ip
-params
-cookie
-referer
-header
-request_line
-method
-request
-
+ | Field type. The options are url, user-agent, ip, params, cookie, referer, header, request_line, method, and request.
|
-index
+ | index
|
-String
+ | String
|
-Subfield:
+ | Subfield
When the field type is url, user-agent, ip, refer, request_line, method, or request, index is not required.
When the field type is params, header, or cookie, and the subfield is customized, the value of index is the customized subfield.
|
-logic_operation
+ | logic_operation
|
-String
+ | String
|
-Logic for matching the condition.
-Enumeration values:
-contain
-not_contain
-equal
-not_equal
-prefix
-not_prefix
-suffix
-not_suffix
-contain_any
-not_contain_all
-equal_any
-not_equal_all
-prefix_any
-not_prefix_all
-suffix_any
-not_suffix_all
-len_greater
-len_less
-len_equal
-len_not_equal
-num_greater
-num_less
-num_equal
-num_not_equal
-exist
-not_exist
-
+ | Logic for matching the condition.
|
-contents
+ | contents
|
-Array of strings
+ | Array of strings
|
-Content of the conditions.
+ | Content of the conditions.
|
-value_list_id
+ | value_list_id
|
-String
+ | String
|
-Reference table ID. It can be obtained by calling the API Querying the Reference Table List. This parameter is available only when a reference table is used when a protection rule is created.
+ | Reference table ID. It can be obtained by calling the API Querying the Reference Table List. This parameter is available only when a reference table is used when a protection rule is created.
|
Table 8 CustomActionParameter
+Table 8 CustomActionParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-category
+ | category
|
-String
+ | String
|
-Operation type
+ | Operation type
block: WAF blocks attacks.
pass: WAF allows requests.
log: WAF only logs detected attacks.
-Enumeration values:
-
|
-followed_action_id
+ | followed_action_id
|
-String
+ | String
|
-ID of a known attack source rule. This parameter can be configured only when category is set to block.
+ | ID of a known attack source rule. This parameter can be configured only when category is set to block.
|
@@ -530,26 +443,26 @@
Status code: 400
-Table 9 Response body parametersParameter
+Table 9 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -557,26 +470,26 @@
Status code: 401
-Table 10 Response body parametersParameter
+Table 10 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -584,26 +497,26 @@
Status code: 500
-Table 11 Response body parametersParameter
+Table 11 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
diff --git a/docs/wafd/api-ref/CreateGeoipRule.html b/docs/wafd/api-ref/CreateGeoipRule.html
index caef12533..27c2a3aca 100644
--- a/docs/wafd/api-ref/CreateGeoipRule.html
+++ b/docs/wafd/api-ref/CreateGeoipRule.html
@@ -1,7 +1,7 @@
Creating a Geolocation Access Control Rule
-FunctionThis API is used to create a geolocation access control rule.
+ FunctionThis API is used to create a geolocation access control rule.
URIPOST /v1/{project_id}/waf/policy/{policy_id}/geoip
@@ -64,7 +64,6 @@
String
|
Content type
-Default: application/json;charset=utf8
|
@@ -151,47 +150,47 @@
Response ParametersStatus code: 200
- Table 4 Response body parametersParameter
+Table 4 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-id
+ | id
|
-String
+ | String
|
-Rule ID.
+ | Rule ID.
|
-policyid
+ | policyid
|
-String
+ | String
|
-Policy ID
+ | Policy ID
|
-name
+ | name
|
-String
+ | String
|
-Rule name. Currently, the console does not support configuring names for geolocation access control rule. Ignore this parameter.
+ | Rule name. Currently, the console does not support configuring names for geolocation access control rule. Ignore this parameter.
|
-geoTagList
+ | geoTagList
|
-Array of strings
+ | Array of strings
|
-List of geographical locations hit the geolocation access control rule.
+ | List of geographical locations hit the geolocation access control rule.
|
-geoip
+ | geoip
|
-String
+ | String
|
-Applicable regions. The value can be the region code.
+ | Applicable regions. The value can be the region code.
CA: Canada
US: USA
AU: Australia
@@ -218,39 +217,39 @@
|
-white
+ | white
|
-Integer
+ | Integer
|
-Protective action. The value can be:
+ | Protective action. The value can be:
0: WAF blocks the requests that hit the rule.
1: WAF allows the requests that hit the rule.
2: WAF only logs the requests that hit the rule.
|
-status
+ | status
|
-Integer
+ | Integer
|
-Rule status. The value can be:
+ | Rule status. The value can be:
0: The rule is disabled.
1: The rule is enabled.
|
-timestamp
+ | timestamp
|
-Long
+ | Long
|
-Time the rule is created. The value is a 13-digit timestamp in ms.
+ | Time the rule is created. The value is a 13-digit timestamp in ms.
|
-description
+ | description
|
-String
+ | String
|
-Rule description
+ | Rule description
|
@@ -258,26 +257,26 @@
Status code: 400
-Table 5 Response body parametersParameter
+ |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|