diff --git a/docs/cfw/api-ref/ALL_META.TXT.json b/docs/cfw/api-ref/ALL_META.TXT.json index c52232a3..5948da34 100644 --- a/docs/cfw/api-ref/ALL_META.TXT.json +++ b/docs/cfw/api-ref/ALL_META.TXT.json @@ -1486,8 +1486,8 @@ "githuburl":"" }, { - "uri":"cfw_02_0011.html", - "node_id":"cfw_02_0011.xml", + "uri":"cfw_02_0023.html", + "node_id":"cfw_02_0023.xml", "product_code":"cfw", "code":"76", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1545,8 +1545,8 @@ "githuburl":"" }, { - "uri":"cfw_02_0016.html", - "node_id":"cfw_02_0016.xml", + "uri":"cfw_02_0017.html", + "node_id":"cfw_02_0017.xml", "product_code":"cfw", "code":"79", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", diff --git a/docs/cfw/api-ref/AddAclRule.html b/docs/cfw/api-ref/AddAclRule.html index cbb11f3c..5b6129a0 100644 --- a/docs/cfw/api-ref/AddAclRule.html +++ b/docs/cfw/api-ref/AddAclRule.html @@ -1,909 +1,930 @@

Creating an ACL Rule

-

Function

This API is used to create an ACL rule.

+

Function

This API is used to create an ACL rule.

-

URI

POST /v1/{project_id}/acl-rule

+

URI

POST /v1/{project_id}/acl-rule

-
Table 1 Path Parameters

Parameter

+
- - - - - - -
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID

+

Project ID
-
Table 2 Query Parameters

Parameter

+
- - - - - - - - - - -
Table 2 Query Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

enterprise_project_id

+

enterprise_project_id

No

+

No

String

+

String

Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

+

Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

fw_instance_id

+

fw_instance_id

No

+

No

String

+

String

Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

+

Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.
-

Request Parameters

-
Table 3 Request header parameters

Parameter

+

Request Parameters

+
- - - - - - -
Table 3 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

+

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.
-
Table 4 Request body parameters

Parameter

+
- - - - - - - - - - - - - - -
Table 4 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

object_id

+

object_id

Yes

+

Yes

String

+

String

Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

+

Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

type

+

type

Yes

+

Yes

Integer

+

Integer

Rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule).

-

Enumeration values:

-
  • 0
  • 1
  • 2
+

Rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule).

+

Enumeration values:

+

  • 0

    +

  • 1

    +

  • 2

    +

rules

+

rules

Yes

+

Yes

Array of rules objects

+

Array of rules objects

rules

+

rules
-
Table 5 rules

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 rules

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

name

+

name

Yes

+

Yes

String

+

String

Rule name

+

Rule name

sequence

+

sequence

Yes

+

Yes

OrderRuleAclDto object

+

OrderRuleAclDto object

Rule sequence

+

Rule sequence

address_type

+

address_type

Yes

+

Yes

Integer

+

Integer

Address type. The value can be 0 (IPv4), 1 (IPv6), or 2 (domain).

-

Enumeration values:

-
  • 0
  • 1
  • 2
+

Address type. The value can be 0 (IPv4), 1 (IPv6), or 2 (domain).

+

Enumeration values:

+

  • 0

    +

  • 1

    +

  • 2

    +

action_type

+

action_type

Yes

+

Yes

Integer

+

Integer

Action. 0: allow; 1: deny

+

Action. 0: allow; 1: deny

status

+

status

Yes

+

Yes

Integer

+

Integer

Rule delivery status. 0: disabled; 1: enabled.

-

Enumeration values:

-
  • 0
  • 1
+

Rule delivery status. 0: disabled; 1: enabled.

+

Enumeration values:

+

  • 0

    +

  • 1

    +

applications

+

applications

No

+

No

Array of strings

+

Array of strings

applications

+

applications

applicationsJsonString

+

applicationsJsonString

No

+

No

String

+

String

applications json string

+

applications json string

long_connect_time

+

long_connect_time

No

+

No

Long

+

Long

Persistent connection duration

+

Persistent connection duration

long_connect_time_hour

+

long_connect_time_hour

No

+

No

Long

+

Long

Persistent connection duration (hour)

+

Persistent connection duration (hour)

long_connect_time_minute

+

long_connect_time_minute

No

+

No

Long

+

Long

Persistent connection duration (minute)

+

Persistent connection duration (minute)

long_connect_time_second

+

long_connect_time_second

No

+

No

Long

+

Long

Persistent Connection Duration (second)

+

Persistent Connection Duration (second)

long_connect_enable

+

long_connect_enable

Yes

+

Yes

Integer

+

Integer

Whether to support persistent connections. 0: not supported; 1: supported.

-

Enumeration values:

-
  • 0
  • 1
+

Whether to support persistent connections. 0: not supported; 1: supported.

+

Enumeration values:

+

  • 0

    +

  • 1

    +

description

+

description

No

+

No

String

+

String

Description

+

Description

direction

+

direction

No

+

No

Integer

+

Integer

Direction: 0 means outside to inside, 1 means inside to outside, direction value is required when rule type is internet or nat.

-

Enumeration values:

-
  • 0
  • 1
+

Direction: 0 means outside to inside, 1 means inside to outside, direction value is required when rule type is internet or nat.

+

Enumeration values:

+

  • 0

    +

  • 1

    +

source

+

source

Yes

+

Yes

RuleAddressDtoForRequest object

+

RuleAddressDtoForRequest object

Source address transmission object

+

Source address transmission object

destination

+

destination

Yes

+

Yes

RuleAddressDtoForRequest object

+

RuleAddressDtoForRequest object

Destination address transmission object

+

Destination address transmission object

service

+

service

Yes

+

Yes

RuleServiceDto object

+

RuleServiceDto object

Service object

+

Service object

tag

+

tag

No

+

No

TagsVO object

+

TagsVO object

Tag value

+

Tag value
-
Table 6 OrderRuleAclDto

Parameter

+
- - - - - - - - - - - - - - -
Table 6 OrderRuleAclDto

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

dest_rule_id

+

dest_rule_id

No

+

No

String

+

String

ID of the rule that the added rule will follow. This parameter cannot be left blank if the rule is not pinned on top, and is empty when the added rule is pinned on top.

+

ID of the rule that the added rule will follow. This parameter cannot be left blank if the rule is not pinned on top, and is empty when the added rule is pinned on top.

top

+

top

No

+

No

Integer

+

Integer

Whether to pin on top. The options are as follows: 0: no; 1: yes.

+

Whether to pin on top. The options are as follows: 0: no; 1: yes.

bottom

+

bottom

No

+

No

Integer

+

Integer

Whether to pin on bottom. The options are as follows: 0: no; 1: yes.

+

Whether to pin on bottom. The options are as follows: 0: no; 1: yes.
-
Table 7 RuleAddressDtoForRequest

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + +
Table 7 RuleAddressDtoForRequest

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

type

+

type

Yes

+

Yes

Integer

+

Integer

Source type. 0: manual input; 1: associated IP address group; 2: domain name; 3: region; 4: domain set 5: multi object, 6: domain set dns, 7: domain url profile

+

Source type. 0: manual input; 1: associated IP address group; 2: domain name; 3: region; 4: domain set 5: multi object, 6: domain set dns, 7: domain url profile

address_type

+

address_type

No

+

No

Integer

+

Integer

Source type. 0: IPv4; 1: IPv6

+

Source type. 0: IPv4; 1: IPv6

address

+

address

No

+

No

String

+

String

Source IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type.

+

Source IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type.

address_set_id

+

address_set_id

No

+

No

String

+

String

ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type.

+

ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type.

address_set_name

+

address_set_name

No

+

No

String

+

String

IP address group name

+

IP address group name

domain_address_name

+

domain_address_name

No

+

No

String

+

String

Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type.

+

Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type.

region_list_json

+

region_list_json

No

+

No

String

+

String

JSON value of the rule region list.

+

JSON value of the rule region list.

region_list

+

region_list

No

+

No

Array of IpRegionDto objects

+

Array of IpRegionDto objects

Region list of a rule

+

Region list of a rule

domain_set_id

+

domain_set_id

No

+

No

String

+

String

domain set id

+

domain set id

domain_set_name

+

domain_set_name

No

+

No

String

+

String

domain set name

+

domain set name

ip_address

+

ip_address

No

+

No

Array of strings

+

Array of strings

IP address list

+

IP address list

address_set_type

+

address_set_type

No

+

No

Integer

+

Integer

Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set.

+

Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set.

predefined_group

+

predefined_group

No

+

No

Array of strings

+

Array of strings

predefined group

+

predefined group

+

address_group

+

No

+

Array of strings

+

address group
-
Table 8 IpRegionDto

Parameter

+
- - - - - - - - - - - - - - - - - - -
Table 8 IpRegionDto

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

region_id

+

region_id

No

+

No

String

+

String

region id

+

region id

description_cn

+

description_cn

No

+

No

String

+

String

cn description

+

cn description

description_en

+

description_en

No

+

No

String

+

String

en description

+

en description

region_type

+

region_type

No

+

No

Integer

+

Integer

Region type, 0 means country, 1 means province, 2 means continent

+

Region type, 0 means country, 1 means province, 2 means continent
-
Table 9 RuleServiceDto

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 9 RuleServiceDto

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

type

+

type

Yes

+

Yes

Integer

+

Integer

Service input type. The value 0 indicates manual input, and the value 1 indicates automatic input.

+

Service input type. The value 0 indicates manual input, and the value 1 indicates automatic input.

protocol

+

protocol

No

+

No

Integer

+

Integer

Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.

+

Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.

protocols

+

protocols

No

+

No

Array of integers

+

Array of integers

Protocols

+

Protocols

source_port

+

source_port

No

+

No

String

+

String

Source port

+

Source port

dest_port

+

dest_port

No

+

No

String

+

String

Destination port

+

Destination port

service_set_id

+

service_set_id

No

+

No

String

+

String

Service group ID. This parameter is left blank for the manual type and cannot be left blank for the automatic type.

+

Service group ID. This parameter is left blank for the manual type and cannot be left blank for the automatic type.

service_set_name

+

service_set_name

No

+

No

String

+

String

Service group name

+

Service group name

custom_service

+

custom_service

No

+

No

Array of ServiceItem objects

+

Array of ServiceItem objects

custom service

+

custom service

predefined_group

+

predefined_group

No

+

No

Array of strings

+

Array of strings

predefined group

+

predefined group

service_group

+

service_group

No

+

No

Array of strings

+

Array of strings

Service group list

+

Service group list

service_group_names

+

service_group_names

No

+

No

Array of ServiceGroupVO objects

+

Array of ServiceGroupVO objects

Service group name list

+

Service group name list

service_set_type

+

service_set_type

No

+

No

Integer

+

Integer

Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases

+

Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases
-
Table 10 ServiceItem

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - -
Table 10 ServiceItem

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

protocol

+

protocol

No

+

No

Integer

+

Integer

Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.

+

Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.

source_port

+

source_port

No

+

No

String

+

String

source port

+

source port

dest_port

+

dest_port

No

+

No

String

+

String

destination port

+

destination port

description

+

description

No

+

No

String

+

String

description

+

description

name

+

name

No

+

No

String

+

String

name

+

name
-
Table 11 ServiceGroupVO

Parameter

+
- - - - - - - - - - - - - - - - - - -
Table 11 ServiceGroupVO

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

name

+

name

No

+

No

String

+

String

service group name

+

service group name

protocols

+

protocols

No

+

No

Array of integers

+

Array of integers

protocols

+

protocols

service_set_type

+

service_set_type

No

+

No

Integer

+

Integer

Query service set type, 0 means custom define service set, 1 means predefine service set.

+

Query service set type, 0 means custom define service set, 1 means predefine service set.

set_id

+

set_id

No

+

No

String

+

String

service set id

+

service set id
-
Table 12 TagsVO

Parameter

+
- - - - - - - - - - - - - - -
Table 12 TagsVO

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

tag_id

+

tag_id

No

+

No

String

+

String

tag id

+

tag id

tag_key

+

tag_key

No

+

No

String

+

String

tag key

+

tag key

tag_value

+

tag_value

No

+

No

String

+

String

tag value

+

tag value
-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 13 Response body parameters

Parameter

+
- - - - -
Table 13 Response body parameters

Parameter

Type

+

Type

Description

+

Description

data

+

data

RuleIdList object

+

RuleIdList object

Rule ID list

+

Rule ID list
-
Table 14 RuleIdList

Parameter

+
- - - - -
Table 14 RuleIdList

Parameter

Type

+

Type

Description

+

Description

rules

+

rules

Array of RuleId objects

+

Array of RuleId objects

Rule ID list

+

Rule ID list
-
Table 15 RuleId

Parameter

+
- - - - - - - -
Table 15 RuleId

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

id

+

id

name

+

name

String

+

String

name

+

name
-

Status code: 400

+

Status code: 400

-
- diff --git a/docs/cfw/api-ref/AddServiceItems.html b/docs/cfw/api-ref/AddServiceItems.html index 77a210ff..1d6f1e71 100644 --- a/docs/cfw/api-ref/AddServiceItems.html +++ b/docs/cfw/api-ref/AddServiceItems.html @@ -153,15 +153,6 @@ - - - - - - -
Table 16 Response body parameters

Parameter

+
- - - - - - - -
Table 16 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_code

+

error_code

String

+

String

Error code

-

Minimum: 8

-

Maximum: 36

+

Error code

+

Minimum: 8

+

Maximum: 36

error_msg

+

error_msg

String

+

String

Description

-

Minimum: 2

-

Maximum: 512

+

Description

+

Minimum: 2

+

Maximum: 512
-

Example Requests

The following example shows how to add an IPv4 inbound rule. The rule name is TestRule, the source is the IP address 1.1.1.1, the destination is the IP address 2.2.2.2, the service type is service, the protocol type is TCP, the source port is 0, and the destination port is 0. Persistent connections are not supported. The action is to allow. The status is enabled.

-
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule
+
Example Requests
The following example shows how to add an IPv4 inbound rule. The rule name is TestRule, the source is the IP address 1.1.1.1, the destination is the IP address 2.2.2.2, the service type is service, the protocol type is TCP, the source port is 0, and the destination port is 0. Persistent connections are not supported. The action is to allow. The status is enabled.

+
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule
 
 {
   "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b",
@@ -941,64 +962,64 @@
   "type" : 0
 }

 

-
Example Responses
Status code: 200

-
Response to the request for adding an ACL

-
{
+
Example Responses
Status code: 200

+
Response to the request for adding an ACL

+
{
   "data" : {
     "rules" : [ {
       "id" : "0475c516-0e41-4caf-990b-0c504eebd73f"
     } ]
   }
 }

-
Status code: 400

-
Bad Request

-
{
+
Status code: 400

+
Bad Request

+
{
   "error_code" : "CFW.00900016",
   "error_msg" : "The import task is in progress. Please operate after the task is completed"
 }

 

-
Status Codes

-

-
-
-
-
@@ -164,7 +164,7 @@
 
-
@@ -231,7 +231,7 @@
 
Status Code

+
Status Codes

+

-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

 
Description

+
Description

 		
 

 
200

+
200

 
Response to the request for adding an ACL

+
Response to the request for adding an ACL

 		
 
400

+
400

 
Bad Request

+
Bad Request

 		
 
401

+
401

 
Unauthorized

+
Unauthorized

 		
 
403

+
403

 
Forbidden

+
Forbidden

 		
 
404

+
404

 
Not Found

+
Not Found

 		
 
500

+
500

 
Internal Server Error

+
Internal Server Error

 		
 

 
 

 

 

-
Error Codes
See Error Codes.

+
Error Codes
See Error Codes.

 

 

 

diff --git a/docs/cfw/api-ref/AddAddressSet.html b/docs/cfw/api-ref/AddAddressSet.html
index 5b3d77ba..49c9701f 100644
--- a/docs/cfw/api-ref/AddAddressSet.html
+++ b/docs/cfw/api-ref/AddAddressSet.html
@@ -100,7 +100,7 @@
 
 
String

 
Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

+
Internet border Protected object ID, You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border.

 		
 

 
name

diff --git a/docs/cfw/api-ref/AddBlackWhiteList.html b/docs/cfw/api-ref/AddBlackWhiteList.html
index 210ab406..991b2057 100644
--- a/docs/cfw/api-ref/AddBlackWhiteList.html
+++ b/docs/cfw/api-ref/AddBlackWhiteList.html
@@ -127,7 +127,7 @@
 		
 
Integer

 
IP address type. 0: ipv4; 1: ipv6; 2: domain

+
IP address type. 0: ipv4; 1: ipv6

 		
 

 
address

diff --git a/docs/cfw/api-ref/AddDomainSet.html b/docs/cfw/api-ref/AddDomainSet.html
index a08b8413..95b8bdcc 100644
--- a/docs/cfw/api-ref/AddDomainSet.html
+++ b/docs/cfw/api-ref/AddDomainSet.html
@@ -109,7 +109,7 @@
 		
 
String

 
Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

+
Internet border Protected object ID, You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border.

 		
 

 
name

@@ -132,7 +132,7 @@
 

 
domain_names

 
No

+
Yes

 		
 
Array of DomainSetInfoDto objects

 

 
domain_name

 
No

+
Yes

 		
 
String

 

 

 

-
Example Requests
Add a domain set whose project ID is 9d80d070b6d44942af73c9c3d38e0429, firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925, domain set name is test, domain name is www.aaa.com, and protected object ID is fde07429-2e02-45c0-a85f-4f1cacea24d2.

+
Example Requests
Add a domain set whose project ID is 9d80d070b6d44942af73c9c3d38e0429, firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925, domain set name is test, domain name is www.aaa.com, and protected object ID is fde07429-2e02-45c0-a85f-4f1cacea24d2 and domain set type is application type.

 
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-set?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default
 
 {
diff --git a/docs/cfw/api-ref/AddDomains.html b/docs/cfw/api-ref/AddDomains.html
index b57fbdf5..edce9bc7 100644
--- a/docs/cfw/api-ref/AddDomains.html
+++ b/docs/cfw/api-ref/AddDomains.html
@@ -146,7 +146,7 @@

domain_name

No

+

Yes

String

Destination port

name

-

No

-

String

-

Service member name

-

description

No

@@ -206,16 +197,16 @@

items

Array of IdObject objects

+

Array of items objects

Service group member ID list

+

service item id list
-
Table 8 IdObject

Parameter

+
@@ -227,14 +218,7 @@ - - - - - diff --git a/docs/cfw/api-ref/AddServiceSet.html b/docs/cfw/api-ref/AddServiceSet.html index e98cb751..24eafbfe 100644 --- a/docs/cfw/api-ref/AddServiceSet.html +++ b/docs/cfw/api-ref/AddServiceSet.html @@ -100,7 +100,7 @@ -
Table 8 items

Parameter

Type

String

ID

-

name

-

String

-

name

+

id

String

Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

+

Internet border Protected object ID, You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border.

name

@@ -131,7 +131,7 @@

Response Parameters

Status code: 200

-
Table 5 Response body parameters

Parameter

+
@@ -141,16 +141,16 @@ - -
Table 5 Response body parameters

Parameter

Type

data

IdObject object

+

data object

Data returned when a service group is created

+

object
-
Table 6 IdObject

Parameter

+
@@ -162,14 +162,7 @@ - - - - - diff --git a/docs/cfw/api-ref/BatchDeleteAddressItems.html b/docs/cfw/api-ref/BatchDeleteAddressItems.html index 97b5301f..5d3cd4bc 100644 --- a/docs/cfw/api-ref/BatchDeleteAddressItems.html +++ b/docs/cfw/api-ref/BatchDeleteAddressItems.html @@ -146,6 +146,7 @@ }

Example Responses

Status code: 200

+

Batch delete address items response

{
   "data" : [ "d072ad2e-033c-40a9-b0b5-751f9c2943a6" ]
 }
@@ -159,7 +160,8 @@
- +
Table 6 data

Parameter

Type

String

ID

-

name

-

String

-

name

+

Protected object ID

200

Batch delete address items response

+
diff --git a/docs/cfw/api-ref/CLASS.TXT.json b/docs/cfw/api-ref/CLASS.TXT.json index ceadb5e3..cc644c7e 100644 --- a/docs/cfw/api-ref/CLASS.TXT.json +++ b/docs/cfw/api-ref/CLASS.TXT.json @@ -678,7 +678,7 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"cfw", "title":"Appendix", - "uri":"cfw_02_0011.html", + "uri":"cfw_02_0023.html", "doc_type":"api", "p_code":"", "code":"76" @@ -705,7 +705,7 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"cfw", "title":"Change History", - "uri":"cfw_02_0016.html", + "uri":"cfw_02_0017.html", "doc_type":"api", "p_code":"", "code":"79" diff --git a/docs/cfw/api-ref/ChangeIpsProtectMode.html b/docs/cfw/api-ref/ChangeIpsProtectMode.html index e0f74b2f..c4e22566 100644 --- a/docs/cfw/api-ref/ChangeIpsProtectMode.html +++ b/docs/cfw/api-ref/ChangeIpsProtectMode.html @@ -118,7 +118,7 @@

Response Parameters

Status code: 200

-
Table 5 Response body parameters

Parameter

+
@@ -128,16 +128,16 @@ - -
Table 5 Response body parameters

Parameter

Type

data

IdObject object

+

data object

Update the IPS protection mode

+

object
-
- - -
Table 6 IdObject

Parameter

+
@@ -149,14 +149,7 @@ - - - - - diff --git a/docs/cfw/api-ref/ChangeIpsSwitchStatus.html b/docs/cfw/api-ref/ChangeIpsSwitchStatus.html index 25fbf29f..0de836b7 100644 --- a/docs/cfw/api-ref/ChangeIpsSwitchStatus.html +++ b/docs/cfw/api-ref/ChangeIpsSwitchStatus.html @@ -148,14 +148,7 @@ - - - - - diff --git a/docs/cfw/api-ref/CreateFirewall.html b/docs/cfw/api-ref/CreateFirewall.html index 2147d1d3..491fb6ac 100644 --- a/docs/cfw/api-ref/CreateFirewall.html +++ b/docs/cfw/api-ref/CreateFirewall.html @@ -109,7 +109,7 @@ - @@ -141,7 +141,7 @@ - @@ -150,7 +150,7 @@ - @@ -173,11 +173,11 @@ - - - - +
Table 6 data

Parameter

Type

String

ID

-

name

-

String

-

name

+

Protected object ID

trace_id

-

String

-

trace_id

-

data

+

data

data object

flavor

No

+

Yes

flavor object

key

Yes

+

No

String

value

Yes

+

No

String

version

No

+

Yes

String

Firewall version: If charge_mode is set to prePaid, only the Professional Edition is supported, and when charge_mode is set to postPaid, the Standard and Professional Editions are supported.

+

Firewall version: If charge_mode is set to postPaid, only the Professional Edition is supported, and when charge_mode is set to prePaid, the Standard and Professional Editions are supported.

Enumeration values:

  • Standard

  • Professional

    @@ -404,7 +404,7 @@

String

Firewall version: If charge_mode is set to prePaid, only the Professional Edition is supported, and when charge_mode is set to postPaid, the Standard and Professional Editions are supported.

+

Firewall version: If charge_mode is set to postPaid, only the Professional Edition is supported, and when charge_mode is set to prePaid, the Standard and Professional Editions are supported.

Enumeration values:

  • Standard

  • Professional

    @@ -534,7 +534,7 @@ "value" : "TagVal" } ], "flavor" : { - "version" : "standard", + "version" : "Standard", "extend_eip_count" : 2000, "extend_bandwidth" : 5000, "extend_vpc_count" : 100 diff --git a/docs/cfw/api-ref/DeleteAclRule.html b/docs/cfw/api-ref/DeleteAclRule.html index dcdc4849..7709f8d4 100644 --- a/docs/cfw/api-ref/DeleteAclRule.html +++ b/docs/cfw/api-ref/DeleteAclRule.html @@ -107,7 +107,8 @@

RuleId object

Rule Id

+
diff --git a/docs/cfw/api-ref/ErrorCode.html b/docs/cfw/api-ref/ErrorCode.html index 0e49105d..9d9df8b9 100644 --- a/docs/cfw/api-ref/ErrorCode.html +++ b/docs/cfw/api-ref/ErrorCode.html @@ -592,7 +592,7 @@
-
Parent topic: Appendix
+
Parent topic: Appendix
diff --git a/docs/cfw/api-ref/ListAccessControlLogs.html b/docs/cfw/api-ref/ListAccessControlLogs.html index a634a895..4b388965 100644 --- a/docs/cfw/api-ref/ListAccessControlLogs.html +++ b/docs/cfw/api-ref/ListAccessControlLogs.html @@ -62,7 +62,7 @@

Long

Start time

+

Start time, a timestamp in milliseconds, such as 1718936272648

end_time

@@ -71,7 +71,7 @@

Long

End time

+

End time, a timestamp in milliseconds, such as 1718936272648

src_ip

@@ -383,7 +383,7 @@

Long

Hit time

+

Hit time, a timestamp in milliseconds, such as 1718936272648

src_region_id

diff --git a/docs/cfw/api-ref/ListAclRules.html b/docs/cfw/api-ref/ListAclRules.html index 31772bf9..07028779 100644 --- a/docs/cfw/api-ref/ListAclRules.html +++ b/docs/cfw/api-ref/ListAclRules.html @@ -1,878 +1,893 @@

Querying a Protection Rule

-

Function

This API is used to query a protection rule.

+

Function

This API is used to query a protection rule.

-

URI

GET /v1/{project_id}/acl-rules

+

URI

GET /v1/{project_id}/acl-rules

-
Table 1 Path Parameters

Parameter

+
- - - - - - -
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID

+

Project ID
-
Table 2 Query Parameters

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

object_id

+

object_id

Yes

+

Yes

String

+

String

Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

+

Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

type

+

type

No

+

No

Integer

+

Integer

Specifies the rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule).

-

Enumeration values:

-
  • 0
  • 1
  • 2
+

Specifies the rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule).

+

Enumeration values:

+

  • 0

    +

  • 1

    +

  • 2

    +

ip

+

ip

No

+

No

String

+

String

IP address

+

IP address

name

+

name

No

+

No

String

+

String

Name

+

Name

direction

+

direction

No

+

No

Integer

+

Integer

Direction. 0: inbound; 1: outbound

+

Direction. 0: inbound; 1: outbound

status

+

status

No

+

No

Integer

+

Integer

Indicates the rule delivery status. 0: disabled; 1: enabled.

-

Enumeration values:

-
  • 0
  • 1
+

Indicates the rule delivery status. 0: disabled; 1: enabled.

+

Enumeration values:

+

  • 0

    +

  • 1

    +

action_type

+

action_type

No

+

No

Integer

+

Integer

Action. 0: allow; 1: deny

-

Enumeration values:

-
  • 0
  • 1
+

Action. 0: allow; 1: deny

+

Enumeration values:

+

  • 0

    +

  • 1

    +

address_type

+

address_type

No

+

No

Integer

+

Integer

Address type. The value can be 0 (IPv4).

-

Enumeration values:

-
  • 0
  • 1
  • 2
+

Address type. The value can be 0 (IPv4).

+

Enumeration values:

+

  • 0

    +

  • 1

    +

  • 2

    +

limit

+

limit

Yes

+

Yes

Integer

+

Integer

Number of records displayed on each page, in the range 1-1024

+

Number of records displayed on each page, in the range 1-1024

offset

+

offset

Yes

+

Yes

Integer

+

Integer

Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

+

Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

enterprise_project_id

+

enterprise_project_id

No

+

No

String

+

String

Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

+

Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

fw_instance_id

+

fw_instance_id

No

+

No

String

+

String

Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

+

Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

tags_id

+

tags_id

No

+

No

String

+

String

tags id

+

tags id

source

+

source

No

+

No

String

+

String

source address

+

source address

destination

+

destination

No

+

No

String

+

String

destination address

+

destination address

service

+

service

No

+

No

String

+

String

service port

+

service port

application

+

application

No

+

No

String

+

String

application

+

application
-

Request Parameters

-
Table 3 Request header parameters

Parameter

+

Request Parameters

+
- - - - - - -
Table 3 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

+

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.
-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 4 Response body parameters

Parameter

+
- - - - -
Table 4 Response body parameters

Parameter

Type

+

Type

Description

+

Description

data

+

data

data object

+

data object

data

+

data
-
Table 5 data

Parameter

+
- - - - - - - - - - - - - - - - -
Table 5 data

Parameter

Type

+

Type

Description

+

Description

offset

+

offset

Integer

+

Integer

Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

+

Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

limit

+

limit

Integer

+

Integer

Number of records displayed on each page, in the range 1-1024

+

Number of records displayed on each page, in the range 1-1024

total

+

total

Integer

+

Integer

Total number of queried records

+

Total number of queried records

object_id

+

object_id

String

+

String

Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

+

Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

records

+

records

Array of records objects

+

Array of records objects

records

+

records
-
Table 6 records

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 records

Parameter

Type

+

Type

Description

+

Description

rule_id

+

rule_id

String

+

String

Rule ID

+

Rule ID

address_type

+

address_type

Integer

+

Integer

Address type. The value can be 0 (IPv4) or 1 (IPv6).

+

Address type. The value can be 0 (IPv4) or 1 (IPv6).

name

+

name

String

+

String

Rule name

+

Rule name

direction

+

direction

Integer

+

Integer

Direction: 0 means outside to inside, 1 means inside to outside, direction value is required when rule type is internet or nat.

-

Enumeration values:

-
  • 0
  • 1end_time
+

Direction: 0 means outside to inside, 1 means inside to outside, direction value is required when rule type is internet or nat.

+

Enumeration values:

+

  • 0

    +

  • 1

    +

action_type

+

action_type

Integer

+

Integer

Action. 0: allow; 1: deny

+

Action. 0: allow; 1: deny

status

+

status

Integer

+

Integer

Rule delivery status. 0: disabled; 1: enabled.

+

Rule delivery status. 0: disabled; 1: enabled.

description

+

description

String

+

String

Description

+

Description

long_connect_time

+

long_connect_time

Long

+

Long

Persistent connection duration

+

Persistent connection duration

long_connect_enable

+

long_connect_enable

Integer

+

Integer

Persistent connection support

+

Persistent connection support

long_connect_time_hour

+

long_connect_time_hour

Long

+

Long

Persistent connection duration (hour)

+

Persistent connection duration (hour)

long_connect_time_minute

+

long_connect_time_minute

Long

+

Long

Persistent connection duration (hour)

+

Persistent connection duration (hour)

long_connect_time_second

+

long_connect_time_second

Long

+

Long

Persistent connection duration (hour)

+

Persistent connection duration (hour)

source

+

source

RuleAddressDtoForResponse object

+

RuleAddressDtoForResponse object

Source address transmission object

+

Source address transmission object

destination

+

destination

RuleAddressDtoForResponse object

+

RuleAddressDtoForResponse object

destination

+

destination

service

+

service

RuleServiceDtoForResponse object

+

RuleServiceDtoForResponse object

service

+

service

type

+

type

Integer

+

Integer

Rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule).

-

Enumeration values:

-
  • 0
  • 1
  • 2
+

Rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule).

+

Enumeration values:

+

  • 0

    +

  • 1

    +

  • 2

    +

created_date

+

created_date

String

+

String

Created time

+

Created time

last_open_time

+

last_open_time

String

+

String

Last open time

+

Last open time

tag

+

tag

TagsVO object

+

TagsVO object

tag

+

tag
-
Table 7 RuleAddressDtoForResponse

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 RuleAddressDtoForResponse

Parameter

Type

+

Type

Description

+

Description

type

+

type

Integer

+

Integer

Source type. 0: manual input; 1: associated IP address group; 2: domain name; 3: region; 4: domain set 5: multi object, 6: domain set dns, 7: domain url profile

+

Source type. 0: manual input; 1: associated IP address group; 2: domain name; 3: region; 4: domain set 5: multi object, 6: domain set dns, 7: domain url profile

address_type

+

address_type

Integer

+

Integer

Source type. 0: IPv4; 1: IPv6

+

Source type. 0: IPv4; 1: IPv6

address

+

address

String

+

String

Source IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type.

+

Source IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type.

address_set_id

+

address_set_id

String

+

String

ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type.

+

ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type.

address_set_name

+

address_set_name

String

+

String

IP address group name

+

IP address group name

domain_address_name

+

domain_address_name

String

+

String

Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type.

+

Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type.

region_list_json

+

region_list_json

String

+

String

JSON value of the rule region list.

+

JSON value of the rule region list.

region_list

+

region_list

Array of IpRegionDto objects

+

Array of IpRegionDto objects

Region list of a rule

+

Region list of a rule

domain_set_id

+

domain_set_id

String

+

String

domain set id

+

domain set id

domain_set_name

+

domain_set_name

String

+

String

domain set name

+

domain set name

ip_address

+

ip_address

Array of strings

+

Array of strings

IP address list

+

IP address list

address_group

+

address_group

Array of strings

+

Array of strings

address group

+

address group

address_group_names

+

address_group_names

Array of AddressGroupVO objects

+

Array of AddressGroupVO objects

Address set list

+

Address set list

address_set_type

+

address_set_type

Integer

+

Integer

Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set.

+

Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set.
-
Table 8 IpRegionDto

Parameter

+
- - - - - - - - - - - - - -
Table 8 IpRegionDto

Parameter

Type

+

Type

Description

+

Description

region_id

+

region_id

String

+

String

region id

+

region id

description_cn

+

description_cn

String

+

String

cn description

+

cn description

description_en

+

description_en

String

+

String

en description

+

en description

region_type

+

region_type

Integer

+

Integer

Region type, 0 means country, 1 means province, 2 means continent

+

Region type, 0 means country, 1 means province, 2 means continent
-
Table 9 AddressGroupVO

Parameter

+
- - - - - - - - - - -
Table 9 AddressGroupVO

Parameter

Type

+

Type

Description

+

Description

address_set_type

+

address_set_type

Integer

+

Integer

Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set.

+

Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set.

name

+

name

String

+

String

name

+

name

set_id

+

set_id

String

+

String

address set id

+

address set id
-
Table 10 RuleServiceDtoForResponse

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 RuleServiceDtoForResponse

Parameter

Type

+

Type

Description

+

Description

type

+

type

Integer

+

Integer

Service input type. The value 0 indicates manual input, and the value 1 indicates automatic input.

+

Service input type. The value 0 indicates manual input, and the value 1 indicates automatic input.

protocol

+

protocol

Integer

+

Integer

Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.

+

Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.

protocols

+

protocols

Array of integers

+

Array of integers

Protocols

+

Protocols

source_port

+

source_port

String

+

String

Source port

+

Source port

dest_port

+

dest_port

String

+

String

Destination port

+

Destination port

service_set_id

+

service_set_id

String

+

String

Service group ID. This parameter is left blank for the manual type and cannot be left blank for the automatic type.

+

Service group ID. This parameter is left blank for the manual type and cannot be left blank for the automatic type.

service_set_name

+

service_set_name

String

+

String

Service group name

+

Service group name

custom_service

+

custom_service

Array of ServiceItem objects

+

Array of ServiceItem objects

custom service

+

custom service

service_group

+

service_group

Array of strings

+

Array of strings

Service group list

+

Service group list

service_group_names

+

service_group_names

Array of ServiceGroupVO objects

+

Array of ServiceGroupVO objects

Service group name list

+

Service group name list

service_set_type

+

service_set_type

Integer

+

Integer

Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases

+

Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases
-
Table 11 ServiceItem

Parameter

+
- - - - - - - - - - - - - - - - -
Table 11 ServiceItem

Parameter

Type

+

Type

Description

+

Description

protocol

+

protocol

Integer

+

Integer

Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.

+

Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.

source_port

+

source_port

String

+

String

source port

+

source port

dest_port

+

dest_port

String

+

String

destination port

+

destination port

description

+

description

String

+

String

description

+

description

name

+

name

String

+

String

name

+

name
-
Table 12 ServiceGroupVO

Parameter

+
- - - - - - - - - - - - - -
Table 12 ServiceGroupVO

Parameter

Type

+

Type

Description

+

Description

name

+

name

String

+

String

service group name

+

service group name

protocols

+

protocols

Array of integers

+

Array of integers

protocols

+

protocols

service_set_type

+

service_set_type

Integer

+

Integer

Query service set type, 0 means custom define service set, 1 means predefine service set.

+

Query service set type, 0 means custom define service set, 1 means predefine service set.

set_id

+

set_id

String

+

String

service set id

+

service set id
-
Table 13 TagsVO

Parameter

+
- - - - - - - - - - -
Table 13 TagsVO

Parameter

Type

+

Type

Description

+

Description

tag_id

+

tag_id

String

+

String

tag id

+

tag id

tag_key

+

tag_key

String

+

String

tag key

+

tag key

tag_value

+

tag_value

String

+

String

tag value

+

tag value
-

Status code: 400

+

Status code: 400

-
Table 14 Response body parameters

Parameter

+
- - - - - - - -
Table 14 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_code

+

error_code

String

+

String

Error code

-

Minimum: 8

-

Maximum: 36

+

Error code

+

Minimum: 8

+

Maximum: 36

error_msg

+

error_msg

String

+

String

Description

-

Minimum: 2

-

Maximum: 512

+

Description

+

Minimum: 2

+

Maximum: 512
-

Example Requests

Query the data whose project ID is 9d80d070b6d44942af73c9c3d38e0429, project ID is e12bd2cd-ebfc-4af7-ad6f-ebe6da398029, and size is 10.

-
https://{Endpoint}/cfw/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rules?object_id=e12bd2cd-ebfc-4af7-ad6f-ebe6da398029&limit=10&offset=0
+

Example Requests

Query the data whose project ID is 9d80d070b6d44942af73c9c3d38e0429, project ID is e12bd2cd-ebfc-4af7-ad6f-ebe6da398029, and size is 10.

+
https://{Endpoint}/cfw/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rules?object_id=e12bd2cd-ebfc-4af7-ad6f-ebe6da398029&limit=10&offset=0
-

Example Responses

Status code: 200

-

OK

-
{
+
Example Responses
Status code: 200

+
OK

+
{
   "data" : {
     "limit" : 10,
     "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2",
@@ -910,55 +925,55 @@
     "total" : 1
   }
 }

-
Status code: 400

-
Bad Request

-
{
+
Status code: 400

+
Bad Request

+
{
   "error_code" : "CFW.0020016",
   "error_msg" : "instance status error"
 }

 

-
Status Codes

-
Status Code

+
Status Codes

+

-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

 
Description

+
Description

 		
 

 
200

+
200

 
OK

+
OK

 		
 
400

+
400

 
Bad Request

+
Bad Request

 		
 
401

+
401

 
Unauthorized

+
Unauthorized

 		
 
403

+
403

 
Forbidden

+
Forbidden

 		
 
404

+
404

 
Not Found

+
Not Found

 		
 
500

+
500

 
Internal Server Error

+
Internal Server Error

 		
 

 
 

 

 

-
Error Codes
See Error Codes.

+
Error Codes
See Error Codes.

 

 

 

diff --git a/docs/cfw/api-ref/ListAddressItems.html b/docs/cfw/api-ref/ListAddressItems.html
index a00e925c..dac8a36c 100644
--- a/docs/cfw/api-ref/ListAddressItems.html
+++ b/docs/cfw/api-ref/ListAddressItems.html
@@ -1,295 +1,295 @@
 
 
 
Querying Address Set Members

-
Function
This API is used to query address group members.

+
Function
This API is used to query address group members.

 

-
URI
GET /v1/{project_id}/address-items

+
URI
GET /v1/{project_id}/address-items

 
-
Table 1 Path Parameters
Parameter

+

-
-
-
-
-
-
-
Table 1 Path Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
project_id

+
project_id

 
Yes

+
Yes

 
String

+
String

 
Project ID

+
Project ID

 		
 

 
 

 

 
-
Table 2 Query Parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 2 Query Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
set_id

+
set_id

 
Yes

+
Yes

 
String

+
String

 
ID of the IP address group

+
ID of the IP address group

 		
 
key_word

+
key_word

 
No

+
No

 
String

+
String

 
Keyword

+
Keyword

 		
 
limit

+
limit

 
Yes

+
Yes

 
Integer

+
Integer

 
Number of records displayed on each page, in the range 1-1024

+
Number of records displayed on each page, in the range 1-1024

 		
 
offset

+
offset

 
Yes

+
Yes

 
Integer

+
Integer

 
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

+
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

 		
 
address

+
address

 
No

+
No

 
String

+
String

 
IP address

+
IP address

 		
 
enterprise_project_id

+
enterprise_project_id

 
No

+
No

 
String

+
String

 
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

+
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

 		
 
fw_instance_id

+
fw_instance_id

 
No

+
No

 
String

+
String

 
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

+
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

 		
 
query_address_set_type

+
query_address_set_type

 
No

+
No

 
Integer

+
Integer

 
Query address set type, 0 means custom define address set, 1 means predefined address set

+
Query address set type, 0 means custom define address set, 1 means predefined address set

 		
 

 
 

 

 
-
Request Parameters

-
Table 3 Request header parameters
Parameter

+
Request Parameters

+

-
-
-
-
-
-
-
Table 3 Request header parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
X-Auth-Token

+
X-Auth-Token

 
Yes

+
Yes

 
String

+
String

 
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

+
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

 		
 

 
 

 

 

-
Response Parameters
Status code: 200

+
Response Parameters
Status code: 200

 
-
Table 4 Response body parameters
Parameter

+

-
-
-
-
-
Table 4 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
data

+
data

 
data object

+
data object

 
Response for address group member query

+
Response for address group member query

 		
 

 
 

 

 
-
Table 5 data
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 5 data
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
offset

+
offset

 
Integer

+
Integer

 
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

+
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

 		
 
limit

+
limit

 
Integer

+
Integer

 
Number of records displayed on each page, in the range 1-1024

+
Number of records displayed on each page, in the range 1-1024

 		
 
total

+
total

 
Integer

+
Integer

 
Total

+
Total

 		
 
set_id

+
set_id

 
String

+
String

 
ID of the IP address group

+
ID of the IP address group

 		
 
records

+
records

 
Array of records objects

+
Array of records objects

 
Member information

+
Member information

 		
 

 
 

 

 
-
Table 6 records
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 6 records
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
item_id

+
item_id

 
String

+
String

 
ID of an address group member

+
ID of an address group member

 		
 
name

+
name

 
String

+
String

 
Name of an address group member

+
Name of an address group member

 		
 
description

+
description

 
String

+
String

 
Description

+
Description

 		
 
address_type

+
address_type

 
Integer

+
Integer

 
Address group type. The value can be 0 (IPv4) or 1 (IPv6).

+
Address group type. The value can be 0 (IPv4) or 1 (IPv6).

 		
 
address

+
address

 
String

+
String

 
Address group

+
Address group

 		
 

 
 

 

-
Status code: 400

+
Status code: 400

 
-

-
Table 7 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
Table 7 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code

-
Minimum: 8

-
Maximum: 36

+
Error code

+
Minimum: 8

+
Maximum: 36

 		
 
error_msg

+
error_msg

 
String

+
String

 
Description

-
Minimum: 2

-
Maximum: 512

+
Description

+
Minimum: 2

+
Maximum: 512

 		
 

 
 

 

 
-
Example Requests
Query members in address group 8773c082-2a6c-4529-939a-edc28ef1a67c of project 9d80d070b6d44942af73c9c3d38e0429.

-
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items?set_id=8773c082-2a6c-4529-939a-edc28ef1a67c&limit=10&offset=0

+
Example Requests
Query members in address group 8773c082-2a6c-4529-939a-edc28ef1a67c of project 9d80d070b6d44942af73c9c3d38e0429.

+
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items?set_id=8773c082-2a6c-4529-939a-edc28ef1a67c&limit=10&offset=0

 

-
Example Responses
Status code: 200

-
Return value for querying address group members

-
{
+
Example Responses
Status code: 200

+
Return value for querying address group members

+
{
   "data" : {
     "limit" : 10,
     "offset" : 0,
@@ -303,55 +303,55 @@
     "total" : 1
   }
 }

-
Status code: 400

-
Bad Request

-
{
+
Status code: 400

+
Bad Request

+
{
   "error_code" : "CFW.00200005",
   "error_msg" : "operation content does not exist"
 }

 

-
Status Codes

-

-
+
+
+
+
+
Status Code

+
Status Codes

+

-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

 
Description

+
Description

 		
 

 
200

+
200

 
Return value for querying address group members

+
Return value for querying address group members

 		
 
400

+
400

 
Bad Request

+
Bad Request

 		
 
401

+
401

 
Unauthorized

+
Unauthorized

 		
 
403

+
403

 
Forbidden

+
Forbidden

 		
 
404

+
404

 
Not Found

+
Not Found

 		
 
500

+
500

 
Internal Server Error

+
Internal Server Error

 		
 

 
 

 

 

-
Error Codes
See Error Codes.

+
Error Codes
See Error Codes.

 

 

 

diff --git a/docs/cfw/api-ref/ListAddressSets.html b/docs/cfw/api-ref/ListAddressSets.html
index f1bab9b7..fabfd61e 100644
--- a/docs/cfw/api-ref/ListAddressSets.html
+++ b/docs/cfw/api-ref/ListAddressSets.html
@@ -44,7 +44,7 @@
 
 
String

 
Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

+
Internet border Protected object ID, You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border.

 		
 

 
key_word

@@ -123,6 +123,15 @@
 
Query address set type, 0 indicates a custom address set and 1 indicates a predefined address set

 		
 
address_set_type

+
No

+
Integer

+
Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set.

+

 
 

 

@@ -259,7 +268,7 @@
 
 
String

 
Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

+
Internet border Protected object ID, You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border.

 		
 

 
address_set_type

diff --git a/docs/cfw/api-ref/ListAttackLogs.html b/docs/cfw/api-ref/ListAttackLogs.html
index 1ba77b69..6ce20bca 100644
--- a/docs/cfw/api-ref/ListAttackLogs.html
+++ b/docs/cfw/api-ref/ListAttackLogs.html
@@ -1,698 +1,702 @@
 
 
 
Querying Attack Logs

-
Function
This API is used to query attack logs.

+
Function
This API is used to query attack logs.

 

-
URI
GET /v1/{project_id}/cfw/logs/attack

+
URI
GET /v1/{project_id}/cfw/logs/attack

 
-
Table 1 Path Parameters
Parameter

+

-
-
-
-
-
-
-
Table 1 Path Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
project_id

+
project_id

 
Yes

+
Yes

 
String

+
String

 
Project ID

+
Project ID

 		
 

 
 

 

 
-
Table 2 Query Parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 2 Query Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
start_time

+
start_time

 
Yes

+
Yes

 
Long

+
Long

 
Start time

+
Start time, a timestamp in milliseconds, such as 1718936272648

 		
 
end_time

+
end_time

 
Yes

+
Yes

 
Long

+
Long

 
End time

+
End time, a timestamp in milliseconds, such as 1718936272648

 		
 
src_ip

+
src_ip

 
No

+
No

 
String

+
String

 
Source IP address

+
Source IP address

 		
 
src_port

+
src_port

 
No

+
No

 
Integer

+
Integer

 
Source port number

-
Minimum: 0

-
Maximum: 65535

+
Source port number

+
Minimum: 0

+
Maximum: 65535

 		
 
dst_ip

+
dst_ip

 
No

+
No

 
String

+
String

 
Destination IP address

+
Destination IP address

 		
 
dst_port

+
dst_port

 
No

+
No

 
Integer

+
Integer

 
Destination port number

-
Minimum: 0

-
Maximum: 65535

+
Destination port number

+
Minimum: 0

+
Maximum: 65535

 		
 
protocol

+
protocol

 
No

+
No

 
String

+
String

 
Protocol types, including TCP, UDP, ICMP, ICMPV6, etc.

+
Protocol types, including TCP, UDP, ICMP, ICMPV6, etc.

 		
 
app

+
app

 
No

+
No

 
String

+
String

 
Application protocol

+
Application protocol

 		
 
log_id

+
log_id

 
No

+
No

 
String

+
String

 
Document ID, the first page is empty, the other pages are not empty, and the other pages can take the log_id of the last query record.

+
Document ID, the first page is empty, the other pages are not empty, and the other pages can take the log_id of the last query record.

 		
 
next_date

+
next_date

 
No

+
No

 
Long

+
Long

 
The next date is empty when it is the first page, not empty when it is not the first page, and the other pages can take the start_time of the last query record.

+
The next date is empty when it is the first page, not empty when it is not the first page, and the other pages can take the start_time of the last query record.

 		
 
offset

+
offset

 
No

+
No

 
Integer

+
Integer

 
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The first page is empty, and the non-first page is not empty.

+
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The first page is empty, and the non-first page is not empty.

 		
 
limit

+
limit

 
Yes

+
Yes

 
Integer

+
Integer

 
Number of records displayed on each page, in the range 1-1024

+
Number of records displayed on each page, in the range 1-1024

 		
 
fw_instance_id

+
fw_instance_id

 
Yes

+
Yes

 
String

+
String

 
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.

+
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.

 		
 
action

+
action

 
No

+
No

 
String

+
String

 
Action. including allow and deny

+
Action. including allow and deny

 		
 
direction

+
direction

 
No

+
No

 
String

+
String

 
Direction. including in2out and out2in

+
Direction. including in2out and out2in

 		
 
attack_type

+
attack_type

 
No

+
No

 
String

+
String

 
Intrusion event type

+
Intrusion event type

 		
 
attack_rule

+
attack_rule

 
No

+
No

 
String

+
String

 
Intrusion event rule

+
Intrusion event rule, Including CRITICAL,HIGH,MEDIUM,LOW.

 		
 
level

+
level

 
No

+
No

 
String

+
String

 
Threat level

-
  • CRITICAL
  • HIGH
  • MEDIUM
  • LOW

+
Threat level

 		
 
source

+
source

 
No

+
No

 
String

+
String

 
Source

+
Source

 		
 
enterprise_project_id

+
enterprise_project_id

 
No

+
No

 
String

+
String

 
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

+
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

 		
 
dst_host

+
dst_host

 
No

+
No

 
String

+
String

 
destination host

+
destination host

 		
 
log_type

+
log_type

 
No

+
No

 
String

+
String

 
log_type

-
Enumeration values:

-
  • internet
  • nat
  • vpc

+
log_type

+
Enumeration values:

+
  • internet
    
+
  • nat
    
+
  • vpc
    
+

 		
 
attack_rule_id

+
attack_rule_id

 
No

+
No

 
String

+
String

 
attack rule id

+
attack rule id

 		
 
src_region_name

+
src_region_name

 
No

+
No

 
String

+
String

 
source region name

+
source region name

 		
 
dst_region_name

+
dst_region_name

 
No

+
No

 
String

+
String

 
destination region name

+
destination region name

 		
 
src_province_name

+
src_province_name

 
No

+
No

 
String

+
String

 
source province name

+
source province name

 		
 
dst_province_name

+
dst_province_name

 
No

+
No

 
String

+
String

 
dst province name

+
dst province name

 		
 
src_city_name

+
src_city_name

 
No

+
No

 
String

+
String

 
source city name

+
source city name

 		
 
dst_city_name

+
dst_city_name

 
No

+
No

 
String

+
String

 
dst city name

+
dst city name

 		
 

 
 

 

 
-
Request Parameters

-
Table 3 Request header parameters
Parameter

+
Request Parameters

+

-
-
-
-
-
-
-
Table 3 Request header parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
X-Auth-Token

+
X-Auth-Token

 
Yes

+
Yes

 
String

+
String

 
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

+
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

 		
 

 
 

 

 

-
Response Parameters
Status code: 200

+
Response Parameters
Status code: 200

 
-
Table 4 Response body parameters
Parameter

+

-
-
-
-
-
Table 4 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
data

+
data

 
data object

+
data object

 
Return value of attack log query

+
Return value of attack log query

 		
 

 
 

 

 
-
Table 5 data
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
Table 5 data
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
total

+
total

 
Integer

+
Integer

 
Returned quantity

+
Returned quantity

 		
 
limit

+
limit

 
Integer

+
Integer

 
Number of records displayed on each page, in the range 1-1024

+
Number of records displayed on each page, in the range 1-1024

 		
 
records

+
records

 
Array of records objects

+
Array of records objects

 
Record

+
Record

 		
 

 
 

 

 
-
Table 6 records
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 6 records
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
direction

+
direction

 
String

+
String

 
Direction, which can be inbound or outbound

-
Enumeration values:

-
  • out2in
  • in2out

+
Direction, which can be inbound or outbound

+
Enumeration values:

+
  • out2in
    
+
  • in2out
    
+

 		
 
action

+
action

 
String

+
String

 
Action

+
Action

 		
 
event_time

+
event_time

 
Long

+
Long

 
Event time

+
Event time, a timestamp in milliseconds, such as 1718936272648

 		
 
attack_type

+
attack_type

 
String

+
String

 
Attack type

+
Attack type

 		
 
attack_rule

+
attack_rule

 
String

+
String

 
Attack rule

+
Attack rule

 		
 
level

+
level

 
String

+
String

 
Threat level

+
Threat level

 		
 
source

+
source

 
String

+
String

 
Source

+
Source

 		
 
packet_length

+
packet_length

 
Long

+
Long

 
Packet length

+
Packet length

 		
 
attack_rule_id

+
attack_rule_id

 
String

+
String

 
Attack rule ID

+
Attack rule ID

 		
 
hit_time

+
hit_time

 
Integer

+
Integer

 
Hit time

+
Hit time, a timestamp in milliseconds, such as 1718936272648

 		
 
log_id

+
log_id

 
String

+
String

 
Log ID

+
Log ID

 		
 
src_ip

+
src_ip

 
String

+
String

 
Source IP address

+
Source IP address

 		
 
src_port

+
src_port

 
Integer

+
Integer

 
Source port

-
Minimum: 0

-
Maximum: 65535

+
Source port

+
Minimum: 0

+
Maximum: 65535

 		
 
dst_ip

+
dst_ip

 
String

+
String

 
Destination IP address

+
Destination IP address

 		
 
dst_port

+
dst_port

 
Integer

+
Integer

 
Destination port

-
Minimum: 0

-
Maximum: 65535

+
Destination port

+
Minimum: 0

+
Maximum: 65535

 		
 
protocol

+
protocol

 
String

+
String

 
Protocol

+
Protocol

 		
 
packet

+
packet

 
String

+
String

 
Attack log packet

+
Attack log packet

 		
 
app

+
app

 
String

+
String

 
Application protocol

+
Application protocol

 		
 
packetMessages

+
packetMessages

 
Array of PacketMessage objects

+
Array of PacketMessage objects

 
packet message

+
packet message

 		
 
src_region_id

+
src_region_id

 
String

+
String

 
source region id

+
source region id

 		
 
src_region_name

+
src_region_name

 
String

+
String

 
source region name

+
source region name

 		
 
dst_region_id

+
dst_region_id

 
String

+
String

 
destination region id

+
destination region id

 		
 
dst_region_name

+
dst_region_name

 
String

+
String

 
destination region name

+
destination region name

 		
 
src_province_id

+
src_province_id

 
String

+
String

 
source province id

+
source province id

 		
 
src_province_name

+
src_province_name

 
String

+
String

 
source province name

+
source province name

 		
 
src_city_id

+
src_city_id

 
String

+
String

 
source city id

+
source city id

 		
 
src_city_name

+
src_city_name

 
String

+
String

 
source city name

+
source city name

 		
 
dst_province_id

+
dst_province_id

 
String

+
String

 
dst province id

+
dst province id

 		
 
dst_province_name

+
dst_province_name

 
String

+
String

 
dst province name

+
dst province name

 		
 
dst_city_id

+
dst_city_id

 
String

+
String

 
dst city id

+
dst city id

 		
 
dst_city_name

+
dst_city_name

 
String

+
String

 
dst city name

+
dst city name

 		
 

 
 

 

 
-
Table 7 PacketMessage
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
Table 7 PacketMessage
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
hex_index

+
hex_index

 
String

+
String

 
hex index

+
hex index

 		
 
hexs

+
hexs

 
Array of strings

+
Array of strings

 
hexs

+
hexs

 		
 
utf8_String

+
utf8_String

 
String

+
String

 
utf8 string

+
utf8 string

 		
 

 
 

 

-
Status code: 400

+
Status code: 400

 
-
Table 8 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
Table 8 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code

-
Minimum: 8

-
Maximum: 36

+
Error code

+
Minimum: 8

+
Maximum: 36

 		
 
error_msg

+
error_msg

 
String

+
String

 
Description

-
Minimum: 2

-
Maximum: 512

+
Description

+
Minimum: 2

+
Maximum: 512

 		
 

 
 

 

 
-
Example Requests
Query 10 records on the first page of the firewall with the ID 2af58b7c-893c-4453-a984-bdd9b1bd6318 in the project 9d80d070b6d44942af73c9c3d38e0429. The query time range is 1663567058000 to 1664171765000.

-
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/cfw/logs/attack?fw_instance_id=2af58b7c-893c-4453-a984-bdd9b1bd6318&start_time=1663567058000&end_time=1664171765000&limit=10

+
Example Requests
Query 10 records on the first page of the firewall with the ID 2af58b7c-893c-4453-a984-bdd9b1bd6318 in the project 9d80d070b6d44942af73c9c3d38e0429. The query time range is 1663567058000 to 1664171765000.

+
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/cfw/logs/attack?fw_instance_id=2af58b7c-893c-4453-a984-bdd9b1bd6318&start_time=1663567058000&end_time=1664171765000&limit=10

 

-
Example Responses
Status code: 200

-
OK

-
{
+
Example Responses
Status code: 200

+
OK

+
{
   "data" : {
     "limit" : 10,
     "records" : [ {
@@ -758,55 +762,55 @@
     "total" : 1
   }
 }

-
Status code: 400

-
Bad Request

-
{
+
Status code: 400

+
Bad Request

+
{
   "error_code" : "00500002",
   "error_msg" : "time range error"
 }

 

-
Status Codes

-

-
-
-
Status Code

+
Status Codes

+

-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

 
Description

+
Description

 		
 

 
200

+
200

 
OK

+
OK

 		
 
400

+
400

 
Bad Request

+
Bad Request

 		
 
401

+
401

 
Unauthorized

+
Unauthorized

 		
 
403

+
403

 
Forbidden

+
Forbidden

 		
 
404

+
404

 
Not Found

+
Not Found

 		
 
500

+
500

 
Internal Server Error

+
Internal Server Error

 		
 

 
 

 

 

-
Error Codes
See Error Codes.

+
Error Codes
See Error Codes.

 

 

 

diff --git a/docs/cfw/api-ref/ListBlackWhiteLists.html b/docs/cfw/api-ref/ListBlackWhiteLists.html
index 8c6de449..cce78873 100644
--- a/docs/cfw/api-ref/ListBlackWhiteLists.html
+++ b/docs/cfw/api-ref/ListBlackWhiteLists.html
@@ -44,7 +44,7 @@
 
 
String

 
Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

+
Internet border Protected object ID, You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border.

 		
 

 
list_type

@@ -66,7 +66,7 @@
 		
 
Integer

 
Specifies the IP address type. The value can be 0 (IPv4), 1 (IPv6), or 2 (domain).

+
Specifies the IP address type. The value can be 0 (IPv4), 1 (IPv6).

 
Enumeration values:

 
  • 0
    
 
  • 1
    
@@ -243,7 +243,7 @@
 

 
Integer

 
IP address type. 0: ipv4; 1: ipv6; 2: domain

+
IP address type. 0: ipv4; 1: ipv6

 		
 

 
address

diff --git a/docs/cfw/api-ref/ListDnsServers.html b/docs/cfw/api-ref/ListDnsServers.html
index 8d116a34..2b1bdb2b 100644
--- a/docs/cfw/api-ref/ListDnsServers.html
+++ b/docs/cfw/api-ref/ListDnsServers.html
@@ -1,188 +1,188 @@
 
 
 
Querying the DNS Server List

-
Function
This API is used to query the DNS server list.

+
Function
This API is used to query the DNS server list.

 

-
URI
GET /v1/{project_id}/dns/servers

+
URI
GET /v1/{project_id}/dns/servers

 
-
Table 1 Path Parameters
Parameter

+

-
-
-
-
-
-
-
Table 1 Path Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
project_id

+
project_id

 
Yes

+
Yes

 
String

+
String

 
Project ID

+
Project ID

 		
 

 
 

 

 
-
Table 2 Query Parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 2 Query Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
limit

+
limit

 
No

+
No

 
Integer

+
Integer

 
Number of records displayed on each page, in the range 1-1024

+
Number of records displayed on each page, in the range 1-1024

 		
 
offset

+
offset

 
No

+
No

 
Integer

+
Integer

 
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

+
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

 		
 
fw_instance_id

+
fw_instance_id

 
No

+
No

 
String

+
String

 
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

+
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

 		
 
enterprise_project_id

+
enterprise_project_id

 
No

+
No

 
String

+
String

 
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

+
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

 		
 

 
 

 

 
-
Request Parameters

-
Table 3 Request header parameters
Parameter

+
Request Parameters

+

-
-
-
-
-
-
-
Table 3 Request header parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
X-Auth-Token

+
X-Auth-Token

 
Yes

+
Yes

 
String

+
String

 
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

+
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

 		
 

 
 

 

 

-
Response Parameters
Status code: 200

+
Response Parameters
Status code: 200

 
-
Table 4 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
Table 4 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
data

+
data

 
Array of DnsServersResponseDTO objects

+
Array of DnsServersResponseDTO objects

 
dns server list

+
dns server list

 		
 
total

+
total

 
Integer

+
Integer

 
dns server total

+
dns server total

 		
 

 
 

 

 
-
Table 5 DnsServersResponseDTO
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 5 DnsServersResponseDTO
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
id

+
id

 
Integer

+
Integer

 
id

+
id

 		
 
is_applied

+
is_applied

 
Integer

+
Integer

 
Indicates whether to apply. 0: no; 1: yes

+
Indicates whether to apply. 0: no; 1: yes

 		
 
is_customized

+
is_customized

 
Integer

+
Integer

 
Indicates whether the DNS server is user-defined. 0: no; 1: yes

+
Indicates whether the DNS server is user-defined. 0: no; 1: yes

 		
 
server_ip

+
server_ip

 
String

+
String

 
DNS server IP address

+
DNS server IP address

 		
 
health_check_domain_name

+
health_check_domain_name

 
String

+
String

 
health check domain name

+
health check domain name

 		
 

 
 

 

 
-
Example Requests
Obtain the DNS server list of the project whose ID is 2349ba469daf4b7daf268bb0261d18b0.

-
https://console.xxxxxx.com/cfw/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers

+
Example Requests
Obtain the DNS server list of the project whose ID is 2349ba469daf4b7daf268bb0261d18b0.

+
https://console.example.com/cfw/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers

 

-
Example Responses
Status code: 200

-
Response to the request for obtaining DNS servers

-
{
+
Example Responses
Status code: 200

+
Response to the request for obtaining DNS servers

+
{
   "data" : {
     "data" : [ {
       "health_check_domain_name" : "sslstatic.xiaoyusan.com",
@@ -201,43 +201,43 @@
   "total" : 2
 }

 

-
Status Codes

-

-
-
diff --git a/docs/cfw/api-ref/ListEipCount.html b/docs/cfw/api-ref/ListEipCount.html
index 85e16fab..5261af77 100644
--- a/docs/cfw/api-ref/ListEipCount.html
+++ b/docs/cfw/api-ref/ListEipCount.html
@@ -205,7 +205,7 @@
     "eip_protected" : 1,
     "eip_protected_self" : 4,
     "eip_total" : 5,
-    "object_id" : "6d3db4fd-fd58-4d8e-914b-ef91aa268f62"
+    "object_id" : ""
   }
 }
Status code: 400

diff --git a/docs/cfw/api-ref/ListFlowLogs.html b/docs/cfw/api-ref/ListFlowLogs.html
index c75bd293..dd67d7e0 100644
--- a/docs/cfw/api-ref/ListFlowLogs.html
+++ b/docs/cfw/api-ref/ListFlowLogs.html
@@ -76,7 +76,7 @@
 
-
-
-
-
-
-
-
-
-
diff --git a/docs/cfw/api-ref/ListRuleAclTags.html b/docs/cfw/api-ref/ListRuleAclTags.html
index 8e9fb9ad..39635b24 100644
--- a/docs/cfw/api-ref/ListRuleAclTags.html
+++ b/docs/cfw/api-ref/ListRuleAclTags.html
@@ -199,6 +199,7 @@
 
https://{Endpoint}/v2/14181c1245cf4fd786824efe1e2b9388/cfw-acl/tags?limit=1000&offset=0&fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default
Example Responses
Status code: 200

+
Get acl tag response

 
{
   "data" : {
     "limit" : 1000,
@@ -229,7 +230,8 @@
 
 

-
+
Status Code

+
Status Codes

+

-
-
-
-
-
-
-
-
-
-
-
Status Code

 
Description

+
Description

 		
 

 
200

+
200

 
Response to the request for obtaining DNS servers

+
Response to the request for obtaining DNS servers

 		
 
401

+
401

 
Unauthorized

+
Unauthorized

 		
 
403

+
403

 
Forbidden

+
Forbidden

 		
 
404

+
404

 
Not Found

+
Not Found

 		
 
500

+
500

 
Internal Server Error

+
Internal Server Error

 		
 

 
 

 

 

-
Error Codes
See Error Codes.

+
Error Codes
See Error Codes.

 

 

 

diff --git a/docs/cfw/api-ref/ListDomainSets.html b/docs/cfw/api-ref/ListDomainSets.html
index d1506681..c1bf1e5b 100644
--- a/docs/cfw/api-ref/ListDomainSets.html
+++ b/docs/cfw/api-ref/ListDomainSets.html
@@ -80,7 +80,7 @@
 
 
String

 
Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

+
Internet border Protected object ID, You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border.

 		
 

 
key_word

diff --git a/docs/cfw/api-ref/ListDomains.html b/docs/cfw/api-ref/ListDomains.html
index d80f5cc3..34bd6613 100644
--- a/docs/cfw/api-ref/ListDomains.html
+++ b/docs/cfw/api-ref/ListDomains.html
@@ -98,7 +98,7 @@
 		
 
String

 
Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

+
Internet border Protected object ID, You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border.

 		
 

 
 
 
Long

 
Start time

+
Start time, a timestamp in milliseconds, such as 1718936272648

 		
 

 
end_time

@@ -85,7 +85,7 @@
 		
 
Long

 
End time

+
End time, a timestamp in milliseconds, such as 1718936272648

 		
 

 
src_ip

@@ -375,14 +375,14 @@
 		
 
Long

 
Start time

+
Start time, a timestamp in milliseconds, such as 1718936272648

 		
 

 
end_time

 		
 
Long

 
End time

+
End time, a timestamp in milliseconds, such as 1718936272648

 		
 

 
log_id

diff --git a/docs/cfw/api-ref/ListProtectedVpcs.html b/docs/cfw/api-ref/ListProtectedVpcs.html
index 13d3c34d..f3057fca 100644
--- a/docs/cfw/api-ref/ListProtectedVpcs.html
+++ b/docs/cfw/api-ref/ListProtectedVpcs.html
@@ -103,14 +103,7 @@
 
 

 
trace_id

-
String

-
Call chain ID

-
data

+
data

 		
 
VPCProtectsVo object

 		
 
 
200

 		 
Get acl tag response

+		
 

 
 

diff --git a/docs/cfw/api-ref/ListServiceItems.html b/docs/cfw/api-ref/ListServiceItems.html
index f97bc739..2613a858 100644
--- a/docs/cfw/api-ref/ListServiceItems.html
+++ b/docs/cfw/api-ref/ListServiceItems.html
@@ -1,293 +1,286 @@
 
 
 
Querying the Service Set Member List

-
Function
This API is used to query service group members.

+
Function
This API is used to query service group members.

 

-
URI
GET /v1/{project_id}/service-items

+
URI
GET /v1/{project_id}/service-items

 
-
Table 1 Path Parameters
Parameter

+

-
-
-
-
-
-
-
Table 1 Path Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
project_id

+
project_id

 
Yes

+
Yes

 
String

+
String

 
Project ID

+
Project ID

 		
 

 
 

 

 
-
Table 2 Query Parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 2 Query Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
set_id

+
set_id

 
Yes

+
Yes

 
String

+
String

 
Service group ID

+
Service group ID

 		
 
key_word

+
key_word

 
No

+
No

 
String

+
String

 
Query field

+
Query field

 		
 
limit

+
limit

 
Yes

+
Yes

 
Integer

+
Integer

 
Number of records displayed on each page, in the range 1-1024

+
Number of records displayed on each page, in the range 1-1024

 		
 
offset

+
offset

 
Yes

+
Yes

 
Integer

+
Integer

 
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

+
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

 		
 
enterprise_project_id

+
enterprise_project_id

 
No

+
No

 
String

+
String

 
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

+
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

 		
 
fw_instance_id

+
fw_instance_id

 
No

+
No

 
String

+
String

 
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

+
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

 		
 
query_service_set_type

+
query_service_set_type

 
No

+
No

 
Integer

+
Integer

 
Query service set type, 0 means custom define service set, 1 means predefine service set.

+
Query service set type, 0 means custom define service set, 1 means predefine service set, Takes effect only if the set_id is a predefined service set ID

 		
 

 
 

 

 
-
Request Parameters

-
Table 3 Request header parameters
Parameter

+
Request Parameters

+

-
-
-
-
-
-
-
Table 3 Request header parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
X-Auth-Token

+
X-Auth-Token

 
Yes

+
Yes

 
String

+
String

 
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

+
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

 		
 

 
 

 

 

-
Response Parameters
Status code: 200

+
Response Parameters
Status code: 200

 
-
Table 4 Response body parameters
Parameter

+

-
-
-
-
-
Table 4 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
data

+
data

 
data object

+
data object

 
Service group member list

+
Service group member list

 		
 

 
 

 

 
-
Table 5 data
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 5 data
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
offset

+
offset

 
Integer

+
Integer

 
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

+
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

 		
 
limit

+
limit

 
Integer

+
Integer

 
Number of records displayed on each page, in the range 1-1024

+
Number of records displayed on each page, in the range 1-1024

 		
 
total

+
total

 
Integer

+
Integer

 
Total number of records

+
Total number of records

 		
 
set_id

+
set_id

 
String

+
String

 
service set id

+
service set id

 		
 
records

+
records

 
Array of records objects

+
Array of records objects

 
Record

+
Record

 		
 

 
 

 

 
-
Table 6 records
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 6 records
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
item_id

+
item_id

 
String

+
String

 
Service member ID

+
Service member ID

 		
 
protocol

+
protocol

 
Integer

+
Integer

 
Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.

+
Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.

 		
 
source_port

+
source_port

 
String

+
String

 
Source port

+
Source port

 		
 
dest_port

+
dest_port

 
String

+
String

 
Destination port

+
Destination port

 		
 
name

+
description

 
String

+
String

 
Service member name

-
description

-
String

-
Service member description

+
Service member description

 		
 

 
 

 

-
Status code: 400

+
Status code: 400

 
-
Table 7 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
Table 7 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code

-
Minimum: 8

-
Maximum: 36

+
Error code

+
Minimum: 8

+
Maximum: 36

 		
 
error_msg

+
error_msg

 
String

+
String

 
Description

-
Minimum: 2

-
Maximum: 512

+
Description

+
Minimum: 2

+
Maximum: 512

 		
 

 
 

 

 
-
Example Requests
Query the member list of the service group whose project ID is 9d80d070b6d44942af73c9c3d38e0429 and service group ID is 7cdebed3-af07-494e-a3c2-b88bb8d58b57.

-
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items?set_id=7cdebed3-af07-494e-a3c2-b88bb8d58b57&limit=10&offset=0

+
Example Requests
Query the member list of the service group whose project ID is 9d80d070b6d44942af73c9c3d38e0429 and service group ID is 7cdebed3-af07-494e-a3c2-b88bb8d58b57.

+
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items?set_id=7cdebed3-af07-494e-a3c2-b88bb8d58b57&limit=10&offset=0

 

-
Example Responses
Status code: 200

-
Return value of the service group member list

-
{
+
Example Responses
Status code: 200

+
Return value of the service group member list

+
{
   "data" : {
     "limit" : 10,
     "offset" : 0,
@@ -302,55 +295,55 @@
     "total" : 1
   }
 }

-
Status code: 400

-
Bad Request

-
{
+
Status code: 400

+
Bad Request

+
{
   "error_code" : "CFW.00200005",
   "error_msg" : "operation content does not exist"
 }

 

-
Status Codes

-
Status Code

+
Status Codes

+

-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

 
Description

+
Description

 		
 

 
200

+
200

 
Return value of the service group member list

+
Return value of the service group member list

 		
 
400

+
400

 
Bad Request

+
Bad Request

 		
 
401

+
401

 
Unauthorized

+
Unauthorized

 		
 
403

+
403

 
Forbidden

+
Forbidden

 		
 
404

+
404

 
Not Found

+
Not Found

 		
 
500

+
500

 
Internal Server Error

+
Internal Server Error

 		
 

 
 

 

 

-
Error Codes
See Error Codes.

+
Error Codes
See Error Codes.

 

 

 

diff --git a/docs/cfw/api-ref/ListServiceSetDetail.html b/docs/cfw/api-ref/ListServiceSetDetail.html
index 2eaf1fc3..1b897727 100644
--- a/docs/cfw/api-ref/ListServiceSetDetail.html
+++ b/docs/cfw/api-ref/ListServiceSetDetail.html
@@ -1,264 +1,264 @@
 
 
 
Querying Service Set Details

-
Function
This API is used to query the details about a service group.

+
Function
This API is used to query the details about a service group.

 

-
URI
GET /v1/{project_id}/service-sets/{set_id}

+
URI
GET /v1/{project_id}/service-sets/{set_id}

 
-
Table 1 Path Parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
Table 1 Path Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
project_id

+
project_id

 
Yes

+
Yes

 
String

+
String

 
Project ID

+
Project ID

 		
 
set_id

+
set_id

 
Yes

+
Yes

 
String

+
String

 
Service group ID

+
Service group ID

 		
 

 
 

 

 
-
Table 2 Query Parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 2 Query Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
enterprise_project_id

+
enterprise_project_id

 
No

+
No

 
String

+
String

 
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

+
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

 		
 
fw_instance_id

+
fw_instance_id

 
No

+
No

 
String

+
String

 
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

+
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

 		
 
query_service_set_type

+
query_service_set_type

 
No

+
No

 
Integer

+
Integer

 
Query service set type, 0 means custom define service set, 1 means predefine service set.

+
Query service set type, 0 means custom define service set, 1 means predefine service set.

 		
 

 
 

 

 
-
Request Parameters

-
Table 3 Request header parameters
Parameter

+
Request Parameters

+

-
-
-
-
-
-
-
Table 3 Request header parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
X-Auth-Token

+
X-Auth-Token

 
Yes

+
Yes

 
String

+
String

 
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

+
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

 		
 

 
 

 

 

-
Response Parameters
Status code: 200

+
Response Parameters
Status code: 200

 
-
Table 4 Response body parameters
Parameter

+

-
-
-
-
-
Table 4 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
data

+
data

 
ServiceSetDetailResponseDto object

+
ServiceSetDetailResponseDto object

 
service set detail response

+
service set detail response

 		
 

 
 

 

 
-
Table 5 ServiceSetDetailResponseDto
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 5 ServiceSetDetailResponseDto
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
id

+
id

 
String

+
String

 
Service group ID

+
Service group ID

 		
 
name

+
name

 
String

+
String

 
Service group name

-
Minimum: 1

-
Maximum: 255

+
Service group name

+
Minimum: 1

+
Maximum: 255

 		
 
description

+
description

 
String

+
String

 
Service group description

-
Minimum: 1

-
Maximum: 255

+
Service group description

+
Minimum: 1

+
Maximum: 255

 		
 
service_set_type

+
service_set_type

 
Integer

+
Integer

 
Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases

+
Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases

 		
 

 
 

 

-
Status code: 400

+
Status code: 400

 
-
Table 6 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
Table 6 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code

-
Minimum: 8

-
Maximum: 36

+
Error code

+
Minimum: 8

+
Maximum: 36

 		
 
error_msg

+
error_msg

 
String

+
String

 
Description

-
Minimum: 2

-
Maximum: 512

+
Description

+
Minimum: 2

+
Maximum: 512

 		
 

 
 

 

 
-
Example Requests
Query details about the service group whose project ID is 9d80d070b6d44942af73c9c3d38e0429 and service group ID is 221cfdca-3abf-4c30-ab0d-516a03c70866.

-
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-sets/221cfdca-3abf-4c30-ab0d-516a03c70866

+
Example Requests
Query details about the service group whose project ID is 9d80d070b6d44942af73c9c3d38e0429 and service group ID is 221cfdca-3abf-4c30-ab0d-516a03c70866.

+
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-sets/221cfdca-3abf-4c30-ab0d-516a03c70866

 

-
Example Responses
Status code: 200

-
Response to the request for querying details about a service group member

-
{
+
Example Responses
Status code: 200

+
Response to the request for querying details about a service group member

+
{
   "data" : {
     "service_set_type" : 0,
     "id" : "221cfdca-3abf-4c30-ab0d-516a03c70866",
     "name" : "ceshi2"
   }
 }

-
Status code: 400

-
Bad Request

-
{
+
Status code: 400

+
Bad Request

+
{
   "error_code" : "CFW.00200005",
   "error_msg" : "operation content does not exist"
 }

 

-
Status Codes

-
Status Code

+
Status Codes

+

-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

 
Description

+
Description

 		
 

 
200

+
200

 
Response to the request for querying details about a service group member

+
Response to the request for querying details about a service group member

 		
 
400

+
400

 
Bad Request

+
Bad Request

 		
 
401

+
401

 
Unauthorized

+
Unauthorized

 		
 
403

+
403

 
Forbidden

+
Forbidden

 		
 
404

+
404

 
Not Found

+
Not Found

 		
 
500

+
500

 
Internal Server Error

+
Internal Server Error

 		
 

 
 

 

 

-
Error Codes
See Error Codes.

+
Error Codes
See Error Codes.

 

 

 

diff --git a/docs/cfw/api-ref/ListServiceSets.html b/docs/cfw/api-ref/ListServiceSets.html
index a7197095..ce3c9209 100644
--- a/docs/cfw/api-ref/ListServiceSets.html
+++ b/docs/cfw/api-ref/ListServiceSets.html
@@ -1,303 +1,296 @@
 
 
 
Obtaining the Service Set List

-
Function
This API is used to obtain the service group list.

+
Function
This API is used to obtain the service group list.

 

-
URI
GET /v1/{project_id}/service-sets

+
URI
GET /v1/{project_id}/service-sets

 
-
Table 1 Path Parameters
Parameter

+

-
-
-
-
-
-
-
Table 1 Path Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
project_id

+
project_id

 
Yes

+
Yes

 
String

+
String

 
Project ID

+
Project ID

 		
 

 
 

 

 
-
Table 2 Query Parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 2 Query Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
object_id

+
object_id

 
Yes

+
Yes

 
String

+
String

 
Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

+
Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

 		
 
key_word

+
key_word

 
No

+
No

 
String

+
String

 
Keyword

+
Keyword

 		
 
limit

+
limit

 
Yes

+
Yes

 
Integer

+
Integer

 
Number of queries on each page, in the range 1-1024

-
Minimum: 1

-
Maximum: 1024

+
Number of queries on each page, in the range 1-1024

+
Minimum: 1

+
Maximum: 1024

 		
 
offset

+
offset

 
Yes

+
Yes

 
Integer

+
Integer

 
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

-
Minimum: 0

+
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

+
Minimum: 0

 		
 
enterprise_project_id

+
enterprise_project_id

 
No

+
No

 
String

+
String

 
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

+
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

 		
 
fw_instance_id

+
fw_instance_id

 
No

+
No

 
String

+
String

 
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

+
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

 		
 
query_service_set_type

+
query_service_set_type

 
No

+
No

 
Integer

+
Integer

 
Query service set type, 0 means custom define service set, 1 means predefine service set.

+
Query service set type, 0 means custom define service set, 1 means predefine service set.

 		
 

 
 

 

 
-
Request Parameters

-
Table 3 Request header parameters
Parameter

+
Request Parameters

+

-
-
-
-
-
-
-
Table 3 Request header parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
X-Auth-Token

+
X-Auth-Token

 
Yes

+
Yes

 
String

+
String

 
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

+
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

 		
 

 
 

 

 

-
Response Parameters
Status code: 200

+
Response Parameters
Status code: 200

 
-
Table 4 Response body parameters
Parameter

+

-
-
-
-
-
Table 4 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
data

+
data

 
ServiceSetRecords object

+
ServiceSetRecords object

 
QueryServiceSetResponse

+
QueryServiceSetResponse

 		
 

 
 

 

 
-
Table 5 ServiceSetRecords
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 5 ServiceSetRecords
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
offset

+
offset

 
Integer

+
Integer

 
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

+
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

 		
 
limit

+
limit

 
Integer

+
Integer

 
Number of records displayed on each page, in the range 1-1024

+
Number of records displayed on each page, in the range 1-1024

 		
 
total

+
total

 
Integer

+
Integer

 
Total number of records queried

+
Total number of records queried

 		
 
records

+
records

 
Array of ServiceSet objects

+
Array of ServiceSet objects

 
Service group list

+
Service group list

 		
 

 
 

 

 
-
Table 6 ServiceSet
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 6 ServiceSet
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
set_id

+
set_id

 
String

+
String

 
Service group ID

+
Service group ID

 		
 
name

+
name

 
String

+
String

 
Name

+
Name

 		
 
description

+
description

 
String

+
String

 
Description

+
Description

 		
 
service_set_type

+
service_set_type

 
Integer

+
Integer

 
Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases

+
Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases

 		
 
ref_count

+
ref_count

 
Integer

+
Integer

 
Reference count

+
Reference count

 		
 
status

+
project_id

 
String

+
String

 
Status

+
Project ID

 		
 
project_id

+
protocols

 
String

+
Array of integers

 
Project ID

-
protocols

-
Array of integers

-
Protocols

+
Protocols

 		
 

 
 

 

-
Status code: 400

+
Status code: 400

 
-
Table 7 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
Table 7 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code

-
Minimum: 8

-
Maximum: 36

+
Error code

+
Minimum: 8

+
Maximum: 36

 		
 
error_msg

+
error_msg

 
String

+
String

 
Description

-
Minimum: 2

-
Maximum: 512

+
Description

+
Minimum: 2

+
Maximum: 512

 		
 

 
 

 

 
-
Example Requests
Query the service group list on the first page of protected object a37bb4eb-c49e-4e88-bf77-944a75b0ce8a in project 2349ba469daf4b7daf268bb0261d18b0.

-
https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/service-sets?object_id=a37bb4eb-c49e-4e88-bf77-944a75b0ce8a&limit=10&offset=0

+
Example Requests
Query the service group list on the first page of protected object a37bb4eb-c49e-4e88-bf77-944a75b0ce8a in project 2349ba469daf4b7daf268bb0261d18b0.

+
https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/service-sets?object_id=a37bb4eb-c49e-4e88-bf77-944a75b0ce8a&limit=10&offset=0

 

-
Example Responses
Status code: 200

-
Response to the request for querying service group information

-
{
+
Example Responses
Status code: 200

+
Response to the request for querying service group information

+
{
   "data" : {
     "limit" : 50,
     "offset" : 0,
@@ -312,55 +305,55 @@
     "total" : 1
   }
 }

-
Status code: 400

-
Bad Request

-
{
+
Status code: 400

+
Bad Request

+
{
   "error_code" : "CFW.0020016",
   "error_msg" : "instance status error"
 }

 

-
Status Codes

-
Status Code

+
Status Codes

+

-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

 
Description

+
Description

 		
 

 
200

+
200

 
Response to the request for querying service group information

+
Response to the request for querying service group information

 		
 
400

+
400

 
Bad Request

+
Bad Request

 		
 
401

+
401

 
Unauthorized

+
Unauthorized

 		
 
403

+
403

 
Forbidden

+
Forbidden

 		
 
404

+
404

 
Not Found

+
Not Found

 		
 
500

+
500

 
Internal Server Error

+
Internal Server Error

 		
 

 
 

 

 

-
Error Codes
See Error Codes.

+
Error Codes
See Error Codes.

 

 

 

diff --git a/docs/cfw/api-ref/UpdateAclRule.html b/docs/cfw/api-ref/UpdateAclRule.html
index 23b005d6..b40bc5a7 100644
--- a/docs/cfw/api-ref/UpdateAclRule.html
+++ b/docs/cfw/api-ref/UpdateAclRule.html
@@ -1,926 +1,937 @@
 
 
 
Updating an ACL Rule

-
Function
This API is used to update an ACL rule.

+
Function
This API is used to update an ACL rule.

 

-
URI
PUT /v1/{project_id}/acl-rule/{acl_rule_id}

+
URI
PUT /v1/{project_id}/acl-rule/{acl_rule_id}

 
-
Table 1 Path Parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
Table 1 Path Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
project_id

+
project_id

 
Yes

+
Yes

 
String

+
String

 
Project ID

+
Project ID

 		
 
acl_rule_id

+
acl_rule_id

 
Yes

+
Yes

 
String

+
String

 
Rule ID

+
Rule ID

 		
 

 
 

 

 
-
Table 2 Query Parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
Table 2 Query Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
enterprise_project_id

+
enterprise_project_id

 
No

+
No

 
String

+
String

 
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

+
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

 		
 
fw_instance_id

+
fw_instance_id

 
No

+
No

 
String

+
String

 
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

+
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

 		
 

 
 

 

 
-
Request Parameters

-
Table 3 Request header parameters
Parameter

+
Request Parameters

+

-
-
-
-
-
-
-
Table 3 Request header parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
X-Auth-Token

+
X-Auth-Token

 
Yes

+
Yes

 
String

+
String

 
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

+
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

 		
 

 
 

 

 
-
Table 4 Request body parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 4 Request body parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
address_type

+
address_type

 
No

+
No

 
Integer

+
Integer

 
Address type. The value can be 0 (IPv4) or 1 (IPv6).

-
Enumeration values:

-
  • 0
  • 1

+
Address type. The value can be 0 (IPv4) or 1 (IPv6).

+
Enumeration values:

+
  • 0
    
+
  • 1
    
+

 		
 
name

+
name

 
No

+
No

 
String

+
String

 
Rule name

+
Rule name

 		
 
sequence

+
sequence

 
No

+
No

 
OrderRuleAclDto object

+
OrderRuleAclDto object

 
UpdateRuleAclDto

+
UpdateRuleAclDto

 		
 
direction

+
direction

 
No

+
No

 
Integer

+
Integer

 
Direction: 0 means outside to inside, 1 means inside to outside, direction value is required when rule type is internet or nat.

-
Enumeration values:

-
  • 0
  • 1

+
Direction: 0 means outside to inside, 1 means inside to outside, direction value is required when rule type is internet or nat.

+
Enumeration values:

+
  • 0
    
+
  • 1
    
+

 		
 
action_type

+
action_type

 
No

+
No

 
Integer

+
Integer

 
Action. 0: allow; 1: deny

-
Enumeration values:

-
  • 0
  • 1

+
Action. 0: allow; 1: deny

+
Enumeration values:

+
  • 0
    
+
  • 1
    
+

 		
 
status

+
status

 
No

+
No

 
Integer

+
Integer

 
Rule delivery status. 0: disabled; 1: enabled.

+
Rule delivery status. 0: disabled; 1: enabled.

 		
 
applications

+
applications

 
No

+
No

 
Array of strings

+
Array of strings

 
applications

+
applications

 		
 
applicationsJsonString

+
applicationsJsonString

 
No

+
No

 
String

+
String

 
applications json string

+
applications json string

 		
 
description

+
description

 
No

+
No

 
String

+
String

 
Description

+
Description

 		
 
long_connect_time_hour

+
long_connect_time_hour

 
No

+
No

 
Long

+
Long

 
Persistent connection duration (hour)

+
Persistent connection duration (hour)

 		
 
long_connect_time_minute

+
long_connect_time_minute

 
No

+
No

 
Long

+
Long

 
Persistent connection duration (hour)

+
Persistent connection duration (hour)

 		
 
long_connect_time_second

+
long_connect_time_second

 
No

+
No

 
Long

+
Long

 
Persistent connection duration (minute)

+
Persistent connection duration (minute)

 		
 
long_connect_time

+
long_connect_time

 
No

+
No

 
Long

+
Long

 
Persistent connection duration

+
Persistent connection duration

 		
 
long_connect_enable

+
long_connect_enable

 
No

+
No

 
Integer

+
Integer

 
Whether to support persistent connections. 0: not supported; 1: supported.

-
Enumeration values:

-
  • 0
  • 1

+
Whether to support persistent connections. 0: not supported; 1: supported.

+
Enumeration values:

+
  • 0
    
+
  • 1
    
+

 		
 
source

+
source

 
No

+
No

 
RuleAddressDto object

+
RuleAddressDto object

 
rule address dto

+
rule address dto

 		
 
destination

+
destination

 
No

+
No

 
RuleAddressDto object

+
RuleAddressDto object

 
rule address dto

+
rule address dto

 		
 
service

+
service

 
No

+
No

 
RuleServiceDto object

+
RuleServiceDto object

 
rule service dto

+
rule service dto

 		
 
type

+
type

 
No

+
No

 
Integer

+
Integer

 
Rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule).

-
Enumeration values:

-
  • 0
  • 1
  • 2

+
Rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule).

+
Enumeration values:

+
  • 0
    
+
  • 1
    
+
  • 2
    
+

 		
 
tag

+
tag

 
No

+
No

 
TagsVO object

+
TagsVO object

 
tag

+
tag

 		
 

 
 

 

 
-
Table 5 OrderRuleAclDto
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 5 OrderRuleAclDto
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
dest_rule_id

+
dest_rule_id

 
No

+
No

 
String

+
String

 
ID of the rule that the added rule will follow. This parameter cannot be left blank if the rule is not pinned on top, and is empty when the added rule is pinned on top.

+
ID of the rule that the added rule will follow. This parameter cannot be left blank if the rule is not pinned on top, and is empty when the added rule is pinned on top.

 		
 
top

+
top

 
No

+
No

 
Integer

+
Integer

 
Whether to pin on top. The options are as follows: 0: no; 1: yes.

+
Whether to pin on top. The options are as follows: 0: no; 1: yes.

 		
 
bottom

+
bottom

 
No

+
No

 
Integer

+
Integer

 
Whether to pin on bottom. The options are as follows: 0: no; 1: yes.

+
Whether to pin on bottom. The options are as follows: 0: no; 1: yes.

 		
 

 
 

 

 
-
Table 6 RuleAddressDto
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 6 RuleAddressDto
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
type

+
type

 
Yes

+
Yes

 
Integer

+
Integer

 
Source type. 0: manual input; 1: associated IP address group; 2: domain name; 3: region; 4: domain set 5: multi object, 6: domain set dns, 7: domain url profile

+
Source type. 0: manual input; 1: associated IP address group; 2: domain name; 3: region; 4: domain set 5: multi object, 6: domain set dns, 7: domain url profile

 		
 
address_type

+
address_type

 
No

+
No

 
Integer

+
Integer

 
Source type. 0: IPv4; 1: IPv6

+
Source type. 0: IPv4; 1: IPv6

 		
 
address

+
address

 
No

+
No

 
String

+
String

 
Source IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type.

+
Source IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type.

 		
 
address_set_id

+
address_set_id

 
No

+
No

 
String

+
String

 
ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type.

+
ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type.

 		
 
address_set_name

+
address_set_name

 
No

+
No

 
String

+
String

 
IP address group name

+
IP address group name

 		
 
domain_address_name

+
domain_address_name

 
No

+
No

 
String

+
String

 
Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type.

+
Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type.

 		
 
region_list_json

+
region_list_json

 
No

+
No

 
String

+
String

 
JSON value of the rule region list.

+
JSON value of the rule region list.

 		
 
region_list

+
region_list

 
No

+
No

 
Array of IpRegionDto objects

+
Array of IpRegionDto objects

 
Region list of a rule

+
Region list of a rule

 		
 
domain_set_id

+
domain_set_id

 
No

+
No

 
String

+
String

 
domain set id

+
domain set id

 		
 
domain_set_name

+
domain_set_name

 
No

+
No

 
String

+
String

 
domain set name

+
domain set name

 		
 
ip_address

+
ip_address

 
No

+
No

 
Array of strings

+
Array of strings

 
IP address list

+
IP address list

 		
 
address_group

+
address_group

 
No

+
No

 
Array of strings

+
Array of strings

 
address group

+
address group

 		
 
address_group_names

+
address_group_names

 
No

+
No

 
Array of AddressGroupVO objects

+
Array of AddressGroupVO objects

 
Address set list

+
Address set list

 		
 
address_set_type

+
address_set_type

 
No

+
No

 
Integer

+
Integer

 
Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set.

+
Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set.

 		
 
predefined_group

+
predefined_group

 
No

+
No

 
Array of strings

+
Array of strings

 
predefined group

+
predefined group

 		
 

 
 

 

 
-
Table 7 IpRegionDto
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 7 IpRegionDto
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
region_id

+
region_id

 
No

+
No

 
String

+
String

 
region id

+
region id

 		
 
description_cn

+
description_cn

 
No

+
No

 
String

+
String

 
cn description

+
cn description

 		
 
description_en

+
description_en

 
No

+
No

 
String

+
String

 
en description

+
en description

 		
 
region_type

+
region_type

 
No

+
No

 
Integer

+
Integer

 
Region type, 0 means country, 1 means province, 2 means continent

+
Region type, 0 means country, 1 means province, 2 means continent

 		
 

 
 

 

 
-
Table 8 AddressGroupVO
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 8 AddressGroupVO
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
address_set_type

+
address_set_type

 
No

+
No

 
Integer

+
Integer

 
Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set.

+
Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set.

 		
 
name

+
name

 
No

+
No

 
String

+
String

 
name

+
name

 		
 
set_id

+
set_id

 
No

+
No

 
String

+
String

 
address set id

+
address set id

 		
 

 
 

 

 
-
Table 9 RuleServiceDto
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 9 RuleServiceDto
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
type

+
type

 
Yes

+
Yes

 
Integer

+
Integer

 
Service input type. The value 0 indicates manual input, and the value 1 indicates automatic input.

+
Service input type. The value 0 indicates manual input, and the value 1 indicates automatic input.

 		
 
protocol

+
protocol

 
No

+
No

 
Integer

+
Integer

 
Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.

+
Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.

 		
 
protocols

+
protocols

 
No

+
No

 
Array of integers

+
Array of integers

 
Protocols

+
Protocols

 		
 
source_port

+
source_port

 
No

+
No

 
String

+
String

 
Source port

+
Source port

 		
 
dest_port

+
dest_port

 
No

+
No

 
String

+
String

 
Destination port

+
Destination port

 		
 
service_set_id

+
service_set_id

 
No

+
No

 
String

+
String

 
Service group ID. This parameter is left blank for the manual type and cannot be left blank for the automatic type.

+
Service group ID. This parameter is left blank for the manual type and cannot be left blank for the automatic type.

 		
 
service_set_name

+
service_set_name

 
No

+
No

 
String

+
String

 
Service group name

+
Service group name

 		
 
custom_service

+
custom_service

 
No

+
No

 
Array of ServiceItem objects

+
Array of ServiceItem objects

 
custom service

+
custom service

 		
 
predefined_group

+
predefined_group

 
No

+
No

 
Array of strings

+
Array of strings

 
predefined group

+
predefined group

 		
 
service_group

+
service_group

 
No

+
No

 
Array of strings

+
Array of strings

 
Service group list

+
Service group list

 		
 
service_group_names

+
service_group_names

 
No

+
No

 
Array of ServiceGroupVO objects

+
Array of ServiceGroupVO objects

 
Service group name list

+
Service group name list

 		
 
service_set_type

+
service_set_type

 
No

+
No

 
Integer

+
Integer

 
Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases

+
Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases

 		
 

 
 

 

 
-
Table 10 ServiceItem
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 10 ServiceItem
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
protocol

+
protocol

 
No

+
No

 
Integer

+
Integer

 
Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.

+
Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.

 		
 
source_port

+
source_port

 
No

+
No

 
String

+
String

 
source port

+
source port

 		
 
dest_port

+
dest_port

 
No

+
No

 
String

+
String

 
destination port

+
destination port

 		
 
description

+
description

 
No

+
No

 
String

+
String

 
description

+
description

 		
 
name

+
name

 
No

+
No

 
String

+
String

 
name

+
name

 		
 

 
 

 

 
-
Table 11 ServiceGroupVO
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 11 ServiceGroupVO
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
name

+
name

 
No

+
No

 
String

+
String

 
service group name

+
service group name

 		
 
protocols

+
protocols

 
No

+
No

 
Array of integers

+
Array of integers

 
protocols

+
protocols

 		
 
service_set_type

+
service_set_type

 
No

+
No

 
Integer

+
Integer

 
Query service set type, 0 means custom define service set, 1 means predefine service set.

+
Query service set type, 0 means custom define service set, 1 means predefine service set.

 		
 
set_id

+
set_id

 
No

+
No

 
String

+
String

 
service set id

+
service set id

 		
 

 
 

 

 
-
Table 12 TagsVO
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 12 TagsVO
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
tag_id

+
tag_id

 
No

+
No

 
String

+
String

 
tag id

+
tag id

 		
 
tag_key

+
tag_key

 
No

+
No

 
String

+
String

 
tag key

+
tag key

 		
 
tag_value

+
tag_value

 
No

+
No

 
String

+
String

 
tag value

+
tag value

 		
 

 
 

 

 
-
Response Parameters
Status code: 200

+
Response Parameters
Status code: 200

 
-
Table 13 Response body parameters
Parameter

+

-
-
-
-
-
Table 13 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
data

+
data

 
RuleId object

+
RuleId object

 
Rule ID

+
Rule ID

 		
 

 
 

 

 
-

-
-
diff --git a/docs/cfw/api-ref/UpdateDnsServers.html b/docs/cfw/api-ref/UpdateDnsServers.html
index 393273c0..756f5ed4 100644
--- a/docs/cfw/api-ref/UpdateDnsServers.html
+++ b/docs/cfw/api-ref/UpdateDnsServers.html
@@ -96,7 +96,7 @@
 
-
diff --git a/docs/cfw/api-ref/UpdateDomainSet.html b/docs/cfw/api-ref/UpdateDomainSet.html
index 321e9243..05333747 100644
--- a/docs/cfw/api-ref/UpdateDomainSet.html
+++ b/docs/cfw/api-ref/UpdateDomainSet.html
@@ -30,7 +30,7 @@
 
-
@@ -121,24 +121,6 @@
 
-
-
-
-
-
-
-
-
-
-
Table 14 RuleId
Parameter

+

-
-
-
-
-
-
-
-
Table 14 RuleId
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
id

+
id

 
String

+
String

 
id

+
id

 		
 
name

+
name

 
String

+
String

 
name

+
name

 		
 

 
 

 

-
Status code: 400

+
Status code: 400

 
-
Table 15 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
Table 15 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_code

+
error_code

 
String

+
String

 
Error code

-
Minimum: 8

-
Maximum: 36

+
Error code

+
Minimum: 8

+
Maximum: 36

 		
 
error_msg

+
error_msg

 
String

+
String

 
Description

-
Minimum: 2

-
Maximum: 512

+
Description

+
Minimum: 2

+
Maximum: 512

 		
 

 
 

 

 
-
Example Requests
The following example shows how to update an IPv4 inbound rule. The rule name is TestRule, the source is the IP address 1.1.1.1, the destination is the IP address 2.2.2.2, the service type is service, the protocol type is TCP, the source port is 0, and the destination port is 0. Persistent connections are not supported. The action is to allow. The status is enabled.

-
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule/ceaa0407-b9c8-4dfd-9eca-b6ead2dfd031
+
Example Requests
The following example shows how to update an IPv4 inbound rule. The rule name is TestRule, the source is the IP address 1.1.1.1, the destination is the IP address 2.2.2.2, the service type is service, the protocol type is TCP, the source port is 0, and the destination port is 0. Persistent connections are not supported. The action is to allow. The status is enabled.

+
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule/ceaa0407-b9c8-4dfd-9eca-b6ead2dfd031
 
 {
   "name" : "TestRule",
@@ -951,62 +962,62 @@
   "direction" : 0
 }

 

-
Example Responses
Status code: 200

-
OK

-
{
+
Example Responses
Status code: 200

+
OK

+
{
   "data" : {
     "id" : "ceaa0407-b9c8-4dfd-9eca-b6ead2dfd031"
   }
 }

-
Status code: 400

-
Bad Request

-
{
+
Status code: 400

+
Bad Request

+
{
   "error_code" : "CFW.00200005",
   "error_msg" : "operation content does not exist"
 }

 

-
Status Codes

-

-
-
-
-
-
Status Code

+
Status Codes

+

-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

 
Description

+
Description

 		
 

 
200

+
200

 
OK

+
OK

 		
 
400

+
400

 
Bad Request

+
Bad Request

 		
 
401

+
401

 
Unauthorized

+
Unauthorized

 		
 
403

+
403

 
Forbidden

+
Forbidden

 		
 
404

+
404

 
Not Found

+
Not Found

 		
 
500

+
500

 
Internal Server Error

+
Internal Server Error

 		
 

 
 

 

 

-
Error Codes
See Error Codes.

+
Error Codes
See Error Codes.

 

 

 

diff --git a/docs/cfw/api-ref/UpdateAddressSet.html b/docs/cfw/api-ref/UpdateAddressSet.html
index 27ebb520..f0519c02 100644
--- a/docs/cfw/api-ref/UpdateAddressSet.html
+++ b/docs/cfw/api-ref/UpdateAddressSet.html
@@ -121,20 +121,6 @@
 
Address group description

 		
 
address_type

-
No

-
Integer

-
Address type. The value can be 0 (IPv4), 1 (IPv6), or 2 (domain).

-
Enumeration values:

-
  • 0
    
-
  • 1
    
-
  • 2
    
-

-

 
 

 

@@ -210,13 +196,12 @@
 

 

 
-
Example Requests
In the project 9d80d070b6d44942af73c9c3d38e0429, change the name of the address set whose ID is cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 to ABCD. Change its address set type to IPV4.

+
Example Requests
In the project 9d80d070b6d44942af73c9c3d38e0429, change the name of the address set whose ID is cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 to ABCD.

 
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-sets/cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16
 
 {
   "name" : "ABCD",
-  "description" : "",
-  "address_type" : 0
+  "description" : ""
 }

 

 
Example Responses
Status code: 200

diff --git a/docs/cfw/api-ref/UpdateBlackWhiteList.html b/docs/cfw/api-ref/UpdateBlackWhiteList.html
index 7b3b0bab..207e945e 100644
--- a/docs/cfw/api-ref/UpdateBlackWhiteList.html
+++ b/docs/cfw/api-ref/UpdateBlackWhiteList.html
@@ -118,12 +118,12 @@
 
 
Integer

 
Address type. 0: ipv4; 1: ipv6; 2: domain

+
Address type. 0: ipv4; 1: ipv6

 		
 

 
address

 
No

+
Yes

 		
 
String

 

 
dns_server

 
No

+
Yes

 		
 
Array of dns_server objects

 		
 
String

 
set id

+
domain set id

 		
 

 
description

 		
 
set_id

-
No

-
String

-
domain set id

-
domain_set_type

-
No

-
Integer

-
Domain name group type. 0 means Application type and 1 means Network type.

-

 
 

 

diff --git a/docs/cfw/api-ref/UpdateServiceSet.html b/docs/cfw/api-ref/UpdateServiceSet.html
index a7b47b18..e9fd633a 100644
--- a/docs/cfw/api-ref/UpdateServiceSet.html
+++ b/docs/cfw/api-ref/UpdateServiceSet.html
@@ -131,7 +131,7 @@
 
 
Response Parameters
Status code: 200

 
-
Table 5 Response body parameters
Parameter

+

@@ -141,16 +141,16 @@
 
-
-
Table 5 Response body parameters
Parameter

 		
 
Type

 

 
data

 
IdObject object

+
data object

 
Data returned when a service group is updated

+
object

 		
 

 
 

 

 
-
Table 6 IdObject
Parameter

+

@@ -162,14 +162,7 @@
 
-
-
-
-
-
diff --git a/docs/cfw/api-ref/cfw_02_0013.html b/docs/cfw/api-ref/cfw_02_0013.html
index 06168005..23e5de1b 100644
--- a/docs/cfw/api-ref/cfw_02_0013.html
+++ b/docs/cfw/api-ref/cfw_02_0013.html
@@ -71,7 +71,7 @@
 

 

-
Parent topic: Appendix

+
Parent topic: Appendix

 

 

 
diff --git a/docs/cfw/api-ref/cfw_02_0016.html b/docs/cfw/api-ref/cfw_02_0016.html
deleted file mode 100644
index 33682102..00000000
--- a/docs/cfw/api-ref/cfw_02_0016.html
+++ /dev/null
@@ -1,26 +0,0 @@
-
-
-
Change History

-

-
Table 6 data
Parameter

 		
 
Type

 		
 
String

 
ID

-
name

-
String

-
name

+
Protected object ID

 		
 

 
 

-
-
-
-
-
-
-
-
-
-
-
Release Date

-
Description

-
2024-05-28

-
This issue is the second official release.

-
Modified the description about whether X-Auth-Token is mandatory.

-
2024-04-30

-
This issue is the first official release.

-

-

-
-
diff --git a/docs/cfw/api-ref/cfw_02_0017.html b/docs/cfw/api-ref/cfw_02_0017.html
new file mode 100644
index 00000000..b979d3e1
--- /dev/null
+++ b/docs/cfw/api-ref/cfw_02_0017.html
@@ -0,0 +1,33 @@
+
+
+
Change History

+

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
Release Date

+
Description

+
2024-07-02

+
This issue is the third official release.

+
Deleted:

+
  • The address_type parameter in the "Updating Address Set Information" API.

+
2024-05-28

+
This issue is the second official release.

+
Modified the description about whether X-Auth-Token is mandatory.

+
2024-04-30

+
This issue is the first official release.

+

+

+

+
diff --git a/docs/cfw/api-ref/cfw_02_0011.html b/docs/cfw/api-ref/cfw_02_0023.html
similarity index 85%
rename from docs/cfw/api-ref/cfw_02_0011.html
rename to docs/cfw/api-ref/cfw_02_0023.html
index 87648e76..a7ee4cb9 100644
--- a/docs/cfw/api-ref/cfw_02_0011.html
+++ b/docs/cfw/api-ref/cfw_02_0023.html
@@ -1,4 +1,4 @@
-
+
 
 
Appendix