Compare commits
2 Commits
main
...
propose-wa
| Author | SHA1 | Date | |
|---|---|---|---|
| 77b1e72d1a | |||
| 597f67eea9 |
@ -108,8 +108,8 @@ Example Requests
|
||||
|
||||
{
|
||||
"name" : "demo",
|
||||
"content" : "-----BEGIN CERTIFICATE-----\nMIICUjCCAbugAwIBAgIJANxRp4YpWj66MA0GCSqGSIb3DQEBCwUAMEIxCzAJBgNV BAYTAlhYMRUwEwYDVQQHDAxEZWZhdWx0IENpdHkxHDAaBgNVBAoME0RlZmF1bHQg Q29tcGFueSBMdGQwHhcNMjMwMzA2MTMwNDI2WhcNMjQwMzA1MTMwNDI2WjBCMQsw CQYDVQQGEwJYWDEVMBMGA1UEBwwMRGVmYXVsdCBDaXR5MRwwGgYDVQQKDBNEZWZh dWx0IENvbXBhbnkgTHRkMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC4KoXA HK8ZcmOMl+FDDnzBKhD/RcSdjqtie47YZYX9T9XNtfuvmJf78JQC3X18xAJdutyP tvX6RwqITLItD6DsI/x6vkMJDLGOfuMpxjHwm6VOILIVIMUVWsZqTk4NdaFRpBCN VpzQdy/j3WUg0l86dYna0GdkOHuk6l1pgk52RwIDAQABo1AwTjAdBgNVHQ4EFgQU 9/usGS95WL1qUuq5F8XiDXA8Fq4wHwYDVR0jBBgwFoAU9/usGS95WL1qUuq5F8Xi DXA8Fq4wDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsFAAOBgQCXIvTibia/fGlf IaraBMH313Z+xBlkBX5X8y2wYRa+RRVR4OB8zTY2Rm0OXOHMgPPEs5xpYXPBK/CH i+kodHIq+0AxYzMlDs3j+V7FzUrZQbItPYXtgQStZjdOvtM129ecuKWRRtmNNSBZ sj9VBsvsMrI1S2bZo5wJMPuR/TGGOQ==\n-----END CERTIFICATE-----",
|
||||
"key" : "-----BEGIN PRIVATE KEY-----\nMIICeAIBADANBgkqhkiG9w0BAQEFAASCAmIwggJeAgEAAoGBALgqhcAcrxlyY4yX 4UMOfMEqEP9FxJ2Oq2J7jthlhf1P1c21+6+Yl/vwlALdfXzEAl263I+29fpHCohM si0PoOwj/Hq+QwkMsY5+4ynGMfCbpU4gshUgxRVaxmpOTg11oVGkEI1WnNB3L+Pd ZSDSXzp1idrQZ2Q4e6TqXWmCTnZHAgMBAAECgYEAh/YknirO/ktbwQzTqczFP1oO CFd6ixMr5d3wHEP/Qn6xCliCwiU2dzIqI19faD/Qu1/bu2HIgQf3d56fn/K8yrgq tmd7BZvXcZuK/LXOLfpAXAdMl5bgOW+ejJvf9LsA6xYWsxmki6+VYbJ+XVr4w2yH nBiimwp7v4eoBlMqVQECQQDeJw6o15p30MEzj5t3oVLL86rY20HZfqnpS6S10CHx l0W/0ah7S4QnvXi6NhvS0o3mj+VNzeYvoHII9DP28IyBAkEA1DnSyH7D5W4GUmsr NfDOBYuKUaahDtdN/Qx2JF1jEvLluLC7Nr1ETzrKodN/+lOYwfIOWx5tkXPpLFMu rko+xwJAWV7DEf+yn7L2loSWWbknsu7y80y5oALJ3hXVTGNP1H4zzChPLFLD9qzN rbPo25ZjCbcn23YSvWRBnAKKCTTagQJBAKWvgxVOimfrLvpXesPA/Ucs+s7mNSVe CCAAA5g+ZGPdyGUZbP++Yb8tWhdfBLINY9w+uuB+b/I3uRoG0xH1Gu8CQQCpEIYC DUNO98ylm4QOAkyC0nv6x33gQqcu6ExtK7ptbdFZT1QdOAwm5SBaE50rWjyTO4gL Cpsd6f0baeGAxNAw\n-----END PRIVATE KEY-----"
|
||||
"content" : "-----BEGIN CERTIFICATE----- MIIDyzCCArOgAwIBAgIJAN5U0Z4Bh5ccMA0GCSqGSIb3DQEBCwUAMHwxCzAJBgNV BAYTAlpIMRIwEAYDVQQIDAlHVUFOR0RPTkcxETAPBgNVBAcMCERPTkdHVUFOMQ0w CwYDVQQKDARERUtFMQswCQYDVQQLDAJESzELMAkGA1UEAwwCT0QxHTAbBgkqhkiG 9w0BCQEWDk8IZC5odWF3ZWkuY29tMB4XDTIxMTExNTA4MTk0MVoXDTIyMTExNTA4 MTk0MVowfDELMAkGA1UEBhMCWkgxEjAQBgNVBAgMCUdVQU5HRE9ORzERMA8GA1UE BwwIRE9OR0dVQU4xDTALBgNVBAoMBERFS0UxCzAJBgNVBAsMAkRLMQswCQYDVQQD DAJPRDEdMBsGCSqGSIb3DQEJARYOTwhkLmh1YXdlaS5jb20wggEiMA0GCSqGSIb3 DQEBAQUAA4IBDwAwggEKAoIBAQDcoLFK62//r0RHFyweYBj97S4NsJ8Qj0RG+Y02 OgwhQmRiNNjubJwP8Nqqyd86zr+fsSQxKBaBCosn1PcN2Pj2vPJD6NEk4I6VdOWr /kFYMlOcimhSfW4wt6VakniOKIYGrCxxvQe1X2OyBxT+ocTLRgEIB8ZbvJyPNseg feLEUuPYRpQ5kXLgJH2/3NwZFOgBHVv/b07l4fR+sWJMnIA2yIjSBQ0DEAOSusXo FQ/WRbBRH7DrQmxGiXsq4VELEr9Nnc/Kywq+9pYi8L+mKeRL+lcMMbXC/3k6OfMB tVTiwcmS1Mkr3iG03i8u6H7RSvRwyBz9G9sE+tmJZTPH6lYtAgMBAAGjUDBOMB0G A1UdDgQWBBQprUUFXW+gIkpzXdrYlsWjfSahWjAfBgNVHSMEGDAWgBQprUUFXW+g IkpzXdrYlsWjfSahWjAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQA2 603KozsQoIKeLvqDJlcAXwWRfNW8SvlaSJAulhHgneMt9bQgIL+3PJWA/iMniOhU o/kVwkiUIcxw4t7RwP0hVms0OZw59MuqKd3oCSWkYO4vEHs3t40JDWnGDnmQ4sol RkOWJwL4w8tnPe3qY9JSupjlsu6Y1hlvKtEfN2vEKFnsuMhidkUpUAJWodHhWBQH wgIDo4/6yTnWZNGK8JDal86Dm5IchXea1EoYBJsHxiJb7HeWQlkre+MCYi1RHOin 4mIXTr0oT4/jWlgklSz6/ZhGRq+7W7tIl7cvzCe+4XsVZIenAcYoNd/WLfo91PD4 yAsRXrOjW1so1Bj0BkDz -----END CERTIFICATE-----",
|
||||
"key" : "-----BEGIN PRIVATE KEY----- MIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDcoLFK62//r0RH FyweYBj97S4NsJ8Qj0RG+Y02OgwhQmRiNNjubJwP8Nqqyd86zr+fsSQxKBaBCosn 1PcN2Pj2vPJD6NEk4I6VdOWr/kFYMlOcimhSfW4wt6VakniOKIYGrCxxvQe1X2Oy BxT+ocTLRgEIB8ZbvJyPNsegfeLEUuPYRpQ5kXLgJH2/3NwZFOgBHVv/b07l4fR+ sWJMnIA2yIjSBQ0DEAOSusXoFQ/WRbBRH7DrQmxGiXsq4VELEr9Nnc/Kywq+9pYi 8L+mKeRL+lcMMbXC/3k6OfMBtVTiwcmS1Mkr3iG03i8u6H7RSvRwyBz9G9sE+tmJ ZTPH6lYtAgMBAAECggEBAL+xZxm/QoqXT+2stoqV2GEYaMFASpRqxlocjZMmEE/9 jZa+cBWIjHhVPsjRqYFBDcHEebu0JwlrjcjIAvgnIvnO5XgXm1A9Q+WbscokmcX1 xCvpHgc+MDVn+uWdCd4KW5kEk4EnSsFN5iNSf+1VxNURN+gwSSp/0E+muwA5IISO G6HQ+p6qs52JAitX5t/7ruKoHYXJxBnf7TUs7768qrh++KPKpPlq044qoYlcGO1n 4urPBHuNLy04GgGw+vkaqjqOvZrNLVOMMaFWBxsDWBehgSSBQTj+f3NCxneGYtt8 3SCTZQI5nIkb+r/M455EwKTSXuEsNHoIwx7L6GEPbQECgYEA8IxgK2fYykloICoh TFJaRAvyjyKa2+Aza4qT9SGY9Y30VPClPjBB1vUu5M9KrFufzlv06nGEcHmpEwOe 8vbRu7nLAQTGYFi8VK63q8w6FlFdAyCG6Sx+BWCfWxJzXsZLAJTfklwi8HsOSlqh 6QNv0xbE2fLjXKf8MHvtrufip40CgYEA6sy87eDrkVgtq4ythAik3i1C5Z3v0fvx mTblG52Z21OyocNq3Tf/b1ZwoIc1ik6cyBzY6z1bIrbSzArCqm0sb2iD+kJL81O0 /qqdXjBxZUkKiVAMNNp7xJGZHHFKWUxT2+UX/tlyx4tT4dzrFIkdDXkcMmqfsRxd 1NEVaAaT8SECgYAoU7BPtpIun43YTpfUfr3pSIN6oZeKoxSbw9i4MNC+4fSDRPC+ 80ImcmZRL7taF+Y7p0jxAOTuIkdJC8NbAiv5J9WzrwQ+5MF2BPB/2bYnRa6tNofH kZDy/9bXYsl6qw2p5Ety8wVcgZTMvFMGiG/32IpZ65FYWEU8L5qSRwfFhQKBgQC9 ihjZTj/bTHtRiHZppzCvyYm/Igd+Uwtsy0uXR1n0G1SQENgrTBD/J6AzdfJae6tE P0U8YIM5Oqxf2i/as9ay+IPRecMl4eSxz7jJWAGx6Yx/3AZ+hAB1ZbNbqniCLYNk d0MvjwmA25ATO+ro4OZ7AdEpQbk3l9aG/WFyYBz9AQKBgQCucFPA1l5eslL8196V WMr2Qo0tqzl7CGSoWQk2Sa2HZtZdfofXAaaqo+zvJ6RPHtJh0jgJtx536DVV3egI 37YrdQyJbCPZXQ3SPgqWCorUnXBwq/nxS06uwu6JBxUFc57ijmMU4fWYNrvkkmWb 7keAg/r5Uy1joMAvBN1I6lB8pg== -----END PRIVATE KEY-----"
|
||||
}
|
||||
|
||||
Example Responses
|
||||
|
||||
@ -89,31 +89,27 @@ Response Parameters
|
||||
|
||||
.. table:: **Table 5** ListCertificateBody
|
||||
|
||||
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+========================================================================+==========================================================================================================================================================+
|
||||
| id | String | Certificate ID |
|
||||
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| name | String | Certificate name |
|
||||
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| certificateid | String | Certificate ID, which is a redundant parameter. Please ignore it. |
|
||||
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| certificatename | String | Certificate name, which is a redundant parameter. Please ignore it. |
|
||||
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| expire_time | Long | Timestamp when the certificate expire. This parameter is returned in the response body only when the value of host in the URL request is true. |
|
||||
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| exp_status | Integer | Certificate expiration status. This parameter is returned in the response body only when the value of host in the URL request is true. The value can be: |
|
||||
| | | |
|
||||
| | | - 0: The certificate is valid. |
|
||||
| | | |
|
||||
| | | - 1: The certificate has expired. |
|
||||
| | | |
|
||||
| | | - 2: The certificate is about to expire. |
|
||||
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| timestamp | Long | Timestamp when the certificate is uploaded |
|
||||
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| bind_host | Array of :ref:`BindHost <listcertificates__response_bindhost>` objects | Domain name associated with the certificate. This parameter is returned in the response body only when the value of host in the URL request is true. |
|
||||
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+------------------------------------------------------------------------+--------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+========================================================================+==================================================+
|
||||
| id | String | Certificate ID |
|
||||
+-----------------------+------------------------------------------------------------------------+--------------------------------------------------+
|
||||
| name | String | Certificate name |
|
||||
+-----------------------+------------------------------------------------------------------------+--------------------------------------------------+
|
||||
| expire_time | Long | Timestamp when the certificate expire |
|
||||
+-----------------------+------------------------------------------------------------------------+--------------------------------------------------+
|
||||
| exp_status | Integer | Certificate expiration status. The value can be: |
|
||||
| | | |
|
||||
| | | - 0: The certificate is valid. |
|
||||
| | | |
|
||||
| | | - 1: The certificate has expired. |
|
||||
| | | |
|
||||
| | | - 2: The certificate is about to expire. |
|
||||
+-----------------------+------------------------------------------------------------------------+--------------------------------------------------+
|
||||
| timestamp | Long | Timestamp when the certificate is uploaded |
|
||||
+-----------------------+------------------------------------------------------------------------+--------------------------------------------------+
|
||||
| bind_host | Array of :ref:`BindHost <listcertificates__response_bindhost>` objects | Domain name associated with the certificate |
|
||||
+-----------------------+------------------------------------------------------------------------+--------------------------------------------------+
|
||||
|
||||
.. _listcertificates__response_bindhost:
|
||||
|
||||
@ -167,7 +163,7 @@ Example Requests
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{Endpoint}/v1/{project_id}/waf/certificate?page=1&pagesize=10&host=true&enterprise_project_id=0
|
||||
GET https://{Endpoint}/v1/{project_id}/waf/certificate?
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
@ -25,27 +25,19 @@ GET /v1/{project_id}/waf/overviews/bandwidth/timeline
|
||||
|
||||
.. table:: **Table 2** Query Parameters
|
||||
|
||||
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+=================+=================+=================+======================================================================================================================================================+
|
||||
| from | Yes | Long | Start time (13-digit timestamp in millisecond). This parameter must be used together with to. |
|
||||
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| to | Yes | Long | End time (13-digit timestamp in millisecond). This parameter must be used together with from. |
|
||||
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| hosts | No | String | List of domain names to query, which can be obtained by calling the ListHost API |
|
||||
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| instances | No | String | This parameter is used to query the bandwidth of the protected domain name protected by a specific dedicated WAF engine instance. |
|
||||
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| group_by | No | String | Data aggregation interval. If this parameter is not specified, data is displayed by a time range calculated based on parameters **from** and **to**. |
|
||||
| | | | |
|
||||
| | | | - If the time range between **from** and **to** is fewer than or equal to 1 day, the interval is one minute. |
|
||||
| | | | |
|
||||
| | | | - If the time range between **from** and **to** is greater than 1 day but fewer than or equal to 3 days, the interval is 5 minutes. |
|
||||
| | | | |
|
||||
| | | | - If the time range between **from** and **to** is greater than 3 days but fewer than or equal 7 days, the interval is 10 minutes. |
|
||||
| | | | |
|
||||
| | | | - If the time range between **from** and **to** is greater than 7 days but fewer than or equal to 30 days, the interval is 1 hour. |
|
||||
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------+-----------+--------+-----------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+===========+===========+========+===============================================================================================+
|
||||
| from | Yes | Long | Start time (13-digit timestamp in millisecond). This parameter must be used together with to. |
|
||||
+-----------+-----------+--------+-----------------------------------------------------------------------------------------------+
|
||||
| to | Yes | Long | End time (13-digit timestamp in millisecond). This parameter must be used together with from. |
|
||||
+-----------+-----------+--------+-----------------------------------------------------------------------------------------------+
|
||||
| hosts | No | String | List of domain names to query, which can be obtained by calling the ListHost API |
|
||||
+-----------+-----------+--------+-----------------------------------------------------------------------------------------------+
|
||||
| instances | No | String | List of instance to query (only for the instantiation mode). |
|
||||
+-----------+-----------+--------+-----------------------------------------------------------------------------------------------+
|
||||
| group_by | No | String | Display dimension. For example, the value is DAY if data is displayed by the day. |
|
||||
+-----------+-----------+--------+-----------------------------------------------------------------------------------------------+
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
@ -31,7 +31,7 @@ Request Parameters
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+=================+=================+=================+==========================================================================================================+
|
||||
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
|
||||
| X-Auth-Token | No | String | User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+
|
||||
| Content-Type | Yes | String | Content type. |
|
||||
| | | | |
|
||||
@ -40,47 +40,31 @@ Request Parameters
|
||||
|
||||
.. table:: **Table 3** Request body parameters
|
||||
|
||||
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+=================+=================+==================+==============================================================================================================================================================================================================+
|
||||
| region | Yes | String | Region where a dedicated engine is to be created. Its value is EU-DE. |
|
||||
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| available_zone | Yes | String | AZ where the dedicated engine is to be created. |
|
||||
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| arch | Yes | String | Dedicated engine CPU architecture. Its value has to be x86. |
|
||||
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| instancename | Yes | String | Prefix of the dedicated WAF engine name, which is user-defined. |
|
||||
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| specification | Yes | String | Specifications of the dedicated engine version. The value can be **waf.instance.enterprise** or **waf.instance.professional**. |
|
||||
| | | | |
|
||||
| | | | - **waf.instance.professional**: WI-100. Performance: 100 Mbit/s of throughput and 2,000 QPS. |
|
||||
| | | | |
|
||||
| | | | - **waf.instance.enterprise**: WI-100. Performance: 500 Mbit/s of throughput and 10,000 QPS. |
|
||||
| | | | |
|
||||
| | | | Enumeration values: |
|
||||
| | | | |
|
||||
| | | | - **waf.instance.professional** |
|
||||
| | | | |
|
||||
| | | | - **waf.instance.enterprise** |
|
||||
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| cpu_flavor | Yes | String | ID of the specifications of the ECS hosting the dedicated engine. You can go to the management console and confirm supported specifications. |
|
||||
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| vpc_id | Yes | String | ID of the VPC where the dedicated engine is located. It can be obtained by calling the ListVpcs API. |
|
||||
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| subnet_id | Yes | String | ID of the VPC subnet where the dedicated engine is located. It can be obtained by calling the **ListSubnets API**. **subnet_id** has the same value as **network_id** obtained by calling the OpenStack APIs |
|
||||
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| security_group | Yes | Array of strings | ID of the security group where the dedicated engine is located. It can be obtained by calling the ListSecurityGroups API. |
|
||||
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| count | Yes | Integer | Number of dedicated engines to be provisioned |
|
||||
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| res_tenant | Yes | Boolean | Whether to create a dedicated engine instance of the network interface type. Its value has to be true. |
|
||||
| | | | |
|
||||
| | | | - **Network Interface**: Your WAF instance will be connected to your network via a VPC. (If ELB is used, only dedicated load balancers can be used.) |
|
||||
| | | | |
|
||||
| | | | Enumeration values: |
|
||||
| | | | |
|
||||
| | | | - **true** |
|
||||
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+================+===========+==================+=========================================================================================================================================================================================================================================================================================================+
|
||||
| chargemode | No | Integer | Billing mode. Currently, only pay-per-use billing (30) is supported. Make sure your account balance is enough, or the dedicated WAF engine will forward requests directly to the origin server without inspection. |
|
||||
+----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| region | Yes | String | Region where a dedicated engine is to be created. Its value is EU-DE. |
|
||||
+----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| available_zone | Yes | String | AZ where the dedicated engine is to be created. |
|
||||
+----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| arch | Yes | String | Dedicated engine CPU architecture. Its value can be x86 . |
|
||||
+----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| instancename | Yes | String | Prefix of the dedicated WAF engine name, which is user-defined. |
|
||||
+----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| specification | Yes | String | Specifications of the dedicated engine version. The value can be waf.instance.enterprise or waf.instance.professional. An enterprise edition dedicated engine has more functions than a professional edition one. For more details, see the Web Application Firewall (WAF) User Guide. |
|
||||
+----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| cpu_flavor | Yes | String | ID of the specifications of the ECS hosting the dedicated engine. It can be obtained by calling the ECS ListFlavors API. For the enterprise edition, ECS specifications with 8 vCPUs and 16 GB memory are used. For the professional edition, ECS specifications with 2 vCPUs and 4 GB memory are used. |
|
||||
+----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| vpc_id | Yes | String | ID of the VPC where the dedicated engine is located. It can be obtained by calling the ListVpcs API. |
|
||||
+----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| subnet_id | Yes | String | ID of the VPC subnet where the dedicated engine is located. It can be obtained by calling the **ListSubnets API**. **subnet_id** has the same value as **network_id** obtained by calling the OpenStack APIs |
|
||||
+----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| security_group | Yes | Array of strings | ID of the security group where the dedicated engine is located. It can be obtained by calling the ListSecurityGroups API. |
|
||||
+----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| count | Yes | Integer | Number of dedicated engines to be provisioned |
|
||||
+----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
@ -147,6 +131,7 @@ Example Requests
|
||||
POST https://{endpoint}/v1/{project_id}/premium-waf/instance
|
||||
|
||||
{
|
||||
"chargemode" : 30,
|
||||
"region" : "region-01-4",
|
||||
"available_zone" : "region-01-4a",
|
||||
"arch" : "x86",
|
||||
@ -156,8 +141,7 @@ Example Requests
|
||||
"vpc_id" : "d7b6a5ff-6c53-4cd4-9d57-f20ee8753056",
|
||||
"subnet_id" : "e59ccd18-7e15-4588-b689-04b856f4e78b",
|
||||
"security_group" : [ "09b156a2-f0f0-41fd-9891-60e594601cfd" ],
|
||||
"count" : 1,
|
||||
"res_tenant" : true
|
||||
"count" : 1
|
||||
}
|
||||
|
||||
Example Responses
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -10,7 +10,6 @@ Managing Websites Protected in Dedicated Mode
|
||||
- :ref:`Querying Domain Name Settings in Dedicated Mode <showpremiumhost>`
|
||||
- :ref:`Modifying a Domain Name Protected by a Dedicated WAF Instance <updatepremiumhost>`
|
||||
- :ref:`Deleting a Domain Name from a Dedicated WAF Instance <deletepremiumhost>`
|
||||
- :ref:`Modifying the Protection Status of a Domain Name in Dedicated Mode <updatepremiumhostprotectstatus>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
@ -21,4 +20,3 @@ Managing Websites Protected in Dedicated Mode
|
||||
querying_domain_name_settings_in_dedicated_mode
|
||||
modifying_a_domain_name_protected_by_a_dedicated_waf_instance
|
||||
deleting_a_domain_name_from_a_dedicated_waf_instance
|
||||
modifying_the_protection_status_of_a_domain_name_in_dedicated_mode
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -8,7 +8,7 @@ Creating a Data Masking Rule
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to create a data masking rule.
|
||||
Creating a Data Masking Rule
|
||||
|
||||
URI
|
||||
---
|
||||
@ -17,13 +17,12 @@ POST /v1/{project_id}/waf/policy/{policy_id}/privacy
|
||||
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
+------------+-----------+--------+------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+============+===========+========+==================================================================+
|
||||
| project_id | Yes | String | Project ID |
|
||||
+------------+-----------+--------+------------------------------------------------------------------+
|
||||
| policy_id | Yes | String | Policy ID. It can be obtained by calling the **ListPolicy** API. |
|
||||
+------------+-----------+--------+------------------------------------------------------------------+
|
||||
========== ========= ====== ===========
|
||||
Parameter Mandatory Type Description
|
||||
========== ========= ====== ===========
|
||||
project_id Yes String Project ID
|
||||
policy_id Yes String Policy ID
|
||||
========== ========= ====== ===========
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -17,13 +17,12 @@ POST /v1/{project_id}/waf/policy/{policy_id}/antitamper
|
||||
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
+------------+-----------+--------+------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+============+===========+========+==================================================================+
|
||||
| project_id | Yes | String | Project ID |
|
||||
+------------+-----------+--------+------------------------------------------------------------------+
|
||||
| policy_id | Yes | String | Policy ID. It can be obtained by calling the **ListPolicy** API. |
|
||||
+------------+-----------+--------+------------------------------------------------------------------+
|
||||
========== ========= ====== ===========
|
||||
Parameter Mandatory Type Description
|
||||
========== ========= ====== ===========
|
||||
project_id Yes String Project ID
|
||||
policy_id Yes String Policy ID
|
||||
========== ========= ====== ===========
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
@ -59,27 +58,27 @@ Response Parameters
|
||||
|
||||
.. table:: **Table 4** Response body parameters
|
||||
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================+=========================================================================================================================================================+
|
||||
| id | String | Rule ID. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| policyid | String | Policy ID |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| timestamp | Long | Timestamp |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| description | String | Rule description. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| status | Integer | Rule status. The value can be: |
|
||||
| | | |
|
||||
| | | - 0: The rule is disabled. |
|
||||
| | | |
|
||||
| | | - 1: The rule is enabled. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| hostname | 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. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| url | String | URL for the web tamper protection rule. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+-----------------------+---------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================+=========================================================+
|
||||
| id | String | Rule ID. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------+
|
||||
| policyid | String | Policy ID |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------+
|
||||
| timestamp | Long | Timestamp |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------+
|
||||
| description | String | Rule description. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------+
|
||||
| status | Integer | Rule status. The value can be: |
|
||||
| | | |
|
||||
| | | - 0: The rule is disabled. |
|
||||
| | | |
|
||||
| | | - 1: The rule is enabled. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------+
|
||||
| hostname | String | Domain name protected by the web tamper protection rule |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------+
|
||||
| url | String | URL for the web tamper protection rule. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------+
|
||||
|
||||
**Status code: 400**
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -17,15 +17,13 @@ DELETE /v1/{project_id}/waf/policy/{policy_id}/whiteblackip/{rule_id}
|
||||
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
+------------+-----------+--------+---------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+============+===========+========+=========================================================================================================+
|
||||
| project_id | Yes | String | Project ID |
|
||||
+------------+-----------+--------+---------------------------------------------------------------------------------------------------------+
|
||||
| policy_id | Yes | String | Policy ID. It can be obtained by calling the **ListPolicy** API. |
|
||||
+------------+-----------+--------+---------------------------------------------------------------------------------------------------------+
|
||||
| rule_id | Yes | String | ID of the blacklist or whitelist rule. It can be obtained by calling the **ListWhiteblackipRules** API. |
|
||||
+------------+-----------+--------+---------------------------------------------------------------------------------------------------------+
|
||||
========== ========= ====== ===========
|
||||
Parameter Mandatory Type Description
|
||||
========== ========= ====== ===========
|
||||
project_id Yes String Project ID
|
||||
policy_id Yes String Policy ID
|
||||
rule_id Yes String Rule ID
|
||||
========== ========= ====== ===========
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
@ -37,7 +35,7 @@ Request Parameters
|
||||
+=================+=================+=================+============================================+
|
||||
| X-Auth-Token | Yes | String | User Token. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------+
|
||||
| Content-Type | No | String | Content type |
|
||||
| Content-Type | Yes | String | Content type |
|
||||
| | | | |
|
||||
| | | | Default: **application/json;charset=utf8** |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------+
|
||||
@ -54,8 +52,6 @@ Response Parameters
|
||||
+=======================+=======================+=====================================================+
|
||||
| id | String | Rule ID |
|
||||
+-----------------------+-----------------------+-----------------------------------------------------+
|
||||
| name | String | Rule name. |
|
||||
+-----------------------+-----------------------+-----------------------------------------------------+
|
||||
| policyid | String | Policy ID. |
|
||||
+-----------------------+-----------------------+-----------------------------------------------------+
|
||||
| timestamp | Long | Rule creation time |
|
||||
@ -68,7 +64,7 @@ Response Parameters
|
||||
| | | |
|
||||
| | | - 1: The rule is enabled. |
|
||||
+-----------------------+-----------------------+-----------------------------------------------------+
|
||||
| addr | String | Blacklisted or whitelisted IP addresses |
|
||||
| addr | String | lacklisted or whitelisted IP addresses |
|
||||
+-----------------------+-----------------------+-----------------------------------------------------+
|
||||
| white | Integer | Protective action. The value can be: |
|
||||
| | | |
|
||||
@ -78,8 +74,6 @@ Response Parameters
|
||||
| | | |
|
||||
| | | - 2: WAF only logs the requests that hit the rule. |
|
||||
+-----------------------+-----------------------+-----------------------------------------------------+
|
||||
| followed_action_id | String | ID of the known attack source rule. |
|
||||
+-----------------------+-----------------------+-----------------------------------------------------+
|
||||
|
||||
**Status code: 400**
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -17,15 +17,13 @@ DELETE /v1/{project_id}/waf/policy/{policy_id}/privacy/{rule_id}
|
||||
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
+------------+-----------+--------+------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+============+===========+========+==========================================================================================+
|
||||
| project_id | Yes | String | Project ID |
|
||||
+------------+-----------+--------+------------------------------------------------------------------------------------------+
|
||||
| policy_id | Yes | String | Policy ID. It can be obtained by calling the **ListPolicy** API. |
|
||||
+------------+-----------+--------+------------------------------------------------------------------------------------------+
|
||||
| rule_id | Yes | String | ID of the data masking rule. It can be obtained by calling the **ListPrivacyRules** API. |
|
||||
+------------+-----------+--------+------------------------------------------------------------------------------------------+
|
||||
========== ========= ====== ===========
|
||||
Parameter Mandatory Type Description
|
||||
========== ========= ====== ===========
|
||||
project_id Yes String Project ID
|
||||
policy_id Yes String Policy ID
|
||||
rule_id Yes String Rule ID
|
||||
========== ========= ====== ===========
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
@ -37,7 +35,7 @@ Request Parameters
|
||||
+=================+=================+=================+============================================+
|
||||
| X-Auth-Token | Yes | String | auth token |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------+
|
||||
| Content-Type | No | String | Content type |
|
||||
| Content-Type | Yes | String | Content type |
|
||||
| | | | |
|
||||
| | | | Default: **application/json;charset=utf8** |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------+
|
||||
@ -45,47 +43,9 @@ Request Parameters
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
**Status code: 200**
|
||||
|
||||
.. table:: **Table 3** Response body parameters
|
||||
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================+====================================================================+
|
||||
| id | String | Rule ID |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------+
|
||||
| policyid | String | Policy ID |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------+
|
||||
| timestamp | Long | Time the rule is created. The value is a 13-digit timestamp in ms. |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------+
|
||||
| status | Integer | Rule status. The value can be: |
|
||||
| | | |
|
||||
| | | - 0: The rule is disabled. |
|
||||
| | | |
|
||||
| | | - 1: The rule is enabled. |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------+
|
||||
| url | String | URL protected by the data masking rule |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------+
|
||||
| category | String | Masked field |
|
||||
| | | |
|
||||
| | | Enumeration values: |
|
||||
| | | |
|
||||
| | | - **params** |
|
||||
| | | |
|
||||
| | | - **cookie** |
|
||||
| | | |
|
||||
| | | - **header** |
|
||||
| | | |
|
||||
| | | - **form** |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------+
|
||||
| index | String | Name of the masked field |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------+
|
||||
| description | String | Rule description |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------+
|
||||
|
||||
**Status code: 400**
|
||||
|
||||
.. table:: **Table 4** Response body parameters
|
||||
.. table:: **Table 3** Response body parameters
|
||||
|
||||
========== ====== =============
|
||||
Parameter Type Description
|
||||
@ -96,7 +56,7 @@ Response Parameters
|
||||
|
||||
**Status code: 401**
|
||||
|
||||
.. table:: **Table 5** Response body parameters
|
||||
.. table:: **Table 4** Response body parameters
|
||||
|
||||
========== ====== =============
|
||||
Parameter Type Description
|
||||
@ -107,7 +67,7 @@ Response Parameters
|
||||
|
||||
**Status code: 500**
|
||||
|
||||
.. table:: **Table 6** Response body parameters
|
||||
.. table:: **Table 5** Response body parameters
|
||||
|
||||
========== ====== =============
|
||||
Parameter Type Description
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -13,17 +13,17 @@ This API is used to delete a reference table.
|
||||
URI
|
||||
---
|
||||
|
||||
DELETE /v1/{project_id}/waf/valuelist/{table_id}
|
||||
DELETE /v1/{project_id}/waf/valuelist/{valuelistid}
|
||||
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
+------------+-----------+--------+---------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+============+===========+========+=============================================================================================+
|
||||
| project_id | Yes | String | Project ID |
|
||||
+------------+-----------+--------+---------------------------------------------------------------------------------------------+
|
||||
| table_id | Yes | String | Reference table ID. It can be obtained by calling the API Querying the Reference Table List |
|
||||
+------------+-----------+--------+---------------------------------------------------------------------------------------------+
|
||||
+-------------+-----------+--------+---------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+=============+===========+========+=============================================================================================+
|
||||
| project_id | Yes | String | Project ID |
|
||||
+-------------+-----------+--------+---------------------------------------------------------------------------------------------+
|
||||
| valuelistid | Yes | String | Reference table ID. It can be obtained by calling the API Querying the Reference Table List |
|
||||
+-------------+-----------+--------+---------------------------------------------------------------------------------------------+
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
@ -117,7 +117,7 @@ Example Requests
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{Endpoint}/v1/{project_id}/waf/valuelist/{table_id}?
|
||||
DELETE https://{Endpoint}/v1/{project_id}/waf/valuelist/{valuelistid}?
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
@ -133,8 +133,6 @@ Request succeeded.
|
||||
"name" : "demo2",
|
||||
"type" : "url",
|
||||
"values" : [ "/demo" ],
|
||||
"description" : "",
|
||||
"producer" : 1,
|
||||
"timestamp" : 1656495488880
|
||||
}
|
||||
|
||||
|
||||
@ -17,15 +17,13 @@ DELETE /v1/{project_id}/waf/policy/{policy_id}/antitamper/{rule_id}
|
||||
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
+------------+-----------+--------+------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+============+===========+========+======================================================================================================+
|
||||
| project_id | Yes | String | Project ID |
|
||||
+------------+-----------+--------+------------------------------------------------------------------------------------------------------+
|
||||
| policy_id | Yes | String | Policy ID. It can be obtained by calling the **ListPolicy** API. |
|
||||
+------------+-----------+--------+------------------------------------------------------------------------------------------------------+
|
||||
| rule_id | Yes | String | ID of the web tamper protection rule. It can be obtained by calling the **ListAntitamperRules** API. |
|
||||
+------------+-----------+--------+------------------------------------------------------------------------------------------------------+
|
||||
========== ========= ====== ===========
|
||||
Parameter Mandatory Type Description
|
||||
========== ========= ====== ===========
|
||||
project_id Yes String Project ID
|
||||
policy_id Yes String Policy ID
|
||||
rule_id Yes String Rule ID
|
||||
========== ========= ====== ===========
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
@ -49,27 +47,27 @@ Response Parameters
|
||||
|
||||
.. table:: **Table 3** Response body parameters
|
||||
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================+=========================================================================================================================================================+
|
||||
| id | String | Rule ID. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| policyid | String | Policy ID |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| timestamp | Long | Timestamp |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| description | String | Rule description. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| status | Integer | Rule status. The value can be: |
|
||||
| | | |
|
||||
| | | - 0: The rule is disabled. |
|
||||
| | | |
|
||||
| | | - 1: The rule is enabled. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| hostname | 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. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| url | String | URL for the web tamper protection rule. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+-----------------------+---------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================+=========================================================+
|
||||
| id | String | Rule ID. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------+
|
||||
| policyid | String | Policy ID |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------+
|
||||
| timestamp | Long | Timestamp |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------+
|
||||
| description | String | Rule description. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------+
|
||||
| status | Integer | Rule status. The value can be: |
|
||||
| | | |
|
||||
| | | - 0: The rule is disabled. |
|
||||
| | | |
|
||||
| | | - 1: The rule is enabled. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------+
|
||||
| hostname | String | Domain name protected by the web tamper protection rule |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------+
|
||||
| url | String | URL for the web tamper protection rule. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------+
|
||||
|
||||
**Status code: 400**
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -2,8 +2,8 @@
|
||||
|
||||
.. _ShowWhiteblackipRule:
|
||||
|
||||
Querying a Blacklist Or Whitelist Rule by ID
|
||||
============================================
|
||||
Querying a Blacklist or Whitelist Rule
|
||||
======================================
|
||||
|
||||
Function
|
||||
--------
|
||||
@ -17,15 +17,13 @@ GET /v1/{project_id}/waf/policy/{policy_id}/whiteblackip/{rule_id}
|
||||
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
+------------+-----------+--------+---------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+============+===========+========+=========================================================================================================+
|
||||
| project_id | Yes | String | Project ID |
|
||||
+------------+-----------+--------+---------------------------------------------------------------------------------------------------------+
|
||||
| policy_id | Yes | String | Policy ID. It can be obtained by calling the **ListPolicy** API. |
|
||||
+------------+-----------+--------+---------------------------------------------------------------------------------------------------------+
|
||||
| rule_id | Yes | String | ID of the blacklist or whitelist rule. It can be obtained by calling the **ListWhiteblackipRules** API. |
|
||||
+------------+-----------+--------+---------------------------------------------------------------------------------------------------------+
|
||||
========== ========= ====== ===========
|
||||
Parameter Mandatory Type Description
|
||||
========== ========= ====== ===========
|
||||
project_id Yes String Project ID
|
||||
policy_id Yes String Policy ID
|
||||
rule_id Yes String Rule ID
|
||||
========== ========= ====== ===========
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
@ -54,8 +52,6 @@ Response Parameters
|
||||
+=======================+=======================+=====================================================+
|
||||
| id | String | Rule ID |
|
||||
+-----------------------+-----------------------+-----------------------------------------------------+
|
||||
| name | String | Rule name. |
|
||||
+-----------------------+-----------------------+-----------------------------------------------------+
|
||||
| policyid | String | Policy ID. |
|
||||
+-----------------------+-----------------------+-----------------------------------------------------+
|
||||
| timestamp | Long | Rule creation time |
|
||||
@ -68,7 +64,7 @@ Response Parameters
|
||||
| | | |
|
||||
| | | - 1: The rule is enabled. |
|
||||
+-----------------------+-----------------------+-----------------------------------------------------+
|
||||
| addr | String | Blacklisted or whitelisted IP addresses |
|
||||
| addr | String | lacklisted or whitelisted IP addresses |
|
||||
+-----------------------+-----------------------+-----------------------------------------------------+
|
||||
| white | Integer | Protective action. The value can be: |
|
||||
| | | |
|
||||
@ -78,8 +74,6 @@ Response Parameters
|
||||
| | | |
|
||||
| | | - 2: WAF only logs the requests that hit the rule. |
|
||||
+-----------------------+-----------------------+-----------------------------------------------------+
|
||||
| followed_action_id | String | ID of the known attack source rule. |
|
||||
+-----------------------+-----------------------+-----------------------------------------------------+
|
||||
|
||||
**Status code: 400**
|
||||
|
||||
@ -124,21 +118,7 @@ Example Requests
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
**Status code: 200**
|
||||
|
||||
Request succeeded.
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"id" : "5d43af25404341058d5ab17b7ba78b56",
|
||||
"policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d",
|
||||
"timestamp" : 1650531872900,
|
||||
"description" : "demo",
|
||||
"status" : 1,
|
||||
"addr" : "x.x.x.x",
|
||||
"white" : 0
|
||||
}
|
||||
None
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user