From 2ced5c725f0755b15ef128632d71d47a21a136bb Mon Sep 17 00:00:00 2001 From: qiaoli Date: Tue, 18 Feb 2025 12:17:50 +0000 Subject: [PATCH] CFW API 20250123 version Reviewed-by: Gladkov, Maksim Co-authored-by: qiaoli Co-committed-by: qiaoli --- docs/cfw/api-ref/ALL_META.TXT.json | 7 +- docs/cfw/api-ref/AddAclRule.html | 766 ++++++------ docs/cfw/api-ref/AddAddressItem.html | 256 ++-- docs/cfw/api-ref/AddAddressSet.html | 210 ++-- docs/cfw/api-ref/AddBlackWhiteList.html | 242 ++-- docs/cfw/api-ref/AddDomainSet.html | 196 ++-- docs/cfw/api-ref/AddDomains.html | 188 +-- docs/cfw/api-ref/AddLogConfig.html | 186 +-- docs/cfw/api-ref/AddServiceItems.html | 240 ++-- docs/cfw/api-ref/AddServiceSet.html | 202 ++-- docs/cfw/api-ref/BatchDeleteAclRules.html | 160 +-- docs/cfw/api-ref/BatchDeleteAddressItems.html | 130 +- docs/cfw/api-ref/BatchDeleteServiceItems.html | 160 +-- .../api-ref/BatchUpdateAclRuleActions.html | 138 +-- docs/cfw/api-ref/CLASS.TXT.json | 4 +- .../api-ref/ChangeEastWestFirewallStatus.html | 188 +-- docs/cfw/api-ref/ChangeEipStatus.html | 260 ++-- docs/cfw/api-ref/ChangeIpsProtectMode.html | 188 +-- docs/cfw/api-ref/ChangeIpsSwitchStatus.html | 168 +-- docs/cfw/api-ref/CreateEastWestFirewall.html | 238 ++-- docs/cfw/api-ref/CreateFirewall.html | 380 +++--- docs/cfw/api-ref/CreateTag.html | 126 +- docs/cfw/api-ref/DeleteAclRule.html | 178 +-- docs/cfw/api-ref/DeleteAclRuleHitCount.html | 168 +-- docs/cfw/api-ref/DeleteAddressItem.html | 178 +-- docs/cfw/api-ref/DeleteAddressSet.html | 178 +-- docs/cfw/api-ref/DeleteBlackWhiteList.html | 178 +-- docs/cfw/api-ref/DeleteDomainSet.html | 132 +-- docs/cfw/api-ref/DeleteDomains.html | 156 +-- docs/cfw/api-ref/DeleteFirewall.html | 90 +- docs/cfw/api-ref/DeleteServiceItem.html | 178 +-- docs/cfw/api-ref/DeleteServiceSet.html | 178 +-- docs/cfw/api-ref/DeleteTag.html | 134 +-- docs/cfw/api-ref/ErrorCode.html | 1044 +++++------------ docs/cfw/api-ref/ListAccessControlLogs.html | 510 ++++---- docs/cfw/api-ref/ListAclRuleHitCount.html | 186 +-- docs/cfw/api-ref/ListAclRules.html | 722 ++++++------ docs/cfw/api-ref/ListAddressItems.html | 272 ++--- docs/cfw/api-ref/ListAddressSetDetail.html | 204 ++-- docs/cfw/api-ref/ListAddressSets.html | 288 ++--- docs/cfw/api-ref/ListAttackLogs.html | 600 +++++----- docs/cfw/api-ref/ListBlackWhiteLists.html | 286 ++--- docs/cfw/api-ref/ListDnsServers.html | 180 +-- docs/cfw/api-ref/ListDomainParseDetail.html | 168 +-- docs/cfw/api-ref/ListDomainSets.html | 250 ++-- docs/cfw/api-ref/ListDomains.html | 212 ++-- docs/cfw/api-ref/ListEastWestFirewall.html | 427 ++++--- docs/cfw/api-ref/ListEipCount.html | 184 +-- docs/cfw/api-ref/ListEips.html | 372 +++--- docs/cfw/api-ref/ListFirewallDetail.html | 436 +++---- docs/cfw/api-ref/ListFirewallList.html | 374 +++--- docs/cfw/api-ref/ListFlowLogs.html | 500 ++++---- docs/cfw/api-ref/ListIpsProtectMode.html | 178 +-- docs/cfw/api-ref/ListIpsSwitchStatus.html | 154 +-- docs/cfw/api-ref/ListJob.html | 131 ++- docs/cfw/api-ref/ListLogConfig.html | 166 +-- docs/cfw/api-ref/ListProtectedVpcs.html | 220 ++-- docs/cfw/api-ref/ListRuleAclTags.html | 176 +-- docs/cfw/api-ref/ListServiceItems.html | 320 ++--- docs/cfw/api-ref/ListServiceSetDetail.html | 198 ++-- docs/cfw/api-ref/ListServiceSets.html | 270 ++--- docs/cfw/api-ref/UpdateAclRule.html | 738 ++++++------ docs/cfw/api-ref/UpdateAclRuleOrder.html | 204 ++-- docs/cfw/api-ref/UpdateAddressSet.html | 202 ++-- docs/cfw/api-ref/UpdateBlackWhiteList.html | 234 ++-- docs/cfw/api-ref/UpdateDnsServers.html | 208 ++-- docs/cfw/api-ref/UpdateDomainSet.html | 156 +-- docs/cfw/api-ref/UpdateLogConfig.html | 186 +-- docs/cfw/api-ref/UpdateServiceSet.html | 202 ++-- docs/cfw/api-ref/cfw_02_0017.html | 19 +- docs/cfw/api-ref/cfw_02_0028.html | 2 +- 71 files changed, 8564 insertions(+), 8996 deletions(-) diff --git a/docs/cfw/api-ref/ALL_META.TXT.json b/docs/cfw/api-ref/ALL_META.TXT.json index d8733582d..d2fb1abdd 100644 --- a/docs/cfw/api-ref/ALL_META.TXT.json +++ b/docs/cfw/api-ref/ALL_META.TXT.json @@ -1347,7 +1347,7 @@ "node_id":"changeipsswitchstatus.xml", "product_code":"cfw", "code":"69", - "des":"This API is used to enable or disable the feature.POST /v1/{project_id}/ips/switchStatus code: 200Enable or disable the basic patch and virtual patch of the engine on the", + "des":"This API is used to enable or disable the feature.POST /v1/{project_id}/ips/switchStatus code: 200API used for toggling IPS. It is used to enable or disable the basic pat", "doc_type":"api", "kw":"Changing the IPS Feature Status,IPS management,API Reference", "search_title":"", @@ -1587,8 +1587,9 @@ "search_title":"", "metedata":[ { + "documenttype":"api", "prodname":"cfw", - "documenttype":"api" + "opensource":"true" } ], "title":"Error Codes", @@ -1635,7 +1636,7 @@ "node_id":"cfw_02_0028.xml", "product_code":"cfw", "code":"84", - "des":"A firewall ID (fw_instance_Id) is a CFW instance ID. It is automatically generated by the system after CFW is created.You can obtain the value by calling the API for Toke", + "des":"A firewall ID (fw_instance_Id) is a CFW instance ID. It is automatically generated by the system after CFW is created.You can obtain the value by calling the API for Quer", "doc_type":"api", "kw":"Obtaining a Firewall ID,Appendix,API Reference", "search_title":"", diff --git a/docs/cfw/api-ref/AddAclRule.html b/docs/cfw/api-ref/AddAclRule.html index a4e71acd4..1490946e0 100644 --- a/docs/cfw/api-ref/AddAclRule.html +++ b/docs/cfw/api-ref/AddAclRule.html @@ -1,895 +1,895 @@

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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

+

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

+

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

fw_instance_id

+

fw_instance_id

No

+

No

String

+

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

+

Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

+

User token. You can obtain the token by referring to Obtaining a User Token.

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

Content type. It can only be set to application/json.

+

Content type. It can only be set to application/json.

-
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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

+

Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

type

+

type

Yes

+

Yes

Integer

+

Integer

Rule type: 0 (Internet border rule), 1 (inter-VPC rule), or 2 (NAT rule). When type is set to 0, the source and destination addresses of the rule must be EIPs or domain names of the public network. For an inter-VPC rule, the source and destination addresses must be private IP addresses. For a NAT rule, the source address must be a private IP address, and the destination address must be an EIP or domain name of the public network.

+

Rule type: 0 (Internet border rule), 1 (inter-VPC rule), or 2 (NAT rule). When type is set to 0, the source and destination addresses of the rule must be EIPs or domain names of the public network. For an inter-VPC rule, the source and destination addresses must be private IP addresses. For a NAT rule, the source address must be a private IP address, and the destination address must be an EIP or domain name of the public network.

rules

+

rules

Yes

+

Yes

Array of rules objects

+

Array of rules objects

Rule list in a rule addition request.

+

Rule list in a rule addition request.

-
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

Request body for changing the rule sequence.

+

Request body for changing the rule sequence.

address_type

+

address_type

Yes

+

Yes

Integer

+

Integer

Address type: 0 (IPv4), 1 (IPv6).

+

Internet protocol type of an address: 0 (IPv4), 1 (IPv6).

action_type

+

action_type

Yes

+

Yes

Integer

+

Integer

Rule action: 0 (permit), 1 (deny).

+

Rule action: 0 (permit), 1 (deny).

status

+

status

Yes

+

Yes

Integer

+

Integer

Rule status: 0 (disabled), 1 (enabled).

+

Rule status: 0 (disabled), 1 (enabled).

applications

+

applications

No

+

No

Array of strings

+

Array of strings

Rule application list. Rule application type: HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

+

Rule application list. Rule application type: HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

applicationsJsonString

+

applicationsJsonString

No

+

No

String

+

String

JSON string converted from the applications field in the application list.

+

JSON string converted from the applications field in the application list.

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 (no), 1 (yes).

+

Whether to support persistent connections: 0 (no), 1 (yes).

description

+

description

No

+

No

String

+

String

Description.

+

Description.

direction

+

direction

No

+

No

Integer

+

Integer

Direction: 0 (inbound) or 1 (outbound). This parameter is mandatory when type is set to 0 (Internet rule) or 2 (NAT rule).

+

Direction: 0 (inbound) or 1 (outbound). This parameter is mandatory when type is set to 0 (Internet rule) or 2 (NAT rule).

source

+

source

Yes

+

Yes

RuleAddressDtoForRequest object

+

RuleAddressDtoForRequest object

Source address Data Transport Object.

+

Source address Data Transport Object.

destination

+

destination

Yes

+

Yes

RuleAddressDtoForRequest object

+

RuleAddressDtoForRequest object

Destination address Data Transport Object.

+

Destination address Data Transport Object.

service

+

service

Yes

+

Yes

RuleServiceDto object

+

RuleServiceDto object

Service object.

+

Service object.

tag

+

tag

No

+

No

TagsVO object

+

TagsVO object

Tag object attached to a rule.

+

Tag object attached to a rule.

-
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 target rule. The added rule is placed after this rule. This parameter cannot be left blank when the added rule is not pinned on top, and can be left blank when the added rule is pinned on top. The rule ID can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

+

ID of the target rule. The added rule is placed after this rule. This parameter cannot be left blank when the added rule is not pinned on top, and can be left blank when the added rule is pinned on top. The rule ID can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

top

+

top

No

+

No

Integer

+

Integer

Whether to pin on top: 0 (no), 1 (yes).

+

Whether to pin on top: 0 (no), 1 (yes).

bottom

+

bottom

No

+

No

Integer

+

Integer

Whether to pin to bottom: 0 (no), 1 (yes).

+

Whether to pin to bottom: 0 (no), 1 (yes).

-
Table 7 RuleAddressDtoForRequest

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

type

+

type

Yes

+

Yes

Integer

+

Integer

Address type: 0 (manual input), 1 (associated IP address group), 2 (domain name), 3 (geographical location), 4 (domain name group) 5 (multiple objects), 6 (domain name group - network), 7 (domain name group - application).

+

Address type: 0 (manual input), 1 (associated IP address group), 2 (domain name), 3 (geographical location), 4 (domain name group) 5 (multiple objects), 6 (domain name group - network), 7 (domain name group - application).

address_type

+

address_type

No

+

No

Integer

+

Integer

Address type: 0 (IPv4), 1 (IPv6). If type is 0, the input cannot be left blank.

+

Internet protocol type of an address: 0 (IPv4), 1 (IPv6). If type is 0, this parameter cannot be left blank.

address

+

address

No

+

No

String

+

String

IP address information. It cannot be left blank if type is set to 0.

+

IP address information. It cannot be left blank if type is set to 0.

address_set_id

+

address_set_id

No

+

No

String

+

String

ID of an associated IP address group. This parameter cannot be left blank when type is set to 1. You can obtain the value by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

+

ID of an associated IP address group. This parameter cannot be left blank when type is set to 1. You can obtain the value by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

address_set_name

+

address_set_name

No

+

No

String

+

String

Name of an associated IP address group. This parameter cannot be left blank when type is set to 1. You can obtain the value by calling the API for querying the address group list. Find the value in data.records.name (The period [.] is used to separate different levels of objects).

+

Name of an associated IP address group. This parameter cannot be left blank when type is set to 1. You can obtain the value by calling the API for querying the address group list. Find the value in data.records.name (The period [.] is used to separate different levels of objects).

domain_address_name

+

domain_address_name

No

+

No

String

+

String

Name of a domain name address. This parameter is valid when type is set to 2 (domain name) or 7 (application domain name group).

+

Name of a domain name address. This parameter is valid when type is set to 2 (domain name) or 7 (application domain name group).

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

Rule region list.

+

Rule region list.

domain_set_id

+

domain_set_id

No

+

No

String

+

String

Domain group ID. The value cannot be left blank when type is set to 4 (domain name group) or 7 (domain name group - application). Its value can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

+

Domain group ID. The value cannot be left blank when type is set to 4 (domain name group) or 7 (domain name group - application). Its value can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

domain_set_name

+

domain_set_name

No

+

No

String

+

String

Domain group name. The value cannot be left blank when type is set to 4 (domain name group) or 7 (domain name group - application). Its value can be obtained by calling the API for querying the domain name group list. Find the value in data.records.name (The period [.] is used to separate different levels of objects).

+

Domain group name. The value cannot be left blank when type is set to 4 (domain name group) or 7 (domain name group - application). Its value can be obtained by calling the API for querying the domain name group list. Find the value in data.records.name (The period [.] is used to separate different levels of objects).

ip_address

+

ip_address

No

+

No

Array of strings

+

Array of strings

IP address list. This parameter cannot be left blank when type is set to 5 (multiple objects).

+

IP address list. This parameter cannot be left blank when type is set to 5 (multiple objects).

address_set_type

+

address_set_type

No

+

No

Integer

+

Integer

Address group type. It cannot be left blank when type is set to 1 (associated IP address group). It value can be 0 (user-defined address group), 1 (WAF back-to-source IP address group), 2 (DDoS back-to-source IP address group), or 3 (NAT64 address group).

+

Address group type. It cannot be left blank when type is set to 1 (associated IP address group). It value can be 0 (user-defined address group), 1 (WAF back-to-source IP address group), 2 (DDoS back-to-source IP address group), or 3 (NAT64 address group).

predefined_group

+

predefined_group

No

+

No

Array of strings

+

Array of strings

Pre-defined address group ID list. This parameter cannot be left blank when type is set to 5 (multiple objects). Its value can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). In the search criteria, query_address_set_type must be set to 1 (predefined address group).

+

Pre-defined address group ID list. This parameter cannot be left blank when type is set to 5 (multiple objects). Its value can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). In the search criteria, query_address_set_type must be set to 1 (predefined address group).

address_group

+

address_group

No

+

No

Array of strings

+

Array of strings

Address group ID list. This parameter cannot be left blank when type is set to 5 (multiple objects). Its value can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). In the search criteria, query_address_set_type must be set to 0 (user-defined address group).

+

Address group ID list. This parameter cannot be left blank when type is set to 5 (multiple objects). Its value can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). In the search criteria, query_address_set_type must be set to 0 (user-defined 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. You can obtain the ID by referring to Obtaining Information About Account, IAM User, Group, Project, Region, and Agency.

+

Region ID. You can obtain the ID by referring to Obtaining Information About Account, IAM User, Group, Project, Region, and Agency.

region_type

+

region_type

No

+

No

Integer

+

Integer

Region type: 0 (country), 1 (province), and 2 (continent). It can be obtained from the region information table.

+

Region type: 0 (country), 1 (province), and 2 (continent). It can be obtained from the region information table.

-
Table 9 RuleServiceDto

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

type

+

type

Yes

+

Yes

Integer

+

Integer

Service input type: 0 (manual), 1 (automatic).

+

Service input type: 0 (manual), 1 (automatic).

protocol

+

protocol

No

+

No

Integer

+

Integer

Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual).

+

Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual).

protocols

+

protocols

No

+

No

Array of integers

+

Array of integers

Protocol list. Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual).

+

Protocol list. Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual).

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 cannot be left blank when type is set to 1 (associated IP address group). Its value can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

+

Service group ID. This parameter cannot be left blank when type is set to 1 (associated IP address group). Its value can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

service_set_name

+

service_set_name

No

+

No

String

+

String

Service group name. This parameter cannot be left blank when type is set to 1 (associated IP address group). Its value can be obtained by calling the API for querying the service group list. Find the value in data.records.name (The period [.] is used to separate different levels of objects).

+

Service group name. This parameter cannot be left blank when type is set to 1 (associated IP address group). Its value can be obtained by calling the API for querying the service group list. Find the value in data.records.name (The period [.] is used to separate different levels of objects).

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 service group ID list. The service group ID can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). In the search criteria, query_service_set_type must be set to 1 (predefined service group).

+

Predefined service group ID list. The service group ID can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). In the search criteria, query_service_set_type must be set to 1 (predefined service group).

service_group

+

service_group

No

+

No

Array of strings

+

Array of strings

Service group ID list. The service group ID can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). In the search criteria, query_service_set_type must be set to 0 (user-defined service group).

+

Service group ID list. The service group ID can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). In the search criteria, query_service_set_type must be set to 0 (user-defined service group).

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 group type: 0 (user-defined service group), 1 (common web service), 2 (common remote login and ping), or 3 (common database).

+

Service group type: 0 (user-defined service group), 1 (common web service), 2 (common remote login and ping), or 3 (common database).

-
Table 10 ServiceItem

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

protocol

+

protocol

No

+

No

Integer

+

Integer

Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when RuleServiceDto.type is set to 0 (manual).

+

Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when RuleServiceDto.type is set to 0 (manual).

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

Service member description.

+

Service member description.

name

+

name

No

+

No

String

+

String

Service member name.

+

Service member 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

Protocol list. Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any).

+

Protocol list. Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any).

service_set_type

+

service_set_type

No

+

No

Integer

+

Integer

Service group type: 0 (user-defined service group), 1 (predefined service group).

+

Service group type: 0 (user-defined service group), 1 (predefined service group).

set_id

+

set_id

No

+

No

String

+

String

Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

+

Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

-
Table 12 TagsVO

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

tag_id

+

tag_id

No

+

No

String

+

String

Rule ID.

+

Rule tag ID.

tag_key

+

tag_key

No

+

No

String

+

String

Rule tag key.

+

Rule tag key.

tag_value

+

tag_value

No

+

No

String

+

String

Rule tag value.

+

Rule 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

Data of the return value for creating a rule.

+

Data of the return value for creating a rule.

-
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

Rule ID.

+

Rule ID.

name

+

name

String

+

String

Rule name.

+

Rule name.

-

Status code: 400

+

Status code: 400

-
Table 16 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

error_code

+

error_code

String

+

String

Error code.

+

Error code.

error_msg

+

error_msg

String

+

String

Error description.

+

Error description.

-

Example Requests

The following example shows how to add an IPv4 inbound rule. The rule name is Test rule, 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 Test rule, 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",
@@ -927,9 +927,9 @@
   "type" : 0
 }
-

Example Responses

Status code: 200

-

Response to the request for creating an ACL rule.

-
{
+

Example Responses

Status code: 200

+

Response to the request for creating an ACL rule.

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

Status code: 400

-

Bad Request

-
{
+

Status code: 400

+

Bad Request

+
{
   "error_code" : "CFW.00900016",
   "error_msg" : "Import is in progress. Please wait until it is complete."
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - - - - - - - - - - - -

Status Code

Description

+

Description

200

+

200

Response to the request for creating an ACL rule.

+

Response to the request for creating an ACL rule.

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/AddAddressItem.html b/docs/cfw/api-ref/AddAddressItem.html index d1ad2a9f9..b5ccb2bd5 100644 --- a/docs/cfw/api-ref/AddAddressItem.html +++ b/docs/cfw/api-ref/AddAddressItem.html @@ -1,292 +1,292 @@

Adding an Address Group Member

-

Function

This API is used to add a member to an address group.

+

Function

This API is used to add a member to an address group.

-

URI

POST /v1/{project_id}/address-items

+

URI

POST /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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

+

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

+

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

fw_instance_id

+

fw_instance_id

No

+

No

String

+

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

+

Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

+

User token. You can obtain the token by referring to Obtaining a User Token.

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

Content type. It can only be set to application/json.

+

Content type. It can only be set to application/json.

-
Table 4 Request body parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

set_id

+

set_id

No

+

No

String

+

String

Address group ID, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

+

Address group ID, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

address_items

+

address_items

No

+

No

Array of address_items objects

+

Array of address_items objects

Address group member list.

+

Address group member list.

-
Table 5 address_items

Parameter

+
- - - - - - - - - - - - - - -
Table 5 address_items

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

address_type

+

address_type

No

+

No

Integer

+

Integer

Address type: 0 (IPv4), 1 (IPv6).

+

Internet protocol type of an address: 0 (IPv4), 1 (IPv6).

address

+

address

Yes

+

Yes

String

+

String

ip

+

ip

description

+

description

No

+

No

String

+

String

Address group member description.

+

Address group member description.

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 6 Response body parameters

Parameter

+
- - - - -
Table 6 Response body parameters

Parameter

Type

+

Type

Description

+

Description

data

+

data

AddressItems object

+

AddressItems object

Data returned after an address group member is added.

+

Data returned after an address group member is added.

-
Table 7 AddressItems

Parameter

+
- - - - - - - -
Table 7 AddressItems

Parameter

Type

+

Type

Description

+

Description

items

+

items

Array of AddressItemIdWithoutName objects

+

Array of AddressItemIdWithoutName objects

List of address group member IDs.

+

List of address group member IDs.

covered_ip

+

covered_ip

Array of CoveredIPVO objects

+

Array of CoveredIPVO objects

List of covered IP addresses.

+

List of covered IP addresses.

-
Table 8 AddressItemIdWithoutName

Parameter

+
- - - - -
Table 8 AddressItemIdWithoutName

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

ID of an address group member.

+

ID of an address group member.

-
Table 9 CoveredIPVO

Parameter

+
- - - - - - - -
Table 9 CoveredIPVO

Parameter

Type

+

Type

Description

+

Description

ip

+

ip

String

+

String

IP address

+

IP address

covered_Ip

+

covered_Ip

String

+

String

Cover an IP address.

+

Cover an IP address.

-

Status code: 400

+

Status code: 400

-
Table 10 Response body parameters

Parameter

+
- - - - - - - -
Table 10 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_code

+

error_code

String

+

String

Error code.

+

Error code.

error_msg

+

error_msg

String

+

String

Error description.

+

Error description.

-

Example Requests

Add an address group member whose IP address is 2.2.2.2 and name is ceshi to the group whose set_id is 8773c082-2a6c-4529-939a-edc28ef1a67c in project 9d80d070b6d44942af73c9c3d38e0429.

-
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items
+

Example Requests

Add an address group member whose IP address is 2.2.2.2 and name is ceshi to the group whose set_id is 8773c082-2a6c-4529-939a-edc28ef1a67c in project 9d80d070b6d44942af73c9c3d38e0429.

+
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items
 
 {
   "set_id" : "8773c082-2a6c-4529-939a-edc28ef1a67c",
@@ -296,9 +296,9 @@
   } ]
 }
-

Example Responses

Status code: 200

-

Return value for adding an address group member.

-
{
+

Example Responses

Status code: 200

+

Return value for adding an address group member.

+
{
   "data" : {
     "covered_ip" : [ ],
     "items" : [ {
@@ -306,55 +306,55 @@
     } ]
   }
 }
-

Status code: 400

-

Bad Request

-
{
+

Status code: 400

+

Bad Request

+
{
   "error_code" : "CFW.00200001",
   "error_msg" : "Empty parameter."
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - - - - - - - - - - - -

Status Code

Description

+

Description

200

+

200

Return value for adding an address group member.

+

Return value for adding an address 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/AddAddressSet.html b/docs/cfw/api-ref/AddAddressSet.html index ec9051870..bf13bc26c 100644 --- a/docs/cfw/api-ref/AddAddressSet.html +++ b/docs/cfw/api-ref/AddAddressSet.html @@ -1,224 +1,224 @@

Adding an Address Group

-

Function

This API is used to add an address group.

+

Function

This API is used to add an address group.

-

URI

POST /v1/{project_id}/address-set

+

URI

POST /v1/{project_id}/address-set

-
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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

+

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

+

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

fw_instance_id

+

fw_instance_id

No

+

No

String

+

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

+

Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

+

User token. You can obtain the token by referring to Obtaining a User Token.

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

Content type. It can only be set to application/json.

+

Content type. It can only be set to application/json.

-
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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

+

Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

name

+

name

Yes

+

Yes

String

+

String

IP address group name.

+

IP address group name.

description

+

description

No

+

No

String

+

String

Address group description.

+

Address group description.

address_type

+

address_type

No

+

No

Integer

+

Integer

Address type: 0 (IPv4), 1 (IPv6).

+

Internet protocol type of an address: 0 (IPv4), 1 (IPv6).

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 5 Response body parameters

Parameter

+
- - - - -
Table 5 Response body parameters

Parameter

Type

+

Type

Description

+

Description

data

+

data

AddressSetId object

+

AddressSetId object

Data returned after an address group is added.

+

Data returned after an address group is added.

-
Table 6 AddressSetId

Parameter

+
- - - - - - - -
Table 6 AddressSetId

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Address group ID.

+

Address group ID.

name

+

name

String

+

String

IP address group name.

+

IP address group name.

-

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.

+

Error code.

error_msg

+

error_msg

String

+

String

Error description.

+

Error description.

-

Example Requests

Add an IPv4 address group whose project ID is 14181c1245cf4fd786824efe1e2b9388, protected object ID is 1530de8a-522d-4771-9067-9fa4e2f53b48, and name is ceshi.

-
https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/address-set
+

Example Requests

Add an IPv4 address group whose project ID is 14181c1245cf4fd786824efe1e2b9388, protected object ID is 1530de8a-522d-4771-9067-9fa4e2f53b48, and name is ceshi.

+
https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/address-set
 
 {
   "object_id" : "1530de8a-522d-4771-9067-9fa4e2f53b48",
@@ -227,63 +227,63 @@
   "address_type" : 0
 }
-

Example Responses

Status code: 200

-

Return value for adding an address group.

-
{
+

Example Responses

Status code: 200

+

Return value for adding an address group.

+
{
   "data" : {
     "id" : "9dffcd62-23bf-4456-83fa-80fa0fee47db",
     "name" : "name"
   }
 }
-

Status code: 400

-

Bad Request

-
{
+

Status code: 400

+

Bad Request

+
{
   "error_code" : "CFW.00900020",
   "error_msg" : "The number of address groups exceeds the upper limit."
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - - - - - - - - - - - -

Status Code

Description

+

Description

200

+

200

Return value for adding an address group.

+

Return value for adding an address group.

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/AddBlackWhiteList.html b/docs/cfw/api-ref/AddBlackWhiteList.html index 3d6a93e00..9163cf98e 100644 --- a/docs/cfw/api-ref/AddBlackWhiteList.html +++ b/docs/cfw/api-ref/AddBlackWhiteList.html @@ -1,260 +1,260 @@

Creating a Blacklist or Whitelist Rule

-

Function

This API is used to create a blacklist or whitelist rule.

+

Function

This API is used to create a blacklist or whitelist rule.

-

URI

POST /v1/{project_id}/black-white-list

+

URI

POST /v1/{project_id}/black-white-list

-
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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

+

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

+

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

fw_instance_id

+

fw_instance_id

No

+

No

String

+

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

+

Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

+

User token. You can obtain the token by referring to Obtaining a User Token.

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

Content type. It can only be set to application/json.

+

Content type. It can only be set to application/json.

-
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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

+

Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

list_type

+

list_type

Yes

+

Yes

Integer

+

Integer

Blacklist/Whitelist type: 4 (blacklist), 5 (whitelist).

+

Blacklist/Whitelist type: 4 (blacklist), 5 (whitelist).

direction

+

direction

Yes

+

Yes

Integer

+

Integer

Address direction: 0 (source), 1 (destination).

+

Address direction: 0 (source), 1 (destination).

address_type

+

address_type

Yes

+

Yes

Integer

+

Integer

IP address type: 0 (IPv4), 1 (IPv6).

+

Internet protocol type of an address: 0 (IPv4), 1 (IPv6).

address

+

address

Yes

+

Yes

String

+

String

IP address

+

IP address

protocol

+

protocol

Yes

+

Yes

Integer

+

Integer

Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).

+

Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).

port

+

port

Yes

+

Yes

String

+

String

Destination port.

+

Destination port.

description

+

description

No

+

No

String

+

String

Description.

+

Description.

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 5 Response body parameters

Parameter

+
- - - - -
Table 5 Response body parameters

Parameter

Type

+

Type

Description

+

Description

data

+

data

BlackWhiteListId object

+

BlackWhiteListId object

Response to the request for adding a blacklist/whitelist item.

+

Response to the request for adding a blacklist/whitelist item.

-
Table 6 BlackWhiteListId

Parameter

+
- - - - - - - -
Table 6 BlackWhiteListId

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Blacklist/Whitelist ID.

+

Blacklist/Whitelist ID.

name

+

name

String

+

String

Blacklist/Whitelist name.

+

Blacklist/Whitelist name.Which is the Address

-

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.

+

Error code.

error_msg

+

error_msg

String

+

String

Error description.

+

Error description.

-

Example Requests

Add an IPv4 whitelist to object cfebd347-b655-4b84-b938-3c54317599b2 of project 9d80d070b6d44942af73c9c3d38e0429. Direction: source address; IP address: 1.1.1.1; protocol type: TCP; port number: 1.

-
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list
+

Example Requests

Add an IPv4 whitelist to object cfebd347-b655-4b84-b938-3c54317599b2 of project 9d80d070b6d44942af73c9c3d38e0429. Direction: source address; IP address: 1.1.1.1; protocol type: TCP; port number: 1.

+
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list
 
 {
   "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2",
@@ -266,63 +266,63 @@
   "address_type" : 0
 }
-

Example Responses

Status code: 200

-

Response to the request for adding a blacklist or whitelist rule.

-
{
+

Example Responses

Status code: 200

+

Response to the request for adding a blacklist or whitelist rule.

+
{
   "data" : {
     "id" : "6e91797b-05bd-4c69-9454-6af905178729",
     "name" : "10.10.1.3"
   }
 }
-

Status code: 400

-

Bad Request

-
{
+

Status code: 400

+

Bad Request

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

Status Codes

-

Status Code

+

Status Codes

+
- - - - - - - - - - - - -

Status Code

Description

+

Description

200

+

200

Response to the request for adding a blacklist or whitelist rule.

+

Response to the request for adding a blacklist or whitelist rule.

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/AddDomainSet.html b/docs/cfw/api-ref/AddDomainSet.html index 3d312face..730ae7bac 100644 --- a/docs/cfw/api-ref/AddDomainSet.html +++ b/docs/cfw/api-ref/AddDomainSet.html @@ -1,238 +1,238 @@

Adding a Domain Name Group

-

Function

This API is used to add a domain name group.

+

Function

This API is used to add a domain name group.

-

URI

POST /v1/{project_id}/domain-set

+

URI

POST /v1/{project_id}/domain-set

-
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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

+

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

+

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

-

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. You can obtain the token by referring to Obtaining a User Token.

+

User token. You can obtain the token by referring to Obtaining a User Token.

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

Content type. It can only be set to application/json.

+

Content type. It can only be set to application/json.

-
Table 4 Request body parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

fw_instance_id

+

fw_instance_id

Yes

+

Yes

String

+

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

+

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

object_id

+

object_id

Yes

+

Yes

String

+

String

Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

+

Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

name

+

name

Yes

+

Yes

String

+

String

Domain name group name.

+

Domain name group name.

description

+

description

No

+

No

String

+

String

Domain name group description.

+

Domain name group description.

domain_names

+

domain_names

Yes

+

Yes

Array of DomainSetInfoDto objects

+

Array of DomainSetInfoDto objects

Domain name information list.

+

Domain name information list.

domain_set_type

+

domain_set_type

No

+

No

Integer

+

Integer

Domain name group typ: 0 (application domain name group), 1 (network domain name group).

+

Domain name group typ: 0 (application domain name group), 1 (network domain name group).

-
Table 5 DomainSetInfoDto

Parameter

+
- - - - - - - - - - -
Table 5 DomainSetInfoDto

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

domain_name

+

domain_name

Yes

+

Yes

String

+

String

Domain name, for example, www.test.com.

+

Domain name, for example, www.test.com.

description

+

description

No

+

No

String

+

String

Domain name description.

+

Domain name description.

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 6 Response body parameters

Parameter

+
- - - - -
Table 6 Response body parameters

Parameter

Type

+

Type

Description

+

Description

data

+

data

DomainSetResponseData object

+

DomainSetResponseData object

Returned data for adding a domain name group.

+

Returned data for adding a domain name group.

-
Table 7 DomainSetResponseData

Parameter

+
- - - - - - - -
Table 7 DomainSetResponseData

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Domain name group ID.

+

Domain name group ID.

name

+

name

String

+

String

Domain name group name.

+

Domain name group name.

-

Example Requests

Add an application domain name group whose name is test, domain name is www.aaa.com, and protected object ID is fde07429-2e02-45c0-a85f-4f1cacea24d2 to the firewall 546af3f8-88e9-47f2-a205-2346d7090925 in project 9d80d070b6d44942af73c9c3d38e0429.

-
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-set?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default
+

Example Requests

Add an application domain name group whose name is test, domain name is www.aaa.com, and protected object ID is fde07429-2e02-45c0-a85f-4f1cacea24d2 to the firewall 546af3f8-88e9-47f2-a205-2346d7090925 in project 9d80d070b6d44942af73c9c3d38e0429.

+
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-set?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default
 
 {
   "name" : "test",
@@ -245,32 +245,32 @@
   "object_id" : "fde07429-2e02-45c0-a85f-4f1cacea24d2"
 }
-

Example Responses

Status code: 200

-

Return value for adding a domain name group.

-
{
+

Example Responses

Status code: 200

+

Return value for adding a domain name group.

+
{
   "data" : {
     "id" : "e43db369-a863-45ed-8850-58d6b571b1ab",
     "name" : "test"
   }
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - -

Status Code

Description

+

Description

200

+

200

Return value for adding a domain name group.

+

Return value for adding a domain name group.

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/cfw/api-ref/AddDomains.html b/docs/cfw/api-ref/AddDomains.html index efaa9ab6e..080e12063 100644 --- a/docs/cfw/api-ref/AddDomains.html +++ b/docs/cfw/api-ref/AddDomains.html @@ -1,229 +1,229 @@

Adding a Domain Name List

-

Function

This API is used to add a domain name list.

+

Function

This API is used to add a domain name list.

-

URI

POST /v1/{project_id}/domain-set/domains/{set_id}

+

URI

POST /v1/{project_id}/domain-set/domains/{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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

+

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

set_id

+

set_id

Yes

+

Yes

String

+

String

Domain name group ID, which can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

+

Domain name group ID, which can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

-
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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

+

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

fw_instance_id

+

fw_instance_id

No

+

No

String

+

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

+

Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

+

User token. You can obtain the token by referring to Obtaining a User Token.

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

Content type. It can only be set to application/json.

+

Content type. It can only be set to application/json.

-
Table 4 Request body parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

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 for querying a firewall instance.

+

Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API for querying a firewall instance.

object_id

+

object_id

Yes

+

Yes

String

+

String

Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

+

Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

domain_names

+

domain_names

Yes

+

Yes

Array of DomainSetInfoDto objects

+

Array of DomainSetInfoDto objects

Domain name list.

+

Domain name list.

-
Table 5 DomainSetInfoDto

Parameter

+
- - - - - - - - - - -
Table 5 DomainSetInfoDto

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

domain_name

+

domain_name

Yes

+

Yes

String

+

String

Domain name, for example, www.test.com.

+

Domain name, for example, www.test.com.

description

+

description

No

+

No

String

+

String

Domain name description.

+

Domain name description.

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 6 Response body parameters

Parameter

+
- - - - -
Table 6 Response body parameters

Parameter

Type

+

Type

Description

+

Description

data

+

data

DomainSetResponseData object

+

DomainSetResponseData object

Return data of a domain name group.

+

Return data of a domain name group.

-
Table 7 DomainSetResponseData

Parameter

+
- - - - - - - -
Table 7 DomainSetResponseData

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Domain name group ID.

+

Domain name group ID.

name

+

name

String

+

String

Domain name group name.

+

Domain name group name.

-

Example Requests

Add domain names www.bnm.com and www.vbc.com to the domain name group of project 14181c1245cf4fd786824efe1e2b9388. The firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925, protected object ID is ae42418e-f077-41a0-9d3b-5b2f5ad9102b, and domain name group ID is 78719348-6d79-477e-acec-676a29842ab2.

-
https://{Endpoint}v1/14181c1245cf4fd786824efe1e2b9388/domain-set/domains/78719348-6d79-477e-acec-676a29842ab2?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default
+

Example Requests

Add domain names www.bnm.com and www.vbc.com to the domain name group of project 14181c1245cf4fd786824efe1e2b9388. The firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925, protected object ID is ae42418e-f077-41a0-9d3b-5b2f5ad9102b, and domain name group ID is 78719348-6d79-477e-acec-676a29842ab2.

+
https://{Endpoint}v1/14181c1245cf4fd786824efe1e2b9388/domain-set/domains/78719348-6d79-477e-acec-676a29842ab2?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default
 
 {
   "domain_names" : [ {
@@ -237,32 +237,32 @@
   "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b"
 }
-

Example Responses

Status code: 200

-

Return value for adding a domain names.

-
{
+

Example Responses

Status code: 200

+

Return value for adding a domain names.

+
{
   "data" : {
     "id" : "78719348-6d79-477e-acec-676a29842ab2",
     "name" : "test26"
   }
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - -

Status Code

Description

+

Description

200

+

200

Return value for adding a domain names.

+

Return value for adding a domain names.

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/cfw/api-ref/AddLogConfig.html b/docs/cfw/api-ref/AddLogConfig.html index 44065383d..ebd037bd7 100644 --- a/docs/cfw/api-ref/AddLogConfig.html +++ b/docs/cfw/api-ref/AddLogConfig.html @@ -1,216 +1,216 @@

Adding Log Configurations

-

Function

This API is used to add log configurations.

+

Function

This API is used to add log configurations.

-

URI

POST /v1/{project_id}/cfw/logs/configuration

+

URI

POST /v1/{project_id}/cfw/logs/configuration

-
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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

+

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

-
Table 2 Query Parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

fw_instance_id

+

fw_instance_id

Yes

+

Yes

String

+

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

+

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

enterprise_project_id

+

enterprise_project_id

No

+

No

String

+

String

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

+

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

-

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. You can obtain the token by referring to Obtaining a User Token.

+

User token. You can obtain the token by referring to Obtaining a User Token.

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

Content type. It can only be set to application/json.

+

Content type. It can only be set to application/json.

-
Table 4 Request body parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

fw_instance_id

+

fw_instance_id

Yes

+

Yes

String

+

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

+

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

lts_enable

+

lts_enable

Yes

+

Yes

Integer

+

Integer

Whether to enable LTS: 1 (yes), 0 (no).

+

Whether to enable LTS: 1 (yes), 0 (no). If the parameter is set to 1 then parameters lts_attack_log_stream_enable, lts_access_log_stream_enable, lts_flow_log_stream_enable must be mandatory.

lts_log_group_id

+

lts_log_group_id

Yes

+

Yes

String

+

String

Log Tank Service (LTS) log group ID, which can be obtained by calling the API for querying all the log groups of an account in LTS. Find the value in log_groups.log_group_id (The period [.] is used to separate different levels of objects).

+

Log Tank Service (LTS) log group ID, which can be obtained by calling the API for querying all the log groups of an account in LTS. Find the value in log_groups.log_group_id (The period [.] is used to separate different levels of objects).

lts_attack_log_stream_id

+

lts_attack_log_stream_id

No

+

No

String

+

String

Attack log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

+

Attack log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

lts_attack_log_stream_enable

+

lts_attack_log_stream_enable

No

+

No

Integer

+

Integer

Whether to enable the attack log stream: 1 (yes), 0 (no).

+

Whether to enable the attack log stream: 1 (yes), 0 (no).

lts_access_log_stream_id

+

lts_access_log_stream_id

No

+

No

String

+

String

Access control log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

+

Access control log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

lts_access_log_stream_enable

+

lts_access_log_stream_enable

No

+

No

Integer

+

Integer

Whether to enable the access control stream: 1 (yes), 0 (no).

+

Whether to enable the access control stream: 1 (yes), 0 (no).

lts_flow_log_stream_id

+

lts_flow_log_stream_id

No

+

No

String

+

String

Traffic log ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

+

Traffic log ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

lts_flow_log_stream_enable

+

lts_flow_log_stream_enable

No

+

No

Integer

+

Integer

Whether to enable the traffic log function: 1 (yes), 0 (no).

+

Whether to enable the traffic log function: 1 (yes), 0 (no).

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 5 Response body parameters

Parameter

+
- - - - -
Table 5 Response body parameters

Parameter

Type

+

Type

Description

+

Description

data

+

data

String

+

String

Return value for adding log configurations. The value is the firewall ID.

+

Return value for adding log configurations. The value is the firewall ID.

-

Example Requests

Add log stream configurations for firewall 4d6c860a-0338-49e8-ac64-fcaeb4182ba5 in project 408972e72dcd4c1a9b033e955802a36b. The LTS group ID is 20282428-a8f9-4e75-8246-165e64cf8ba8. The access control log stream, traffic log stream, attack log stream, and LTS are disabled.

-
https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=4d6c860a-0338-49e8-ac64-fcaeb4182ba5&enterprise_project_id=default
+

Example Requests

Add log stream configurations for firewall 4d6c860a-0338-49e8-ac64-fcaeb4182ba5 in project 408972e72dcd4c1a9b033e955802a36b. The LTS group ID is 20282428-a8f9-4e75-8246-165e64cf8ba8. The access control log stream, traffic log stream, attack log stream, and LTS are disabled.

+
https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=4d6c860a-0338-49e8-ac64-fcaeb4182ba5&enterprise_project_id=default
 
 {
   "fw_instance_id" : "4d6c860a-0338-49e8-ac64-fcaeb4182ba5",
@@ -221,29 +221,29 @@
   "lts_flow_log_stream_enable" : 0
 }
-

Example Responses

Status code: 200

-

Return value for adding log configurations.

-
{
+

Example Responses

Status code: 200

+

Return value for adding log configurations.

+
{
   "data" : "4d6c860a-0338-49e8-ac64-fcaeb4182ba5"
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - -

Status Code

Description

+

Description

200

+

200

Return value for adding log configurations.

+

Return value for adding log configurations.

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/cfw/api-ref/AddServiceItems.html b/docs/cfw/api-ref/AddServiceItems.html index 82b336f9a..ab1c3fb76 100644 --- a/docs/cfw/api-ref/AddServiceItems.html +++ b/docs/cfw/api-ref/AddServiceItems.html @@ -1,268 +1,268 @@

Adding Service Group Members

-

Function

This API is used to add service group members in batches.

+

Function

This API is used to add service group members in batches.

-

URI

POST /v1/{project_id}/service-items

+

URI

POST /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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

+

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

+

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

fw_instance_id

+

fw_instance_id

No

+

No

String

+

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

+

Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

+

User token. You can obtain the token by referring to Obtaining a User Token.

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

Content type. It can only be set to application/json.

+

Content type. It can only be set to application/json.

-
Table 4 Request body parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

set_id

+

set_id

Yes

+

Yes

String

+

String

Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

+

Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

service_items

+

service_items

Yes

+

Yes

Array of service_items objects

+

Array of service_items objects

Service group member list.

+

Service group member list.

-
Table 5 service_items

Parameter

+
- - - - - - - - - - - - - - - - - - -
Table 5 service_items

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

protocol

+

protocol

Yes

+

Yes

Integer

+

Integer

Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).

+

Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).

source_port

+

source_port

Yes

+

Yes

String

+

String

Source port.

+

Source port.

dest_port

+

dest_port

Yes

+

Yes

String

+

String

Destination port.

+

Destination port.

description

+

description

No

+

No

String

+

String

Service member description.

+

Service member description.

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 6 Response body parameters

Parameter

+
- - - - -
Table 6 Response body parameters

Parameter

Type

+

Type

Description

+

Description

data

+

data

ServiceItemIds object

+

ServiceItemIds object

Data returned for creating a service group member.

+

Data returned for creating a service group member.

-
Table 7 ServiceItemIds

Parameter

+
- - - - -
Table 7 ServiceItemIds

Parameter

Type

+

Type

Description

+

Description

items

+

items

Array of items objects

+

Array of items objects

List of service group member IDs.

+

List of service group member IDs.

-
Table 8 items

Parameter

+
- - - - -
Table 8 items

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Service group member ID.

+

Service group member ID.

-

Status code: 400

+

Status code: 400

-
Table 9 Response body parameters

Parameter

+
- - - - - - - -
Table 9 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_code

+

error_code

String

+

String

Error code.

+

Error code.

error_msg

+

error_msg

String

+

String

Error description.

+

Error description.

-

Example Requests

Add a service group member named ceshi to project 9d80d070b6d44942af73c9c3d38e0429. The description is Add a service group member.

-
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items
+

Example Requests

Add a service group member named ceshi to project 9d80d070b6d44942af73c9c3d38e0429. The description is Add a service group member.

+
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items
 
 {
   "set_id" : "7cdebed3-af07-494e-a3c2-b88bb8d58b57",
@@ -274,64 +274,64 @@
   } ]
 }
-

Example Responses

Status code: 200

-

Return value for adding service group members.

-
{
+

Example Responses

Status code: 200

+

Return value for adding service group members.

+
{
   "data" : {
     "items" : [ {
       "id" : "cc41c4af-86e8-4ed2-80ad-87d399aeaed0"
     } ]
   }
 }
-

Status code: 400

-

Bad Request

-
{
+

Status code: 400

+

Bad Request

+
{
   "error_code" : "CFW.00200001",
   "error_msg" : "Empty parameter."
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - - - - - - - - - - - -

Status Code

Description

+

Description

200

+

200

Return value for adding service group members.

+

Return value for adding service 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/AddServiceSet.html b/docs/cfw/api-ref/AddServiceSet.html index c9ee0ac13..27ede6517 100644 --- a/docs/cfw/api-ref/AddServiceSet.html +++ b/docs/cfw/api-ref/AddServiceSet.html @@ -1,215 +1,215 @@

Creating a Service Group

-

Function

This API is used to create a service group.

+

Function

This API is used to create a service group.

-

URI

POST /v1/{project_id}/service-set

+

URI

POST /v1/{project_id}/service-set

-
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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

+

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

+

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

fw_instance_id

+

fw_instance_id

No

+

No

String

+

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

+

Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

+

User token. You can obtain the token by referring to Obtaining a User Token.

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

Content type. It can only be set to application/json.

+

Content type. It can only be set to application/json.

-
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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

+

Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

name

+

name

Yes

+

Yes

String

+

String

Service group name.

+

Service group name.

description

+

description

No

+

No

String

+

String

Service group description.

+

Service group description.

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 5 Response body parameters

Parameter

+
- - - - -
Table 5 Response body parameters

Parameter

Type

+

Type

Description

+

Description

data

+

data

ServiceSetId object

+

ServiceSetId object

Data returned for creating a service group.

+

Data returned for creating a service group.

-
Table 6 ServiceSetId

Parameter

+
- - - - - - - -
Table 6 ServiceSetId

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Service group ID.

+

Service group ID.

name

+

name

String

+

String

Service group name.

+

Service group name.

-

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.

+

Error code.

error_msg

+

error_msg

String

+

String

Error description.

+

Error description.

-

Example Requests

Add a service group whose project ID is 9d80d070b6d44942af73c9c3d38e0429, protected object is cfebd347-b655-4b84-b938-3c54317599b2, and name is ceshi.

-
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-set
+

Example Requests

Add a service group whose project ID is 9d80d070b6d44942af73c9c3d38e0429, protected object is cfebd347-b655-4b84-b938-3c54317599b2, and name is ceshi.

+
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-set
 
 {
   "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2",
@@ -217,62 +217,62 @@
   "description" : ""
 }
-

Example Responses

Status code: 200

-

Return value for creating a service group.

-
{
+

Example Responses

Status code: 200

+

Return value for creating a service group.

+
{
   "data" : {
     "id" : "221cfdca-3abf-4c30-ab0d-516a03c70866"
   }
 }
-

Status code: 400

-

Bad Request

-
{
+

Status code: 400

+

Bad Request

+
{
   "error_code" : "CFW.00200024",
   "error_msg" : "Exceeded the upper limit."
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - - - - - - - - - - - -

Status Code

Description

+

Description

200

+

200

Return value for creating a service group.

+

Return value for creating a service group.

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/BatchDeleteAclRules.html b/docs/cfw/api-ref/BatchDeleteAclRules.html index ab4d151bd..27510f612 100644 --- a/docs/cfw/api-ref/BatchDeleteAclRules.html +++ b/docs/cfw/api-ref/BatchDeleteAclRules.html @@ -1,207 +1,207 @@

Deleting ACL Rules in Batches

-

Function

This API is used to delete ACL rules in batches.

+

Function

This API is used to delete ACL rules in batches.

-

URI

DELETE /v1/{project_id}/acl-rule

+

URI

DELETE /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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

+

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

+

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

fw_instance_id

+

fw_instance_id

No

+

No

String

+

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

+

Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

+

User token. You can obtain the token by referring to Obtaining a User Token.

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

Content type. It can only be set to application/json.

+

Content type. It can only be set to application/json.

-
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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

+

Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

rule_ids

+

rule_ids

Yes

+

Yes

Array of strings

+

Array of strings

Rule ID list, which is the ID list transferred when rules are deleted in batches. Rule IDs can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

+

Rule ID list, which is the ID list transferred when rules are deleted in batches. Rule IDs can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 5 Response body parameters

Parameter

+
- - - - -
Table 5 Response body parameters

Parameter

Type

+

Type

Description

+

Description

data

+

data

BatchDeleteAclRulesResponseData object

+

BatchDeleteAclRulesResponseData object

Returned data for deleting ACL rules in batches.

+

Returned data for deleting ACL rules in batches.

-
Table 6 BatchDeleteAclRulesResponseData

Parameter

+
- - - - -
Table 6 BatchDeleteAclRulesResponseData

Parameter

Type

+

Type

Description

+

Description

responseDatas

+

responseDatas

Array of BatchDeleteRuleInfo objects

+

Array of BatchDeleteRuleInfo objects

Data returned when rules are deleted in batches.

+

Data returned when rules are deleted in batches.

-
Table 7 BatchDeleteRuleInfo

Parameter

+
- - - - - - - -
Table 7 BatchDeleteRuleInfo

Parameter

Type

+

Type

Description

+

Description

name

+

name

String

+

String

Names of the ACL rules to be deleted in batches.

+

Names of the ACL rules to be deleted in batches.

id

+

id

String

+

String

IDs of the ACL rules to be deleted in batches.

+

IDs of the ACL rules to be deleted in batches.

-

Example Requests

Delete rules 0475c516-0e41-4caf-990b-0c504eebd73f and 8662868e-fe7e-4dfc-bfb1-ca4d73081ca6 from the protected object ae42418e-f077-41a0-9d3b-5b2f5ad9102b whose project ID is 9d80d070b6d44942af73c9c3d38e0429.

-
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule
+

Example Requests

Delete rules 0475c516-0e41-4caf-990b-0c504eebd73f and 8662868e-fe7e-4dfc-bfb1-ca4d73081ca6 from the protected object ae42418e-f077-41a0-9d3b-5b2f5ad9102b whose project ID is 9d80d070b6d44942af73c9c3d38e0429.

+
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule
 
 {
   "rule_ids" : [ "0475c516-0e41-4caf-990b-0c504eebd73f", "8662868e-fe7e-4dfc-bfb1-ca4d73081ca6" ],
   "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b"
 }
-

Example Responses

Status code: 200

-

Return value for deleting rules in batches.

-
{
+

Example Responses

Status code: 200

+

Return value for deleting rules in batches.

+
{
   "data" : {
     "responseDatas" : [ {
       "name" : "test",
@@ -213,23 +213,23 @@
   }
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - -

Status Code

Description

+

Description

200

+

200

Return value for deleting rules in batches.

+

Return value for deleting rules in batches.

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/cfw/api-ref/BatchDeleteAddressItems.html b/docs/cfw/api-ref/BatchDeleteAddressItems.html index 99508fffa..d7b850887 100644 --- a/docs/cfw/api-ref/BatchDeleteAddressItems.html +++ b/docs/cfw/api-ref/BatchDeleteAddressItems.html @@ -1,182 +1,182 @@

Deleting Address Group Members in Batches

-

Function

This API is used to delete address group members in batches.

+

Function

This API is used to delete address group members in batches.

-

URI

DELETE /v1/{project_id}/address-items

+

URI

DELETE /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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

+

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

+

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

fw_instance_id

+

fw_instance_id

No

+

No

String

+

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

+

Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

+

User token. You can obtain the token by referring to Obtaining a User Token.

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

Content type. It can only be set to application/json.

+

Content type. It can only be set to application/json.

-
Table 4 Request body parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

set_id

+

set_id

Yes

+

Yes

String

+

String

Address group ID, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

+

Address group ID, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

address_item_ids

+

address_item_ids

Yes

+

Yes

Array of strings

+

Array of strings

List of address group member IDs. Address group member IDs can be obtained by calling the API for querying address group members. Find the value in data.records.item_id (The period [.] is used to separate different levels of objects).

+

List of address group member IDs. Address group member IDs can be obtained by calling the API for querying address group members. Find the value in data.records.item_id (The period [.] is used to separate different levels of objects).

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 5 Response body parameters

Parameter

+
- - - - -
Table 5 Response body parameters

Parameter

Type

+

Type

Description

+

Description

data

+

data

Array of strings

+

Array of strings

ID list of the address group members to be deleted in batches.

+

ID list of the address group members to be deleted in batches.

-

Example Requests

Delete address group member d072ad2e-033c-40a9-b0b5-751f9c2943a6 from address group e4884376-7efb-40e7-b98b-13668d6f8b85 in project 9d80d070b6d44942af73c9c3d38e0429.

-
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default
+

Example Requests

Delete address group member d072ad2e-033c-40a9-b0b5-751f9c2943a6 from address group e4884376-7efb-40e7-b98b-13668d6f8b85 in project 9d80d070b6d44942af73c9c3d38e0429.

+
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default
 
 {
   "set_id" : "e4884376-7efb-40e7-b98b-13668d6f8b85",
   "address_item_ids" : [ "d072ad2e-033c-40a9-b0b5-751f9c2943a6" ]
 }
-

Example Responses

Status code: 200

-

Return value for deleting address group members in batches.

-
{
+

Example Responses

Status code: 200

+

Return value for deleting address group members in batches.

+
{
   "data" : [ "d072ad2e-033c-40a9-b0b5-751f9c2943a6" ]
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - -

Status Code

Description

+

Description

200

+

200

Return value for deleting address group members in batches.

+

Return value for deleting address group members in batches.

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/cfw/api-ref/BatchDeleteServiceItems.html b/docs/cfw/api-ref/BatchDeleteServiceItems.html index fb8f24c4c..049e93270 100644 --- a/docs/cfw/api-ref/BatchDeleteServiceItems.html +++ b/docs/cfw/api-ref/BatchDeleteServiceItems.html @@ -1,220 +1,220 @@

Deleting Service Group Members in Batches

-

Function

This API is used to delete service group members in batches.

+

Function

This API is used to delete service group members in batches.

-

URI

DELETE /v1/{project_id}/service-items

+

URI

DELETE /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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

+

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

+

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

fw_instance_id

+

fw_instance_id

No

+

No

String

+

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

+

Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

+

User token. You can obtain the token by referring to Obtaining a User Token.

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

Content type. It can only be set to application/json.

+

Content type. It can only be set to application/json.

-
Table 4 Request body parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

set_id

+

set_id

Yes

+

Yes

String

+

String

Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

+

Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

service_item_ids

+

service_item_ids

Yes

+

Yes

Array of strings

+

Array of strings

List of service group member IDs. Service group member IDs can be obtained by calling the API for querying the service group member list. Find the value in data.records.item_id (The period [.] is used to separate different levels of objects).

+

List of service group member IDs. Service group member IDs can be obtained by calling the API for querying the service group member list. Find the value in data.records.item_id (The period [.] is used to separate different levels of objects).

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 5 Response body parameters

Parameter

+
- - - - -
Table 5 Response body parameters

Parameter

Type

+

Type

Description

+

Description

data

+

data

Array of strings

+

Array of strings

ID list of the service group members to be deleted in batches.

+

ID list of the service group members to be deleted in batches.

-

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.

+

Error code.

error_msg

+

error_msg

String

+

String

Error description.

+

Error description.

-

Example Requests

Delete service group member f837f7ae-22c9-449d-a99c-4be24533e243 from service group 688faf62-20fc-4ca6-b9f9-6fbc518df5ae in project 9d80d070b6d44942af73c9c3d38e0429.

-
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default
+

Example Requests

Delete service group member f837f7ae-22c9-449d-a99c-4be24533e243 from service group 688faf62-20fc-4ca6-b9f9-6fbc518df5ae in project 9d80d070b6d44942af73c9c3d38e0429.

+
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default
 
 {
   "set_id" : "688faf62-20fc-4ca6-b9f9-6fbc518df5ae",
   "service_item_ids" : [ "f837f7ae-22c9-449d-a99c-4be24533e243" ]
 }
-

Example Responses

Status code: 200

-

Return value for deleting service group members in batches.

-
{
+

Example Responses

Status code: 200

+

Return value for deleting service group members in batches.

+
{
   "data" : [ "f837f7ae-22c9-449d-a99c-4be24533e243" ]
 }
-

Status code: 400

-

Bad Request

-
{
+

Status code: 400

+

Bad Request

+
{
   "error_code" : "CFW.00200005",
   "error_msg" : "Object not found."
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - - - -

Status Code

Description

+

Description

200

+

200

Return value for deleting service group members in batches.

+

Return value for deleting service group members in batches.

400

+

400

Bad Request

+

Bad Request

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/cfw/api-ref/BatchUpdateAclRuleActions.html b/docs/cfw/api-ref/BatchUpdateAclRuleActions.html index c71eccf3c..9e60791e0 100644 --- a/docs/cfw/api-ref/BatchUpdateAclRuleActions.html +++ b/docs/cfw/api-ref/BatchUpdateAclRuleActions.html @@ -1,162 +1,162 @@

Updating Rule Actions in Batches

-

Function

This API is used to update rule actions in batches.

+

Function

This API is used to update rule actions in batches.

-

URI

PUT /v1/{project_id}/acl-rule/action

+

URI

PUT /v1/{project_id}/acl-rule/action

-
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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

+

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

+

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

fw_instance_id

+

fw_instance_id

No

+

No

String

+

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

+

Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

+

User token. You can obtain the token by referring to Obtaining a User Token.

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

Content type. It can only be set to application/json.

+

Content type. It can only be set to application/json.

-
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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

+

Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

action

+

action

Yes

+

Yes

String

+

String

Rule action: enable (permit), disable (deny).

+

Rule action: enable (permit), disable (deny).

rule_ids

+

rule_ids

Yes

+

Yes

Array of strings

+

Array of strings

List of rule IDs. You can obtain the rule IDs by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

+

List of rule IDs. You can obtain the rule IDs by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 5 Response body parameters

Parameter

+
- - - - -
Table 5 Response body parameters

Parameter

Type

+

Type

Description

+

Description

data

+

data

Array of strings

+

Array of strings

IDs of ACL rules to be updated in batches. The value is the rule IDs transferred from the request body.

+

IDs of ACL rules to be updated in batches. The value is the rule IDs transferred from the request body.

-

Example Requests

Update the statuses of rules 4e12d889-c1d3-491b-8470-3d1b3dadc1fd and f798a6a8-c4c5-42b4-838c-c922c9908cb4 of firewall 546af3f8-88e9-47f2-a205-2346d7090925 in project 14181c1245cf4fd786824efe1e2b9388 to enabled.

-
https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/acl-rule/action?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default
+

Example Requests

Update the statuses of rules 4e12d889-c1d3-491b-8470-3d1b3dadc1fd and f798a6a8-c4c5-42b4-838c-c922c9908cb4 of firewall 546af3f8-88e9-47f2-a205-2346d7090925 in project 14181c1245cf4fd786824efe1e2b9388 to enabled.

+
https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/acl-rule/action?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default
 
 {
   "action" : "enable",
@@ -164,29 +164,29 @@
   "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b"
 }
-

Example Responses

Status code: 200

-

Returned value for batch ACL rule update.

-
{
+

Example Responses

Status code: 200

+

Returned value for batch ACL rule update.

+
{
   "data" : [ "4e12d889-c1d3-491b-8470-3d1b3dadc1fd", "f798a6a8-c4c5-42b4-838c-c922c9908cb4" ]
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - -

Status Code

Description

+

Description

200

+

200

Returned value for batch ACL rule update.

+

Returned value for batch ACL rule update.

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/cfw/api-ref/CLASS.TXT.json b/docs/cfw/api-ref/CLASS.TXT.json index 6d88e3f0e..3c30c0c4f 100644 --- a/docs/cfw/api-ref/CLASS.TXT.json +++ b/docs/cfw/api-ref/CLASS.TXT.json @@ -612,7 +612,7 @@ "code":"68" }, { - "desc":"This API is used to enable or disable the feature.POST /v1/{project_id}/ips/switchStatus code: 200Enable or disable the basic patch and virtual patch of the engine on the", + "desc":"This API is used to enable or disable the feature.POST /v1/{project_id}/ips/switchStatus code: 200API used for toggling IPS. It is used to enable or disable the basic pat", "product_code":"cfw", "title":"Changing the IPS Feature Status", "uri":"ChangeIpsSwitchStatus.html", @@ -747,7 +747,7 @@ "code":"83" }, { - "desc":"A firewall ID (fw_instance_Id) is a CFW instance ID. It is automatically generated by the system after CFW is created.You can obtain the value by calling the API for Toke", + "desc":"A firewall ID (fw_instance_Id) is a CFW instance ID. It is automatically generated by the system after CFW is created.You can obtain the value by calling the API for Quer", "product_code":"cfw", "title":"Obtaining a Firewall ID", "uri":"cfw_02_0028.html", diff --git a/docs/cfw/api-ref/ChangeEastWestFirewallStatus.html b/docs/cfw/api-ref/ChangeEastWestFirewallStatus.html index 5758296b3..894466de4 100644 --- a/docs/cfw/api-ref/ChangeEastWestFirewallStatus.html +++ b/docs/cfw/api-ref/ChangeEastWestFirewallStatus.html @@ -1,261 +1,261 @@

Changing the East-West Firewall Protection Status

-

Function

This API is used to enable or disable east-west protection.

+

Function

This API is used to enable or disable east-west protection.

-

URI

POST /v1/{project_id}/firewall/east-west/protect

+

URI

POST /v1/{project_id}/firewall/east-west/protect

-
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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

+

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

+

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

fw_instance_id

+

fw_instance_id

No

+

No

String

+

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

+

Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

+

User token. You can obtain the token by referring to Obtaining a User Token.

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

Content type. It can only be set to application/json.

+

Content type. It can only be set to application/json.

-
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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 1 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

+

Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 1 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

status

+

status

Yes

+

Yes

Integer

+

Integer

Protection status: 0 (enabled), 1 (disabled).

+

Protection status: 0 (enabled), 1 (disabled).

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 5 Response body parameters

Parameter

+
- - - - -
Table 5 Response body parameters

Parameter

Type

+

Type

Description

+

Description

data

+

data

ChangeEastWestFirewallStatusResponseData object

+

ChangeEastWestFirewallStatusResponseData object

Data returned for modifying east-west protection.

+

Data returned for modifying east-west protection.

-
Table 6 ChangeEastWestFirewallStatusResponseData

Parameter

+
- - - - -
Table 6 ChangeEastWestFirewallStatusResponseData

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

East-west protected object ID, which can be obtained by calling the API for querying a firewall instance. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). Note that type indicates the protected object type. 0 indicates the ID of a protected object at the Internet border, 1 indicates the ID of a protected object at the VPC border. Here, a protected object ID whose type is 1 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

+

East-west protected object ID, which can be obtained by calling the API for querying a firewall instance. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). Note that type indicates the protected object type. 0 indicates the ID of a protected object at the Internet border, 1 indicates the ID of a protected object at the VPC border. Here, a protected object ID whose type is 1 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

-

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.

+

Error code.

error_msg

+

error_msg

String

+

String

Error description.

+

Error description.

-

Example Requests

In the project with the ID 09bb24e6fe80d23d2fa2c010b53b418c, enable east-west firewall protection for the object with the ID 74820b38-1cc0-4f0b-8cce-32490fa840a3.

-
https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/firewall/east-west/protect
+

Example Requests

In the project with the ID 09bb24e6fe80d23d2fa2c010b53b418c, enable east-west firewall protection for the object with the ID 74820b38-1cc0-4f0b-8cce-32490fa840a3.

+
https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/firewall/east-west/protect
 
 {
   "object_id" : "74820b38-1cc0-4f0b-8cce-32490fa840a3",
   "status" : 1
 }
-

Example Responses

Status code: 200

-

Response body for updating the east-west protection status.

-
{
+

Example Responses

Status code: 200

+

Response body for updating the east-west protection status.

+
{
   "data" : {
     "id" : "5c539816-7a94-4833-9df0-944b362f0797"
   }
 }
-

Status code: 400

-

Bad Request

-
{
+

Status code: 400

+

Bad Request

+
{
   "error_code" : "CFW.00200005",
   "error_msg" : "Object not found."
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - - - - - - - - - - - -

Status Code

Description

+

Description

200

+

200

Response body for updating the east-west protection status.

+

Response body for updating the east-west protection status.

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/ChangeEipStatus.html b/docs/cfw/api-ref/ChangeEipStatus.html index a66b917c7..d1dfd5689 100644 --- a/docs/cfw/api-ref/ChangeEipStatus.html +++ b/docs/cfw/api-ref/ChangeEipStatus.html @@ -1,295 +1,296 @@

Enabling or Disabling EIP Protection

-

Function

This API is used to enable or disable EIP protection. After a customer purchases an EIP, the customer needs to call ListEips to synchronize EIPs asset before enabling EIP protection for the first time. The sync field should be set to 1.

+

Function

This API is used to enable or disable EIP protection. After a customer purchases an EIP, the customer needs to call ListEips to synchronize EIPs asset before enabling EIP protection for the first time. The sync field should be set to 1.

-

URI

POST /v1/{project_id}/eip/protect

+

URI

POST /v1/{project_id}/eip/protect

-
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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

+

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

+

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

fw_instance_id

+

fw_instance_id

No

+

No

String

+

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

+

Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

+

User token. You can obtain the token by referring to Obtaining a User Token.

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

Content type. It can only be set to application/json.

+

Content type. It can only be set to application/json.

-
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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 0 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

+

Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 0 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

status

+

status

Yes

+

Yes

Integer

+

Integer

Status that an EIP will be changed to: 0 (protected), 1 (unprotected).

+

Status that an EIP will be changed to: 0 (protected), 1 (unprotected).

ip_infos

+

ip_infos

Yes

+

Yes

Array of ip_infos objects

+

Array of ip_infos objects

List of EIPs whose protection status is changed.

+

List of EIPs whose protection status is changed.

-
Table 5 ip_infos

Parameter

+
- - - - - - - - - - - - - - -
Table 5 ip_infos

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

id

+

id

No

+

No

String

+

String

EIP ID, which can be obtained by calling the API for querying the EIP list. Find the value in data.records.id (The period [.] is used to separate different levels of objects).

+

EIP ID, which can be obtained by calling the API for querying the EIP list. Find the value in data.records.id (The period [.] is used to separate different levels of objects).

public_ip

+

public_ip

No

+

No

String

+

String

EIP IPv4 address, which can be obtained by calling the API for querying the EIP list. Find the value in data.records.public_ip (The period [.] is used to separate different levels of objects).

+

EIP IPv4 address, which can be obtained by calling the API for querying the EIP list. Find the value in data.records.public_ip (The period [.] is used to separate different levels of objects).

public_ipv6

+

public_ipv6

No

+

No

String

+

String

EIP IPv6 address, which can be obtained by calling the API for querying the EIP list. Find the value in data.records.public_ipv6 (The period [.] is used to separate different levels of objects).

+

EIP IPv6 address, which can be obtained by calling the API for querying the EIP list. Find the value in data.records.public_ipv6 (The period [.] is used to separate different levels of objects).

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 6 Response body parameters

Parameter

+
- - - - -
Table 6 Response body parameters

Parameter

Type

+

Type

Description

+

Description

data

+

data

EIPSwitchStatusVO object

+

EIPSwitchStatusVO object

Data returned for changing the EIP protection status.

+

Data returned for changing the EIP protection status.

-
Table 7 EIPSwitchStatusVO

Parameter

+
- - - - - - - - - - - - - -
Table 7 EIPSwitchStatusVO

Parameter

Type

+

Type

Description

+

Description

object_id

+

object_id

String

+

String

Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 0 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

+

Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 0 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

fail_eip_id_list

+

fail_eip_id_list

Array of strings

+

Array of strings

List of EIP protection statuses that fail to be modified. The status can be successful or fail.

+

List of EIP protection statuses that fail to be modified. The status can be successful or fail.

fail_eip_list

+

fail_eip_list

Array of FailedEipInfo objects

+

Array of FailedEipInfo objects

List of failures to modify the EIP protection status.

+

List of failures to modify the EIP protection status.

id

+

id

String

+

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

+

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

-
Table 8 FailedEipInfo

Parameter

+
- - - - - - - -
Table 8 FailedEipInfo

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

ID of an EIP whose status fails to be changed.

+

ID of an EIP whose status fails to be changed.

error_message

+

error_message

String

+

String

Error code of a status change failure.

+

Error code of a status change failure.

-

Status code: 400

+

Status code: 400

-
Table 9 Response body parameters

Parameter

+
- - - - - - - -
Table 9 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_code

+

error_code

String

+

String

Error code.

+

Error code.

error_msg

+

error_msg

String

+

String

Error description.

+

Error description.

-

Example Requests

  • Enable traffic protection for the EIP (1.2.3.4) whose EIP ID is 4a589be0-b40a-4694-94ff-c0710af9a0a2, project ID is 857ddec2-55f2-4503-a93a-fe70021b743c, and protected object ID is 6d3db4fd-fd58-4d8e-914b-ef91aa268f62.
    https://{Endpoint}/v1/857ddec2-55f2-4503-a93a-fe70021b743c/eip/protect
    +

    Example Requests

    • Enable traffic protection for the EIP (1.2.3.4) whose EIP ID is 4a589be0-b40a-4694-94ff-c0710af9a0a2, project ID is 857ddec2-55f2-4503-a93a-fe70021b743c, and protected object ID is 6d3db4fd-fd58-4d8e-914b-ef91aa268f62.

      +
      https://{Endpoint}/v1/857ddec2-55f2-4503-a93a-fe70021b743c/eip/protect
       
       {
         "object_id" : "6d3db4fd-fd58-4d8e-914b-ef91aa268f62",
      @@ -299,7 +300,8 @@
           "public_ip" : "1.2.3.4"
         } ]
       }
      -
    • Disable traffic protection for the EIP (1.2.3.4) whose EIP ID is 4a589be0-b40a-4694-94ff-c0710af9a0a2, project ID is 857ddec2-55f2-4503-a93a-fe70021b743c, and protected object ID is 6d3db4fd-fd58-4d8e-914b-ef91aa268f62.
      /v1/857ddec2-55f2-4503-a93a-fe70021b743c/eip/protect
      +
    • Disable traffic protection for the EIP (1.2.3.4) whose EIP ID is 4a589be0-b40a-4694-94ff-c0710af9a0a2, project ID is 857ddec2-55f2-4503-a93a-fe70021b743c, and protected object ID is 6d3db4fd-fd58-4d8e-914b-ef91aa268f62.

      +
      /v1/857ddec2-55f2-4503-a93a-fe70021b743c/eip/protect
       
       {
         "object_id" : "6d3db4fd-fd58-4d8e-914b-ef91aa268f62",
      @@ -311,9 +313,9 @@
       }
    -

    Example Responses

    Status code: 200

    -

    Return value for enabling or disabling EIP protection.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for enabling or disabling EIP protection.

    +
    {
       "data": {
         "fail_eip_id_list": [],
         "fail_eip_list": [],
    @@ -321,48 +323,48 @@
         "id": "b0a2dacc-3886-4805-838e-281653d3cd1f"
       }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for enabling or disabling EIP protection.

    +

    Return value for enabling or disabling EIP protection.

    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/ChangeIpsProtectMode.html b/docs/cfw/api-ref/ChangeIpsProtectMode.html index 015df07e2..6ea21d024 100644 --- a/docs/cfw/api-ref/ChangeIpsProtectMode.html +++ b/docs/cfw/api-ref/ChangeIpsProtectMode.html @@ -1,261 +1,261 @@

    Changing the Protection Mode

    -

    Function

    This API is used to change the protection mode.

    +

    Function

    This API is used to change the protection mode.

    -

    URI

    POST /v1/{project_id}/ips/protect

    +

    URI

    POST /v1/{project_id}/ips/protect

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    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 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.

    +

    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 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.

    mode

    +

    mode

    Yes

    +

    Yes

    Integer

    +

    Integer

    IPS protection mode: 0 (observation mode), 1 (strict mode), 2 (medium mode), or 3 (loose mode).

    +

    IPS protection mode: 0 (observation mode), 1 (strict mode), 2 (medium mode), or 3 (loose mode).

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 5 Response body parameters

    Parameter

    +
    - - - - -
    Table 5 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    data

    +

    data

    data object

    +

    data object

    Response body.

    +

    Response body.

    -
    Table 6 data

    Parameter

    +
    - - - - -
    Table 6 data

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    ID information.

    +

    ID information.

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Set the protection mode to Interception mode - strict for the protected object whose ID is cfebd347-b655-4b84-b938-3c54317599b2 in the project 9d80d070b6d44942af73c9c3d38e0429.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/ips/protect
    +

    Example Requests

    Set the protection mode to Interception mode - strict for the protected object whose ID is cfebd347-b655-4b84-b938-3c54317599b2 in the project 9d80d070b6d44942af73c9c3d38e0429.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/ips/protect
     
     {
       "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2",
       "mode" : 1
     }
    -

    Example Responses

    Status code: 200

    -

    Request body for modifying the IPS protection mode.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Request body for modifying the IPS protection mode.

    +
    {
       "data" : {
         "id" : "cfebd347-b655-4b84-b938-3c54317599b2"
       }
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

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

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request body for modifying the IPS protection mode.

    +

    Request body for modifying the IPS protection mode.

    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/ChangeIpsSwitchStatus.html b/docs/cfw/api-ref/ChangeIpsSwitchStatus.html index 26f5e7513..fbec0c72b 100644 --- a/docs/cfw/api-ref/ChangeIpsSwitchStatus.html +++ b/docs/cfw/api-ref/ChangeIpsSwitchStatus.html @@ -1,233 +1,233 @@

    Changing the IPS Feature Status

    -

    Function

    This API is used to enable or disable the feature.

    +

    Function

    This API is used to enable or disable the feature.

    -

    URI

    POST /v1/{project_id}/ips/switch

    +

    URI

    POST /v1/{project_id}/ips/switch

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 0 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    +

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 0 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    ips_type

    +

    ips_type

    Yes

    +

    Yes

    Integer

    +

    Integer

    Patch type. Its value can only be 2 (virtual patch).

    +

    Patch type. Its value can only be 2 (virtual patch).

    status

    +

    status

    Yes

    +

    Yes

    Integer

    +

    Integer

    IPS feature status: 0 (disabled), 1 (enabled).

    +

    IPS feature status: 0 (disabled), 1 (enabled).

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 5 Response body parameters

    Parameter

    +
    - - - - -
    Table 5 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    data

    +

    data

    data object

    +

    data object

    Response body.

    +

    Response body.

    -
    Table 6 data

    Parameter

    +
    - - - - -
    Table 6 data

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    ID information.

    +

    ID information.

    -

    Example Requests

    Enable or disable the basic patch and virtual patch of the engine on the user side. The following example shows how to enable the basic patch function for protected object 1530de8a-522d-4771-9067-9fa4e2f53b48 whose project ID is 14181c1245cf4fd786824efe1e2b9388.

    -
    https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/ips/switch?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default
    +

    Example Requests

    API used for toggling IPS. It is used to enable or disable the basic patch and virtual patch of the engine on the user side. The following example shows how to enable the virtual patch function for protected object 1530de8a-522d-4771-9067-9fa4e2f53b48 whose project ID is 14181c1245cf4fd786824efe1e2b9388.

    +
    https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/ips/switch?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default
     
     {
    -  "ips_type" : 1,
    +  "ips_type" : 2,
       "object_id" : "1530de8a-522d-4771-9067-9fa4e2f53b48",
       "status" : 1
     }
    -

    Example Responses

    Status code: 200

    -

    Return value for changing the IPS feature status.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for changing the IPS feature status.

    +
    {
       "data" : {
         "id" : "1530de8a-522d-4771-9067-9fa4e2f53b48"
       }
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for changing the IPS feature status.

    +

    Return value for changing the IPS feature status.

    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/CreateEastWestFirewall.html b/docs/cfw/api-ref/CreateEastWestFirewall.html index 6b8f24c8b..166deab14 100644 --- a/docs/cfw/api-ref/CreateEastWestFirewall.html +++ b/docs/cfw/api-ref/CreateEastWestFirewall.html @@ -1,297 +1,297 @@

    Creating an East-West Firewall

    -

    Function

    This API is used to create an east-west firewall.

    +

    Function

    This API is used to create an east-west firewall.

    -

    URI

    POST /v1/{project_id}/firewall/east-west

    +

    URI

    POST /v1/{project_id}/firewall/east-west

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    Yes

    +

    Yes

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    Table 4 Request body parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    er_id

    +

    er_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the associated enterprise router in the outbound direction, which can be obtained by calling the API for querying the enterprise router list of the Enterprise Router service. Find the enterprise router ID in instances.id (The period [.] is used to separate different levels of objects).

    +

    ID of the associated enterprise router in the outbound direction, which can be obtained by calling the API for querying the enterprise router list of the Enterprise Router service. Find the enterprise router ID in instances.id (The period [.] is used to separate different levels of objects).

    inspection_vpc_id

    +

    inspection_vpc_id

    No

    +

    No

    String

    +

    String

    Traffic diversion VPC ID.

    +

    Inspection VPC ID.

    er_associated_subnet

    +

    er_associated_subnet

    No

    +

    No

    AssociatedSubnet object

    +

    AssociatedSubnet object

    Subnet associated with an enterprise router.

    +

    Subnet associated with an enterprise router.

    firewall_associated_subnets

    +

    firewall_associated_subnets

    No

    +

    No

    Array of AssociatedSubnet objects

    +

    Array of AssociatedSubnet objects

    List of subnets associated with a firewall.

    +

    List of subnets associated with a firewall.

    -
    Table 5 AssociatedSubnet

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 5 AssociatedSubnet

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    az

    +

    az

    Yes

    +

    Yes

    String

    +

    String

    AZ.

    +

    AZ.

    subnet_segment

    +

    subnet_segment

    Yes

    +

    Yes

    String

    +

    String

    Subnet CIDR block.

    +

    Subnet CIDR block.

    subnet_name

    +

    subnet_name

    Yes

    +

    Yes

    String

    +

    String

    Subnet name.

    +

    Subnet name.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 6 Response body parameters

    Parameter

    +
    - - - - -
    Table 6 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    data

    +

    data

    CreateEWFirewallResp object

    +

    CreateEWFirewallResp object

    Return value for creating an east-west firewall.

    +

    Return value for creating an east-west firewall.

    -
    Table 7 CreateEWFirewallResp

    Parameter

    +
    - - - - - - - - - - -
    Table 7 CreateEWFirewallResp

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    East-west protection ID, corresponding to the object_id field.

    +

    East-west protection ID, corresponding to the object_id field.

    er

    +

    er

    ER object

    +

    ER object

    Enterprise router information.

    +

    Enterprise router information.

    inspertion_vpc

    +

    inspertion_vpc

    CreateEWFirewallInspectVpcResp object

    +

    CreateEWFirewallInspectVpcResp object

    Information about the traffic diversion VPC.

    +

    Information about the inspection VPC.

    -
    Table 8 ER

    Parameter

    +
    - - - - - - - -
    Table 8 ER

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    er_id

    +

    er_id

    String

    +

    String

    Enterprise router ID, which is referenced when east-west protection is created.

    +

    Enterprise router ID, which is referenced when east-west protection is created.

    er_attach_id

    +

    er_attach_id

    String

    +

    String

    Connection ID of an enterprise router. This connection is used to connect the firewall and the enterprise router. This field can be used to obtain the connection details on the connection management page after querying a specified enterprise router by its ID on the Enterprise Router page.

    +

    Connection ID of an enterprise router. This connection is used to connect the firewall and the enterprise router. This field can be used to obtain the connection details on the connection management page after querying a specified enterprise router by its ID on the Enterprise Router page.

    -
    Table 9 CreateEWFirewallInspectVpcResp

    Parameter

    +
    - - - - - - - -
    Table 9 CreateEWFirewallInspectVpcResp

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    vpc_id

    +

    vpc_id

    String

    +

    String

    ID of a traffic diversion VPC.

    +

    ID of a inspection VPC.

    subnet_ids

    +

    subnet_ids

    Array of strings

    +

    Array of strings

    Subnet ID list of the created traffic diversion VPC.

    +

    Subnet ID list of the created inspection VPC.

    -

    Example Requests

    Under firewall 55b26ab5-e4b0-40e8-941c-a1778fe2a500 in project 09bb24e6f280d23d0f9fc0104b901480, create a firewall in enterprise router mode. The enterprise router ID is 0eb296a4-aa9b-493e-b58a-ce993a16edfc, the traffic diversion VPC is 0eb296a4-aa9b-493e-b58a-ce993a16edfd, the subnets associated with the firewall are fw-subnet and cfw-subnet, and the subnet associated with the enterprise router is er-subnet.

    -
    https://{Endpoint}/v1/09bb24e6f280d23d0f9fc0104b901480/firewall/east-west?fw_instance_id=55b26ab5-e4b0-40e8-941c-a1778fe2a500&enterprise_project_id=default
    +

    Example Requests

    Under firewall 55b26ab5-e4b0-40e8-941c-a1778fe2a500 in project 09bb24e6f280d23d0f9fc0104b901480, create a firewall in enterprise router mode. The enterprise router ID is 0eb296a4-aa9b-493e-b58a-ce993a16edfc, the inspection VPC is 0eb296a4-aa9b-493e-b58a-ce993a16edfd, the subnets associated with the firewall are fw-subnet and cfw-subnet, and the subnet associated with the enterprise router is er-subnet.

    +
    https://{Endpoint}/v1/09bb24e6f280d23d0f9fc0104b901480/firewall/east-west?fw_instance_id=55b26ab5-e4b0-40e8-941c-a1778fe2a500&enterprise_project_id=default
     
     {
       "er_associated_subnet" : {
    @@ -312,9 +312,9 @@
       "inspection_vpc_id" : "0eb296a4-aa9b-493e-b58a-ce993a16edfd"
     }
    -

    Example Responses

    Status code: 200

    -

    Return value for creating an east-west firewall.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for creating an east-west firewall.

    +
    {
       "data" : {
         "id" : "acc86ca7-818b-4c3d-8a9a-3915a2b21651",
         "er" : {
    @@ -328,23 +328,23 @@
       }
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for creating an east-west firewall.

    +

    Return value for creating an east-west firewall.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/cfw/api-ref/CreateFirewall.html b/docs/cfw/api-ref/CreateFirewall.html index db4dde9b8..b4192a509 100644 --- a/docs/cfw/api-ref/CreateFirewall.html +++ b/docs/cfw/api-ref/CreateFirewall.html @@ -1,388 +1,452 @@

    Creating a Firewall

    -

    Function

    This API is used to create a firewall.

    +

    Function

    This API is used to create a firewall.

    -

    URI

    POST /v2/{project_id}/firewall

    +

    URI

    POST /v2/{project_id}/firewall

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    -

    Request Parameters

    -
    Table 2 Request header parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - - - - - - - - - -
    Table 2 Request header parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    X-Auth-Token

    +

    X-Auth-Token

    Yes

    +

    Yes

    String

    +

    String

    User token. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    X-Client-Token

    +

    X-Client-Token

    No

    +

    No

    String

    +

    String

    Identifier that ensures idempotency of client requests.

    -

    It is a 32-bit UUID and is generated by the client. The value must be unique.

    +

    Identifier that ensures idempotency of client requests.

    +

    It is a 32-bit UUID and is generated by the client. The value must be unique.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    Table 3 Request body parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - -
    Table 3 Request body parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    name

    +

    name

    Yes

    +

    Yes

    String

    +

    String

    Firewall name.

    +

    Firewall name.

    enterprise_project_id

    +

    enterprise_project_id

    No

    +

    No

    String

    +

    String

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    tags

    +

    tags

    No

    +

    No

    Array of tags objects

    +

    Array of tags objects

    List of service resource tags. After tags are added to firewall resources, you can query resources and combine CDRs by key and value.

    +

    List of service resource tags. After tags are added to firewall resources, you can query resources and combine CDRs by key and value.

    flavor

    +

    flavor

    Yes

    +

    Yes

    flavor object

    +

    flavor object

    Firewall specifications.

    +

    Firewall specifications.

    charge_info

    +

    charge_info

    Yes

    +

    Yes

    charge_info object

    +

    charge_info object

    Billing type, which can be yearly/monthly or pay-per-use (default setting).

    +

    Billing type, which can be yearly/monthly or pay-per-use (default setting).

    -
    Table 4 tags

    Parameter

    +
    - - - - - - - - - - -
    Table 4 tags

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    key

    +

    key

    No

    +

    No

    String

    +

    String

    Resource tag key.

    +

    Resource tag key.

    value

    +

    value

    No

    +

    No

    String

    +

    String

    Resource tag value.

    +

    Resource tag value.

    -
    Table 5 flavor

    Parameter

    +
    - - - - - - -
    Table 5 flavor

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    version

    +

    version

    Yes

    +

    Yes

    String

    +

    String

    Firewall edition. Only the professional edition is supported.

    +

    Firewall edition. Only the professional edition is supported.

    -
    Table 6 charge_info

    Parameter

    +
    - - - - - - - + + + + + + + + + + + + + + + + + + + +
    Table 6 charge_info

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    charge_mode

    +

    charge_mode

    Yes

    +

    Yes

    String

    +

    String

    Billing mode. The value can only be postPaid, indicating pay-per-use billing.

    +

    Billing mode. The value can only be postPaid, indicating pay-per-use billing.

    +

    period_type

    +

    No

    +

    String

    +

    Leave it blank.

    +

    period_num

    +

    No

    +

    String

    +

    Leave it blank.

    +

    is_auto_renew

    +

    No

    +

    String

    +

    Leave it blank.

    +

    is_auto_pay

    +

    No

    +

    String

    +

    Leave it blank.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 7 Response body parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 7 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    job_id

    +

    job_id

    String

    +

    String

    Instance creation task ID. This parameter is returned only when pay-per-use instances are created.

    +

    Instance creation task ID. This parameter is returned only when pay-per-use instances are created.

    order_id

    +

    order_id

    String

    +

    String

    Order ID. This parameter is returned only when yearly/monthly instances are created.

    +

    Order ID. This parameter is returned only when yearly/monthly instances are created.

    data

    +

    data

    CreateFirewallReq object

    +

    CreateFirewallReq object

    Request body for creating a firewall.

    +

    Request body for creating a firewall.

    -
    Table 8 CreateFirewallReq

    Parameter

    +
    - - - - - - - - - - - - - - - - -
    Table 8 CreateFirewallReq

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    name

    +

    name

    String

    +

    String

    Firewall name.

    +

    Firewall name.

    enterprise_project_id

    +

    enterprise_project_id

    String

    +

    String

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    tags

    +

    tags

    Array of tags objects

    +

    Array of tags objects

    List of service resource tags. After tags are added to firewall resources, you can query resources and combine CDRs by key and value.

    +

    List of service resource tags. After tags are added to firewall resources, you can query resources and combine CDRs by key and value.

    flavor

    +

    flavor

    flavor object

    +

    flavor object

    Firewall specifications.

    +

    Firewall specifications.

    charge_info

    +

    charge_info

    charge_info object

    +

    charge_info object

    Billing type, which can be yearly/monthly or pay-per-use (default setting).

    +

    Billing type, which can be yearly/monthly or pay-per-use (default setting).

    -
    Table 9 tags

    Parameter

    +
    - - - - - - - -
    Table 9 tags

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    key

    +

    key

    String

    +

    String

    Resource tag key.

    +

    Resource tag key.

    value

    +

    value

    String

    +

    String

    Resource tag value.

    +

    Resource tag value.

    -
    Table 10 flavor

    Parameter

    +
    - - - - -
    Table 10 flavor

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    version

    +

    version

    String

    +

    String

    Firewall edition. Only the professional edition is supported.

    +

    Firewall edition. Only the professional edition is supported.

    -
    Table 11 charge_info

    Parameter

    +
    - - - - - + + + + + + + + + + + + + + + +
    Table 11 charge_info

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    charge_mode

    +

    charge_mode

    String

    +

    String

    Billing mode. The value can only be postPaid, indicating pay-per-use billing.

    +

    Billing mode. The value can only be postPaid, indicating pay-per-use billing.

    +

    period_type

    +

    String

    +

    Leave it blank.

    +

    period_num

    +

    String

    +

    Leave it blank.

    +

    is_auto_renew

    +

    String

    +

    Leave it blank.

    +

    is_auto_pay

    +

    String

    +

    Leave it blank.

    -

    Status code: 400

    +

    Status code: 400

    -
    Table 12 Response body parameters

    Parameter

    +
    - - - - - - - -
    Table 12 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    The customer whose project ID is 124147da-5b08-471a-93d2-bc82acc290c6 subscribes to the standard firewall. The firewall name is CFW-Test, the enterprise project ID is 0, the resource tag is a key-value pair, the key is TagKey, the value is TagValue, the added number of protected EIPs is 2000, the added protection bandwidth is 5000 Mbit/s, and the added number of protected VPCs is 100. The yearly/monthly billing mode is used. Auto-renewal and auto-payment are enabled. The usage duration is one month.

    -
    https://{Endpoint}/v2/124147da-5b08-471a-93d2-bc82acc290c6/firewall
    +

    Example Requests

    The customer whose project ID is 124147da-5b08-471a-93d2-bc82acc290c6 subscribes to the standard firewall. The firewall name is CFW-Test, the enterprise project ID is 0, the resource tag is a key-value pair, the key is TagKey, the value is TagValue, the added number of protected EIPs is 2000, the added protection bandwidth is 5000 Mbit/s, and the added number of protected VPCs is 100. The yearly/monthly billing mode is used. Auto-renewal and auto-payment are enabled. The usage duration is one month.

    +
    https://{Endpoint}/v2/124147da-5b08-471a-93d2-bc82acc290c6/firewall
     
     {
       "name" : "CFW-TEST",
    @@ -406,9 +470,9 @@
       }
     }
    -

    Example Responses

    Status code: 200

    -

    Information returned when the firewall is purchased successfully.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Information returned when the firewall is purchased successfully.

    +
    {
       "data" : {
         "charge_info" : {
           "charge_mode" : "prePaid",
    @@ -432,35 +496,35 @@
       },
       "job_id" : "CS2403271050ZEM0L"
     }
    -

    Status code: 400

    -

    Returned error information.

    -
    {
    +

    Status code: 400

    +

    Returned error information.

    +
    {
       "error_code" : "CFW.00100001",
       "error_msg" : "System busy. Try again later."
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Information returned when the firewall is purchased successfully.

    +

    Information returned when the firewall is purchased successfully.

    400

    +

    400

    Returned error information.

    +

    Returned error information.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/cfw/api-ref/CreateTag.html b/docs/cfw/api-ref/CreateTag.html index 06a074b97..690de73a0 100644 --- a/docs/cfw/api-ref/CreateTag.html +++ b/docs/cfw/api-ref/CreateTag.html @@ -1,152 +1,152 @@

    Creating a Tag

    -

    Function

    This API is used to create a tag.

    +

    Function

    This API is used to create a tag.

    -

    URI

    POST /v2/{project_id}/cfw-cfw/{fw_instance_id}/tags/create

    +

    URI

    POST /v2/{project_id}/cfw-cfw/{fw_instance_id}/tags/create

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    fw_instance_id

    +

    fw_instance_id

    Yes

    +

    Yes

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    -

    Request Parameters

    -
    Table 2 Request header parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - - - - - -
    Table 2 Request header parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    X-Auth-Token

    +

    X-Auth-Token

    Yes

    +

    Yes

    String

    +

    String

    User token. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    Table 3 Request body parameters

    Parameter

    +
    - - - - - - -
    Table 3 Request body parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    tags

    +

    tags

    No

    +

    No

    Array of CreateTag objects

    +

    Array of CreateTag objects

    Create a firewall tag list.

    +

    Create a firewall tag list.

    -
    Table 4 CreateTag

    Parameter

    +
    - - - - - - - - - - -
    Table 4 CreateTag

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    key

    +

    key

    No

    +

    No

    String

    +

    String

    Tag key.

    +

    Tag key.

    value

    +

    value

    No

    +

    No

    String

    +

    String

    Tag value.

    +

    Tag value.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 5 Response body parameters

    Parameter

    +
    - - - - - +
    Table 5 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    -

    +

    -

    String

    +

    String

      
    -

    Example Requests

    Add a tag whose key is keytest and value is valuetest to firewall 5e7eba7f-5de4-4ce9-8f60-11330dfc6565 in project 0b2179bbe180d3762fb0c01a2d5725c7.

    -
    https://{Endpoint}/v2/0b2179bbe180d3762fb0c01a2d5725c7/cfw-cfw/5e7eba7f-5de4-4ce9-8f60-11330dfc6565/tags/create
    +

    Example Requests

    Add a tag whose key is keytest and value is valuetest to firewall 5e7eba7f-5de4-4ce9-8f60-11330dfc6565 in project 0b2179bbe180d3762fb0c01a2d5725c7.

    +
    https://{Endpoint}/v2/0b2179bbe180d3762fb0c01a2d5725c7/cfw-cfw/5e7eba7f-5de4-4ce9-8f60-11330dfc6565/tags/create
     
     {
       "tags" : [ {
    @@ -155,25 +155,25 @@
       } ]
     }
    -

    Example Responses

    None

    +

    Example Responses

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    OK

    +

    OK

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/cfw/api-ref/DeleteAclRule.html b/docs/cfw/api-ref/DeleteAclRule.html index 3ea1dfec8..aeaa81a11 100644 --- a/docs/cfw/api-ref/DeleteAclRule.html +++ b/docs/cfw/api-ref/DeleteAclRule.html @@ -1,241 +1,241 @@

    Deleting an ACL Rule

    -

    Function

    This API is used to delete an ACL rule.

    +

    Function

    This API is used to delete an ACL rule.

    -

    URI

    DELETE /v1/{project_id}/acl-rule/{acl_rule_id}

    +

    URI

    DELETE /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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    acl_rule_id

    +

    acl_rule_id

    Yes

    +

    Yes

    String

    +

    String

    Rule ID, which can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

    +

    Rule ID, which can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    RuleId object

    +

    RuleId object

    Rule ID.

    +

    Rule ID.

    -
    Table 5 RuleId

    Parameter

    +
    - - - - - - - -
    Table 5 RuleId

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Rule ID.

    +

    Rule ID.

    name

    +

    name

    String

    +

    String

    Rule name.

    +

    Rule name.

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Delete the rule ceaa0407-b9c8-4dfd-9eca-b6ead2dfd031 from project 9d80d070b6d44942af73c9c3d38e0429.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule/ceaa0407-b9c8-4dfd-9eca-b6ead2dfd031
    +

    Example Requests

    Delete the rule ceaa0407-b9c8-4dfd-9eca-b6ead2dfd031 from project 9d80d070b6d44942af73c9c3d38e0429.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule/ceaa0407-b9c8-4dfd-9eca-b6ead2dfd031
    -

    Example Responses

    Status code: 200

    -

    Data returned for rule deletion.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Data returned for rule deletion.

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

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00900016",
       "error_msg" : "Import is in progress. Please wait until it is complete."
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Data returned for rule deletion.

    +

    Data returned for rule deletion.

    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/DeleteAclRuleHitCount.html b/docs/cfw/api-ref/DeleteAclRuleHitCount.html index 0057ecb9a..054e93162 100644 --- a/docs/cfw/api-ref/DeleteAclRuleHitCount.html +++ b/docs/cfw/api-ref/DeleteAclRuleHitCount.html @@ -1,227 +1,227 @@

    Deleting the Number of Rule Hits

    -

    Function

    This API is used to delete the number of rule hits.

    +

    Function

    This API is used to delete the number of rule hits.

    -

    URI

    DELETE /v1/{project_id}/acl-rule/count

    +

    URI

    DELETE /v1/{project_id}/acl-rule/count

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    Table 4 Request body parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    rule_ids

    +

    rule_ids

    Yes

    +

    Yes

    Array of strings

    +

    Array of strings

    List of rules deleted during rule hit deletion. Rule IDs can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

    +

    List of rules deleted during rule hit deletion. Rule IDs can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 5 Response body parameters

    Parameter

    +
    - - - - - +
    Table 5 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    -

    +

    -

    String

    +

    String

      
    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Clear the hits of ACL rule 59ff6bd9-0a76-41ec-9650-380086069965 whose project ID is 0b2179bbe180d3762fb0c01a2d5725c7.

    -
    https://{Endpoint}/v1/0b2179bbe180d3762fb0c01a2d5725c7/acl-rule/count
    +

    Example Requests

    Clear the hits of ACL rule 59ff6bd9-0a76-41ec-9650-380086069965 whose project ID is 0b2179bbe180d3762fb0c01a2d5725c7.

    +
    https://{Endpoint}/v1/0b2179bbe180d3762fb0c01a2d5725c7/acl-rule/count
     
     {
       "rule_ids" : [ "59ff6bd9-0a76-41ec-9650-380086069965" ]
     }
    -

    Example Responses

    Status code: 200

    -

    OK

    -
    { }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Example Responses

    Status code: 200

    +

    OK

    +
    { }
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00400006",
       "error_msg" : "Error occurred when deleting the rule hit count."
     }
    -

    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/DeleteAddressItem.html b/docs/cfw/api-ref/DeleteAddressItem.html index 4bfd83518..fe476d1a3 100644 --- a/docs/cfw/api-ref/DeleteAddressItem.html +++ b/docs/cfw/api-ref/DeleteAddressItem.html @@ -1,241 +1,241 @@

    Deleting an Address Group Member

    -

    Function

    This API is used to delete a member from an address group.

    +

    Function

    This API is used to delete a member from an address group.

    -

    URI

    DELETE /v1/{project_id}/address-items/{item_id}

    +

    URI

    DELETE /v1/{project_id}/address-items/{item_id}

    -
    Table 1 Path Parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    item_id

    +

    item_id

    Yes

    +

    Yes

    String

    +

    String

    Address group member ID, which can be obtained by calling the API for querying address group members. Find the value in data.records.item_id (The period [.] is used to separate different levels of objects).

    +

    Address group member ID, which can be obtained by calling the API for querying address group members. Find the value in data.records.item_id (The period [.] is used to separate different levels of objects).

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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 AddressItemId objects

    +

    Array of AddressItemId objects

    Delete an address group member ID.

    +

    Delete an address group member ID.

    -
    Table 5 AddressItemId

    Parameter

    +
    - - - - - - - -
    Table 5 AddressItemId

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    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.

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Delete address group member 65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae from project 9d80d070b6d44942af73c9c3d38e0429.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items/65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae
    +

    Example Requests

    Delete address group member 65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae from project 9d80d070b6d44942af73c9c3d38e0429.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items/65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae
    -

    Example Responses

    Status code: 200

    -

    Return value for deleting an address group member.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for deleting an address group member.

    +
    {
       "data" : {
         "id" : "65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae",
         "name" : "test"
       }
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

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

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for deleting an address group member.

    +

    Return value for deleting an address 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/DeleteAddressSet.html b/docs/cfw/api-ref/DeleteAddressSet.html index 7080423af..b34c4f8c4 100644 --- a/docs/cfw/api-ref/DeleteAddressSet.html +++ b/docs/cfw/api-ref/DeleteAddressSet.html @@ -1,241 +1,241 @@

    Deleting an Address Group

    -

    Function

    This API is used to delete an address group.

    +

    Function

    This API is used to delete an address group.

    -

    URI

    DELETE /v1/{project_id}/address-sets/{set_id}

    +

    URI

    DELETE /v1/{project_id}/address-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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    set_id

    +

    set_id

    Yes

    +

    Yes

    String

    +

    String

    Address group ID, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    Address group ID, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    AddressSetId object

    +

    AddressSetId object

    Data returned after an address group is deleted.

    +

    Data returned after an address group is deleted.

    -
    Table 5 AddressSetId

    Parameter

    +
    - - - - - - - -
    Table 5 AddressSetId

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Address group ID.

    +

    Address group ID.

    name

    +

    name

    String

    +

    String

    IP address group name.

    +

    IP address group name.

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Delete address group cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 from project 9d80d070b6d44942af73c9c3d38e0429.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-sets/cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16
    +

    Example Requests

    Delete address group cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 from project 9d80d070b6d44942af73c9c3d38e0429.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-sets/cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16
    -

    Example Responses

    Status code: 200

    -

    Return value for deleting an address group.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for deleting an address group.

    +
    {
       "data" : {
         "id" : "cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16",
         "name" : "test"
       }
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00200004",
       "error_msg" : "Failed to delete the resource because it is being referenced."
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for deleting an address group.

    +

    Return value for deleting an address group.

    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/DeleteBlackWhiteList.html b/docs/cfw/api-ref/DeleteBlackWhiteList.html index 51aaa0d13..97689095b 100644 --- a/docs/cfw/api-ref/DeleteBlackWhiteList.html +++ b/docs/cfw/api-ref/DeleteBlackWhiteList.html @@ -1,240 +1,240 @@

    Deleting a Blacklist or Whitelist Rule

    -

    Function

    This API is used to delete a blacklist or whitelist rule.

    +

    Function

    This API is used to delete a blacklist or whitelist rule.

    -

    URI

    DELETE /v1/{project_id}/black-white-list/{list_id}

    +

    URI

    DELETE /v1/{project_id}/black-white-list/{list_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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    list_id

    +

    list_id

    Yes

    +

    Yes

    String

    +

    String

    Blacklist or whitelist ID, which can be obtained through the API for querying the blacklist or whitelist. Find the value in data.records.list_id (The period [.] is used to separate different levels of objects).

    +

    Blacklist or whitelist ID, which can be obtained through the API for querying the blacklist or whitelist. Find the value in data.records.list_id (The period [.] is used to separate different levels of objects).

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    BlackWhiteListId object

    +

    BlackWhiteListId object

    Response to the request for deleting a blacklist/whitelist item.

    +

    Response to the request for deleting a blacklist/whitelist item.

    -
    Table 5 BlackWhiteListId

    Parameter

    +
    - - - - - - - -
    Table 5 BlackWhiteListId

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Blacklist/Whitelist ID.

    +

    Blacklist/Whitelist ID.

    name

    +

    name

    String

    +

    String

    Blacklist/Whitelist name.

    +

    Blacklist/Whitelist name.Which is the Address

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Delete the blacklist or whitelist whose ID is 2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a from the project 9d80d070b6d44942af73c9c3d38e0429.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list/2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a
    +

    Example Requests

    Delete the blacklist or whitelist whose ID is 2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a from the project 9d80d070b6d44942af73c9c3d38e0429.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list/2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a
    -

    Example Responses

    Status code: 200

    -

    Blacklist/Whitelist deletion response.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Blacklist/Whitelist deletion response.

    +
    {
       "data" : {
         "id" : "2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a"
       }
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00200005",
       "error_msg" : "Object not found."
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Blacklist/Whitelist deletion response.

    +

    Blacklist/Whitelist deletion response.

    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/DeleteDomainSet.html b/docs/cfw/api-ref/DeleteDomainSet.html index 30012691b..d1dee01c3 100644 --- a/docs/cfw/api-ref/DeleteDomainSet.html +++ b/docs/cfw/api-ref/DeleteDomainSet.html @@ -1,183 +1,183 @@

    Deleting a Domain Name Group

    -

    Function

    This API is used to delete a domain name group.

    +

    Function

    This API is used to delete a domain name group.

    -

    URI

    DELETE /v1/{project_id}/domain-set/{set_id}

    +

    URI

    DELETE /v1/{project_id}/domain-set/{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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    set_id

    +

    set_id

    Yes

    +

    Yes

    String

    +

    String

    Domain name group ID, which can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    Domain name group ID, which can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    Yes

    +

    Yes

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    DomainSetResponseData object

    +

    DomainSetResponseData object

    Returned data for deleting a domain name group.

    +

    Returned data for deleting a domain name group.

    -
    Table 5 DomainSetResponseData

    Parameter

    +
    - - - - - - - -
    Table 5 DomainSetResponseData

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Domain name group ID.

    +

    Domain name group ID.

    name

    +

    name

    String

    +

    String

    Domain name group name.

    +

    Domain name group name.

    -

    Example Requests

    Delete domain name group 89bce6a4-9b59-4d7a-b5f9-cac5ac16d88a from firewall 7a004e79-0b8b-4679-ab20-267f3946e8ba in project 9d80d070b6d44942af73c9c3d38e0429.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-set/89bce6a4-9b59-4d7a-b5f9-cac5ac16d88a?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default
    +

    Example Requests

    Delete domain name group 89bce6a4-9b59-4d7a-b5f9-cac5ac16d88a from firewall 7a004e79-0b8b-4679-ab20-267f3946e8ba in project 9d80d070b6d44942af73c9c3d38e0429.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-set/89bce6a4-9b59-4d7a-b5f9-cac5ac16d88a?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default
    -

    Example Responses

    Status code: 200

    -

    Return value for deleting a domain name group.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for deleting a domain name group.

    +
    {
       "data" : {
         "id" : "89bce6a4-9b59-4d7a-b5f9-cac5ac16d88a",
         "name" : "test"
       }
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for deleting a domain name group.

    +

    Return value for deleting a domain name group.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/cfw/api-ref/DeleteDomains.html b/docs/cfw/api-ref/DeleteDomains.html index f1c3dd2a1..f68511d8c 100644 --- a/docs/cfw/api-ref/DeleteDomains.html +++ b/docs/cfw/api-ref/DeleteDomains.html @@ -1,220 +1,220 @@

    Deleting a Domain Name List

    -

    Function

    This API is used to delete a domain name list.

    +

    Function

    This API is used to delete a domain name list.

    -

    URI

    DELETE /v1/{project_id}/domain-set/domains/{set_id}

    +

    URI

    DELETE /v1/{project_id}/domain-set/domains/{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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    set_id

    +

    set_id

    Yes

    +

    Yes

    String

    +

    String

    Domain name group ID, which can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    Domain name group ID, which can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    Yes

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    +

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    domain_address_ids

    +

    domain_address_ids

    Yes

    +

    Yes

    Array of strings

    +

    Array of strings

    Domain name ID list. Domain name IDs can be obtained by calling the API for querying the domain name list under a domain name group. Find the value in data.records.domain_address_id (The period [.] is used to separate different levels of objects).

    +

    Domain name ID list. Domain name IDs can be obtained by calling the API for querying the domain name list under a domain name group. Find the value in data.records.domain_address_id (The period [.] is used to separate different levels of objects).

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 5 Response body parameters

    Parameter

    +
    - - - - -
    Table 5 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    data

    +

    data

    DomainSetResponseData object

    +

    DomainSetResponseData object

    Returned data for deleting a domain name list.

    +

    Returned data for deleting a domain name list.

    -
    Table 6 DomainSetResponseData

    Parameter

    +
    - - - - - - - -
    Table 6 DomainSetResponseData

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Domain name group ID.

    +

    Domain name group ID.

    name

    +

    name

    String

    +

    String

    Domain name group name.

    +

    Domain name group name.

    -

    Example Requests

    In project 14181c1245cf4fd786824efe1e2b9388, delete domain names from domain name group 78719348-6d79-477e-acec-676a29842ab2. The firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925, the protected object ID is ae42418e-f077-41a0-9d3b-5b2f5ad9102b, the domain name group ID is 78719348-6d79-477e-acec-676a29842ab2, and the domain list is "b9c23ad8-16d2-4f14-894f-29250c5d27e5", "c36f9462-467b-4303-9734-f9abc38ddb95".

    -
    https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/domain-set/domains/78719348-6d79-477e-acec-676a29842ab2?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default
    +

    Example Requests

    In project 14181c1245cf4fd786824efe1e2b9388, delete domain names from domain name group 78719348-6d79-477e-acec-676a29842ab2. The firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925, the protected object ID is ae42418e-f077-41a0-9d3b-5b2f5ad9102b, the domain name group ID is 78719348-6d79-477e-acec-676a29842ab2, and the domain list is "b9c23ad8-16d2-4f14-894f-29250c5d27e5", "c36f9462-467b-4303-9734-f9abc38ddb95".

    +
    https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/domain-set/domains/78719348-6d79-477e-acec-676a29842ab2?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default
     
     {
       "domain_address_ids" : [ "b9c23ad8-16d2-4f14-894f-29250c5d27e5", "c36f9462-467b-4303-9734-f9abc38ddb95" ],
       "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b"
     }
    -

    Example Responses

    Status code: 200

    -

    Return value for deleting a domain name list.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for deleting a domain name list.

    +
    {
       "data" : {
         "id" : "78719348-6d79-477e-acec-676a29842ab2",
         "name" : "test26"
       }
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for deleting a domain name list.

    +

    Return value for deleting a domain name list.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/cfw/api-ref/DeleteFirewall.html b/docs/cfw/api-ref/DeleteFirewall.html index 9add4342b..dc78a8bf8 100644 --- a/docs/cfw/api-ref/DeleteFirewall.html +++ b/docs/cfw/api-ref/DeleteFirewall.html @@ -1,122 +1,122 @@

    Deleting a Firewall

    -

    Function

    This API is used to delete a firewall. It takes effect only for pay-per-use firewalls.

    +

    Function

    This API is used to delete a firewall. It takes effect only for pay-per-use firewalls.

    -

    URI

    DELETE /v2/{project_id}/firewall/{resource_id}

    +

    URI

    DELETE /v2/{project_id}/firewall/{resource_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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    resource_id

    +

    resource_id

    Yes

    +

    Yes

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    -

    Request Parameters

    -
    Table 2 Request header parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - - - - - -
    Table 2 Request header parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    X-Auth-Token

    +

    X-Auth-Token

    Yes

    +

    Yes

    String

    +

    String

    User token. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 3 Response body parameters

    Parameter

    +
    - - - - -
    Table 3 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    data

    +

    data

    String

    +

    String

    ID of a firewall deletion task.

    +

    ID of a firewall deletion task.

    -

    Example Requests

    Delete the pay-per-use firewall 08065281-860a-4c98-aeb5-82cf65c44c46 from project 06217ebc876e427a80a2c05d51264ab1.

    -
    https://{Endpoint}/v2/06217ebc876e427a80a2c05d51264ab1/firewall/08065281-860a-4c98-aeb5-82cf65c44c46
    +

    Example Requests

    Delete the pay-per-use firewall 08065281-860a-4c98-aeb5-82cf65c44c46 from project 06217ebc876e427a80a2c05d51264ab1.

    +
    https://{Endpoint}/v2/06217ebc876e427a80a2c05d51264ab1/firewall/08065281-860a-4c98-aeb5-82cf65c44c46
    -

    Example Responses

    Status code: 200

    -

    Return value for deleting a firewall.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for deleting a firewall.

    +
    {
       "data" : "56884cd0-cf3c-4cb7-bbeb-59d8722a2671"
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for deleting a firewall.

    +

    Return value for deleting a firewall.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/cfw/api-ref/DeleteServiceItem.html b/docs/cfw/api-ref/DeleteServiceItem.html index 33f4e085d..694fdd384 100644 --- a/docs/cfw/api-ref/DeleteServiceItem.html +++ b/docs/cfw/api-ref/DeleteServiceItem.html @@ -1,241 +1,241 @@

    Deleting a Service Group Member

    -

    Function

    This API is used to delete a member from a service group.

    +

    Function

    This API is used to delete a member from a service group.

    -

    URI

    DELETE /v1/{project_id}/service-items/{item_id}

    +

    URI

    DELETE /v1/{project_id}/service-items/{item_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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    item_id

    +

    item_id

    Yes

    +

    Yes

    String

    +

    String

    Service group member ID, which can be obtained by calling the API for querying the service group member list. Find the value in data.records.item_id (The period [.] is used to separate different levels of objects).

    +

    Service group member ID, which can be obtained by calling the API for querying the service group member list. Find the value in data.records.item_id (The period [.] is used to separate different levels of objects).

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    DeleteServiceItemResponseBodyData object

    +

    DeleteServiceItemResponseBodyData object

    Delete service group member data.

    +

    Delete service group member data.

    -
    Table 5 DeleteServiceItemResponseBodyData

    Parameter

    +
    - - - - - - - -
    Table 5 DeleteServiceItemResponseBodyData

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Service group member ID.

    +

    Service group member ID.

    name

    +

    name

    String

    +

    String

    Service group member name.

    +

    Service group member name,which is the source port and destination port.

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Delete the service group member whose ID is 6b37ed55-1e21-46a5-a7dc-a59ef418d359 from project 9d80d070b6d44942af73c9c3d38e0429.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items/6b37ed55-1e21-46a5-a7dc-a59ef418d359
    +

    Example Requests

    Delete the service group member whose ID is 6b37ed55-1e21-46a5-a7dc-a59ef418d359 from project 9d80d070b6d44942af73c9c3d38e0429.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items/6b37ed55-1e21-46a5-a7dc-a59ef418d359
    -

    Example Responses

    Status code: 200

    -

    Information returned for service group member deletion.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Information returned for service group member deletion.

    +
    {
       "data" : {
         "id" : "26f562c4-fe11-43d0-9654-f54298d5b12e",
         "name" : "0|1"
       }
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

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

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Information returned for service group member deletion.

    +

    Information returned for service group member deletion.

    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/DeleteServiceSet.html b/docs/cfw/api-ref/DeleteServiceSet.html index 0c973220f..9c698c1a4 100644 --- a/docs/cfw/api-ref/DeleteServiceSet.html +++ b/docs/cfw/api-ref/DeleteServiceSet.html @@ -1,241 +1,241 @@

    Deleting a Service Group

    -

    Function

    This API is used to delete a service group.

    +

    Function

    This API is used to delete a service group.

    -

    URI

    DELETE /v1/{project_id}/service-sets/{set_id}

    +

    URI

    DELETE /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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    set_id

    +

    set_id

    Yes

    +

    Yes

    String

    +

    String

    Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    ServiceSetId object

    +

    ServiceSetId object

    Data returned for deleting a service group.

    +

    Data returned for deleting a service group.

    -
    Table 5 ServiceSetId

    Parameter

    +
    - - - - - - - -
    Table 5 ServiceSetId

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Service group ID.

    +

    Service group ID.

    name

    +

    name

    String

    +

    String

    Service group name.

    +

    Service group name.

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Delete service group 221cfdca-3abf-4c30-ab0d-516a03c70866 in project 9d80d070b6d44942af73c9c3d38e0429.

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

    Example Requests

    Delete service group 221cfdca-3abf-4c30-ab0d-516a03c70866 in project 9d80d070b6d44942af73c9c3d38e0429.

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

    Example Responses

    Status code: 200

    -

    Return value for deleting a service group.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for deleting a service group.

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

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00200004",
       "error_msg" : "Failed to delete the resource because it is being referenced."
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for deleting a service group.

    +

    Return value for deleting a service group.

    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/DeleteTag.html b/docs/cfw/api-ref/DeleteTag.html index 2b27f924f..b6d5b22d2 100644 --- a/docs/cfw/api-ref/DeleteTag.html +++ b/docs/cfw/api-ref/DeleteTag.html @@ -1,161 +1,161 @@

    Deleting a Tag

    -

    Function

    This API is used to delete a tag.

    +

    Function

    This API is used to delete a tag.

    -

    URI

    DELETE /v2/{project_id}/cfw-cfw/{fw_instance_id}/tags/delete

    +

    URI

    DELETE /v2/{project_id}/cfw-cfw/{fw_instance_id}/tags/delete

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    fw_instance_id

    +

    fw_instance_id

    Yes

    +

    Yes

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    -

    Request Parameters

    -
    Table 2 Request header parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - - - - - -
    Table 2 Request header parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    X-Auth-Token

    +

    X-Auth-Token

    Yes

    +

    Yes

    String

    +

    String

    User token. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    Table 3 Request body parameters

    Parameter

    +
    - - - - - - -
    Table 3 Request body parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    tags

    +

    tags

    No

    +

    No

    Array of ResourceTag objects

    +

    Array of ResourceTag objects

    Firewall tag list.

    +

    Firewall tag list.

    -
    Table 4 ResourceTag

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 4 ResourceTag

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    key

    +

    key

    No

    +

    No

    String

    +

    String

    Tag key.

    +

    Tag key.

    value

    +

    value

    No

    +

    No

    String

    +

    String

    Tag value.

    +

    Tag value.

    update_time

    +

    update_time

    No

    +

    No

    String

    +

    String

    Tag update time.

    +

    Tag update time.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 5 Response body parameters

    Parameter

    +
    - - - - - +
    Table 5 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    -

    +

    -

    String

    +

    String

      
    -

    Example Requests

    Delete a tag from firewall 5e7eba7f-5de4-4ce9-8f60-11330dfc6565 in project 0b2179bbe180d3762fb0c01a2d5725c7. The tag key is keytest and the tag value is valuetest.

    -
    https://{Endpoint}/v2/408972e72dcd4c1a9b033e955802a36b/cfw-cfw/5e7eba7f-5de4-4ce9-8f60-11330dfc6565/tags/delete
    +

    Example Requests

    Delete a tag from firewall 5e7eba7f-5de4-4ce9-8f60-11330dfc6565 in project 0b2179bbe180d3762fb0c01a2d5725c7. The tag key is keytest and the tag value is valuetest.

    +
    https://{Endpoint}/v2/408972e72dcd4c1a9b033e955802a36b/cfw-cfw/5e7eba7f-5de4-4ce9-8f60-11330dfc6565/tags/delete
     
     {
       "tags" : [ {
    @@ -164,25 +164,25 @@
       } ]
     }
    -

    Example Responses

    None

    +

    Example Responses

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    OK

    +

    OK

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/cfw/api-ref/ErrorCode.html b/docs/cfw/api-ref/ErrorCode.html index 8f9e98cc2..7ddda20ba 100644 --- a/docs/cfw/api-ref/ErrorCode.html +++ b/docs/cfw/api-ref/ErrorCode.html @@ -1,1101 +1,589 @@

    Error Codes

    -
    -

    Module

    +
    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/cfw/api-ref/ListAccessControlLogs.html b/docs/cfw/api-ref/ListAccessControlLogs.html index d1f39632b..7005c8191 100644 --- a/docs/cfw/api-ref/ListAccessControlLogs.html +++ b/docs/cfw/api-ref/ListAccessControlLogs.html @@ -1,572 +1,572 @@

    Querying Access Control Logs

    -

    Function

    This API is used to query access control logs.

    +

    Function

    This API is used to query access control logs.

    -

    URI

    GET /v1/{project_id}/cfw/logs/access-control

    +

    URI

    GET /v1/{project_id}/cfw/logs/access-control

    -

    Status Code

    Status Code

    +

    Error Codes

    Error Code

    +

    Error Message

    Message

    +

    Description

    Description

    -

    Measure

    +

    Solution

    Common module

    +

    400

    400

    +

    CFW.00109004

    CFW.00109004

    +

    http to external service error.

    HTTP request error

    +

    http to external service error.

    HTTP request error

    -

    Try again later or contact technical support.

    -

    400

    -

    CFW.00300001

    -

    Failed to query the database.

    -

    Failed to query the database.

    -

    Contact technical support.

    -

    400

    -

    CFW.00400008

    -

    The protected object does not exist.

    -

    The protected object does not exist.

    -

    Contact technical support.

    -

    400

    -

    CFW.00800001

    -

    An exception occurred when querying ETCD.

    -

    An exception occurred when querying ETCD.

    -

    Contact technical support.

    -

    400

    -

    CFW.00800002

    -

    An exception occurred when querying ETCD.

    -

    An exception occurred when querying ETCD.

    -

    Contact technical support.

    -

    400

    -

    CFW.00800003

    -

    An exception occurred when querying ETCD.

    -

    An exception occurred when querying ETCD.

    -

    Contact technical support.

    -

    400

    -

    CFW.01100008

    -

    Configurations cannot be delivered during cluster scale-out.

    -

    Configurations cannot be delivered during cluster scale-out.

    -

    Contact technical support.

    -

    DNS resolution

    -

    400

    -

    CFW.00200005

    -

    The domain name group in the request does not exist.

    -

    The domain name group in the request does not exist.

    -

    Check whether the domain name group carried in the request exists.

    -

    Deleting a domain name

    -

    400

    -

    CFW.00200005

    -

    The domain name group in the request does not exist.

    -

    The domain name group in the request does not exist.

    -

    Check whether the domain name group carried in the request exists.

    -

    Deleting a domain name group

    -

    400

    -

    CFW.00200004

    -

    The domain name group to be deleted is referenced.

    -

    The domain name group to be deleted is referenced.

    -

    Delete the rules that reference the domain name group and then delete the domain name group.

    -

    400

    -

    CFW.00200005

    -

    The domain name group in the request does not exist.

    -

    The domain name group in the request does not exist.

    -

    Check whether the domain name group carried in the request exists.

    -

    Updating a domain group

    -

    400

    -

    CFW.00200005

    -

    The domain name group in the request does not exist.

    -

    The domain name group in the request does not exist.

    -

    Check whether the domain name group carried in the request exists.

    +

    Try again later or contact technical support.

    Querying access control logs

    -

    400

    +

    400

    CFW.00500002

    +

    CFW.00200001

    Invalid interval

    +

    empty param

    Invalid interval

    +

    empty param.

    Contact technical support.

    +

    contact technical support.

    Querying attack logs

    +

    400

    400

    +

    CFW.00200004

    CFW.00500002

    +

    can not delete for used.

    Invalid interval

    +

    can not delete for used.

    Invalid interval

    -

    Contact technical support.

    +

    contact technical support.

    400

    +

    400

    CFW.00500004

    +

    CFW.00200005

    The page jump spacing is too large.

    +

    operation content does not exist.

    The page jump spacing is too large.

    +

    operation content does not exist.

    Contact technical support.

    +

    contact technical support.

    Querying traffic logs

    -

    400

    +

    400

    CFW.00500002

    +

    CFW.00200007

    Invalid interval

    +

    name conflict.

    Invalid interval

    +

    name conflict.

    Contact technical support.

    +

    please rename the name.

    Querying the protected EIP list

    +

    400

    400

    +

    CFW.00200009

    CFW.00200030

    +

    A request with the same param already exists.

    Incorrect address type

    +

    A request with the same param already exists.

    Incorrect address type

    -

    Contact technical support.

    +

    contact technical support.

    400

    +

    400

    CFW.00200016

    +

    CFW.00200010

    Incorrect instance status

    +

    Config type error.

    Incorrect instance status

    +

    Config type error.

    Contact technical support.

    +

    contact technical support.

    Querying the rule list

    -

    400

    +

    400

    CFW.00200030

    +

    CFW.00200011

    Incorrect address type

    +

    Not support batch operation.

    Incorrect address type

    +

    Not support batch operation.

    Contact technical support.

    +

    contact technical support.

    Adding an ACL rule

    +

    400

    400

    +

    CFW.00200013

    CFW.00200001

    +

    url syntax error.

    The rule direction cannot be empty.

    +

    url syntax error.

    The rule direction cannot be empty.

    -

    Check whether the rule direction in the request parameter is empty.

    +

    contact technical support.

    400

    +

    400

    CFW.00200005

    +

    CFW.00200020

    The address group ID in the request does not exist.

    +

    added acl rules can't exceed 20.

    The address group ID in the request does not exist.

    +

    added acl rules can't exceed 20.

    Check whether the address group ID carried in the request exists.

    +

    Please reduce the number of added acl rules.

    400

    +

    400

    CFW.00200005

    +

    CFW.00200022

    The service group ID in the request does not exist.

    +

    all IP address segments is not allowed in black and white list.

    The service group ID in the request does not exist.

    +

    all IP address segments is not allowed in black and white list.

    Check whether the service group ID in the request exists.

    +

    Please specify the black and white list ip address segment.

    400

    +

    400

    CFW.00200005

    +

    CFW.00200023

    The domain name group in the request does not exist.

    +

    PARAM_UPGRADING_TASK_OUT_OF_RANGE

    The domain name group in the request does not exist.

    +

    PARAM_UPGRADING_TASK_OUT_OF_RANGE.

    Check whether the domain name group carried in the request exists.

    +

    contact technical support.

    400

    +

    400

    CFW.00200007

    +

    CFW.00200024

    The rule name carried in the request is the same as a rule name in the database.

    +

    Exceeded maximum quantity limit.

    The rule name carried in the request is the same as a rule name in the database.

    +

    Exceeded maximum quantity limit.

    Delete duplicate rules from the request.

    +

    contact technical support.

    400

    +

    400

    CFW.00200020

    +

    CFW.00200025

    Up to 20 ACL rules can be added.

    +

    long connection acl rules time out of range.

    Up to 20 ACL rules can be added.

    +

    long connection acl rules time out of range.

    Reduce the number of ACL rules to be added.

    +

    Please make sure the long connection rule duration is from one second to a thousand days.

    400

    +

    400

    CFW.00200025

    +

    CFW.00200026

    The time limit of persistent connection is exceeded.

    +

    Long connection acl rules reach limit.

    The time limit of persistent connection is exceeded.

    +

    Long connection acl rules reach limit.

    Ensure that the duration of the persistent connection is in the range from 1 second to 1000 days.

    +

    Please delete some long connection rules.

    400

    +

    400

    CFW.00200026

    +

    CFW.00200027

    The number of persistent connection rules reaches the upper limit.

    +

    acl address is error.

    The number of persistent connection rules reaches the upper limit.

    +

    acl address is error.

    Delete unnecessary persistent connection rules.

    +

    Please make sure that the acl rule address conforms to the specification.

    400

    +

    400

    CFW.00200028

    +

    CFW.00200028

    Inconsistent address types

    +

    inconsistent address types.

    Inconsistent address types

    +

    inconsistent address types.

    Ensure the address types are the same.

    +

    Please make sure the address type is the same.

    400

    +

    400

    CFW.00200032

    +

    CFW.00200030

    The engine does not support IPv6.

    +

    address type is error.

    The engine does not support IPv6.

    +

    address type is error.

    Contact technical support.

    +

    contact technical support.

    400

    +

    400

    CFW.00400007

    +

    CFW.00200032

    The types of the added rules are inconsistent.

    +

    The engine does not support IPv6.

    The types of the added rules are inconsistent.

    +

    The engine does not support IPv6.

    Ensure the types of the added rules are the same.

    +

    contact technical support.

    400

    +

    400

    CFW.00400010

    +

    CFW.00200036

    The protocol is not supported by the persistent connection.

    +

    The network segment cannot be changed to a private network segment.

    The protocol is not supported by the persistent connection.

    +

    The network segment cannot be changed to a private network segment.

    Ensure the protocol is TCP or UDP.

    +

    contact technical support.

    Updating an ACL rule

    -

    400

    +

    400

    CFW.00200005

    +

    CFW.00200041

    The address group ID in the request does not exist.

    +

    address is null.

    The address group ID in the request does not exist.

    +

    address is null.

    Check whether the address group ID carried in the request is correct.

    +

    Please add address type parameter.

    400

    +

    400

    CFW.00200005

    +

    CFW.00200016

    The service group ID in the request does not exist.

    +

    instance status error.

    The service group ID in the request does not exist.

    +

    instance status error.

    Check whether the service group ID carried in the request is correct.

    +

    contact technical support.

    400

    +

    400

    CFW.00200005

    +

    CFW.00200110

    The domain name group in the request does not exist.

    +

    Can't operate basic defense

    The domain name group in the request does not exist.

    +

    Can't operate basic defense

    Check whether the domain name group carried in the request is correct.

    +

    contact technical support.

    400

    +

    400

    CFW.00200007

    +

    CFW.00300001

    The rule name carried in the request is the same as a rule name in the database.

    +

    Parse command error.

    The rule name carried in the request is the same as a rule name in the database.

    +

    Parse command error.

    Delete duplicate rules from the request.

    +

    contact technical support.

    400

    +

    400

    CFW.00200025

    +

    CFW.00400002

    The time limit of persistent connection is exceeded.

    +

    not need to operate.

    The time limit of persistent connection is exceeded.

    +

    not need to operate.

    Ensure that the duration of the persistent connection is in the range from 1 second to 1000 days.

    +

    contact technical support.

    400

    +

    400

    CFW.00200026

    +

    CFW.00400004

    The number of persistent connection rules reaches the upper limit.

    +

    item already exist.

    The number of persistent connection rules reaches the upper limit.

    +

    item already exist.

    Delete unnecessary persistent connection rules.

    +

    Please delete some service items.

    400

    +

    400

    CFW.00200028

    +

    CFW.00400006

    Inconsistent address types

    +

    clear rule hit count param error.

    Inconsistent address types

    +

    clear rule hit count param error.

    Ensure the address types are the same.

    +

    Please check and confirm whether the parameter value is legal.

    400

    +

    400

    CFW.00400010

    +

    CFW.00400007

    The protocol is not supported by the persistent connection.

    +

    ACL_RULE_TYPE_INCONSISTENT.

    The protocol is not supported by the persistent connection.

    +

    ACL_RULE_TYPE_INCONSISTENT.

    Ensure the protocol is TCP or UDP.

    +

    Make sure to add the same rule type.

    Modifying the priority of an ACL rule

    +

    400

    400

    +

    CFW.00400008

    CFW.00400002

    +

    protect object doesn't exist.

    No operation is required.

    +

    protect object doesn't exist.

    No operation is required.

    -

    Contact technical support.

    +

    contact technical support.

    Deleting the rule hit count

    -

    400

    +

    400

    CFW.00400006

    +

    CFW.00400009

    An error occurred when the rule hit count is deleted.

    +

    The number of wildcard domain name protection rules exceeds the upper limit

    An error occurred when the rule hit count is deleted.

    +

    The number of wildcard domain name protection rules exceeds the upper limit

    Check whether the parameter value is valid.

    +

    Please delete some generic domain name protection rules.

    Creating an east-west CFW instance

    -

    400

    +

    400

    CFW.00700001

    +

    CFW.00400010

    The associated ER does not exist.

    +

    not supported protocol for long connection.

    The associated ER does not exist.

    +

    not supported protocol for long connection.

    The associated ER does not exist.

    +

    Please make sure that the rule protocol belongs to TCP, UDP.

    400

    +

    400

    CFW.00700002

    +

    CFW.00400011

    The associated VPC does not exist.

    +

    BLACK_WHITE_LIST_REPEAT.

    The associated VPC does not exist.

    +

    BLACK_WHITE_LIST_REPEAT.

    Check whether the VPC exists.

    +

    Make sure to add a different black and white list.

    400

    +

    400

    CFW.00700003

    +

    CFW.00400012

    The network segments of the associated subnets conflict.

    +

    East west protection not existed,private Ip blackWhite list cannot be submitted.

    The network segments of the associated subnets conflict.

    +

    East west protection not existed,private Ip blackWhite list cannot be submitted.

    Ensure the subnet to be created does not overlap with the subnet CIDR block in the existing VPC.

    +

    Please add east-west protection.

    400

    +

    400

    CFW.00700004

    +

    CFW.00400013

    Failed to create the subnet.

    +

    The number of blocklists or trustlists exceeds the maximum 2000.

    Failed to create the subnet.

    +

    The number of blocklists or trustlists exceeds the maximum 2000.

    Contact technical support.

    +

    Please delete some black and white lists.

    400

    +

    400

    CFW.00700007

    +

    CFW.00500002

    ER failed to create a VPC connection

    +

    time range error.

    ER failed to create a VPC connection

    +

    time range error.

    Contact technical support.

    +

    contact technical support.

    400

    +

    400

    CFW.00700012

    +

    CFW.00500004

    Failed to modify the route.

    +

    time range error.

    Failed to modify the route.

    +

    time range error.

    Contact technical support.

    +

    contact technical support.

    400

    +

    400

    CFW.00700015

    +

    CFW.00600003

    Failed to query VPC quotas.

    +

    HTTP response status code does not match.

    Failed to query VPC quotas.

    +

    HTTP response status code does not match.

    Contact technical support.

    +

    contact technical support.

    400

    +

    400

    CFW.00700016

    +

    CFW.00700001

    Insufficient route table quota for the VPC.

    +

    er not exist error.

    Insufficient route table quota for the VPC.

    +

    er not exist error.

    Delete the existing route table in the VPC.

    +

    Please check if er exists.

    Changing the east-west protection status

    +

    400

    400

    +

    CFW.00700002

    CFW.00200016

    +

    vpc not exist error.

    Incorrect instance status

    +

    vpc not exist error.

    Incorrect instance status

    -

    Contact technical support.

    +

    Please check if vpc exists.

    Creating a firewall

    -

    400

    +

    400

    CFW.00600003

    +

    CFW.00700003

    The available specifications are empty.

    +

    associated subnet conflict.

    The available specifications are empty.

    +

    associated subnet conflict.

    Contact technical support.

    +

    Please make sure that the created subnet does not overlap with the subnet segment under the existing vpc.

    Deleting a firewall

    +

    400

    400

    +

    CFW.00700004

    CFW.00200016

    +

    create subnet error.

    Incorrect instance status

    +

    create subnet error.

    Incorrect instance status

    -

    Contact technical support.

    +

    contact technical support.

    Adding an address group

    -

    400

    +

    400

    CFW.00200001

    +

    CFW.00700007

    The address group name is empty.

    +

    er attach vpc error.

    The address group name is empty.

    +

    er attach vpc error.

    Check whether the address group name in the request is empty.

    +

    contact technical support.

    400

    +

    400

    CFW.00200007

    +

    CFW.00700012

    The address group name carried in the request is the same as an address group name in the database.

    +

    change route error.

    The address group name carried in the request is the same as an address group name in the database.

    +

    change route error.

    Delete duplicate address group names from the request.

    +

    contact technical support.

    400

    +

    400

    CFW.00200032

    +

    CFW.00700015

    The engine does not support IPv6.

    +

    Get VPC quotas error.

    The engine does not support IPv6.

    +

    Get VPC quotas error.

    Contact technical support.

    +

    contact technical support.

    400

    +

    400

    CFW.00900020

    +

    CFW.00700016

    The number of address groups exceeds the upper limit.

    +

    Vpc contain route table quota not enough.

    The number of address groups exceeds the upper limit.

    +

    Vpc contain route table quota not enough.

    Delete some address groups.

    +

    Please delete the existing routing table under vpc.

    Adding an address group member list

    +

    400

    400

    +

    CFW.00800001

    CFW.00200001

    +

    An error occurred when querying from etcd.

    The address group member list is empty.

    +

    An error occurred when querying from etcd.

    The address group member list is empty.

    -

    Check whether the address group member list in the request is empty.

    +

    contact technical support.

    Obtaining the address group list

    -

    400

    +

    400

    CFW.00200030

    +

    CFW.00800002

    Incorrect address type

    +

    An error occurred when deleting from etcd.

    Incorrect address type

    +

    An error occurred when deleting from etcd.

    Contact technical support.

    +

    contact technical support.

    Updating an address group

    +

    400

    400

    +

    CFW.00800003

    CFW.00200005

    +

    An error occurred when save to etcd.

    The address group in the request does not exist.

    +

    An error occurred when save to etcd.

    The address group in the request does not exist.

    -

    Check whether the address group carried in the request exists.

    +

    contact technical support.

    400

    +

    400

    CFW.00200007

    +

    CFW.00900016

    The address group name carried in the request is the same as an address group name in the database.

    +

    The import task is in progress. Please operate after the task is completed.

    The address group name carried in the request is the same as an address group name in the database.

    +

    The import task is in progress. Please operate after the task is completed.

    Delete duplicate address group names from the request.

    +

    Please wait some time until the import task finishes.

    400

    +

    400

    CFW.00200016

    +

    CFW.00900020

    Incorrect instance status

    +

    Address groups exceed the maximum limit

    Incorrect instance status

    +

    Address groups exceed the maximum limit

    Contact technical support.

    +

    Please delete some address groups.

    Deleting an address group

    -

    400

    +

    400

    CFW.00200004

    +

    CFW.00900030

    The address group to be deleted is being referenced.

    +

    Global services reach limit.

    The address group to be deleted is being referenced.

    +

    Global services reach limit.

    Delete the rules that reference the address group and then delete the address group.

    +

    Please delete some service items.

    400

    -

    CFW.00200005

    -

    The address group in the request does not exist.

    -

    The address group in the request does not exist.

    -

    Check whether the address group carried in the request exists.

    -

    Updating members in an address group

    -

    400

    -

    CFW.00400004

    -

    The member already exists.

    -

    The member already exists.

    -

    Delete unnecessary address group members.

    -

    Adding a service group

    -

    400

    -

    CFW.00200007

    -

    The service group name carried in the request is the same as a service group name in the database.

    -

    The service group name carried in the request is the same as a service group name in the database.

    -

    Delete duplicate service group names from the request.

    -

    400

    -

    CFW.00200024

    -

    The number of added service groups exceeds the upper limit.

    -

    The number of added service groups exceeds the upper limit.

    -

    Remove unnecessary service groups and try again.

    -

    Adding a member to a service group

    -

    400

    -

    CFW.00400004

    -

    The member already exists.

    -

    The member already exists.

    -

    Delete unnecessary service group members.

    -

    400

    -

    CFW.00900030

    -

    The total number of services reaches the upper limit.

    -

    The total number of services reaches the upper limit.

    -

    Delete unnecessary service group members.

    -

    Updating a service group

    -

    400

    -

    CFW.00200005

    -

    The service group in the request does not exist.

    -

    The service group in the request does not exist.

    -

    Check whether the service group in the request exists.

    -

    400

    -

    CFW.00200007

    -

    The address group name carried in the request is the same as an address group name in the database.

    -

    The address group name carried in the request is the same as an address group name in the database.

    -

    Delete duplicate service group names from the request.

    -

    Deleting a service group

    -

    400

    -

    CFW.00200004

    -

    The service group to be deleted is being referenced.

    -

    The service group to be deleted is being referenced.

    -

    Delete the rules that reference the service group and then delete the address group.

    -

    400

    -

    CFW.00200005

    -

    The service group in the request does not exist.

    -

    The service group in the request does not exist.

    -

    Check whether the service group in the request exists.

    -

    Updating a member in a service group

    -

    400

    -

    CFW.00400004

    -

    The member already exists.

    -

    The member already exists.

    -

    Delete unnecessary service group members.

    -

    Configuring the blacklist or whitelist

    -

    400

    -

    CFW.00200022

    -

    It is not allowed to configuring all IP address segments in the blacklist and whitelist.

    -

    It is not allowed to configuring all IP address segments in the blacklist and whitelist.

    -

    Set specific IP address segments in the blacklist and whitelist.

    -

    400

    -

    CFW.00200016

    -

    Incorrect instance status

    -

    Incorrect instance status

    -

    Contact technical support.

    -

    400

    -

    CFW.00200032

    -

    The engine does not support IPv6.

    -

    The engine does not support IPv6.

    -

    Contact technical support.

    -

    400

    -

    CFW.00400011

    -

    Duplicate blacklist and whitelist information.

    -

    Duplicate blacklist and whitelist information.

    -

    Ensure unique blacklist and whitelist items are added.

    -

    400

    -

    CFW.00400012

    -

    East-west protection does not support IPv6, and the private IP address blacklist and whitelist cannot be delivered.

    -

    East-west protection does not support IPv6, and the private IP address blacklist and whitelist cannot be delivered.

    -

    Add east-west protection.

    -

    400

    -

    CFW.00400013

    -

    The number of records in the blacklist and whitelist has reached the upper limit (2000).

    -

    The number of records in the blacklist and whitelist has reached the upper limit (2000).

    -

    Delete unnecessary blacklist or whitelist items.

    -

    Updating the blacklist or whitelist

    -

    400

    -

    CFW.00200005

    -

    The blacklist or whitelist item carried in the request does not exist.

    -

    The blacklist or whitelist item carried in the request does not exist.

    -

    Check whether the blacklist and whitelist items carried in the request exist.

    -

    400

    -

    CFW.00200005

    -

    The blacklist or whitelist item carried in the request does not exist.

    -

    The blacklist or whitelist item carried in the request does not exist.

    -

    Check whether the blacklist and whitelist items carried in the request exist.

    -

    400

    -

    CFW.00200022

    -

    It is not allowed to configuring all IP address segments in the blacklist and whitelist.

    -

    It is not allowed to configuring all IP address segments in the blacklist and whitelist.

    -

    Set specific IP address segments in the blacklist and whitelist.

    -

    400

    -

    CFW.00200032

    -

    The engine does not support IPv6.

    -

    The engine does not support IPv6.

    -

    Contact technical support.

    -

    400

    -

    CFW.00200036

    -

    The CIDR block cannot be changed to a private network segment.

    -

    The CIDR block cannot be changed to a private network segment.

    -

    Contact technical support.

    -

    400

    -

    CFW.00200016

    -

    Incorrect instance status

    -

    Incorrect instance status

    -

    Contact technical support.

    -

    400

    -

    CFW.00400011

    -

    Duplicate blacklist and whitelist information.

    -

    Duplicate blacklist and whitelist information.

    -

    Ensure unique blacklist and whitelist items are added.

    -

    400

    -

    CFW.00200028

    -

    Inconsistent address types

    -

    Inconsistent address types

    -

    Ensure the address types are the same.

    -

    Removing a blacklisted or whitelisted item

    -

    400

    -

    CFW.00200005

    -

    The blacklist or whitelist item carried in the request does not exist.

    -

    The blacklist or whitelist item carried in the request does not exist.

    -

    Check whether the blacklist and whitelist items carried in the request exist.

    -

    User-defined IPS rules

    -

    400

    -

    CFW.00200016

    -

    Incorrect instance status

    -

    Incorrect instance status

    -

    Contact technical support.

    -

    Changing the IPS switch status

    -

    400

    -

    CFW.00200023

    -

    Failed to call the background API for modifying the IPS switch status.

    -

    Failed to call the background API for modifying the IPS switch status.

    -

    Try again later or contact technical support.

    -

    400

    -

    CFW.00200110

    -

    Basic defense cannot be operated.

    -

    Basic defense cannot be operated.

    -

    Contact technical support.

    -

    Changing the EIP protection mode

    -

    400

    +

    400

    CFW.00200016

    +

    CFW.01100008

    Incorrect instance status

    +

    Configurations cannot be delivered during cluster capacity expansion.

    Incorrect instance status

    +

    Configurations cannot be delivered during cluster capacity expansion.

    Contact technical support.

    +

    contact technical support.

    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    -
    Table 2 Query Parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    fw_instance_id

    +

    fw_instance_id

    Yes

    +

    Yes

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    rule_id

    +

    rule_id

    No

    +

    No

    String

    +

    String

    Rule ID, which can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

    +

    Rule ID, which can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

    start_time

    +

    start_time

    Yes

    +

    Yes

    Long

    +

    Long

    Start time, in milliseconds. The value is a timestamp, for example, 1718936272648.

    +

    Start time, in milliseconds. The value is a timestamp, for example, 1718936272648.

    end_time

    +

    end_time

    Yes

    +

    Yes

    Long

    +

    Long

    End time, in milliseconds. The value is a timestamp, for example, 1718936272648.

    +

    End time, in milliseconds. The value is a timestamp, for example, 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.

    +

    Source port.

    dst_ip

    +

    dst_ip

    No

    +

    No

    String

    +

    String

    Destination IP address.

    +

    Destination IP address.

    dst_port

    +

    dst_port

    No

    +

    No

    Integer

    +

    Integer

    Destination port.

    +

    Destination port.

    protocol

    +

    protocol

    No

    +

    No

    String

    +

    String

    Protocol type. Its value can be TCP, UDP, ICMP, or ICMPv6.

    +

    Protocol type. Its value can be TCP, UDP, ICMP, or ICMPv6.

    app

    +

    app

    No

    +

    No

    String

    +

    String

    Rule application type. Its value can be HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

    +

    Rule application type. Its value can be HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

    log_id

    +

    log_id

    No

    +

    No

    String

    +

    String

    Document ID. For the first page, its value is null. For other pages, its value can be the log_id of the last record in the last query.

    +

    Document ID. For the first page, its value is null. For other pages, its value can be the log_id of the last record in the last query.

    next_date

    +

    next_date

    No

    +

    No

    Integer

    +

    Integer

    Next date. For the first page, its value is null. For other pages, its value can be the start_time of the last record in the last query.

    +

    Next date. For the first page, its value is null. For other pages, its value can be the start_time of the last record in the last query.

    offset

    +

    offset

    No

    +

    No

    Integer

    +

    Integer

    Offset, which specifies the start position of the record to be returned. The value must be a number greater than 0. For the first page, its value is null. For other pages, its value is not null.

    +

    Offset, which specifies the start position of the record to be returned. The value must be a number greater than 0. For the first page, its value is null. For other pages, its value is not null.

    limit

    +

    limit

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    log_type

    +

    log_type

    No

    +

    No

    String

    +

    String

    Log type. Its value can be internet, vpc, or nat.

    +

    Log type. Its value can be internet, vpc, or nat.

    enterprise_project_id

    +

    enterprise_project_id

    No

    +

    No

    String

    +

    String

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    dst_host

    +

    dst_host

    No

    +

    No

    String

    +

    String

    Destination host.

    +

    Destination host.

    rule_name

    +

    rule_name

    No

    +

    No

    String

    +

    String

    Rule name.

    +

    Rule name.

    action

    +

    action

    No

    +

    No

    String

    +

    String

    Action. Its value can be permit or deny.

    +

    Action. Its value can be permit or deny.

    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

    Destination province name.

    +

    Destination 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

    Destination city name.

    +

    Destination 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    Returned data for querying access control logs.

    +

    Returned data for querying access control logs.

    -
    Table 5 data

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    total

    +

    total

    Integer

    +

    Integer

    Query the total number of access control logs.

    +

    Query the total number of access control logs.

    limit

    +

    limit

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    records

    +

    records

    Array of records objects

    +

    Array of records objects

    Query access control logs.

    +

    Query access control logs.

    -
    Table 6 records

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    action

    +

    action

    String

    +

    String

    Action: 0 (allow), 1 (deny).

    +

    Action: 0 (allow), 1 (deny).

    rule_name

    +

    rule_name

    String

    +

    String

    Rule name.

    +

    Rule name.

    rule_id

    +

    rule_id

    String

    +

    String

    Rule ID.

    +

    Rule ID.

    hit_time

    +

    hit_time

    Long

    +

    Long

    Hit time, in milliseconds. The value is a timestamp, for example, 1718936272648.

    +

    Hit time, in milliseconds. The value is a timestamp, for example, 1718936272648.

    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.

    log_id

    +

    log_id

    String

    +

    String

    Document ID.

    +

    Document ID.

    src_ip

    +

    src_ip

    String

    +

    String

    Source IP address.

    +

    Source IP address.

    src_port

    +

    src_port

    Integer

    +

    Integer

    Source port.

    +

    Source port.

    dst_ip

    +

    dst_ip

    String

    +

    String

    Destination IP address.

    +

    Destination IP address.

    dst_port

    +

    dst_port

    Integer

    +

    Integer

    Destination port.

    +

    Destination port.

    protocol

    +

    protocol

    String

    +

    String

    Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).

    +

    Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).

    app

    +

    app

    String

    +

    String

    Rule application type. Its value can be HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

    +

    Rule application type. Its value can be HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

    dst_host

    +

    dst_host

    String

    +

    String

    Destination host.

    +

    Destination host.

    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

    Destination province ID.

    +

    Destination province ID.

    dst_province_name

    +

    dst_province_name

    String

    +

    String

    Destination province name.

    +

    Destination province name.

    dst_city_id

    +

    dst_city_id

    String

    +

    String

    Destination city ID.

    +

    Destination city ID.

    dst_city_name

    +

    dst_city_name

    String

    +

    String

    Destination city name.

    +

    Destination city name.

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Query the records whose initial position is 0 on the first page of the firewall with the ID 2af58b7c-893c-4453-a984-bdd9b1bd6318 in the project 9d80d070b6d44942af73c9c3d38e0429. The query time range is 1664159069544 to 1664162669544.

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

    Example Requests

    Query the records whose initial position is 0 on the first page of the firewall with the ID 2af58b7c-893c-4453-a984-bdd9b1bd6318 in the project 9d80d070b6d44942af73c9c3d38e0429. The query time range is 1664159069544 to 1664162669544.

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

    Example Responses

    Status code: 200

    -

    Return value for querying access control logs.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for querying access control logs.

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

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00500002",
       "error_msg" : "Invalid interval."
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for querying access control logs.

    +

    Return value for querying access control logs.

    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/ListAclRuleHitCount.html b/docs/cfw/api-ref/ListAclRuleHitCount.html index 75993e89b..0b410084a 100644 --- a/docs/cfw/api-ref/ListAclRuleHitCount.html +++ b/docs/cfw/api-ref/ListAclRuleHitCount.html @@ -1,218 +1,218 @@

    Obtaining the Number of Rule Hits

    -

    Function

    This API is used to obtain the number of rule hits.

    +

    Function

    This API is used to obtain the number of rule hits.

    -

    URI

    POST /v1/{project_id}/acl-rule/count

    +

    URI

    POST /v1/{project_id}/acl-rule/count

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    Table 4 Request body parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    rule_ids

    +

    rule_ids

    Yes

    +

    Yes

    Array of strings

    +

    Array of strings

    List of rule IDs. You can obtain the rule IDs by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

    +

    List of rule IDs. You can obtain the rule IDs by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 5 Response body parameters

    Parameter

    +
    - - - - -
    Table 5 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    data

    +

    data

    RuleHitCountRecords object

    +

    RuleHitCountRecords object

    Response to the request for obtaining the number of rule hits.

    +

    Response to the request for obtaining the number of rule hits.

    -
    Table 6 RuleHitCountRecords

    Parameter

    +
    - - - - - - - - - - - - - -
    Table 6 RuleHitCountRecords

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    limit

    +

    limit

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    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.

    total

    +

    total

    Integer

    +

    Integer

    Obtain the total number of rule hits.

    +

    Obtain the total number of rule hits.

    records

    +

    records

    Array of RuleHitCountObject objects

    +

    Array of RuleHitCountObject objects

    List of rule hits.

    +

    List of rule hits.

    -
    Table 7 RuleHitCountObject

    Parameter

    +
    - - - - - - - -
    Table 7 RuleHitCountObject

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    rule_id

    +

    rule_id

    String

    +

    String

    Rule ID.

    +

    Rule ID.

    rule_hit_count

    +

    rule_hit_count

    Integer

    +

    Integer

    Number of hits of a rule. When an ACL rule is triggered, the number of hits of the corresponding rule ID increases by one.

    +

    Number of hits of a rule. When an ACL rule is triggered, the number of hits of the corresponding rule ID increases by one.

    -

    Example Requests

    Query the hits of ACL rule 59ff6bd9-0a76-41ec-9650-380086069965 whose project ID is 0b2179bbe180d3762fb0c01a2d5725c7.

    -
    https://{Endpoint}/v1/0b2179bbe180d3762fb0c01a2d5725c7/acl-rule/count
    +

    Example Requests

    Query the hits of ACL rule 59ff6bd9-0a76-41ec-9650-380086069965 whose project ID is 0b2179bbe180d3762fb0c01a2d5725c7.

    +
    https://{Endpoint}/v1/0b2179bbe180d3762fb0c01a2d5725c7/acl-rule/count
     
     {
       "rule_ids" : [ "59ff6bd9-0a76-41ec-9650-380086069965" ]
     }
    -

    Example Responses

    Status code: 200

    -

    Response to the request for obtaining the number of rule hits.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Response to the request for obtaining the number of rule hits.

    +
    {
       "data" : {
         "limit" : 1,
         "offset" : 1,
    @@ -224,43 +224,43 @@
       }
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Response to the request for obtaining the number of rule hits.

    +

    Response to the request for obtaining the number of rule hits.

    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/ListAclRules.html b/docs/cfw/api-ref/ListAclRules.html index 787b50fae..85c916d9a 100644 --- a/docs/cfw/api-ref/ListAclRules.html +++ b/docs/cfw/api-ref/ListAclRules.html @@ -1,857 +1,857 @@

    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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    +

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    type

    +

    type

    No

    +

    No

    Integer

    +

    Integer

    Rule type: 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule).

    +

    Rule type: 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule).

    ip

    +

    ip

    No

    +

    No

    String

    +

    String

    IP address

    +

    IP address

    name

    +

    name

    No

    +

    No

    String

    +

    String

    Rule name.

    +

    Rule name.

    direction

    +

    direction

    No

    +

    No

    Integer

    +

    Integer

    Direction: 0 (inbound), 1 (outbound).

    +

    Direction: 0 (inbound), 1 (outbound).

    status

    +

    status

    No

    +

    No

    Integer

    +

    Integer

    Rule delivery status: 0 (disabled), 1 (enabled).

    +

    Rule delivery status: 0 (disabled), 1 (enabled).

    action_type

    +

    action_type

    No

    +

    No

    Integer

    +

    Integer

    Action: 0 (allow), 1 (deny).

    +

    Action: 0 (allow), 1 (deny).

    address_type

    +

    address_type

    No

    +

    No

    Integer

    +

    Integer

    Address type: 0 (IPv4), 1 (IPv6).

    +

    Internet protocol type of an address: 0 (IPv4), 1 (IPv6).

    limit

    +

    limit

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    tags_id

    +

    tags_id

    No

    +

    No

    String

    +

    String

    Rule tag ID, which is generated when a rule is created.

    +

    Rule tag ID, which is generated when a rule is created.

    source

    +

    source

    No

    +

    No

    String

    +

    String

    Source IP address.

    +

    Source IP address.

    destination

    +

    destination

    No

    +

    No

    String

    +

    String

    Destination IP address.

    +

    Destination IP address.

    service

    +

    service

    No

    +

    No

    String

    +

    String

    Service port.

    +

    Service port.

    application

    +

    application

    No

    +

    No

    String

    +

    String

    Rule application type. Its value can be HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

    +

    Rule application type. Its value can be HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

    -

    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.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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 for querying the rule list.

    +

    Return value for querying the rule 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. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    total

    +

    total

    Integer

    +

    Integer

    Query the total number of rules in the rule list.

    +

    Query the total number of rules in the rule list.

    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 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.

    +

    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 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.

    records

    +

    records

    Array of records objects

    +

    Array of records objects

    Query the rule list.

    +

    Query the rule list.

    -
    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: 0 (IPv4), 1 (IPv6).

    +

    Internet protocol type of an address: 0 (IPv4), 1 (IPv6).

    name

    +

    name

    String

    +

    String

    Rule name.

    +

    Rule name.

    direction

    +

    direction

    Integer

    +

    Integer

    Rule direction: 0 (inbound), 1 (outbound).

    +

    Rule direction: 0 (inbound), 1 (outbound).

    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 (minute).

    +

    Persistent connection duration (minute).

    long_connect_time_second

    +

    long_connect_time_second

    Long

    +

    Long

    Persistent connection duration (second).

    +

    Persistent connection duration (second).

    source

    +

    source

    RuleAddressDtoForResponse object

    +

    RuleAddressDtoForResponse object

    Source address object.

    +

    Source address object.

    destination

    +

    destination

    RuleAddressDtoForResponse object

    +

    RuleAddressDtoForResponse object

    Destination address object.

    +

    Destination address object.

    service

    +

    service

    RuleServiceDtoForResponse object

    +

    RuleServiceDtoForResponse object

    Service object.

    +

    Service object.

    type

    +

    type

    Integer

    +

    Integer

    Rule type: 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule).

    +

    Rule type: 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule).

    created_date

    +

    created_date

    String

    +

    String

    Rule creation time, for example, 2024-08-12 08:40:00.

    +

    Rule creation time, for example, 2024-08-12 08:40:00.

    last_open_time

    +

    last_open_time

    String

    +

    String

    Last time when the rule was enabled, for example, 2024-08-12 08:40:00.

    +

    Last time when the rule was enabled, for example, 2024-08-12 08:40:00.

    tag

    +

    tag

    TagsVO object

    +

    TagsVO object

    Tag object attached to a rule.

    +

    Tag object attached to a rule.

    -
    Table 7 RuleAddressDtoForResponse

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    type

    +

    type

    Integer

    +

    Integer

    Address type: 0 (manual input), 1 (associated IP address group), 2 (domain name), 3 (geographical location), 4 (domain name group) 5 (multiple objects), 6 (domain name group - network), 7 (domain name group - application).

    +

    Address type: 0 (manual input), 1 (associated IP address group), 2 (domain name), 3 (geographical location), 4 (domain name group) 5 (multiple objects), 6 (domain name group - network), 7 (domain name group - application).

    address_type

    +

    address_type

    Integer

    +

    Integer

    Address type: 0 (IPv4), 1 (IPv6). If type is 0, the input cannot be left blank.

    +

    Internet protocol type of an address: 0 (IPv4), 1 (IPv6). If type is 0, this parameter cannot be left blank.

    address

    +

    address

    String

    +

    String

    IP address information.

    +

    IP address information.

    address_set_id

    +

    address_set_id

    String

    +

    String

    ID of an associated IP address group.

    +

    ID of an associated IP address group.

    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 a domain name address.

    +

    Name of a domain name address.

    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

    Rule region list.

    +

    Rule region list.

    domain_set_id

    +

    domain_set_id

    String

    +

    String

    Domain name group ID

    +

    Domain name group ID

    domain_set_name

    +

    domain_set_name

    String

    +

    String

    Domain name group name.

    +

    Domain name group 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 ID list.

    +

    Address group ID list.

    address_group_names

    +

    address_group_names

    Array of AddressGroupVO objects

    +

    Array of AddressGroupVO objects

    Address group name list.

    +

    Address group name list.

    address_set_type

    +

    address_set_type

    Integer

    +

    Integer

    Address group type: 0 (user-defined address group), 1 (WAF back-to-source IP address group), 2 (DDoS back-to-source IP address group), or 3 (NAT64 address group).

    +

    Address group type: 0 (user-defined address group), 1 (WAF back-to-source IP address group), 2 (DDoS back-to-source IP address group), or 3 (NAT64 address group).

    -
    Table 8 IpRegionDto

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    region_id

    +

    region_id

    String

    +

    String

    Region ID. You can obtain the ID by referring to Obtaining Information About Account, IAM User, Group, Project, Region, and Agency.

    +

    Region ID. You can obtain the ID by referring to Obtaining Information About Account, IAM User, Group, Project, Region, and Agency.

    region_type

    +

    region_type

    Integer

    +

    Integer

    Region type: 0 (country), 1 (province), and 2 (continent). It can be obtained from the region information table.

    +

    Region type: 0 (country), 1 (province), and 2 (continent). It can be obtained from the region information table.

    -
    Table 9 AddressGroupVO

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    address_set_type

    +

    address_set_type

    Integer

    +

    Integer

    Address group type: 0 (user-defined address group), 1 (WAF back-to-source IP address group), 2 (DDoS back-to-source IP address group), or 3 (NAT64 address group).

    +

    Address group type: 0 (user-defined address group), 1 (WAF back-to-source IP address group), 2 (DDoS back-to-source IP address group), or 3 (NAT64 address group).

    name

    +

    name

    String

    +

    String

    Name of an associated IP address group, which can be obtained by calling the API for querying the address group list. Find the value in data.records.name (The period [.] is used to separate different levels of objects).

    +

    Name of an associated IP address group, which can be obtained by calling the API for querying the address group list. Find the value in data.records.name (The period [.] is used to separate different levels of objects).

    set_id

    +

    set_id

    String

    +

    String

    ID of an associated IP address group, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    ID of an associated IP address group, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    -
    Table 10 RuleServiceDtoForResponse

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    type

    +

    type

    Integer

    +

    Integer

    Service input type: 0 (manual), 1 (automatic).

    +

    Service input type: 0 (manual), 1 (automatic).

    protocol

    +

    protocol

    Integer

    +

    Integer

    Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).

    +

    Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).

    protocols

    +

    protocols

    Array of integers

    +

    Array of integers

    Protocol list. Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).

    +

    Protocol list. Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).

    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.

    +

    Service group ID.

    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 ID list.

    +

    Service group ID 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 group type: 0 (user-defined service group), 1 (common web service), 2 (common remote login and ping), or 3 (common database).

    +

    Service group type: 0 (user-defined service group), 1 (common web service), 2 (common remote login and ping), or 3 (common database).

    -
    Table 11 ServiceItem

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    protocol

    +

    protocol

    Integer

    +

    Integer

    Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when RuleServiceDto.type is set to 0 (manual).

    +

    Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when RuleServiceDto.type is set to 0 (manual).

    source_port

    +

    source_port

    String

    +

    String

    Source port.

    +

    Source port.

    dest_port

    +

    dest_port

    String

    +

    String

    Destination port.

    +

    Destination port.

    description

    +

    description

    String

    +

    String

    Service member description.

    +

    Service member description.

    name

    +

    name

    String

    +

    String

    Service member name.

    +

    Service member 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

    Protocol list. Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any).

    +

    Protocol list. Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any).

    service_set_type

    +

    service_set_type

    Integer

    +

    Integer

    Service group type: 0 (user-defined service group), 1 (predefined service group).

    +

    Service group type: 0 (user-defined service group), 1 (predefined service group).

    set_id

    +

    set_id

    String

    +

    String

    Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    -
    Table 13 TagsVO

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    tag_id

    +

    tag_id

    String

    +

    String

    Rule ID.

    +

    Rule tag ID.

    tag_key

    +

    tag_key

    String

    +

    String

    Rule tag key.

    +

    Rule tag key.

    tag_value

    +

    tag_value

    String

    +

    String

    Rule tag value.

    +

    Rule 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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Query data on the first page of the protected object e12bd2cd-ebfc-4af7-ad6f-ebe6da398029 whose project ID is 9d80d070b6d44942af73c9c3d38e0429, with limit set to 10.

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

    Example Requests

    Query data on the first page of the protected object e12bd2cd-ebfc-4af7-ad6f-ebe6da398029 whose project ID is 9d80d070b6d44942af73c9c3d38e0429, with limit set to 10.

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

    Example Responses

    Status code: 200

    -

    Return value for querying the rule list.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for querying the rule list.

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

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

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

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for querying the rule list.

    +

    Return value for querying the rule 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/ListAddressItems.html b/docs/cfw/api-ref/ListAddressItems.html index 5898bc194..106618675 100644 --- a/docs/cfw/api-ref/ListAddressItems.html +++ b/docs/cfw/api-ref/ListAddressItems.html @@ -1,300 +1,300 @@

    Querying Address Group Members

    -

    Function

    This API is used to query members in an address group.

    +

    Function

    This API is used to query members in an address group.

    -

    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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

    Address group ID, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    Address group ID, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    key_word

    +

    key_word

    No

    +

    No

    String

    +

    String

    Keyword, including the name or part of the description of an address group member.

    +

    Keyword, including the name or part of the description of an address group member.

    limit

    +

    limit

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    query_address_set_type

    +

    query_address_set_type

    No

    +

    No

    Integer

    +

    Integer

    Type of the address group to be queried: 0 (user-defined address group), 1 (predefined address group).

    +

    Type of the address group to be queried: 0 (user-defined address group), 1 (predefined address group).

    -

    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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    Returned data for querying address group members.

    +

    Returned data for querying address group members.

    -
    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. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    total

    +

    total

    Integer

    +

    Integer

    Total number of address group members.

    +

    Total number of address group members.

    set_id

    +

    set_id

    String

    +

    String

    Address group ID.

    +

    Address group ID.

    records

    +

    records

    Array of records objects

    +

    Array of records objects

    List of address group member records.

    +

    List of address group member records.

    -
    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 type: 0 (IPv4), 1 (IPv6).

    +

    Internet protocol type of an address: 0 (IPv4), 1 (IPv6).

    address

    +

    address

    String

    +

    String

    Address information.

    +

    Address information.

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

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

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

    Example Requests

    Query members in the address group 8773c082-2a6c-4529-939a-edc28ef1a67c in 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,
    @@ -308,55 +308,55 @@
         "total" : 1
       }
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00200005",
       "error_msg" : "Object not found."
     }
    -

    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/ListAddressSetDetail.html b/docs/cfw/api-ref/ListAddressSetDetail.html index b3a05e26a..0c18add43 100644 --- a/docs/cfw/api-ref/ListAddressSetDetail.html +++ b/docs/cfw/api-ref/ListAddressSetDetail.html @@ -1,217 +1,217 @@

    Querying Address Group Details

    -

    Function

    This API is used to query address group details.

    +

    Function

    This API is used to query address group details.

    -

    URI

    GET /v1/{project_id}/address-sets/{set_id}

    +

    URI

    GET /v1/{project_id}/address-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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    set_id

    +

    set_id

    Yes

    +

    Yes

    String

    +

    String

    Address group ID, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    Address group ID, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    query_address_set_type

    +

    query_address_set_type

    No

    +

    No

    Integer

    +

    Integer

    Type of the address group to be queried: 0 (user-defined address group), 1 (predefined address group).

    +

    Type of the address group to be queried: 0 (user-defined address group), 1 (predefined address group).

    -

    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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    Query address group details.

    +

    Query address group details.

    -
    Table 5 data

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Address group ID.

    +

    Address group ID.

    name

    +

    name

    String

    +

    String

    IP address group name.

    +

    IP address group name.

    description

    +

    description

    String

    +

    String

    Address group description.

    +

    Address group description.

    address_set_type

    +

    address_set_type

    Integer

    +

    Integer

    Address group type: 0 (user-defined address group), 1 (WAF back-to-source IP address group), 2 (DDoS back-to-source IP address group), or 3 (NAT64 address group).

    +

    Address group type: 0 (user-defined address group), 1 (WAF back-to-source IP address group), 2 (DDoS back-to-source IP address group), or 3 (NAT64 address group).

    address_type

    +

    address_type

    Integer

    +

    Integer

    Address type: 0 (IPv4), 1 (IPv6).

    +

    Internet protocol type of an address: 0 (IPv4), 1 (IPv6).

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Query details about the address group cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 in project 9d80d070b6d44942af73c9c3d38e0429.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-sets/cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16
    +

    Example Requests

    Query details about the address group cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 in project 9d80d070b6d44942af73c9c3d38e0429.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-sets/cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16
    -

    Example Responses

    Status code: 200

    -

    Response body for querying address group details.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Response body for querying address group details.

    +
    {
       "data" : {
         "address_set_type" : 0,
         "address_type" : 0,
    @@ -220,55 +220,55 @@
         "name" : "ABC"
       }
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00200005",
       "error_msg" : "Object not found."
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Response body for querying address group details.

    +

    Response body for querying address group details.

    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 3c4c4b634..ee6e2bcf5 100644 --- a/docs/cfw/api-ref/ListAddressSets.html +++ b/docs/cfw/api-ref/ListAddressSets.html @@ -1,318 +1,318 @@

    Querying the Address Group List

    -

    Function

    This API is used to query the address group list.

    +

    Function

    This API is used to query the address group list.

    -

    URI

    GET /v1/{project_id}/address-sets

    +

    URI

    GET /v1/{project_id}/address-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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    +

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    key_word

    +

    key_word

    No

    +

    No

    String

    +

    String

    Keyword, including the name or part of the description of an address group.

    +

    Keyword, including the name or part of the description of an address group.

    limit

    +

    limit

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 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

    address_type

    +

    address_type

    No

    +

    No

    Integer

    +

    Integer

    Address type: 0 (IPv4), 1 (IPv6).

    +

    Internet protocol type of an address: 0 (IPv4), 1 (IPv6).

    enterprise_project_id

    +

    enterprise_project_id

    No

    +

    No

    String

    +

    String

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    query_address_set_type

    +

    query_address_set_type

    No

    +

    No

    Integer

    +

    Integer

    Type of the address group to be queried: 0 (user-defined address group), 1 (predefined address group). This parameter takes effect only if address_set_type is not 0 and query_address_set_type is 1.

    +

    Type of the address group to be queried: 0 (user-defined address group), 1 (predefined address group). This parameter takes effect only if address_set_type is not 0 and query_address_set_type is 1.

    address_set_type

    +

    address_set_type

    No

    +

    No

    Integer

    +

    Integer

    Address group type: 0 (user-defined address group), 1 (WAF back-to-source IP address group), 2 (DDoS back-to-source IP address group), or 3 (NAT64 address group).

    +

    Address group type: 0 (user-defined address group), 1 (WAF back-to-source IP address group), 2 (DDoS back-to-source IP address group), or 3 (NAT64 address group).

    -

    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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    Returned data for querying the address group list.

    +

    Returned data for querying the address group 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. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    total

    +

    total

    Integer

    +

    Integer

    Total number of address groups.

    +

    Total number of address groups.

    records

    +

    records

    Array of records objects

    +

    Array of records objects

    IP address group list.

    +

    IP address group list.

    -
    Table 6 records

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    set_id

    +

    set_id

    String

    +

    String

    Address group ID.

    +

    Address group ID.

    ref_count

    +

    ref_count

    Integer

    +

    Integer

    Number of times an address group is referenced by rules.

    +

    Number of times an address group is referenced by rules.

    description

    +

    description

    String

    +

    String

    Description.

    +

    Description.

    address_type

    +

    address_type

    Integer

    +

    Integer

    Address type: 0 (IPv4), 1 (IPv6).

    +

    Internet protocol type of an address: 0 (IPv4), 1 (IPv6).

    object_id

    +

    object_id

    String

    +

    String

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    +

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    address_set_type

    +

    address_set_type

    Integer

    +

    Integer

    Address group type: 0 (user-defined address group), 1 (WAF back-to-source IP address group), 2 (DDoS back-to-source IP address group), or 3 (NAT64 address group).

    +

    Address group type: 0 (user-defined address group), 1 (WAF back-to-source IP address group), 2 (DDoS back-to-source IP address group), or 3 (NAT64 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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Query the IP address groups on the first page of the protected object 8a41d6a5-f215-428a-a76c-dc923b5d599a in project 5c69cf330cda42369cbd726ee1bc5e76.

    -
    https://{Endpoint}/v1/5c69cf330cda42369cbd726ee1bc5e76/address-sets?object_id=8a41d6a5-f215-428a-a76c-dc923b5d599a&limit=10&offset=0
    +

    Example Requests

    Query the IP address groups on the first page of the protected object 8a41d6a5-f215-428a-a76c-dc923b5d599a in project 5c69cf330cda42369cbd726ee1bc5e76.

    +
    https://{Endpoint}/v1/5c69cf330cda42369cbd726ee1bc5e76/address-sets?object_id=8a41d6a5-f215-428a-a76c-dc923b5d599a&limit=10&offset=0
    -

    Example Responses

    Status code: 200

    -

    Return value for querying the address group list.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for querying the address group list.

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

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

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

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for querying the address group list.

    +

    Return value for querying the address group 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/ListAttackLogs.html b/docs/cfw/api-ref/ListAttackLogs.html index 383ba0b35..9ae7623d6 100644 --- a/docs/cfw/api-ref/ListAttackLogs.html +++ b/docs/cfw/api-ref/ListAttackLogs.html @@ -1,681 +1,681 @@

    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, in milliseconds. The value is a timestamp, for example, 1718936272648.

    +

    Start time, in milliseconds. The value is a timestamp, for example, 1718936272648.

    end_time

    +

    end_time

    Yes

    +

    Yes

    Long

    +

    Long

    End time, in milliseconds. The value is a timestamp, for example, 1718936272648.

    +

    End time, in milliseconds. The value is a timestamp, for example, 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.

    +

    Source port.

    dst_ip

    +

    dst_ip

    No

    +

    No

    String

    +

    String

    Destination IP address.

    +

    Destination IP address.

    dst_port

    +

    dst_port

    No

    +

    No

    Integer

    +

    Integer

    Destination port.

    +

    Destination port.

    protocol

    +

    protocol

    No

    +

    No

    String

    +

    String

    Protocol type. Its value can be TCP, UDP, ICMP, or ICMPv6.

    +

    Protocol type. Its value can be TCP, UDP, ICMP, or ICMPv6.

    app

    +

    app

    No

    +

    No

    String

    +

    String

    Rule application type. Its value can be HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

    +

    Rule application type. Its value can be HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

    log_id

    +

    log_id

    No

    +

    No

    String

    +

    String

    Document ID. For the first page, its value is null. For other pages, its value can be the log_id of the last record in the last query.

    +

    Document ID. For the first page, its value is null. For other pages, its value can be the log_id of the last record in the last query.

    next_date

    +

    next_date

    No

    +

    No

    Long

    +

    Long

    Next date. For the first page, its value is null. For other pages, its value can be the event_time of the last record in the last query.

    +

    Next date. For the first page, its value is null. For other pages, its value can be the event_time of the last record in the last query.

    offset

    +

    offset

    No

    +

    No

    Integer

    +

    Integer

    Offset, which specifies the start position of the record to be returned. The value must be a number greater than 0. For the first page, its value is null. For other pages, its value is not null.

    +

    Offset, which specifies the start position of the record to be returned. The value must be a number greater than 0. For the first page, its value is null. For other pages, its value is not null.

    limit

    +

    limit

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    fw_instance_id

    +

    fw_instance_id

    Yes

    +

    Yes

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    action

    +

    action

    No

    +

    No

    String

    +

    String

    Action. Its value can be permit or deny.

    +

    Action. Its value can be permit or deny.

    direction

    +

    direction

    No

    +

    No

    String

    +

    String

    Direction. Its value can be in2out or out2in.

    +

    Direction. Its value can be in2out or 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.

    level

    +

    level

    No

    +

    No

    String

    +

    String

    Threat level. Its value can be CRITICAL, HIGH, MEDIUM, or LOW.

    +

    Threat level. Its value can be CRITICAL, HIGH, MEDIUM, or LOW.

    enterprise_project_id

    +

    enterprise_project_id

    No

    +

    No

    String

    +

    String

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    dst_host

    +

    dst_host

    No

    +

    No

    String

    +

    String

    Destination host.

    +

    Destination host.

    log_type

    +

    log_type

    No

    +

    No

    String

    +

    String

    Log type. Its value can be internet, vpc, or nat.

    +

    Log type. Its value can be internet, vpc, or nat.

    attack_rule_id

    +

    attack_rule_id

    No

    +

    No

    String

    +

    String

    Intrusion event ID.

    +

    Intrusion event 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

    Destination province name.

    +

    Destination 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

    Destination city name.

    +

    Destination 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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 for querying attack logs.

    +

    Return value for querying attack logs.

    -
    Table 5 data

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    total

    +

    total

    Integer

    +

    Integer

    Total number of returned attack data records.

    +

    Total number of returned attack data records.

    limit

    +

    limit

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    records

    +

    records

    Array of records objects

    +

    Array of records objects

    Attack log list.

    +

    Attack log list.

    -
    Table 6 records

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    direction

    +

    direction

    String

    +

    String

    Direction. Its value can be in2out or out2in.

    +

    Direction. Its value can be in2out or out2in.

    action

    +

    action

    String

    +

    String

    Action. Its value can be permit or deny.

    +

    Action. Its value can be permit or deny.

    event_time

    +

    event_time

    Long

    +

    Long

    Event time, in milliseconds. The value is a timestamp, for example, 1718936272648.

    +

    Event time, in milliseconds. The value is a timestamp, for example, 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. Its value can be CRITICAL, HIGH, MEDIUM, or LOW.

    +

    Threat level. Its value can be CRITICAL, HIGH, MEDIUM, or LOW.

    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

    Long

    +

    Long

    Hit time, in milliseconds. The value is a timestamp, for example, 1718936272648.

    +

    Hit time, in milliseconds. The value is a timestamp, for example, 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.

    +

    Source port.

    dst_ip

    +

    dst_ip

    String

    +

    String

    Destination IP address.

    +

    Destination IP address.

    dst_port

    +

    dst_port

    Integer

    +

    Integer

    Destination port.

    +

    Destination port.

    protocol

    +

    protocol

    String

    +

    String

    Protocol type. Its value can be TCP, UDP, ICMP, or ICMPv6.

    +

    Protocol type. Its value can be TCP, UDP, ICMP, or ICMPv6.

    packet

    +

    packet

    String

    +

    String

    Attack log packet.

    +

    Attack log packet.

    app

    +

    app

    String

    +

    String

    Rule application type. Its value can be HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

    +

    Rule application type. Its value can be HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

    packetMessages

    +

    packetMessages

    Array of PacketMessage objects

    +

    Array of PacketMessage objects

    Attack packet information.

    +

    Attack packet information.

    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

    Destination province ID.

    +

    Destination province ID.

    dst_province_name

    +

    dst_province_name

    String

    +

    String

    Destination province name.

    +

    Destination province name.

    dst_city_id

    +

    dst_city_id

    String

    +

    String

    Destination city ID.

    +

    Destination city ID.

    dst_city_name

    +

    dst_city_name

    String

    +

    String

    Destination city name.

    +

    Destination city name.

    -
    Table 7 PacketMessage

    Parameter

    +
    - - - - - - - - - - -
    Table 7 PacketMessage

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    hex_index

    +

    hex_index

    String

    +

    String

    Hexadecimal index.

    +

    Hexadecimal index.

    hexs

    +

    hexs

    Array of strings

    +

    Array of strings

    Hexadecimal number sequence.

    +

    Hexadecimal number sequence.

    utf8_String

    +

    utf8_String

    String

    +

    String

    UTF-8 string.

    +

    UTF-8 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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    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

    -

    Return value for querying attack logs.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for querying attack logs.

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

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "00500002",
       "error_msg" : "Invalid interval."
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for querying attack logs.

    +

    Return value for querying attack logs.

    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 410de0db3..79f26584b 100644 --- a/docs/cfw/api-ref/ListBlackWhiteLists.html +++ b/docs/cfw/api-ref/ListBlackWhiteLists.html @@ -1,316 +1,316 @@

    Querying a Blacklist or Whitelist

    -

    Function

    This API is used to query a blacklist or whitelist.

    +

    Function

    This API is used to query a blacklist or whitelist.

    -

    URI

    GET /v1/{project_id}/black-white-lists

    +

    URI

    GET /v1/{project_id}/black-white-lists

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    +

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    list_type

    +

    list_type

    Yes

    +

    Yes

    Integer

    +

    Integer

    Blacklist/Whitelist type: 4 (blacklist), 5 (whitelist).

    +

    Blacklist/Whitelist type: 4 (blacklist), 5 (whitelist).

    address_type

    +

    address_type

    No

    +

    No

    Integer

    +

    Integer

    IP address type: 0 (IPv4), 1 (IPv6).

    +

    Internet protocol type of an address: 0 (IPv4), 1 (IPv6).

    address

    +

    address

    No

    +

    No

    String

    +

    String

    IP address

    +

    IP address

    port

    +

    port

    No

    +

    No

    String

    +

    String

    Port

    +

    Port

    limit

    +

    limit

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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 for querying the blacklist/whitelist.

    +

    Return value for querying the blacklist/whitelist.

    -
    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. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    total

    +

    total

    Integer

    +

    Integer

    Query the total number of blacklist/whitelist records.

    +

    Query the total number of blacklist/whitelist records.

    records

    +

    records

    Array of records objects

    +

    Array of records objects

    Blacklist/Whitelist.

    +

    Blacklist/Whitelist.

    -
    Table 6 records

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    list_id

    +

    list_id

    String

    +

    String

    Blacklist/Whitelist ID.

    +

    Blacklist/Whitelist ID.

    direction

    +

    direction

    Integer

    +

    Integer

    Direction of a blacklist/whitelist address: 0 (source address), 1 (destination address).

    +

    Direction of a blacklist/whitelist address: 0 (source address), 1 (destination address).

    address_type

    +

    address_type

    Integer

    +

    Integer

    IP address type: 0 (IPv4), 1 (IPv6).

    +

    Internet protocol type of an address: 0 (IPv4), 1 (IPv6).

    address

    +

    address

    String

    +

    String

    IP address

    +

    IP address

    protocol

    +

    protocol

    Integer

    +

    Integer

    Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).

    +

    Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).

    port

    +

    port

    String

    +

    String

    Port

    +

    Port

    description

    +

    description

    String

    +

    String

    Description.

    +

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Query five whitelist records on the first page of object cfebd347-b655-4b84-b938-3c54317599b2 in project 9d80d070b6d44942af73c9c3d38e0429.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-lists?object_id=cfebd347-b655-4b84-b938-3c54317599b2&limit=10&offset=0&list_type=5
    +

    Example Requests

    Query five whitelist records on the first page of object cfebd347-b655-4b84-b938-3c54317599b2 in project 9d80d070b6d44942af73c9c3d38e0429.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-lists?object_id=cfebd347-b655-4b84-b938-3c54317599b2&limit=10&offset=0&list_type=5
    -

    Example Responses

    Status code: 200

    -

    Return value of a blacklist or whitelist query.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value of a blacklist or whitelist query.

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

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

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

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value of a blacklist or whitelist query.

    +

    Return value of a blacklist or whitelist query.

    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/ListDnsServers.html b/docs/cfw/api-ref/ListDnsServers.html index 578fd7ff3..62d61a70b 100644 --- a/docs/cfw/api-ref/ListDnsServers.html +++ b/docs/cfw/api-ref/ListDnsServers.html @@ -1,197 +1,197 @@

    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 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 ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    enterprise_project_id

    +

    enterprise_project_id

    No

    +

    No

    String

    +

    String

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    -

    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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    Total number of DNS servers.

    +

    Total number of DNS servers.

    -
    Table 5 DnsServersResponseDTO

    Parameter

    +
    - - - - - - - - - - - - - - - - -
    Table 5 DnsServersResponseDTO

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    Integer

    +

    Integer

    Domain name server ID.

    +

    Domain name server ID.

    is_applied

    +

    is_applied

    Integer

    +

    Integer

    Whether the DNS server is applied: 0 (no), 1 (yes).

    +

    Whether the DNS server is applied: 0 (no), 1 (yes).

    is_customized

    +

    is_customized

    Integer

    +

    Integer

    Whether the DNS server is user-defined: 0 (no), 1 (yes).

    +

    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 project 2349ba469daf4b7daf268bb0261d18b0.

    -
    https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers?fw_instance_id=80e0f2df-24fd-49c2-8398-11f9a0299b3e
    +

    Example Requests

    Obtain the DNS server list of project 2349ba469daf4b7daf268bb0261d18b0.

    +
    https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers?fw_instance_id=80e0f2df-24fd-49c2-8398-11f9a0299b3e
    -

    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" : [ {
         "health_check_domain_name" : "sslstatic.xiaoyusan.com",
         "id" : 20165,
    @@ -208,43 +208,43 @@
       "total" : 2
     }
    -

    Status Codes

    -

    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/ListDomainParseDetail.html b/docs/cfw/api-ref/ListDomainParseDetail.html index e963a7176..3f38f2ddb 100644 --- a/docs/cfw/api-ref/ListDomainParseDetail.html +++ b/docs/cfw/api-ref/ListDomainParseDetail.html @@ -1,221 +1,221 @@

    Querying an IP Address for Domain Name Resolution

    -

    Function

    This API is used to check the validity of a domain name.

    +

    Function

    This API is used to check the validity of a domain name.

    -

    URI

    GET /v1/{project_id}/domain/parse/{domain_name}

    +

    URI

    GET /v1/{project_id}/domain/parse/{domain_name}

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    domain_name

    +

    domain_name

    Yes

    +

    Yes

    String

    +

    String

    Domain name, for example, www.test.com.

    +

    Domain name, for example, www.test.com.

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    address_type

    +

    address_type

    No

    +

    No

    Integer

    +

    Integer

    Address type: 0 (IPv4), 1 (IPv6).

    +

    Internet protocol type of an address: 0 (IPv4), 1 (IPv6).

    -

    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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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 strings

    +

    Array of strings

    IP address list for domain name resolution.

    +

    IP address list for domain name resolution.

    -

    Status code: 400

    +

    Status code: 400

    -
    Table 5 Response body parameters

    Parameter

    +
    - - - - - - - -
    Table 5 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Check whether the domain name ceshi.com of project 5c69cf330cda42369cbd726ee1bc5e76 is valid.

    -
    https://{Endpoint}/v1/5c69cf330cda42369cbd726ee1bc5e76/domain/parse/ceshi.com
    +

    Example Requests

    Check whether the domain name ceshi.com of project 5c69cf330cda42369cbd726ee1bc5e76 is valid.

    +
    https://{Endpoint}/v1/5c69cf330cda42369cbd726ee1bc5e76/domain/parse/ceshi.com
    -

    Example Responses

    Status code: 200

    -

    Return value for querying domain name validity.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for querying domain name validity.

    +
    {
       "data" : [ "192.168.88.85", "192.168.88.50", "192.168.88.22", "192.168.88.87", "192.168.88.86", "192.168.5.1", "192.168.88.88", "192.168.88.90", "192.168.88.83", "192.168.88.84" ]
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00109004",
       "error_msg" : "HTTP request error."
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for querying domain name validity.

    +

    Return value for querying domain name validity.

    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/ListDomainSets.html b/docs/cfw/api-ref/ListDomainSets.html index 11c1fa029..b1eebb977 100644 --- a/docs/cfw/api-ref/ListDomainSets.html +++ b/docs/cfw/api-ref/ListDomainSets.html @@ -1,306 +1,306 @@

    Querying the Domain Name Group List

    -

    Function

    This API is used to query the domain name group list.

    +

    Function

    This API is used to query the domain name group list.

    -

    URI

    GET /v1/{project_id}/domain-sets

    +

    URI

    GET /v1/{project_id}/domain-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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    Yes

    +

    Yes

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    limit

    +

    limit

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 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.

    object_id

    +

    object_id

    Yes

    +

    Yes

    String

    +

    String

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    +

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    key_word

    +

    key_word

    No

    +

    No

    String

    +

    String

    Keyword, which can be the domain name group name or description.

    +

    Keyword, which can be the domain name group name or description.

    domain_set_type

    +

    domain_set_type

    No

    +

    No

    Integer

    +

    Integer

    Domain name group typ: 0 (application domain name group), 1 (network domain name group).

    +

    Domain name group typ: 0 (application domain name group), 1 (network domain name group).

    config_status

    +

    config_status

    No

    +

    No

    Integer

    +

    Integer

    Configuration status: -1 (unconfigured), 0 (configuration failed), 1 (configuration succeeded), 2 (configuring), 3 (normal), or 4 (abnormal).

    +

    Configuration status: -1 (unconfigured), 0 (configuration failed), 1 (configuration succeeded), 2 (configuring), 3 (normal), or 4 (abnormal).

    -

    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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    ListDomainsetsResponseData object

    +

    ListDomainsetsResponseData object

    Returned data for querying the domain name group list.

    +

    Returned data for querying the domain name group list.

    -
    Table 5 ListDomainsetsResponseData

    Parameter

    +
    - - - - - - - - - - - - - -
    Table 5 ListDomainsetsResponseData

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    limit

    +

    limit

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    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.

    total

    +

    total

    Integer

    +

    Integer

    Total number of domain name groups.

    +

    Total number of domain name groups.

    records

    +

    records

    Array of DomainSetVo objects

    +

    Array of DomainSetVo objects

    Domain name group list.

    +

    Domain name group list.

    -
    Table 6 DomainSetVo

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - -
    Table 6 DomainSetVo

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    set_id

    +

    set_id

    String

    +

    String

    Domain name group ID.

    +

    Domain name group ID.

    name

    +

    name

    String

    +

    String

    Domain name group name.

    +

    Domain name group name.

    description

    +

    description

    String

    +

    String

    Domain name group description.

    +

    Domain name group description.

    ref_count

    +

    ref_count

    Integer

    +

    Integer

    Number of times a domain name group is referenced by rules.

    +

    Number of times a domain name group is referenced by rules.

    domain_set_type

    +

    domain_set_type

    Integer

    +

    Integer

    Domain name group typ: 0 (application domain name group), 1 (network domain name group).

    +

    Domain name group typ: 0 (application domain name group), 1 (network domain name group).

    config_status

    +

    config_status

    Integer

    +

    Integer

    Configuration status: -1 (unconfigured), 0 (configuration failed), 1 (configuration succeeded), 2 (configuring), 3 (normal), or 4 (abnormal).

    +

    Configuration status: -1 (unconfigured), 0 (configuration failed), 1 (configuration succeeded), 2 (configuring), 3 (normal), or 4 (abnormal).

    rules

    +

    rules

    Array of UseRuleVO objects

    +

    Array of UseRuleVO objects

    Used rule ID list.

    +

    Used rule ID list.

    -
    Table 7 UseRuleVO

    Parameter

    +
    - - - - - - - -
    Table 7 UseRuleVO

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Rule ID.

    +

    Rule ID.

    name

    +

    name

    String

    +

    String

    Rule name.

    +

    Rule name.

    -

    Example Requests

    Query the domain name group list of firewall 546af3f8-88e9-47f2-a205-2346d7090925 in project 9d80d070b6d44942af73c9c3d38e0429. The protected object ID is ae42418e-f077-41a0-9d3b-5b2f5ad9102b.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-sets?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&limit=50&offset=0&object_id=ae42418e-f077-41a0-9d3b-5b2f5ad9102b
    +

    Example Requests

    Query the domain name group list of firewall 546af3f8-88e9-47f2-a205-2346d7090925 in project 9d80d070b6d44942af73c9c3d38e0429. The protected object ID is ae42418e-f077-41a0-9d3b-5b2f5ad9102b.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-sets?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&limit=50&offset=0&object_id=ae42418e-f077-41a0-9d3b-5b2f5ad9102b
    -

    Example Responses

    Status code: 200

    -

    Return value for querying the domain name group list.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for querying the domain name group list.

    +
    {
       "data" : {
         "limit" : 50,
         "offset" : 0,
    @@ -317,23 +317,23 @@
       }
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for querying the domain name group list.

    +

    Return value for querying the domain name group list.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/cfw/api-ref/ListDomains.html b/docs/cfw/api-ref/ListDomains.html index 2121a4d9b..747a77f9f 100644 --- a/docs/cfw/api-ref/ListDomains.html +++ b/docs/cfw/api-ref/ListDomains.html @@ -1,257 +1,257 @@

    Obtaining the Domain Name List in a Domain Name Group

    -

    Function

    This API is used to obtain the list of domain names in a domain name group.

    +

    Function

    This API is used to obtain the list of domain names in a domain name group.

    -

    URI

    GET /v1/{project_id}/domain-set/domains/{domain_set_id}

    +

    URI

    GET /v1/{project_id}/domain-set/domains/{domain_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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    domain_set_id

    +

    domain_set_id

    Yes

    +

    Yes

    String

    +

    String

    Domain name group ID, which can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    Domain name group ID, which can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    Yes

    +

    Yes

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    limit

    +

    limit

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 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.

    domain_name

    +

    domain_name

    No

    +

    No

    String

    +

    String

    Domain name, for example, www.test.com.

    +

    Domain name, for example, www.test.com.

    object_Id

    +

    object_Id

    No

    +

    No

    String

    +

    String

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    +

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    -

    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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    ListDomainResponseData object

    +

    ListDomainResponseData object

    Returned data for querying the domain name list.

    +

    Returned data for querying the domain name list.

    -
    Table 5 ListDomainResponseData

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - -
    Table 5 ListDomainResponseData

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    limit

    +

    limit

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    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.

    project_id

    +

    project_id

    String

    +

    String

    Project ID.

    +

    Project ID.

    records

    +

    records

    Array of DomainInfo objects

    +

    Array of DomainInfo objects

    Domain name information list.

    +

    Domain name information list.

    set_id

    +

    set_id

    String

    +

    String

    Domain name group ID.

    +

    Domain name group ID.

    total

    +

    total

    Integer

    +

    Integer

    Total number of domain names.

    +

    Total number of domain names.

    -
    Table 6 DomainInfo

    Parameter

    +
    - - - - - - - - - - -
    Table 6 DomainInfo

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    domain_address_id

    +

    domain_address_id

    String

    +

    String

    Domain name ID.

    +

    Domain name ID.

    domain_name

    +

    domain_name

    String

    +

    String

    Domain name, for example, www.test.com.

    +

    Domain name, for example, www.test.com.

    description

    +

    description

    String

    +

    String

    Domain name description.

    +

    Domain name description.

    -

    Example Requests

    Query the domain name list of project 14181c1245cf4fd786824efe1e2b9388. The domain name group ID is 78719348-6d79-477e-acec-676a29842ab2, and the firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925.

    -
    https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/domain-set/domains/78719348-6d79-477e-acec-676a29842ab2?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&limit=200&offset=0
    +

    Example Requests

    Query the domain name list of project 14181c1245cf4fd786824efe1e2b9388. The domain name group ID is 78719348-6d79-477e-acec-676a29842ab2, and the firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925.

    +
    https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/domain-set/domains/78719348-6d79-477e-acec-676a29842ab2?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&limit=200&offset=0
    -

    Example Responses

    Status code: 200

    -

    Return value for querying the domain name list.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for querying the domain name list.

    +
    {
       "data" : {
         "limit" : 200,
         "offset" : 0,
    @@ -266,23 +266,23 @@
       }
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for querying the domain name list.

    +

    Return value for querying the domain name list.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/cfw/api-ref/ListEastWestFirewall.html b/docs/cfw/api-ref/ListEastWestFirewall.html index d4540a6b2..dd76359d0 100644 --- a/docs/cfw/api-ref/ListEastWestFirewall.html +++ b/docs/cfw/api-ref/ListEastWestFirewall.html @@ -1,495 +1,488 @@

    Obtaining East-West Firewall Information

    -

    Function

    This API is used to obtain east-west firewall information.

    +

    Function

    This API is used to obtain east-west firewall information.

    -

    URI

    GET /v1/{project_id}/firewall/east-west

    +

    URI

    GET /v1/{project_id}/firewall/east-west

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    -
    Table 2 Query Parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    limit

    +

    limit

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    Yes

    +

    Yes

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    GetEastWestFirewallResponseBody object

    +

    GetEastWestFirewallResponseBody object

    Returned data for obtaining the east-west firewall list.

    +

    Returned data for obtaining the east-west firewall list.

    -
    Table 5 GetEastWestFirewallResponseBody

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 5 GetEastWestFirewallResponseBody

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    object_id

    +

    object_id

    String

    +

    String

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 1 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    +

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 1 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    project_id

    +

    project_id

    String

    +

    String

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    status

    +

    status

    Integer

    +

    Integer

    Protection status: 0 (enabled), 1 (disabled).

    +

    Protection status: 0 (enabled), 1 (disabled).

    er_associated_subnet

    +

    firewall_associated_subnets

    SubnetInfo object

    +

    Array of SubnetInfo objects

    Information about the subnet associated with an enterprise router.

    +

    Information about the subnet associated with a cloud firewall.

    firewall_associated_subnets

    +

    er

    Array of SubnetInfo objects

    +

    ErInstance object

    Information about the subnet associated with a cloud firewall.

    +

    Information about the associated enterprise router in the outbound direction.

    er

    +

    inspection_vpc

    ErInstance object

    +

    VpcDetail object

    Information about the associated enterprise router in the outbound direction.

    +

    Information about the inspection VPC.

    inspection_vpc

    +

    protect_infos

    VpcDetail object

    +

    Array of EwProtectResourceInfo objects

    Information about the traffic diversion VPC.

    +

    East-west protected resource information.

    protect_infos

    +

    total

    Array of EwProtectResourceInfo objects

    +

    Integer

    East-west protected resource information.

    +

    Total number of protected VPCs.

    total

    +

    offset

    Integer

    +

    Integer

    Total number of protected VPCs.

    +

    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

    +

    limit

    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.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    limit

    +

    mode

    Integer

    +

    String

    Number of records displayed on each page. The value ranges from 1 to 1024.

    -

    mode

    -

    String

    -

    Protection mode. Its value is er.

    +

    Protection mode. Its value is er.

    -
    Table 6 SubnetInfo

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - -
    Table 6 SubnetInfo

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    availability_zone

    +

    availability_zone

    String

    +

    String

    ID of the AZ where a subnet is located, which is obtained from an endpoint.

    +

    ID of the AZ where a subnet is located, which is obtained from an endpoint.

    cidr

    +

    cidr

    String

    +

    String

    Available IP address ranges for subnets in a VPC.

    -

    Value ranges:

    -

    10.0.0.0/8-24

    -

    172.16.0.0/12-24

    -

    192.168.0.0/16-24

    -

    If cidr is not specified, it is left blank by default.

    -

    The value must be in CIDR format, for example, 192.168.0.0/16.

    +

    Available IP address ranges for subnets in a VPC.

    +

    Value ranges:

    +

    10.0.0.0/8-24

    +

    172.16.0.0/12-24

    +

    192.168.0.0/16-24

    +

    If cidr is not specified, it is left blank by default.

    +

    The value must be in CIDR format, for example, 192.168.0.0/16.

    name

    +

    name

    String

    +

    String

    Subnet name.

    +

    Subnet name.

    id

    +

    id

    String

    +

    String

    Subnet ID.

    +

    Subnet ID.

    gateway_ip

    +

    gateway_ip

    String

    +

    String

    Subnet gateway. The value is the IP address in the subnet CIDR block cidr.

    +

    Subnet gateway. The value is the IP address in the subnet CIDR block cidr.

    vpc_id

    +

    vpc_id

    String

    +

    String

    UUID generated when a VPC is created.

    +

    UUID generated when a VPC is created.

    ipv6_enable

    +

    ipv6_enable

    Boolean

    +

    Boolean

    Whether IPv6 is supported: true (yes), false (no).

    +

    Whether IPv6 is supported: true (yes), false (no).

    -
    Table 7 ErInstance

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - -
    Table 7 ErInstance

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Enterprise router ID, which is generated when an enterprise router is created.

    +

    Enterprise router ID, which is generated when an enterprise router is created.

    name

    +

    name

    String

    +

    String

    Enterprise router name.

    +

    Enterprise router name.

    state

    +

    state

    String

    +

    String

    Enterprise router status: pending, available, modifying, deleting, or failed.

    +

    Enterprise router status: pending, available, modifying, deleting, or failed.

    enterprise_project_id

    +

    enterprise_project_id

    String

    +

    String

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    project_id

    +

    project_id

    String

    +

    String

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    enable_ipv6

    +

    enable_ipv6

    String

    +

    String

    Whether to enable IPv6: true (yes), false (no).

    +

    Whether to enable IPv6: true (yes), false (no).

    attachment_id

    +

    attachment_id

    String

    +

    String

    Connection ID of an enterprise router. This connection is used to connect the firewall and the enterprise router. This field can be used to obtain the connection details on the connection management page after querying a specified enterprise router by its ID on the Enterprise Router page.

    +

    Connection ID of an enterprise router. This connection is used to connect the firewall and the enterprise router. This field can be used to obtain the connection details on the connection management page after querying a specified enterprise router by its ID on the Enterprise Router page.

    -
    Table 8 VpcDetail

    Parameter

    +
    - - - - - - - - - - -
    Table 8 VpcDetail

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Random UUID generated when a traffic diversion VPC is created.

    +

    Random UUID generated when a inspection VPC is created.

    name

    +

    name

    String

    +

    String

    Traffic diversion VPC name.

    +

    Inspection VPC name.

    cidr

    +

    cidr

    String

    +

    String

    Available subnet ranges in a VPC. Value ranges: 10.0.0.0/8-24; 172.16.0.0/12-24; and 192.168.0.0/16-24. If cidr is not specified, it is left blank by default. Constraint: The value must be in CIDR format, for example, 192.168.0.0/16.

    +

    Available subnet ranges in a VPC. Value ranges: 10.0.0.0/8-24; 172.16.0.0/12-24; and 192.168.0.0/16-24. If cidr is not specified, it is left blank by default. Constraint: The value must be in CIDR format, for example, 192.168.0.0/16.

    -
    Table 9 EwProtectResourceInfo

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 9 EwProtectResourceInfo

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    protected_resource_type

    +

    protected_resource_type

    Integer

    +

    Integer

    Protected resource type: 0 (VPC), 1 (VGW), 2 (VPN), or 3 (peering).

    +

    Protected resource type: 0 (VPC), 1 (VGW), 2 (VPN), or 3 (peering).

    protected_resource_name

    +

    protected_resource_name

    String

    +

    String

    Protected resource name.

    +

    Protected resource name.

    protected_resource_id

    +

    protected_resource_id

    String

    +

    String

    Protected resource ID.

    +

    Protected resource ID.

    protected_resource_nat_name

    +

    protected_resource_nat_name

    String

    +

    String

    Name of the NAT gateway to be protected. The professional edition supports NAT rules.

    +

    Name of the NAT gateway to be protected. The professional edition supports NAT rules.

    protected_resource_nat_id

    +

    protected_resource_nat_id

    String

    +

    String

    ID of the NAT gateway to be protected. The professional edition supports NAT rules.

    +

    ID of the NAT gateway to be protected. The professional edition supports NAT rules.

    protected_resource_project_id

    +

    protected_resource_project_id

    String

    +

    String

    Tenant ID of a protected resource. The firewall supports cross-account protection.

    +

    Tenant ID of a protected resource. The firewall supports cross-account protection.

    protected_resource_mode

    +

    protected_resource_mode

    String

    +

    String

    Protected resource mode. Its value is er.

    +

    Protected resource mode. Its value is er.

    status

    +

    status

    Integer

    +

    Integer

    Protection status of a protected resource: 0 (associated), 1 (not associated).

    +

    Protection status of a protected resource: 0 (associated), 1 (not associated).

    -

    Status code: 500

    +

    Status code: 500

    -
    Table 10 Response body parameters

    Parameter

    +
    - - - - - - - -
    Table 10 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Obtain information about the east-west firewall 80e0f2df-24fd-49c2-8398-11f9a0299b3e whose project ID is 09bb24e6f280d23d0f9fc0104b901480.

    -
    https://{Endpoint}/v1/09bb24e6f280d23d0f9fc0104b901480/firewall/east-west?limit=10&offset=0&fw_instance_id=80e0f2df-24fd-49c2-8398-11f9a0299b3e
    +

    Example Requests

    Obtain information about the east-west firewall 80e0f2df-24fd-49c2-8398-11f9a0299b3e whose project ID is 09bb24e6f280d23d0f9fc0104b901480.

    +
    https://{Endpoint}/v1/09bb24e6f280d23d0f9fc0104b901480/firewall/east-west?limit=10&offset=0&fw_instance_id=80e0f2df-24fd-49c2-8398-11f9a0299b3e
    -

    Example Responses

    Status code: 200

    -

    Response to the request for querying east-west firewall information.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Response to the request for querying east-west firewall information.

    +
    {
       "data" : {
         "er" : {
           "id" : "9635a8c7-6274-4e23-836c-7f3061894fd7",
    @@ -541,48 +534,48 @@
       }
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Response to the request for querying east-west firewall information.

    +

    Response to the request for querying east-west firewall 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/ListEipCount.html b/docs/cfw/api-ref/ListEipCount.html index 5546b01b5..0d51957cd 100644 --- a/docs/cfw/api-ref/ListEipCount.html +++ b/docs/cfw/api-ref/ListEipCount.html @@ -1,194 +1,194 @@

    Querying the Number of EIPs

    -

    Function

    This API is used to query the number of EIPs.

    +

    Function

    This API is used to query the number of EIPs.

    -

    URI

    GET /v1/{project_id}/eip-count/{object_id}

    +

    URI

    GET /v1/{project_id}/eip-count/{object_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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    object_id

    +

    object_id

    Yes

    +

    Yes

    String

    +

    String

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 0 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    +

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 0 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    EipCountRespData object

    +

    EipCountRespData object

    EIP count.

    +

    EIP count.

    -
    Table 5 EipCountRespData

    Parameter

    +
    - - - - - - - - - - -
    Table 5 EipCountRespData

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    eip_total

    +

    eip_total

    Integer

    +

    Integer

    Total number of EIPs.

    +

    Total number of EIPs.

    eip_protected

    +

    eip_protected

    Integer

    +

    Integer

    Total number of EIPs protected by all firewalls under the account.

    +

    Total number of EIPs protected by all firewalls under the account.

    eip_protected_self

    +

    eip_protected_self

    Integer

    +

    Integer

    Number of EIPs protected by the current firewall.

    +

    Number of EIPs protected by the current firewall.

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Query the number of EIPs whose project ID is 9d80d070b6d44942af73c9c3d38e0429 and protected object ID is cfebd347-b655-4b84-b938-3c54317599b2.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/eip-count/cfebd347-b655-4b84-b938-3c54317599b2
    +

    Example Requests

    Query the number of EIPs whose project ID is 9d80d070b6d44942af73c9c3d38e0429 and protected object ID is cfebd347-b655-4b84-b938-3c54317599b2.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/eip-count/cfebd347-b655-4b84-b938-3c54317599b2
    -

    Example Responses

    Status code: 200

    -

    OK

    -
    {
    +

    Example Responses

    Status code: 200

    +

    OK

    +
    {
       "data" : {
         "eip_protected" : 1,
         "eip_protected_self" : 4,
    @@ -196,55 +196,55 @@
         "object_id" : ""
       }
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00200005",
       "error_msg" : "Object not found."
     }
    -

    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/ListEips.html b/docs/cfw/api-ref/ListEips.html index 9d1a8fb89..f1013f53a 100644 --- a/docs/cfw/api-ref/ListEips.html +++ b/docs/cfw/api-ref/ListEips.html @@ -1,415 +1,415 @@

    Querying the EIP List

    -

    Function

    This API is used to query the EIP list.

    +

    Function

    This API is used to query the EIP list.

    -

    URI

    GET /v1/{project_id}/eips/protect

    +

    URI

    GET /v1/{project_id}/eips/protect

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 0 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    +

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 0 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    key_word

    +

    key_word

    No

    +

    No

    String

    +

    String

    Keyword for querying the protected EIP list. You can set an EIP ID or an EIP.

    +

    Keyword for querying the protected EIP list. You can set an EIP ID or an EIP.

    status

    +

    status

    No

    +

    No

    String

    +

    String

    Protection status: null (all), 0 (enabled), or 1 (disabled).

    +

    Protection status: null (all), 0 (enabled), or 1 (disabled).

    sync

    +

    sync

    No

    +

    No

    Integer

    +

    Integer

    Whether to synchronize tenant EIP data: 0 (no), 1 (yes)

    +

    Whether to synchronize tenant EIP data: 0 (no), 1 (yes)

    limit

    +

    limit

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    device_key

    +

    device_key

    No

    +

    No

    String

    +

    String

    Device keyword, which is the name or ID of the asset bound to an EIP.

    +

    Device keyword, which is the name or ID of the asset bound to an EIP.

    address_type

    +

    address_type

    No

    +

    No

    Integer

    +

    Integer

    Address type: 0 (IPv4), 1 (IPv6).

    +

    Internet protocol type of an address: 0 (IPv4), 1 (IPv6).

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    fw_key_word

    +

    fw_key_word

    No

    +

    No

    String

    +

    String

    Firewall keyword, which can be queried based on the firewall ID or name. For details, see Obtaining a Firewall ID.

    +

    Firewall keyword, which can be queried based on the firewall ID or name. For details, see Obtaining a Firewall ID.

    eps_id

    +

    eps_id

    No

    +

    No

    String

    +

    String

    Enterprise project ID of the EIP, which can be obtained by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID of the EIP, which can be obtained by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    tags

    +

    tags

    No

    +

    No

    String

    +

    String

    You can obtain the tag list by querying it on the EIP console.

    +

    You can obtain the tag list by querying it on the EIP console.

    -

    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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    EipResponseData object

    +

    EipResponseData object

    Returned data for querying an EIP.

    +

    Returned data for querying an EIP.

    -
    Table 5 EipResponseData

    Parameter

    +
    - - - - - - - - - - - - - -
    Table 5 EipResponseData

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    limit

    +

    limit

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    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.

    total

    +

    total

    Integer

    +

    Integer

    Query the total number of EIPs.

    +

    Query the total number of EIPs.

    records

    +

    records

    Array of EipResource objects

    +

    Array of EipResource objects

    EIP resource record.

    +

    EIP resource record.

    -
    Table 6 EipResource

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 6 EipResource

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    EIP ID.

    +

    EIP ID.

    public_ip

    +

    public_ip

    String

    +

    String

    EIP.

    +

    EIP.

    status

    +

    status

    Integer

    +

    Integer

    EIP protection status: 0 (protected), 1 (unprotected).

    +

    EIP protection status: 0 (protected), 1 (unprotected).

    public_ipv6

    +

    public_ipv6

    String

    +

    String

    EIP (IPv6).

    +

    EIP (IPv6).

    enterprise_project_id

    +

    enterprise_project_id

    String

    +

    String

    Enterprise project ID of the account that the EIP belongs to.

    +

    Enterprise project ID of the account that the EIP belongs to.

    device_id

    +

    device_id

    String

    +

    String

    ID of the device (such as ECS and NAT) bound to the EIP.

    +

    ID of the device (such as ECS and NAT) bound to the EIP.

    device_name

    +

    device_name

    String

    +

    String

    Name of the device (such as ECS and NAT) bound to the EIP

    +

    Name of the device (such as ECS and NAT) bound to the EIP

    device_owner

    +

    device_owner

    String

    +

    String

    Owner of the device (such as ECS and NAT) bound to the EIP.

    +

    Owner of the device (such as ECS and NAT) bound to the EIP.

    associate_instance_type

    +

    associate_instance_type

    String

    +

    String

    Type of the associated instance: NATGW, ELB, or PORT.

    +

    Type of the associated instance: NATGW, ELB, or PORT.

    fw_instance_name

    +

    fw_instance_name

    String

    +

    String

    Firewall name.

    +

    Firewall name.

    fw_instance_id

    +

    fw_instance_id

    String

    +

    String

    Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API for querying a firewall instance.

    +

    Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API for querying a firewall instance.

    fw_enterprise_project_id

    +

    fw_enterprise_project_id

    String

    +

    String

    Enterprise project ID of the firewall bound to the EIP.

    +

    Enterprise project ID of the firewall bound to the EIP.

    object_id

    +

    object_id

    String

    +

    String

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 0 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    +

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 0 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    tags

    +

    tags

    String

    +

    String

    Tag list.

    +

    Tag list.

    domain_id

    +

    domain_id

    String

    +

    String

    ID of the user that an EIP belongs to. You can obtain the ID by referring to Obtaining Information About Account, IAM User, Group, Project, Region, and Agency.

    +

    ID of the user that an EIP belongs to. You can obtain the ID by referring to Obtaining Information About Account, IAM User, Group, Project, Region, and Agency.

    fw_domain_id

    +

    fw_domain_id

    String

    +

    String

    User that a firewall belongs to. You can obtain it by referring to Obtaining Information About Account, IAM User, Group, Project, Region, and Agency.

    +

    User that a firewall belongs to. You can obtain it by referring to Obtaining Information About Account, IAM User, Group, Project, Region, and Agency.

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Query the existing data, without updating it through synchronization, on the first page of protected object cfebd347-b655-4b84-b938-3c54317599b2 in project 9d80d070b6d44942af73c9c3d38e0429.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/eips/protect?object_id=cfebd347-b655-4b84-b938-3c54317599b2&limit=10&offset=0&sync=0
    +

    Example Requests

    Query the existing data, without updating it through synchronization, on the first page of protected object cfebd347-b655-4b84-b938-3c54317599b2 in project 9d80d070b6d44942af73c9c3d38e0429.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/eips/protect?object_id=cfebd347-b655-4b84-b938-3c54317599b2&limit=10&offset=0&sync=0
    -

    Example Responses

    Status code: 200

    -

    Return value for querying EIP data.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for querying EIP data.

    +
    {
       "data" : {
         "limit" : 200,
         "offset" : 0,
    @@ -433,55 +433,55 @@
         "total" : 1
       }
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00109004",
       "error_msg" : "HTTP request error."
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for querying EIP data.

    +

    Return value for querying EIP data.

    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/ListFirewallDetail.html b/docs/cfw/api-ref/ListFirewallDetail.html index fab767e37..2a29534c3 100644 --- a/docs/cfw/api-ref/ListFirewallDetail.html +++ b/docs/cfw/api-ref/ListFirewallDetail.html @@ -1,515 +1,515 @@

    Querying Firewall Details

    -

    Function

    This API is used to query firewall instance details.

    +

    Function

    This API is used to query firewall instance details.

    -

    URI

    GET /v1/{project_id}/firewall/exist

    +

    URI

    GET /v1/{project_id}/firewall/exist

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    -
    Table 2 Query Parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    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.

    limit

    +

    limit

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    service_type

    +

    service_type

    Yes

    +

    Yes

    Integer

    +

    Integer

    Service type. Currently, only 0 (Internet protection) is supported.

    +

    Service type. Currently, only 0 (Internet protection) is supported.

    enterprise_project_id

    +

    enterprise_project_id

    No

    +

    No

    String

    +

    String

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall instance ID, which is automatically generated by the system after a CFW is created. You can call the API for querying firewall instances. By default, if this parameter is left blank, information about the first firewall under the account is returned. If this parameter is specified, information about the corresponding firewall is returned.

    +

    Firewall instance ID, which is automatically generated by the system after a CFW is created. You can call the API for querying firewall instances. By default, if this parameter is left blank, information about the first firewall under the account is returned. If this parameter is specified, information about the corresponding firewall is returned.

    name

    +

    name

    No

    +

    No

    String

    +

    String

    Firewall name.

    +

    Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    GetFirewallInstanceData object

    +

    GetFirewallInstanceData object

    Query firewall instance data.

    +

    Query firewall instance data.

    -
    Table 5 GetFirewallInstanceData

    Parameter

    +
    - - - - - - - - - - - - - -
    Table 5 GetFirewallInstanceData

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    limit

    +

    limit

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    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.

    total

    +

    total

    Integer

    +

    Integer

    Total number of firewalls.

    +

    Total number of firewalls.

    records

    +

    records

    Array of GetFirewallInstanceResponseRecord objects

    +

    Array of GetFirewallInstanceResponseRecord objects

    Query the firewall instance list.

    +

    Query the firewall instance list.

    -
    Table 6 GetFirewallInstanceResponseRecord

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 6 GetFirewallInstanceResponseRecord

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    fw_instance_id

    +

    fw_instance_id

    String

    +

    String

    Firewall instance ID, which is automatically generated by the system after a CFW instance is created. You can call the API for querying firewall instances. By default, if fw_instance_Id is left blank, information about the first firewall under the account is returned. If fw_instance_Id is specified, the information about the firewall corresponding to fw_instance_Id is returned.

    +

    Firewall instance ID, which is automatically generated by the system after a CFW instance is created. You can call the API for querying firewall instances. By default, if fw_instance_Id is left blank, information about the first firewall under the account is returned. If fw_instance_Id is specified, the information about the firewall corresponding to fw_instance_Id is returned.

    name

    +

    name

    String

    +

    String

    Firewall name.

    +

    Firewall name.

    ha_type

    +

    ha_type

    Integer

    +

    Integer

    Cluster type: 0 (active/standby), 1 (cluster). In active/standby mode, there are four nodes. Two active nodes form a cluster, and the other two are the standby of the active nodes. In cluster mode, only two nodes are started to form a cluster.

    +

    Cluster type: 0 (active/standby), 1 (cluster). In active/standby mode, there are four nodes. Two active nodes form a cluster, and the other two are the standby of the active nodes. In cluster mode, only two nodes are started to form a cluster.

    charge_mode

    +

    charge_mode

    Integer

    +

    Integer

    Billing mode: 0 (yearly/monthly), 1 (pay-per-use).

    +

    Billing mode: 0 (yearly/monthly), 1 (pay-per-use).

    service_type

    +

    service_type

    Integer

    +

    Integer

    Firewall protection type. Currently, its value can only be 0 (Internet protection).

    +

    Firewall protection type. Currently, its value can only be 0 (Internet protection).

    engine_type

    +

    engine_type

    Integer

    +

    Integer

    Engine type. Its value can only be 1 (Hillstone engine).

    +

    Engine type. Its value can only be 1 (Hillstone engine).

    flavor

    +

    flavor

    Flavor object

    +

    Flavor object

    Firewall specifications.

    +

    Firewall specifications.

    protect_objects

    +

    protect_objects

    Array of ProtectObjectVO objects

    +

    Array of ProtectObjectVO objects

    Protected object list.

    +

    Protected object list.

    status

    +

    status

    Integer

    +

    Integer

    Firewall status: -1 (waiting for payment), 0 (creating), 1 (deleting), 2 (running), 3 (upgrading), 4 (deleted), 5 (frozen), 6 (creation failed), 7 (deletion failed), 8 (freezing failed), or 9 (being stored), 10 (storage failed), or 11 (upgrade failed).

    +

    Firewall status: -1 (waiting for payment), 0 (creating), 1 (deleting), 2 (running), 3 (upgrading), 4 (deleted), 5 (frozen), 6 (creation failed), 7 (deletion failed), 8 (freezing failed), or 9 (being stored), 10 (storage failed), or 11 (upgrade failed).

    is_old_firewall_instance

    +

    is_old_firewall_instance

    Boolean

    +

    Boolean

    Whether an engine old: true (yes), false (no).

    +

    Whether an engine old: true (yes), false (no).

    is_available_obs

    +

    is_available_obs

    Boolean

    +

    Boolean

    Whether OBS is supported: true (yes), false (no).

    +

    Whether OBS is supported: true (yes), false (no).

    is_support_threat_tags

    +

    is_support_threat_tags

    Boolean

    +

    Boolean

    Whether threat intelligence tags are supported: true (yes), false (no).

    +

    Whether threat intelligence tags are supported: true (yes), false (no).

    support_ipv6

    +

    support_ipv6

    Boolean

    +

    Boolean

    Whether IPv6 is supported: true (yes), false (no).

    +

    Whether IPv6 is supported: true (yes), false (no).

    feature_toggle

    +

    feature_toggle

    Map<String,Boolean>

    +

    Map<String,Boolean>

    Whether a feature is enabled: true (yes), false (no).

    +

    Whether a feature is enabled: true (yes), false (no).

    resources

    +

    resources

    Array of FirewallInstanceResource objects

    +

    Array of FirewallInstanceResource objects

    Firewall resource list.

    +

    Firewall resource list.

    fw_instance_name

    +

    fw_instance_name

    String

    +

    String

    Firewall name.

    +

    Firewall name.

    enterprise_project_id

    +

    enterprise_project_id

    String

    +

    String

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    resource_id

    +

    resource_id

    String

    +

    String

    Firewall resource ID, which is the same as fw_instance_id.

    +

    Firewall resource ID, which is the same as fw_instance_id.

    support_url_filtering

    +

    support_url_filtering

    Boolean

    +

    Boolean

    Whether website filtering is supported: true (yes), false (no).

    +

    Whether website filtering is supported: true (yes), false (no).

    tags

    +

    tags

    String

    +

    String

    Tag list, which is a JSON string converted from the tag key value map, for example, "{"key":"value"}".

    +

    Tag list, which is a JSON string converted from the tag key value map, for example, "{"key":"value"}".

    -
    Table 7 Flavor

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 7 Flavor

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    version

    +

    version

    Integer

    +

    Integer

    Firewall version. Its value can only be 1 (professional edition).

    +

    Firewall version. Its value can only be 1 (professional edition).

    eip_count

    +

    eip_count

    Integer

    +

    Integer

    Number of EIPs.

    +

    Number of EIPs.

    vpc_count

    +

    vpc_count

    Integer

    +

    Integer

    Number of VPCs.

    +

    Number of VPCs.

    bandwidth

    +

    bandwidth

    Integer

    +

    Integer

    Bandwidth, in Mbit/s.

    +

    Bandwidth, in Mbit/s.

    log_storage

    +

    log_storage

    Integer

    +

    Integer

    Log storage, in bytes.

    +

    Log storage, in bytes.

    default_bandwidth

    +

    default_bandwidth

    Integer

    +

    Integer

    Default firewall bandwidth, in Mbit/s. The value is 10 for the standard edition, 50 for the professional edition, and 200 for the pay-per-use professional edition.

    +

    Default firewall bandwidth, in Mbit/s. The value is 10 for the standard edition, 50 for the professional edition, and 200 for the pay-per-use professional edition.

    default_eip_count

    +

    default_eip_count

    Integer

    +

    Integer

    Default number of EIPs. The value is 20 for the standard edition, 50 for the professional edition, and 1,000 for the pay-per-use professional edition.

    +

    Default number of EIPs. The value is 20 for the standard edition, 50 for the professional edition, and 1,000 for the pay-per-use professional edition.

    default_log_storage

    +

    default_log_storage

    Integer

    +

    Integer

    Default log storage, in bytes. The default value is 0.

    +

    Default log storage, in bytes. The default value is 0.

    default_vpc_count

    +

    default_vpc_count

    Integer

    +

    Integer

    Default number of VPCs. The value is 0 for the standard edition, 2 for the professional edition, and 5 for the pay-per-use professional edition.

    +

    Default number of VPCs. The value is 0 for the standard edition, 2 for the professional edition, and 5 for the pay-per-use professional edition.

    -
    Table 8 ProtectObjectVO

    Parameter

    +
    - - - - - - - - - - -
    Table 8 ProtectObjectVO

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    object_id

    +

    object_id

    String

    +

    String

    Protected object ID. It is used to distinguish Internet border protection from VPC border protection after a CFW instance is created.

    +

    Protected object ID. It is used to distinguish Internet border protection from VPC border protection after a CFW instance is created.

    object_name

    +

    object_name

    String

    +

    String

    Protected object name.

    +

    Protected object name.

    type

    +

    type

    Integer

    +

    Integer

    Project type: 0 (north-south), 1 (east-west).

    +

    Project type: 0 (north-south), 1 (east-west).

    -
    Table 9 FirewallInstanceResource

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - -
    Table 9 FirewallInstanceResource

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    resource_id

    +

    resource_id

    String

    +

    String

    Resource ID. It can be the firewall ID, bandwidth ID, EIP ID, VPC ID, or the ID returned after CBC callback.

    +

    Resource ID. It can be the firewall ID, bandwidth ID, EIP ID, VPC ID, or the ID returned after CBC callback.

    cloud_service_type

    +

    cloud_service_type

    String

    +

    String

    Service type, which is used by CBC. The value is otc.service.type.cfw.

    +

    Service type, which is used by CBC. The value is otc.service.type.cfw.

    resource_type

    +

    resource_type

    String

    +

    String

    Resource type.Enumeration values:- otc.resource.type.cfw (cloud firewall)- otc.resource.type.cfw.exp.eip (EIP)- otc.resource.type.cfw.exp.bandwidth (bandwidth)- otc.resource.type.cfw.exp (VPC)

    +

    Resource type.Enumeration values:- otc.resource.type.cfw (cloud firewall)- otc.resource.type.cfw.exp.eip (EIP)- otc.resource.type.cfw.exp.bandwidth (bandwidth)- otc.resource.type.cfw.exp (VPC)

    resource_spec_code

    +

    resource_spec_code

    String

    +

    String

    Inventory unit code: cfw.standard (firewall standard edition), cfw.professional (firewall professional edition), cfw.expack.eip.standard (EIP standard edition), cfw.expack.eip.professional (EIP professional edition), cfw.expack.bandwidth.standard (bandwidth basic edition), cfw.expack.bandwidth.professional (bandwidth professional edition), or cfw.expack.vpc.professional (VPC professional edition).

    +

    Inventory unit code: cfw.standard (firewall standard edition), cfw.professional (firewall professional edition), cfw.expack.eip.standard (EIP standard edition), cfw.expack.eip.professional (EIP professional edition), cfw.expack.bandwidth.standard (bandwidth basic edition), cfw.expack.bandwidth.professional (bandwidth professional edition), or cfw.expack.vpc.professional (VPC professional edition).

    resource_size

    +

    resource_size

    Integer

    +

    Integer

    Resource quantity.

    +

    Resource quantity.

    resource_size_measure_id

    +

    resource_size_measure_id

    Integer

    +

    Integer

    Resource unit.

    +

    Resource unit.

    -

    Example Requests

    Query the firewall list of project 9d80d070b6d44942af73c9c3d38e0429.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/firewall/exist?service_type=0&offset=0&limit=10
    +

    Example Requests

    Query the firewall list of project 9d80d070b6d44942af73c9c3d38e0429.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/firewall/exist?service_type=0&offset=0&limit=10
    -

    Example Responses

    Status code: 200

    -

    Response to the request for obtaining an existing firewall instance.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Response to the request for obtaining an existing firewall instance.

    +
    {
         "data": {
             "limit": 10,
             "offset": 0,
    @@ -639,43 +639,43 @@
         }
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Response to the request for obtaining an existing firewall instance.

    +

    Response to the request for obtaining an existing firewall instance.

    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/ListFirewallList.html b/docs/cfw/api-ref/ListFirewallList.html index 0d540663a..b209de596 100644 --- a/docs/cfw/api-ref/ListFirewallList.html +++ b/docs/cfw/api-ref/ListFirewallList.html @@ -1,465 +1,465 @@

    Querying the Firewall List

    -

    Function

    This API is used to query a firewall list.

    +

    Function

    This API is used to query a firewall list.

    -

    URI

    POST /v1/{project_id}/firewalls/list

    +

    URI

    POST /v1/{project_id}/firewalls/list

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    -

    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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    Table 4 Request body parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    enterprise_project_id

    +

    enterprise_project_id

    No

    +

    No

    String

    +

    String

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    key_word

    +

    key_word

    No

    +

    No

    String

    +

    String

    Query keyword, which can be a firewall ID or part of a firewall name. You can obtain the firewall ID by referring to Obtaining a Firewall ID.

    +

    Query keyword, which can be a firewall ID or part of a firewall name. You can obtain the firewall ID by referring to Obtaining a Firewall ID.

    tags

    +

    tags

    No

    +

    No

    Array of TagInfo objects

    +

    Array of TagInfo objects

    Tag list, which can be obtained by calling the API for querying tags. The return value is the tag list.

    +

    Tag list, which can be obtained by calling the API for querying tags. The return value is the tag list.

    limit

    +

    limit

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 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.

    -
    Table 5 TagInfo

    Parameter

    +
    - - - - - - - - - - -
    Table 5 TagInfo

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    key

    +

    key

    No

    +

    No

    String

    +

    String

    Tag key.

    +

    Tag key.

    values

    +

    values

    No

    +

    No

    Array of strings

    +

    Array of strings

    Tag value list.

    +

    Tag value list.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 6 Response body parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - -
    Table 6 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    user_support_eps

    +

    user_support_eps

    Boolean

    +

    Boolean

    Whether enterprise projects are supported: true (yes), false (no).

    +

    Whether enterprise projects are supported: true (yes), false (no).

    has_ndr

    +

    has_ndr

    Boolean

    +

    Boolean

    Whether NDR exists: true (yes), false (no). NDR is the original out-of-path firewall and is no longer sold.

    +

    Whether NDR exists: true (yes), false (no). NDR is the original out-of-path firewall and is no longer sold.

    is_support_postpaid

    +

    is_support_postpaid

    Boolean

    +

    Boolean

    Whether pay-per-use purchase is supported: true (yes), false (no).

    +

    Whether pay-per-use purchase is supported: true (yes), false (no).

    is_support_basic_version

    +

    is_support_basic_version

    Boolean

    +

    Boolean

    Whether the basic edition is supported: true (yes), false (no).

    +

    Whether the basic edition is supported: true (yes), false (no).

    is_support_buy_professional

    +

    is_support_buy_professional

    Boolean

    +

    Boolean

    Whether the professional edition can be purchased: true (yes), false (no).

    +

    Whether the professional edition can be purchased: true (yes), false (no).

    data

    +

    data

    HttpFirewallInstanceListResponseData object

    +

    HttpFirewallInstanceListResponseData object

    Data returned for querying the firewall list.

    +

    Data returned for querying the firewall list.

    -
    Table 7 HttpFirewallInstanceListResponseData

    Parameter

    +
    - - - - - - - - - - - - - - - - -
    Table 7 HttpFirewallInstanceListResponseData

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    limit

    +

    limit

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    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.

    project_id

    +

    project_id

    String

    +

    String

    Tenant project ID

    +

    Tenant project ID

    total

    +

    total

    Integer

    +

    Integer

    Total number of firewalls.

    +

    Total number of firewalls.

    records

    +

    records

    Array of FirewallInstanceVO objects

    +

    Array of FirewallInstanceVO objects

    Query the firewall list.

    +

    Query the firewall list.

    -
    Table 8 FirewallInstanceVO

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 8 FirewallInstanceVO

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    fw_instance_id

    +

    fw_instance_id

    String

    +

    String

    Firewall instance ID, which is automatically generated by the system after a CFW instance is created.

    +

    Firewall instance ID, which is automatically generated by the system after a CFW instance is created.

    resource_id

    +

    resource_id

    String

    +

    String

    Resource ID, which is the same as the firewall instance ID fw_instance_id.

    +

    Resource ID, which is the same as the firewall instance ID fw_instance_id.

    name

    +

    name

    String

    +

    String

    Firewall creation timestamp.

    +

    Firewall creation timestamp.

    fw_instance_name

    +

    fw_instance_name

    String

    +

    String

    Firewall name.

    +

    Firewall name.

    enterprise_project_id

    +

    enterprise_project_id

    String

    +

    String

    Enterprise project ID, which is generated after the enterprise project is supported for a user.

    +

    Enterprise project ID, which is generated after the enterprise project is supported for a user.

    ha_type

    +

    ha_type

    Integer

    +

    Integer

    Cluster type: 0 (active/standby), 1 (cluster). In active/standby mode, there are four nodes. Two active nodes form a cluster, and the other two are the standby of the active nodes. In cluster mode, only two nodes are started to form a cluster.

    +

    Cluster type: 0 (active/standby), 1 (cluster). In active/standby mode, there are four nodes. Two active nodes form a cluster, and the other two are the standby of the active nodes. In cluster mode, only two nodes are started to form a cluster.

    charge_mode

    +

    charge_mode

    Integer

    +

    Integer

    Billing mode: 0 (yearly/monthly), 1 (pay-per-use).

    +

    Billing mode: 0 (yearly/monthly), 1 (pay-per-use).

    service_type

    +

    service_type

    Integer

    +

    Integer

    Firewall protection type. Currently, its value can only be 0 (Internet protection).

    +

    Firewall protection type. Currently, its value can only be 0 (Internet protection).

    engine_type

    +

    engine_type

    Integer

    +

    Integer

    Engine type: 0 (self-developed engine), 1 (Hillstone engine), or 3 (TOPSEC engine).

    +

    Engine type: 0 (self-developed engine), 1 (Hillstone engine), or 3 (TOPSEC engine).

    flavor

    +

    flavor

    Flavor object

    +

    Flavor object

    Firewall specifications.

    +

    Firewall specifications.

    status

    +

    status

    Integer

    +

    Integer

    Firewall status: -1 (waiting for payment), 0 (creating), 1 (deleting), 2 (running), 3 (upgrading), 4 (deleted), 5 (frozen), 6 (creation failed), 7 (deletion failed), 8 (freezing failed), or 9 (being stored), 10 (storage failed), or 11 (upgrade failed).

    +

    Firewall status: -1 (waiting for payment), 0 (creating), 1 (deleting), 2 (running), 3 (upgrading), 4 (deleted), 5 (frozen), 6 (creation failed), 7 (deletion failed), 8 (freezing failed), or 9 (being stored), 10 (storage failed), or 11 (upgrade failed).

    tags

    +

    tags

    String

    +

    String

    Tag list, which is a JSON string converted from the tag key value map, for example, "{"key":"value"}".

    +

    Tag list, which is a JSON string converted from the tag key value map, for example, "{"key":"value"}".

    -
    Table 9 Flavor

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 9 Flavor

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    version

    +

    version

    Integer

    +

    Integer

    Firewall version. Its value can only be 1 (professional edition).

    +

    Firewall version. Its value can only be 1 (professional edition).

    eip_count

    +

    eip_count

    Integer

    +

    Integer

    Number of EIPs.

    +

    Number of EIPs.

    vpc_count

    +

    vpc_count

    Integer

    +

    Integer

    Number of VPCs.

    +

    Number of VPCs.

    bandwidth

    +

    bandwidth

    Integer

    +

    Integer

    Bandwidth, in Mbit/s.

    +

    Bandwidth, in Mbit/s.

    log_storage

    +

    log_storage

    Integer

    +

    Integer

    Log storage, in bytes.

    +

    Log storage, in bytes.

    default_bandwidth

    +

    default_bandwidth

    Integer

    +

    Integer

    Default firewall bandwidth, in Mbit/s. The value is 10 for the standard edition, 50 for the professional edition, and 200 for the pay-per-use professional edition.

    +

    Default firewall bandwidth, in Mbit/s. The value is 10 for the standard edition, 50 for the professional edition, and 200 for the pay-per-use professional edition.

    default_eip_count

    +

    default_eip_count

    Integer

    +

    Integer

    Default number of EIPs. The value is 20 for the standard edition, 50 for the professional edition, and 1,000 for the pay-per-use professional edition.

    +

    Default number of EIPs. The value is 20 for the standard edition, 50 for the professional edition, and 1,000 for the pay-per-use professional edition.

    default_log_storage

    +

    default_log_storage

    Integer

    +

    Integer

    Default log storage, in bytes. The default value is 0.

    +

    Default log storage, in bytes. The default value is 0.

    default_vpc_count

    +

    default_vpc_count

    Integer

    +

    Integer

    Default number of VPCs. The value is 0 for the standard edition, 2 for the professional edition, and 5 for the pay-per-use professional edition.

    +

    Default number of VPCs. The value is 0 for the standard edition, 2 for the professional edition, and 5 for the pay-per-use professional edition.

    -

    Example Requests

    Query the firewall list on the first page of the enterprise project whose ID is all_granted_eps and project ID is 14181c1245cf4fd786824efe1e2b9388.

    -
    https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/firewalls/list?enterprise_project_id=all_granted_eps
    +

    Example Requests

    Query the firewall list on the first page of the enterprise project whose ID is all_granted_eps and project ID is 14181c1245cf4fd786824efe1e2b9388.

    +
    https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/firewalls/list?enterprise_project_id=all_granted_eps
     
     {
       "limit" : 10,
       "offset" : 0
     }
    -

    Example Responses

    Status code: 200

    -

    Return value for querying the firewall list.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for querying the firewall list.

    +
    {
       "data" : {
         "limit" : 1,
         "offset" : 0,
    @@ -497,23 +497,23 @@
       "user_support_eps" : false
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for querying the firewall list.

    +

    Return value for querying the firewall list.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/cfw/api-ref/ListFlowLogs.html b/docs/cfw/api-ref/ListFlowLogs.html index 1e51ea69a..303af4284 100644 --- a/docs/cfw/api-ref/ListFlowLogs.html +++ b/docs/cfw/api-ref/ListFlowLogs.html @@ -1,561 +1,561 @@

    Querying Flow Logs

    -

    Function

    This API is used to query flow logs.

    +

    Function

    This API is used to query flow logs.

    -

    URI

    GET /v1/{project_id}/cfw/logs/flow

    +

    URI

    GET /v1/{project_id}/cfw/logs/flow

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    -
    Table 2 Query Parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    fw_instance_id

    +

    fw_instance_id

    Yes

    +

    Yes

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    direction

    +

    direction

    No

    +

    No

    String

    +

    String

    Direction. Its value can be in2out or out2in.

    +

    Direction. Its value can be in2out or out2in.

    log_type

    +

    log_type

    No

    +

    No

    String

    +

    String

    Log type. Its value can be internet, vpc, or nat.

    +

    Log type. Its value can be internet, vpc, or nat.

    start_time

    +

    start_time

    Yes

    +

    Yes

    Long

    +

    Long

    Start time, in milliseconds. The value is a timestamp, for example, 1718936272648.

    +

    Start time, in milliseconds. The value is a timestamp, for example, 1718936272648.

    end_time

    +

    end_time

    Yes

    +

    Yes

    Long

    +

    Long

    End time, in milliseconds. The value is a timestamp, for example, 1718936272648.

    +

    End time, in milliseconds. The value is a timestamp, for example, 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.

    +

    Source port.

    dst_ip

    +

    dst_ip

    No

    +

    No

    String

    +

    String

    Destination IP address.

    +

    Destination IP address.

    dst_port

    +

    dst_port

    No

    +

    No

    Integer

    +

    Integer

    Destination port.

    +

    Destination port.

    protocol

    +

    protocol

    No

    +

    No

    String

    +

    String

    Protocol type. Its value can be TCP, UDP, ICMP, or ICMPv6.

    +

    Protocol type. Its value can be TCP, UDP, ICMP, or ICMPv6.

    app

    +

    app

    No

    +

    No

    String

    +

    String

    Rule application type. Its value can be HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

    +

    Rule application type. Its value can be HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

    log_id

    +

    log_id

    No

    +

    No

    String

    +

    String

    Document ID. For the first page, its value is null. For other pages, its value can be the log_id of the last record in the last query.

    +

    Document ID. For the first page, its value is null. For other pages, its value can be the log_id of the last record in the last query.

    next_date

    +

    next_date

    No

    +

    No

    Long

    +

    Long

    Next date. For the first page, its value is null. For other pages, its value can be the start_time of the last record in the last query.

    +

    Next date. For the first page, its value is null. For other pages, its value can be the start_time of the last record in the last query.

    offset

    +

    offset

    No

    +

    No

    Integer

    +

    Integer

    Offset, which specifies the start position of the record to be returned. The value must be a number greater than 0. For the first page, its value is null. For other pages, its value is not null.

    +

    Offset, which specifies the start position of the record to be returned. The value must be a number greater than 0. For the first page, its value is null. For other pages, its value is not null.

    limit

    +

    limit

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    enterprise_project_id

    +

    enterprise_project_id

    No

    +

    No

    String

    +

    String

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    dst_host

    +

    dst_host

    No

    +

    No

    String

    +

    String

    Destination host.

    +

    Destination host.

    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

    Destination province name.

    +

    Destination 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

    Destination city name.

    +

    Destination 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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 for querying flow logs.

    +

    Return value for querying flow logs.

    -
    Table 5 data

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    total

    +

    total

    Integer

    +

    Integer

    Total number of returned records for querying flow logs.

    +

    Total number of returned records for querying flow logs.

    limit

    +

    limit

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 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

    bytes

    +

    bytes

    Double

    +

    Double

    Byte.

    +

    Byte.

    direction

    +

    direction

    String

    +

    String

    Direction: in2out (outbound) or out2in (inbound).

    +

    Direction: in2out (outbound) or out2in (inbound).

    packets

    +

    packets

    Integer

    +

    Integer

    Number of packets.

    +

    Number of packets.

    start_time

    +

    start_time

    Long

    +

    Long

    Start time, in milliseconds. The value is a timestamp, for example, 1718936272648.

    +

    Start time, in milliseconds. The value is a timestamp, for example, 1718936272648.

    end_time

    +

    end_time

    Long

    +

    Long

    End time, in milliseconds. The value is a timestamp, for example, 1718936272648.

    +

    End time, in milliseconds. The value is a timestamp, for example, 1718936272648.

    log_id

    +

    log_id

    String

    +

    String

    Document ID.

    +

    Document ID.

    src_ip

    +

    src_ip

    String

    +

    String

    Source IP address.

    +

    Source IP address.

    src_port

    +

    src_port

    Integer

    +

    Integer

    Source port.

    +

    Source port.

    dst_ip

    +

    dst_ip

    String

    +

    String

    Destination IP address.

    +

    Destination IP address.

    app

    +

    app

    String

    +

    String

    Rule application type. Its value can be HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

    +

    Rule application type. Its value can be HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

    dst_port

    +

    dst_port

    Integer

    +

    Integer

    Destination port.

    +

    Destination port.

    protocol

    +

    protocol

    String

    +

    String

    Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).

    +

    Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).

    dst_host

    +

    dst_host

    String

    +

    String

    Destination host.

    +

    Destination host.

    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_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_province_id

    +

    dst_province_id

    String

    +

    String

    Destination province ID.

    +

    Destination province ID.

    dst_province_name

    +

    dst_province_name

    String

    +

    String

    Destination province name.

    +

    Destination province name.

    dst_city_id

    +

    dst_city_id

    String

    +

    String

    Destination city ID.

    +

    Destination city ID.

    dst_city_name

    +

    dst_city_name

    String

    +

    String

    Destination city name.

    +

    Destination city 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.

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Query the flow logs on the first page of the firewall with the ID 2af58b7c-893c-4453-a984-bdd9b1bd6318 in the project 9d80d070b6d44942af73c9c3d38e0429. The query time range is 1663555012000 to 1664159798000.

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

    Example Requests

    Query the flow logs on the first page of the firewall with the ID 2af58b7c-893c-4453-a984-bdd9b1bd6318 in the project 9d80d070b6d44942af73c9c3d38e0429. The query time range is 1663555012000 to 1664159798000.

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

    Example Responses

    Status code: 200

    -

    Value returned for flow log query.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Value returned for flow log query.

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

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00500002",
       "error_msg" : "Invalid interval."
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Value returned for flow log query.

    +

    Value returned for flow log query.

    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/ListIpsProtectMode.html b/docs/cfw/api-ref/ListIpsProtectMode.html index 735390a13..1a793cf5d 100644 --- a/docs/cfw/api-ref/ListIpsProtectMode.html +++ b/docs/cfw/api-ref/ListIpsProtectMode.html @@ -1,241 +1,241 @@

    Querying a Protection Mode

    -

    Function

    This API is used to query a protection mode.

    +

    Function

    This API is used to query a protection mode.

    -

    URI

    GET /v1/{project_id}/ips/protect

    +

    URI

    GET /v1/{project_id}/ips/protect

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 0 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    +

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 0 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    enterprise_project_id

    +

    enterprise_project_id

    No

    +

    No

    String

    +

    String

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    IpsProtectModeObject object

    +

    IpsProtectModeObject object

    Returned value for querying the IPS protection mode.

    +

    Returned value for querying the IPS protection mode.

    -
    Table 5 IpsProtectModeObject

    Parameter

    +
    - - - - - - - -
    Table 5 IpsProtectModeObject

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    IPS protection mode ID. The value is the ID of the protected object, which can be obtained by calling the API for querying a firewall instance. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects).

    +

    IPS protection mode ID. The value is the ID of the protected object, which can be obtained by calling the API for querying a firewall instance. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects).

    mode

    +

    mode

    Integer

    +

    Integer

    IPS protection mode: 0 (observation mode), 1 (strict mode), 2 (medium mode), or 3 (loose mode).

    +

    IPS protection mode: 0 (observation mode), 1 (strict mode), 2 (medium mode), or 3 (loose mode). The observation mode is the default mode.

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Query the IPS protection mode of project 9d80d070b6d44942af73c9c3d38e0429.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/ips/protect?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&object_id=cfebd347-b655-4b84-b938-3c54317599b2
    +

    Example Requests

    Query the IPS protection mode of project 9d80d070b6d44942af73c9c3d38e0429.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/ips/protect?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&object_id=cfebd347-b655-4b84-b938-3c54317599b2
    -

    Example Responses

    Status code: 200

    -

    Return value for a protection mode query

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for a protection mode query

    +
    {
       "data" : {
         "id" : "d5b75aba-dfca-40e4-99dd-ed56578e8e48",
         "mode" : 0
       }
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

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

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for a protection mode query

    +

    Return value for a protection mode query

    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/ListIpsSwitchStatus.html b/docs/cfw/api-ref/ListIpsSwitchStatus.html index 14618816b..eb1579937 100644 --- a/docs/cfw/api-ref/ListIpsSwitchStatus.html +++ b/docs/cfw/api-ref/ListIpsSwitchStatus.html @@ -1,167 +1,167 @@

    Querying the Status of the IPS Feature

    -

    Function

    This API is used to query the status of the IPS feature.

    +

    Function

    This API is used to query the status of the IPS feature.

    -

    URI

    GET /v1/{project_id}/ips/switch

    +

    URI

    GET /v1/{project_id}/ips/switch

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 0 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    +

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 0 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    enterprise_project_id

    +

    enterprise_project_id

    No

    +

    No

    String

    +

    String

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    IpsSwitchResponseDTO object

    +

    IpsSwitchResponseDTO object

    Returned value for querying the IPS switch.

    +

    Returned value for querying the IPS switch.

    -
    Table 5 IpsSwitchResponseDTO

    Parameter

    +
    - - - - - - - - - - -
    Table 5 IpsSwitchResponseDTO

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    IPS switch ID. The value is the ID of the protected object at the Internet border, which can be obtained by calling the API for querying a firewall instance. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects).

    +

    IPS switch ID. The value is the ID of the protected object at the Internet border, which can be obtained by calling the API for querying a firewall instance. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects).

    basic_defense_status

    +

    basic_defense_status

    Integer

    +

    Integer

    Basic defense status: 0 (disabled), 1 (enabled).

    +

    Basic defense status: 0 (disabled), 1 (enabled).

    virtual_patches_status

    +

    virtual_patches_status

    Integer

    +

    Integer

    Virtual patch status: 0 (disabled), 1 (enabled).

    +

    Virtual patch status: 0 (disabled), 1 (enabled).

    -

    Example Requests

    Query the patch status of the current user based on the user ID 14181c1245cf4fd786824efe1e2b9388 and load the virtual patch status on the intrusion prevention page.

    -
    https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/ips/switch?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&object_id=cfebd347-b655-4b84-b938-3c54317599b2
    +

    Example Requests

    Query the patch status of the current user based on the user ID 14181c1245cf4fd786824efe1e2b9388 and load the virtual patch status on the intrusion prevention page.

    +
    https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/ips/switch?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&object_id=cfebd347-b655-4b84-b938-3c54317599b2
    -

    Example Responses

    Status code: 200

    -

    Return value for querying the IPS switch.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for querying the IPS switch.

    +
    {
       "data" : {
         "basic_defense_status" : 1,
         "id" : "cefe80aa-83e4-4308-99aa-f9b6c816de00",
    @@ -169,43 +169,43 @@
       }
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for querying the IPS switch.

    +

    Return value for querying the IPS switch.

    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/ListJob.html b/docs/cfw/api-ref/ListJob.html index 765a02880..a08a60844 100644 --- a/docs/cfw/api-ref/ListJob.html +++ b/docs/cfw/api-ref/ListJob.html @@ -1,146 +1,149 @@

    Obtaining the Status of a CFW Task

    -

    Function

    This API is used to obtain the status of a CFW task.

    +

    Function

    This API is used to obtain the status of a CFW task.

    -

    URI

    GET /v3/{project_id}/jobs/{job_id}

    +

    URI

    GET /v3/{project_id}/jobs/{job_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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    job_id

    +

    job_id

    Yes

    +

    Yes

    String

    +

    String

    Task ID returned when a pay-per-use firewall is created. You can obtain the task ID by calling the API for creating a firewall. Its value is obtained from job_id in the return value.

    +

    Task ID returned when a pay-per-use firewall is created. You can obtain the task ID by calling the API for creating a firewall. Its value is obtained from job_id in the return value.

    -

    Request Parameters

    -
    Table 2 Request header parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - - - - - -
    Table 2 Request header parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    X-Auth-Token

    +

    X-Auth-Token

    Yes

    +

    Yes

    String

    +

    String

    User token. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 3 Response body parameters

    Parameter

    +
    - - - - -
    Table 3 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    data

    +

    data

    GetCreateFirewallJobResponseData object

    +

    GetCreateFirewallJobResponseData object

    Data returned for creating a pay-per-use firewall.

    +

    Data returned for creating a pay-per-use firewall.

    -
    Table 4 GetCreateFirewallJobResponseData

    Parameter

    +
    - - - - - - - - - - - - - -
    Table 4 GetCreateFirewallJobResponseData

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    ID of the task for creating a pay-per-use firewall.

    +

    ID of the task for creating a pay-per-use firewall.

    status

    +

    status

    String

    +

    String

    Task execution status, which indicates whether a firewall is successfully created.

    -

    Enumeration values:

    -
    • Running
    • Success
    • Failed
    +

    Task execution status, which indicates whether a firewall is successfully created.

    +

    Enumeration values:

    +
    • Running

      +
    • Success

      +
    • Failed

      +

    begin_time

    +

    begin_time

    String

    +

    String

    Creation time in the "yyyy-mm-ddThh:mm:ssZ" format.

    -

    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.

    +

    Creation time in the "yyyy-mm-ddThh:mm:ssZ" format.

    +

    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.

    end_time

    +

    end_time

    String

    +

    String

    End time in the "yyyy-mm-ddThh:mm:ssZ" format.

    -

    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.

    +

    End time in the "yyyy-mm-ddThh:mm:ssZ" format.

    +

    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.

    -

    Example Requests

    Obtain information about the f588ce71-e26c-400d-8981-f854355f6849 task for creating a pay-per-use firewall in project 09bb24e6fe80d23d2fa2c010b53b418c.

    -
    https://{Endpoint}/v3/09bb24e6fe80d23d2fa2c010b53b418c/jobs/f588ce71-e26c-400d-8981-f854355f6849
    +

    Example Requests

    Obtain information about the f588ce71-e26c-400d-8981-f854355f6849 task for creating a pay-per-use firewall in project 09bb24e6fe80d23d2fa2c010b53b418c.

    +
    https://{Endpoint}/v3/09bb24e6fe80d23d2fa2c010b53b418c/jobs/f588ce71-e26c-400d-8981-f854355f6849
    -

    Example Responses

    Status code: 200

    -

    Return value of the API for obtaining the information about a pay-per-use firewall creation task.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value of the API for obtaining the information about a pay-per-use firewall creation task.

    +
    {
       "data" : {
         "begin_time" : 1641370501000,
         "end_time" : 1641370515000,
    @@ -149,23 +152,23 @@
       }
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value of the API for obtaining the information about a pay-per-use firewall creation task.

    +

    Return value of the API for obtaining the information about a pay-per-use firewall creation task.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/cfw/api-ref/ListLogConfig.html b/docs/cfw/api-ref/ListLogConfig.html index 092e04e19..0aacf40ba 100644 --- a/docs/cfw/api-ref/ListLogConfig.html +++ b/docs/cfw/api-ref/ListLogConfig.html @@ -1,200 +1,200 @@

    Obtaining Log Configurations

    -

    Function

    This API is used to obtain log configurations.

    +

    Function

    This API is used to obtain log configurations.

    -

    URI

    GET /v1/{project_id}/cfw/logs/configuration

    +

    URI

    GET /v1/{project_id}/cfw/logs/configuration

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    -
    Table 2 Query Parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    fw_instance_id

    +

    fw_instance_id

    Yes

    +

    Yes

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    enterprise_project_id

    +

    enterprise_project_id

    No

    +

    No

    String

    +

    String

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    -

    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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    LogConfigDto object

    +

    LogConfigDto object

    Log configurations.

    +

    Log configurations.

    -
    Table 5 LogConfigDto

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 5 LogConfigDto

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    fw_instance_id

    +

    fw_instance_id

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    lts_enable

    +

    lts_enable

    Integer

    +

    Integer

    Whether to enable LTS: 1 (yes), 0 (no).

    +

    Whether to enable LTS: 1 (yes), 0 (no). If the parameter is set to 1 then parameters lts_attack_log_stream_enable, lts_access_log_stream_enable, lts_flow_log_stream_enable must be mandatory.

    lts_log_group_id

    +

    lts_log_group_id

    String

    +

    String

    Log Tank Service (LTS) log group ID, which can be obtained by calling the API for querying all the log groups of an account in LTS. Find the value in log_groups.log_group_id (The period [.] is used to separate different levels of objects).

    +

    Log Tank Service (LTS) log group ID, which can be obtained by calling the API for querying all the log groups of an account in LTS. Find the value in log_groups.log_group_id (The period [.] is used to separate different levels of objects).

    lts_attack_log_stream_id

    +

    lts_attack_log_stream_id

    String

    +

    String

    Attack log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

    +

    Attack log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

    lts_attack_log_stream_enable

    +

    lts_attack_log_stream_enable

    Integer

    +

    Integer

    Whether to enable the attack log stream: 1 (yes), 0 (no).

    +

    Whether to enable the attack log stream: 1 (yes), 0 (no).

    lts_access_log_stream_id

    +

    lts_access_log_stream_id

    String

    +

    String

    Access control log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

    +

    Access control log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

    lts_access_log_stream_enable

    +

    lts_access_log_stream_enable

    Integer

    +

    Integer

    Whether to enable the access control stream: 1 (yes), 0 (no).

    +

    Whether to enable the access control stream: 1 (yes), 0 (no).

    lts_flow_log_stream_id

    +

    lts_flow_log_stream_id

    String

    +

    String

    Traffic log ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

    +

    Traffic log ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

    lts_flow_log_stream_enable

    +

    lts_flow_log_stream_enable

    Integer

    +

    Integer

    Whether to enable the traffic log function: 1 (yes), 0 (no).

    +

    Whether to enable the traffic log function: 1 (yes), 0 (no).

    -

    Example Requests

    Query the log configuration of the firewall 4e113415-7811-4bb3-bf5e-eb835953f7d4 in project 408972e72dcd4c1a9b033e955802a36b.

    -
    https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=4e113415-7811-4bb3-bf5e-eb835953f7d4&enterprise_project_id=default
    +

    Example Requests

    Query the log configuration of the firewall 4e113415-7811-4bb3-bf5e-eb835953f7d4 in project 408972e72dcd4c1a9b033e955802a36b.

    +
    https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=4e113415-7811-4bb3-bf5e-eb835953f7d4&enterprise_project_id=default
    -

    Example Responses

    Status code: 200

    -

    Return value for querying log configurations.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for querying log configurations.

    +
    {
       "data" : {
         "fw_instance_id" : "4df2bcd1-6299-4fba-8e71-8d50ea807090",
         "lts_access_log_stream_enable" : 0,
    @@ -205,23 +205,23 @@
       }
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for querying log configurations.

    +

    Return value for querying log configurations.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/cfw/api-ref/ListProtectedVpcs.html b/docs/cfw/api-ref/ListProtectedVpcs.html index 09fba8245..5b3c2b7e4 100644 --- a/docs/cfw/api-ref/ListProtectedVpcs.html +++ b/docs/cfw/api-ref/ListProtectedVpcs.html @@ -1,241 +1,241 @@

    Querying the Number of Protected VPCs

    -

    Function

    This API is used to query information about protected VPCs.

    +

    Function

    This API is used to query information about protected VPCs.

    -

    URI

    GET /v1/{project_id}/vpcs/protection

    +

    URI

    GET /v1/{project_id}/vpcs/protection

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 1 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    +

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. Here, a protected object ID whose type is 1 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    enterprise_project_id

    +

    enterprise_project_id

    No

    +

    No

    String

    +

    String

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    VPCProtectsVo object

    +

    VPCProtectsVo object

    Return value for querying protected VPCs.

    +

    Return value for querying protected VPCs.

    -
    Table 5 VPCProtectsVo

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - -
    Table 5 VPCProtectsVo

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    total

    +

    total

    Integer

    +

    Integer

    Total number of protected VPCs.

    +

    Total number of protected VPCs.

    self_total

    +

    self_total

    Integer

    +

    Integer

    The firewall can protect VPCs across accounts. self_total indicates the total number of protected VPCs in the current project.

    +

    The firewall can protect VPCs across accounts. self_total indicates the total number of protected VPCs in the current project.

    other_total

    +

    other_total

    Integer

    +

    Integer

    The east-west firewall protection can protect VPCs across accounts. other_total indicates the number of protected VPCs in other projects.

    +

    The east-west firewall protection can protect VPCs across accounts. other_total indicates the number of protected VPCs in other projects.

    protect_vpcs

    +

    protect_vpcs

    Array of VpcAttachmentDetail objects

    +

    Array of VpcAttachmentDetail objects

    The east-west firewall protection can protect VPCs across accounts. protect_vpcs indicates the list of all protected VPCs.

    +

    The east-west firewall protection can protect VPCs across accounts. protect_vpcs indicates the list of all protected VPCs.

    self_protect_vpcs

    +

    self_protect_vpcs

    Array of VpcAttachmentDetail objects

    +

    Array of VpcAttachmentDetail objects

    The east-west firewall protection can protect VPCs across accounts. self_protect_vpcs indicates the list of protected VPCs in the current project.

    +

    The east-west firewall protection can protect VPCs across accounts. self_protect_vpcs indicates the list of protected VPCs in the current project.

    other_protect_vpcs

    +

    other_protect_vpcs

    Array of VpcAttachmentDetail objects

    +

    Array of VpcAttachmentDetail objects

    The east-west firewall protection can protect VPCs across accounts. other_protect_vpcs indicates the list of protected VPCs of other projects.

    +

    The east-west firewall protection can protect VPCs across accounts. other_protect_vpcs indicates the list of protected VPCs of other projects.

    total_assets

    +

    total_assets

    Integer

    +

    Integer

    Total number of VPC assets of a tenant.

    +

    Total number of VPC assets of a tenant.

    -
    Table 6 VpcAttachmentDetail

    Parameter

    +
    - - - - -
    Table 6 VpcAttachmentDetail

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    vpc_id

    +

    vpc_id

    String

    +

    String

    ID of a protected VPC added for east-west protection.

    +

    ID of a protected VPC added for east-west protection.

    -

    Status code: 500

    +

    Status code: 500

    -
    Table 7 Response body parameters

    Parameter

    +
    - - - - - - - -
    Table 7 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Query the east-west firewall protection information about the projected object with the ID 8839526e-b804-4a15-a082-a2c797dce633 in project 0b2179bbe180d3762fb0c01a2d5725c7.

    -
    https://{Endpoint}/v1/0b2179bbe180d3762fb0c01a2d5725c7/vpcs/protection?object_id=8839526e-b804-4a15-a082-a2c797dce633
    +

    Example Requests

    Query the east-west firewall protection information about the projected object with the ID 8839526e-b804-4a15-a082-a2c797dce633 in project 0b2179bbe180d3762fb0c01a2d5725c7.

    +
    https://{Endpoint}/v1/0b2179bbe180d3762fb0c01a2d5725c7/vpcs/protection?object_id=8839526e-b804-4a15-a082-a2c797dce633
    -

    Example Responses

    Status code: 200

    -

    Return value of east-west protection query.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value of east-west protection query.

    +
    {
       "data" : {
         "other_protect_vpcs" : [ ],
         "other_total" : 0,
    @@ -246,55 +246,55 @@
         "total_assets" : 5
       }
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00109004",
       "error_msg" : "HTTP request error."
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value of east-west protection query.

    +

    Return value of east-west protection query.

    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/ListRuleAclTags.html b/docs/cfw/api-ref/ListRuleAclTags.html index 1323424fe..d2c2db88f 100644 --- a/docs/cfw/api-ref/ListRuleAclTags.html +++ b/docs/cfw/api-ref/ListRuleAclTags.html @@ -1,216 +1,216 @@

    Querying Rule Tags

    -

    Function

    This API is used to query rule tags.

    +

    Function

    This API is used to query rule tags.

    -

    URI

    GET /v2/{project_id}/cfw-acl/tags

    +

    URI

    GET /v2/{project_id}/cfw-acl/tags

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    Yes

    +

    Yes

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    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.

    limit

    +

    limit

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    -

    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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    HttpGetAclTagResponseData object

    +

    HttpGetAclTagResponseData object

    Obtain rule tag data.

    +

    Obtain rule tag data.

    -
    Table 5 HttpGetAclTagResponseData

    Parameter

    +
    - - - - - - - - - - - - - -
    Table 5 HttpGetAclTagResponseData

    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. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    total

    +

    total

    Integer

    +

    Integer

    Total number of rule tags.

    +

    Total number of rule tags.

    records

    +

    records

    Array of TagsVO objects

    +

    Array of TagsVO objects

    Rule tag list.

    +

    Rule tag list.

    -
    Table 6 TagsVO

    Parameter

    +
    - - - - - - - - - - -
    Table 6 TagsVO

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    tag_id

    +

    tag_id

    String

    +

    String

    Rule ID.

    +

    Rule tag ID.

    tag_key

    +

    tag_key

    String

    +

    String

    Rule tag key.

    +

    Rule tag key.

    tag_value

    +

    tag_value

    String

    +

    String

    Rule tag value.

    +

    Rule tag value.

    -

    Example Requests

    Query the existing ACL tags of the firewall 546af3f8-88e9-47f2-a205-2346d7090925 in project 14181c1245cf4fd786824efe1e2b9388.

    -
    https://{Endpoint}/v2/14181c1245cf4fd786824efe1e2b9388/cfw-acl/tags?limit=1000&offset=0&fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default
    +

    Example Requests

    Query the existing ACL tags of the firewall 546af3f8-88e9-47f2-a205-2346d7090925 in project 14181c1245cf4fd786824efe1e2b9388.

    +
    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

    -

    Return value for querying rule tags.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for querying rule tags.

    +
    {
       "data" : {
         "limit" : 1000,
         "offset" : 0,
    @@ -231,23 +231,23 @@
       }
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for querying rule tags.

    +

    Return value for querying rule tags.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/cfw/api-ref/ListServiceItems.html b/docs/cfw/api-ref/ListServiceItems.html index 9816a0cc1..5ef74b9e8 100644 --- a/docs/cfw/api-ref/ListServiceItems.html +++ b/docs/cfw/api-ref/ListServiceItems.html @@ -1,367 +1,367 @@

    Querying the Service Group Member List

    -

    Function

    This API is used to query the service group member list.

    +

    Function

    This API is used to query the service group member list.

    -

    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    key_word

    +

    key_word

    No

    +

    No

    String

    +

    String

    Query field, which can be a service group member name or a part of the service group member description.

    +

    Query field, which can be a service group member name or a part of the service group member description.

    limit

    +

    limit

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of records displayed on each page. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    query_service_set_type

    +

    query_service_set_type

    No

    +

    No

    Integer

    +

    Integer

    Type of the service group to be queried: 0 (user-defined service group), 1 (predefined service group). This parameter is valid only if set_id is the ID of a predefined service group.

    +

    Type of the service group to be queried: 0 (user-defined service group), 1 (predefined service group). This parameter is valid only if set_id is the ID of a predefined service group.

    -

    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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    total

    +

    total

    Integer

    +

    Integer

    Total number of service group members.

    +

    Total number of service group members.

    set_id

    +

    set_id

    String

    +

    String

    Service group ID.

    +

    Service group 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: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).

    +

    Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).

    source_port

    +

    source_port

    String

    +

    String

    Source port.

    +

    Source port.

    dest_port

    +

    dest_port

    String

    +

    String

    Destination port.

    +

    Destination port.

    description

    +

    description

    String

    +

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Status code: 401

    +

    Status code: 401

    -
    Table 8 Response body parameters

    Parameter

    +
    - - - - - +
    Table 8 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    -

    +

    -

    String

    +

    String

      
    -

    Status code: 403

    +

    Status code: 403

    -
    Table 9 Response body parameters

    Parameter

    +
    - - - - - +
    Table 9 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    -

    +

    -

    String

    +

    String

      
    -

    Status code: 404

    +

    Status code: 404

    -
    Table 10 Response body parameters

    Parameter

    +
    - - - - - +
    Table 10 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    -

    +

    -

    String

    +

    String

      
    -

    Status code: 500

    +

    Status code: 500

    -
    Table 11 Response body parameters

    Parameter

    +
    - - - - - +
    Table 11 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    -

    +

    -

    String

    +

    String

      
    -

    Example Requests

    Query the members of service group 7cdebed3-af07-494e-a3c2-b88bb8d58b57 in project 9d80d070b6d44942af73c9c3d38e0429.

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

    Example Requests

    Query the members of service group 7cdebed3-af07-494e-a3c2-b88bb8d58b57 in project 9d80d070b6d44942af73c9c3d38e0429.

    +
    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,
    @@ -376,55 +376,55 @@
         "total" : 1
       }
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00200005",
       "error_msg" : "Object not found."
     }
    -

    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 a23dfc336..7918fc314 100644 --- a/docs/cfw/api-ref/ListServiceSetDetail.html +++ b/docs/cfw/api-ref/ListServiceSetDetail.html @@ -1,265 +1,265 @@

    Querying Service Group Details

    -

    Function

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

    +

    Function

    This API is used to query 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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    set_id

    +

    set_id

    Yes

    +

    Yes

    String

    +

    String

    Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    query_service_set_type

    +

    query_service_set_type

    No

    +

    No

    Integer

    +

    Integer

    Type of the service group to be queried: 0 (user-defined service group), 1 (predefined service group).

    +

    Type of the service group to be queried: 0 (user-defined service group), 1 (predefined service group).

    -

    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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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 group details.

    +

    Service group details.

    -
    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.

    +

    Service group name.

    description

    +

    description

    String

    +

    String

    Service group description.

    +

    Service group description.

    service_set_type

    +

    service_set_type

    Integer

    +

    Integer

    Service group type: 0 (user-defined service group), 1 (common web service), 2 (common remote login and ping), or 3 (common database).

    +

    Service group type: 0 (user-defined service group), 1 (common web service), 2 (common remote login and ping), or 3 (common database).

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Query details about service group 221cfdca-3abf-4c30-ab0d-516a03c70866 in project 9d80d070b6d44942af73c9c3d38e0429.

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

    Example Requests

    Query details about service group 221cfdca-3abf-4c30-ab0d-516a03c70866 in project 9d80d070b6d44942af73c9c3d38e0429.

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

    Example Responses

    Status code: 200

    -

    Return value for querying service group details.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for querying service group details.

    +
    {
       "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" : "Object not found."
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for querying service group details.

    +

    Return value for querying service group details.

    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 694c639de..e9ed2971f 100644 --- a/docs/cfw/api-ref/ListServiceSets.html +++ b/docs/cfw/api-ref/ListServiceSets.html @@ -1,298 +1,298 @@

    Obtaining the Service Group 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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a 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 between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    +

    Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

    key_word

    +

    key_word

    No

    +

    No

    String

    +

    String

    Keyword, which can be the service group name or part of the service group description.

    +

    Keyword, which can be the service group name or part of the service group description.

    limit

    +

    limit

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of query records on each page. The value ranges from 1 to 1024.

    +

    Number of query records on each page. The value ranges from 1 to 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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    query_service_set_type

    +

    query_service_set_type

    No

    +

    No

    Integer

    +

    Integer

    Type of the service group to be queried: 0 (user-defined service group), 1 (predefined service group).

    +

    Type of the service group to be queried: 0 (user-defined service group), 1 (predefined service group).

    -

    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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -

    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

    Query the service group list.

    +

    Query the service group list.

    -
    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. The value ranges from 1 to 1024.

    +

    Number of records displayed on each page. The value ranges from 1 to 1024.

    total

    +

    total

    Integer

    +

    Integer

    Query the total number of service groups.

    +

    Query the total number of service groups.

    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

    Service group name.

    +

    Service group name.

    description

    +

    description

    String

    +

    String

    Service group description.

    +

    Service group description.

    service_set_type

    +

    service_set_type

    Integer

    +

    Integer

    Service group type: 0 (user-defined service group), 1 (common web service), 2 (common remote login and ping), or 3 (common database).

    +

    Service group type: 0 (user-defined service group), 1 (common web service), 2 (common remote login and ping), or 3 (common database).

    ref_count

    +

    ref_count

    Integer

    +

    Integer

    Number of times a service group is referenced by rules.

    +

    Number of times a service group is referenced by rules.

    project_id

    +

    project_id

    String

    +

    String

    Project ID.

    +

    Project ID.

    protocols

    +

    protocols

    Array of integers

    +

    Array of integers

    Protocol list. Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual).

    +

    Protocol list. Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual).

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    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

    -

    Return value for the service group list query.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for the service group list query.

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

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

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

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for the service group list query.

    +

    Return value for the service group list query.

    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 b32d284d6..2d82fa26d 100644 --- a/docs/cfw/api-ref/UpdateAclRule.html +++ b/docs/cfw/api-ref/UpdateAclRule.html @@ -1,853 +1,853 @@

    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    acl_rule_id

    +

    acl_rule_id

    Yes

    +

    Yes

    String

    +

    String

    Rule ID, which can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

    +

    Rule ID, which can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    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: 0 (IPv4), 1 (IPv6).

    +

    Internet protocol type of an address: 0 (IPv4), 1 (IPv6).

    name

    +

    name

    No

    +

    No

    String

    +

    String

    Rule name.

    +

    Rule name.

    direction

    +

    direction

    No

    +

    No

    Integer

    +

    Integer

    Direction: 0 (inbound) or 1 (outbound). This parameter is mandatory when type is set to 0 (Internet rule) or 2 (NAT rule).

    +

    Direction: 0 (inbound) or 1 (outbound). This parameter is mandatory when type is set to 0 (Internet rule) or 2 (NAT rule).

    action_type

    +

    action_type

    No

    +

    No

    Integer

    +

    Integer

    Rule action: 0 (permit), 1 (deny).

    +

    Rule action: 0 (permit), 1 (deny).

    status

    +

    status

    No

    +

    No

    Integer

    +

    Integer

    Rule status: 0 (disabled), 1 (enabled).

    +

    Rule status: 0 (disabled), 1 (enabled).

    applications

    +

    applications

    No

    +

    No

    Array of strings

    +

    Array of strings

    Rule application list. Rule application type: HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

    +

    Rule application list. Rule application type: HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP.

    applicationsJsonString

    +

    applicationsJsonString

    No

    +

    No

    String

    +

    String

    JSON string converted from the applications field in the application list.

    +

    JSON string converted from the applications field in the application list.

    description

    +

    description

    No

    +

    No

    String

    +

    String

    Rule description.

    +

    Rule 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 (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_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 (no), 1 (yes).

    +

    Whether to support persistent connections: 0 (no), 1 (yes).

    source

    +

    source

    No

    +

    No

    RuleAddressDto object

    +

    RuleAddressDto object

    Source address Data Transport Object.

    +

    Source address Data Transport Object.

    destination

    +

    destination

    No

    +

    No

    RuleAddressDto object

    +

    RuleAddressDto object

    Destination address Data Transport Object.

    +

    Destination address Data Transport Object.

    service

    +

    service

    No

    +

    No

    RuleServiceDto object

    +

    RuleServiceDto object

    Service object.

    +

    Service object.

    type

    +

    type

    No

    +

    No

    Integer

    +

    Integer

    Rule type: 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule).

    +

    Rule type: 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule).

    tag

    +

    tag

    No

    +

    No

    TagsVO object

    +

    TagsVO object

    Tag object attached to a rule.

    +

    Tag object attached to a rule.

    -
    Table 5 RuleAddressDto

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 5 RuleAddressDto

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    type

    +

    type

    Yes

    +

    Yes

    Integer

    +

    Integer

    Address type: 0 (manual input), 1 (associated IP address group), 2 (domain name), 3 (geographical location), 4 (domain name group) 5 (multiple objects), 6 (domain name group - network), 7 (domain name group - application).

    +

    Address type: 0 (manual input), 1 (associated IP address group), 2 (domain name), 3 (geographical location), 4 (domain name group) 5 (multiple objects), 6 (domain name group - network), 7 (domain name group - application).

    address_type

    +

    address_type

    No

    +

    No

    Integer

    +

    Integer

    Address type: 0 (IPv4), 1 (IPv6). If type is 0, the input cannot be left blank.

    +

    Internet protocol type of an address: 0 (IPv4), 1 (IPv6). If type is 0, this parameter cannot be left blank.

    address

    +

    address

    No

    +

    No

    String

    +

    String

    IP address information. It cannot be left blank if type is set to 0.

    +

    IP address information. It cannot be left blank if type is set to 0.

    address_set_id

    +

    address_set_id

    No

    +

    No

    String

    +

    String

    ID of an associated IP address group. This parameter cannot be left blank when type is set to 1. You can obtain the value by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    ID of an associated IP address group. This parameter cannot be left blank when type is set to 1. You can obtain the value by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    address_set_name

    +

    address_set_name

    No

    +

    No

    String

    +

    String

    Name of an associated IP address group. This parameter cannot be left blank when type is set to 1. You can obtain the value by calling the API for querying the address group list. Find the value in data.records.name (The period [.] is used to separate different levels of objects).

    +

    Name of an associated IP address group. This parameter cannot be left blank when type is set to 1. You can obtain the value by calling the API for querying the address group list. Find the value in data.records.name (The period [.] is used to separate different levels of objects).

    domain_address_name

    +

    domain_address_name

    No

    +

    No

    String

    +

    String

    Name of a domain name address. This parameter is valid when type is set to 2 (domain name) or 7 (application domain name group).

    +

    Name of a domain name address. This parameter is valid when type is set to 2 (domain name) or 7 (application domain name group).

    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

    Rule region list.

    +

    Rule region list.

    domain_set_id

    +

    domain_set_id

    No

    +

    No

    String

    +

    String

    Domain group ID. The value cannot be left blank when type is set to 4 (domain name group) or 7 (domain name group - application). Its value can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    Domain group ID. The value cannot be left blank when type is set to 4 (domain name group) or 7 (domain name group - application). Its value can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    domain_set_name

    +

    domain_set_name

    No

    +

    No

    String

    +

    String

    Domain group name. The value cannot be left blank when type is set to 4 (domain name group) or 7 (domain name group - application). Its value can be obtained by calling the API for querying the domain name group list. Find the value in data.records.name (The period [.] is used to separate different levels of objects).

    +

    Domain group name. The value cannot be left blank when type is set to 4 (domain name group) or 7 (domain name group - application). Its value can be obtained by calling the API for querying the domain name group list. Find the value in data.records.name (The period [.] is used to separate different levels of objects).

    ip_address

    +

    ip_address

    No

    +

    No

    Array of strings

    +

    Array of strings

    IP address list. This parameter cannot be left blank when type is set to 5 (multiple objects).

    +

    IP address list. This parameter cannot be left blank when type is set to 5 (multiple objects).

    address_group

    +

    address_group

    No

    +

    No

    Array of strings

    +

    Array of strings

    Address group ID list. This parameter cannot be left blank when type is set to 5 (multiple objects). Its value can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). In the search criteria, query_address_set_type must be set to 0 (user-defined address group).

    +

    Address group ID list. This parameter cannot be left blank when type is set to 5 (multiple objects). Its value can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). In the search criteria, query_address_set_type must be set to 0 (user-defined address group).

    address_group_names

    +

    address_group_names

    No

    +

    No

    Array of AddressGroupVO objects

    +

    Array of AddressGroupVO objects

    Address group name list.

    +

    Address group name list.

    address_set_type

    +

    address_set_type

    No

    +

    No

    Integer

    +

    Integer

    Address group type. It cannot be left blank when type is set to 1 (associated IP address group). It value can be 0 (user-defined address group), 1 (WAF back-to-source IP address group), 2 (DDoS back-to-source IP address group), or 3 (NAT64 address group).

    +

    Address group type. It cannot be left blank when type is set to 1 (associated IP address group). It value can be 0 (user-defined address group), 1 (WAF back-to-source IP address group), 2 (DDoS back-to-source IP address group), or 3 (NAT64 address group).

    predefined_group

    +

    predefined_group

    No

    +

    No

    Array of strings

    +

    Array of strings

    Pre-defined address group ID list. This parameter cannot be left blank when type is set to 5 (multiple objects). Its value can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). In the search criteria, query_address_set_type must be set to 1 (predefined address group).

    +

    Pre-defined address group ID list. This parameter cannot be left blank when type is set to 5 (multiple objects). Its value can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). In the search criteria, query_address_set_type must be set to 1 (predefined address group).

    -
    Table 6 IpRegionDto

    Parameter

    +
    - - - - - - - - - - -
    Table 6 IpRegionDto

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    region_id

    +

    region_id

    No

    +

    No

    String

    +

    String

    Region ID. You can obtain the ID by referring to Obtaining Information About Account, IAM User, Group, Project, Region, and Agency.

    +

    Region ID. You can obtain the ID by referring to Obtaining Information About Account, IAM User, Group, Project, Region, and Agency.

    region_type

    +

    region_type

    No

    +

    No

    Integer

    +

    Integer

    Region type: 0 (country), 1 (province), and 2 (continent). It can be obtained from the region information table.

    +

    Region type: 0 (country), 1 (province), and 2 (continent). It can be obtained from the region information table.

    -
    Table 7 AddressGroupVO

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 7 AddressGroupVO

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    address_set_type

    +

    address_set_type

    No

    +

    No

    Integer

    +

    Integer

    Address group type: 0 (user-defined address group), 1 (WAF back-to-source IP address group), 2 (DDoS back-to-source IP address group), or 3 (NAT64 address group).

    +

    Address group type: 0 (user-defined address group), 1 (WAF back-to-source IP address group), 2 (DDoS back-to-source IP address group), or 3 (NAT64 address group).

    name

    +

    name

    No

    +

    No

    String

    +

    String

    Name of an associated IP address group, which can be obtained by calling the API for querying the address group list. Find the value in data.records.name (The period [.] is used to separate different levels of objects).

    +

    Name of an associated IP address group, which can be obtained by calling the API for querying the address group list. Find the value in data.records.name (The period [.] is used to separate different levels of objects).

    set_id

    +

    set_id

    No

    +

    No

    String

    +

    String

    ID of an associated IP address group, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    ID of an associated IP address group, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    -
    Table 8 RuleServiceDto

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 8 RuleServiceDto

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    type

    +

    type

    Yes

    +

    Yes

    Integer

    +

    Integer

    Service input type: 0 (manual), 1 (automatic).

    +

    Service input type: 0 (manual), 1 (automatic).

    protocol

    +

    protocol

    No

    +

    No

    Integer

    +

    Integer

    Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual).

    +

    Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual).

    protocols

    +

    protocols

    No

    +

    No

    Array of integers

    +

    Array of integers

    Protocol list. Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual).

    +

    Protocol list. Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual).

    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 cannot be left blank when type is set to 1 (associated IP address group). Its value can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    Service group ID. This parameter cannot be left blank when type is set to 1 (associated IP address group). Its value can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    service_set_name

    +

    service_set_name

    No

    +

    No

    String

    +

    String

    Service group name. This parameter cannot be left blank when type is set to 1 (associated IP address group). Its value can be obtained by calling the API for querying the service group list. Find the value in data.records.name (The period [.] is used to separate different levels of objects).

    +

    Service group name. This parameter cannot be left blank when type is set to 1 (associated IP address group). Its value can be obtained by calling the API for querying the service group list. Find the value in data.records.name (The period [.] is used to separate different levels of objects).

    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 service group ID list. The service group ID can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). In the search criteria, query_service_set_type must be set to 1 (predefined service group).

    +

    Predefined service group ID list. The service group ID can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). In the search criteria, query_service_set_type must be set to 1 (predefined service group).

    service_group

    +

    service_group

    No

    +

    No

    Array of strings

    +

    Array of strings

    Service group ID list. The service group ID can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). In the search criteria, query_service_set_type must be set to 0 (user-defined service group).

    +

    Service group ID list. The service group ID can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). In the search criteria, query_service_set_type must be set to 0 (user-defined service group).

    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 group type: 0 (user-defined service group), 1 (common web service), 2 (common remote login and ping), or 3 (common database).

    +

    Service group type: 0 (user-defined service group), 1 (common web service), 2 (common remote login and ping), or 3 (common database).

    -
    Table 9 ServiceItem

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - -
    Table 9 ServiceItem

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    protocol

    +

    protocol

    No

    +

    No

    Integer

    +

    Integer

    Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when RuleServiceDto.type is set to 0 (manual).

    +

    Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when RuleServiceDto.type is set to 0 (manual).

    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

    Service member description.

    +

    Service member description.

    name

    +

    name

    No

    +

    No

    String

    +

    String

    Service member name.

    +

    Service member name.

    -
    Table 10 ServiceGroupVO

    Parameter

    +
    - - - - - - - - - - - - - - - - - - -
    Table 10 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

    Protocol list. Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any).

    +

    Protocol list. Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any).

    service_set_type

    +

    service_set_type

    No

    +

    No

    Integer

    +

    Integer

    Service group type: 0 (user-defined service group), 1 (predefined service group).

    +

    Service group type: 0 (user-defined service group), 1 (predefined service group).

    set_id

    +

    set_id

    No

    +

    No

    String

    +

    String

    Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    -
    Table 11 TagsVO

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 11 TagsVO

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    tag_id

    +

    tag_id

    No

    +

    No

    String

    +

    String

    Rule ID.

    +

    Rule tag ID.

    tag_key

    +

    tag_key

    No

    +

    No

    String

    +

    String

    Rule tag key.

    +

    Rule tag key.

    tag_value

    +

    tag_value

    No

    +

    No

    String

    +

    String

    Rule tag value.

    +

    Rule tag value.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 12 Response body parameters

    Parameter

    +
    - - - - -
    Table 12 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    data

    +

    data

    RuleId object

    +

    RuleId object

    Rule data.

    +

    Rule data.

    -
    Table 13 RuleId

    Parameter

    +
    - - - - - - - -
    Table 13 RuleId

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Rule ID.

    +

    Rule ID.

    name

    +

    name

    String

    +

    String

    Rule name.

    +

    Rule name.

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    The following example shows how to update an IPv4 inbound rule. The rule name is Test rule, 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 Test rule, 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" : "Test rule.",
    @@ -878,62 +878,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" : "Object not found."
     }
    -

    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/UpdateAclRuleOrder.html b/docs/cfw/api-ref/UpdateAclRuleOrder.html index b49fbf374..3e603a2db 100644 --- a/docs/cfw/api-ref/UpdateAclRuleOrder.html +++ b/docs/cfw/api-ref/UpdateAclRuleOrder.html @@ -1,279 +1,279 @@

    Setting the Priority of an ACL Protection Rule

    -

    Function

    This API is used to set the priority of an ACL protection rule.

    +

    Function

    This API is used to set the priority of an ACL protection rule.

    -

    URI

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

    +

    URI

    PUT /v1/{project_id}/acl-rule/order/{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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    acl_rule_id

    +

    acl_rule_id

    Yes

    +

    Yes

    String

    +

    String

    Rule ID, which can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

    +

    Rule ID, which can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    Table 4 Request body parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    dest_rule_id

    +

    dest_rule_id

    No

    +

    No

    String

    +

    String

    ID of the target rule. The added rule is placed after this rule. This parameter cannot be left blank when the added rule is not pinned on top, and can be left blank when the added rule is pinned on top. The rule ID can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

    +

    ID of the target rule. The added rule is placed after this rule. This parameter cannot be left blank when the added rule is not pinned on top, and can be left blank when the added rule is pinned on top. The rule ID can be obtained by calling the API for querying protection rules. Find the value in data.records.rule_id (The period [.] is used to separate different levels of objects).

    top

    +

    top

    No

    +

    No

    Integer

    +

    Integer

    Whether to pin on top: 0 (no), 1 (yes).

    +

    Whether to pin on top: 0 (no), 1 (yes).

    bottom

    +

    bottom

    No

    +

    No

    Integer

    +

    Integer

    Whether to pin to bottom: 0 (no), 1 (yes).

    +

    Whether to pin to bottom: 0 (no), 1 (yes).

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 5 Response body parameters

    Parameter

    +
    - - - - -
    Table 5 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    data

    +

    data

    OrderRuleId object

    +

    OrderRuleId object

    Rule ID.

    +

    Rule ID.

    -
    Table 6 OrderRuleId

    Parameter

    +
    - - - - -
    Table 6 OrderRuleId

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Rule ID.

    +

    Rule ID.

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    In the project 9d80d070b6d44942af73c9c3d38e0429, move the rule whose ID is ffe9af47-d893-483b-86e3-ee5242e8cb15 behind the rule whose ID is 69c32dc5-f801-4294-98ee-978b51f97d35.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule/order/ffe9af47-d893-483b-86e3-ee5242e8cb15
    +

    Example Requests

    In the project 9d80d070b6d44942af73c9c3d38e0429, move the rule whose ID is ffe9af47-d893-483b-86e3-ee5242e8cb15 behind the rule whose ID is 69c32dc5-f801-4294-98ee-978b51f97d35.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule/order/ffe9af47-d893-483b-86e3-ee5242e8cb15
     
     {
       "top" : 0,
       "dest_rule_id" : "69c32dc5-f801-4294-98ee-978b51f97d35"
     }
    -

    Example Responses

    Status code: 200

    -

    Rule sorting response.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Rule sorting response.

    +
    {
       "data" : {
         "id" : "ffe9af47-d893-483b-86e3-ee5242e8cb15"
       }
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "00200005",
       "error_msg" : "Object not found."
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Rule sorting response.

    +

    Rule sorting response.

    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 9a4fba437..a028c1349 100644 --- a/docs/cfw/api-ref/UpdateAddressSet.html +++ b/docs/cfw/api-ref/UpdateAddressSet.html @@ -1,277 +1,277 @@

    Updating Address Group Information

    -

    Function

    This API is used to update address group information.

    +

    Function

    This API is used to update address group information.

    -

    URI

    PUT /v1/{project_id}/address-sets/{set_id}

    +

    URI

    PUT /v1/{project_id}/address-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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    set_id

    +

    set_id

    Yes

    +

    Yes

    String

    +

    String

    Address group ID, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    Address group ID, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    Table 4 Request body parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    name

    +

    name

    No

    +

    No

    String

    +

    String

    IP address group name.

    +

    IP address group name.

    description

    +

    description

    No

    +

    No

    String

    +

    String

    Address group description.

    +

    Address group description.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 5 Response body parameters

    Parameter

    +
    - - - - -
    Table 5 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    data

    +

    data

    UpdateAddressSetResponseData object

    +

    UpdateAddressSetResponseData object

    Data returned after an address group is updated.

    +

    Data returned after an address group is updated.

    -
    Table 6 UpdateAddressSetResponseData

    Parameter

    +
    - - - - - - - -
    Table 6 UpdateAddressSetResponseData

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Address group ID.

    +

    Address group ID.

    name

    +

    name

    String

    +

    String

    IP address group name.

    +

    IP address group name.

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Change the name of address group cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16) in project 9d80d070b6d44942af73c9c3d38e0429 to ABCD.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-sets/cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16
    +

    Example Requests

    Change the name of address group cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16) in project 9d80d070b6d44942af73c9c3d38e0429 to ABCD.

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

    Example Responses

    Status code: 200

    -

    Return value for updating an address group.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for updating an address group.

    +
    {
       "data" : {
         "id" : "cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16"
       }
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00200005",
       "error_msg" : "Object not found."
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for updating an address group.

    +

    Return value for updating an address group.

    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/UpdateBlackWhiteList.html b/docs/cfw/api-ref/UpdateBlackWhiteList.html index 06de75ff3..8999ca539 100644 --- a/docs/cfw/api-ref/UpdateBlackWhiteList.html +++ b/docs/cfw/api-ref/UpdateBlackWhiteList.html @@ -1,251 +1,251 @@

    Updating a Blacklist or Whitelist

    -

    Function

    This API is used to update a blacklist or whitelist.

    +

    Function

    This API is used to update a blacklist or whitelist.

    -

    URI

    PUT /v1/{project_id}/black-white-list/{list_id}

    +

    URI

    PUT /v1/{project_id}/black-white-list/{list_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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    list_id

    +

    list_id

    Yes

    +

    Yes

    String

    +

    String

    Blacklist or whitelist ID, which can be obtained through the API for querying the blacklist or whitelist. Find the value in data.records.list_id (The period [.] is used to separate different levels of objects).

    +

    Blacklist or whitelist ID, which can be obtained through the API for querying the blacklist or whitelist. Find the value in data.records.list_id (The period [.] is used to separate different levels of objects).

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    Table 4 Request body parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    direction

    +

    direction

    No

    +

    No

    Integer

    +

    Integer

    Address direction: 0 (source), 1 (destination).

    +

    Address direction: 0 (source), 1 (destination).

    address_type

    +

    address_type

    No

    +

    No

    Integer

    +

    Integer

    Address type: 0 (IPv4), 1 (IPv6).

    +

    Internet protocol type of an address: 0 (IPv4), 1 (IPv6).

    address

    +

    address

    Yes

    +

    Yes

    String

    +

    String

    IP address

    +

    IP address

    protocol

    +

    protocol

    No

    +

    No

    Integer

    +

    Integer

    Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any).

    +

    Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any).

    port

    +

    port

    No

    +

    No

    String

    +

    String

    Port

    +

    Port

    description

    +

    description

    No

    +

    No

    String

    +

    String

    Description.

    +

    Description.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 5 Response body parameters

    Parameter

    +
    - - - - -
    Table 5 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    data

    +

    data

    BlackWhiteListId object

    +

    BlackWhiteListId object

    Response to the request for updating the blacklist/whitelist.

    +

    Response to the request for updating the blacklist/whitelist.

    -
    Table 6 BlackWhiteListId

    Parameter

    +
    - - - - - - - -
    Table 6 BlackWhiteListId

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Blacklist/Whitelist ID.

    +

    Blacklist/Whitelist ID.

    name

    +

    name

    String

    +

    String

    Blacklist/Whitelist name.

    +

    Blacklist/Whitelist name.Which is the Address

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Update the whitelist of object cfebd347-b655-4b84-b938-3c54317599b2 of project 9d80d070b6d44942af73c9c3d38e0429. Direction: source address; IP address: 1.1.1.1; protocol type: TCP; port number: 1.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list/9d80d070b6d44942af73c9c3d38e042b
    +

    Example Requests

    Update the whitelist of object cfebd347-b655-4b84-b938-3c54317599b2 of project 9d80d070b6d44942af73c9c3d38e0429. Direction: source address; IP address: 1.1.1.1; protocol type: TCP; port number: 1.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list/9d80d070b6d44942af73c9c3d38e042b
     
     {
       "direction" : 0,
    @@ -255,63 +255,63 @@
       "address_type" : 0
     }
    -

    Example Responses

    Status code: 200

    -

    Response to the request for updating a blacklist or whitelist.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Response to the request for updating a blacklist or whitelist.

    +
    {
       "data" : {
         "id" : "5d37afe6-c5b4-400d-8ff3-a8d6396d7ace",
         "name" : "10.1.1.10"
       }
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00200005",
       "error_msg" : "Object not found."
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Response to the request for updating a blacklist or whitelist.

    +

    Response to the request for updating a blacklist or whitelist.

    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/UpdateDnsServers.html b/docs/cfw/api-ref/UpdateDnsServers.html index 50930e043..04dac7ce8 100644 --- a/docs/cfw/api-ref/UpdateDnsServers.html +++ b/docs/cfw/api-ref/UpdateDnsServers.html @@ -1,221 +1,221 @@

    Updating the DNS Server List

    -

    Function

    This API is used to update the DNS server list.

    +

    Function

    This API is used to update the DNS server list.

    -

    URI

    PUT /v1/{project_id}/dns/servers

    +

    URI

    PUT /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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    -
    Table 2 Query Parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    fw_instance_id

    +

    fw_instance_id

    Yes

    +

    Yes

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    enterprise_project_id

    +

    enterprise_project_id

    No

    +

    No

    String

    +

    String

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    -

    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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    Table 4 Request body parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    dns_server

    +

    dns_server

    Yes

    +

    Yes

    Array of dns_server objects

    +

    Array of dns_server objects

    DNS server list.

    +

    DNS server list.

    health_check_domain_name

    +

    health_check_domain_name

    No

    +

    No

    String

    +

    String

    Health check domain name, which can be obtained by calling the API for querying the DNS server list. Find the value in data.health_check_domain_name (The period [.] is used to separate different levels of objects).

    +

    Health check domain name, which can be obtained by calling the API for querying the DNS server list. Find the value in data.health_check_domain_name (The period [.] is used to separate different levels of objects).

    -
    Table 5 dns_server

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 5 dns_server

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    server_ip

    +

    server_ip

    Yes

    +

    Yes

    String

    +

    String

    DNS server IP address, which can be obtained by calling the API for querying the DNS server list. Find the value in data.server_ip (The period [.] is used to separate different levels of objects).

    +

    DNS server IP address, which can be obtained by calling the API for querying the DNS server list. Find the value in data.server_ip (The period [.] is used to separate different levels of objects).

    is_customized

    +

    is_customized

    Yes

    +

    Yes

    Integer

    +

    Integer

    Whether the DNS server is user-defined: 0 (no), 1 (yes).

    +

    Whether the DNS server is user-defined: 0 (no), 1 (yes).

    is_applied

    +

    is_applied

    Yes

    +

    Yes

    Integer

    +

    Integer

    Whether to apply: 0 (no), 1 (yes).

    +

    Whether to apply: 0 (no), 1 (yes).

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 6 Response body parameters

    Parameter

    +
    - - - - -
    Table 6 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    data

    +

    data

    Array of strings

    +

    Array of strings

    DNS server list.

    +

    DNS server list.

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Update the settings of the DNS resolver whose project ID is 2349ba469daf4b7daf268bb0261d18b0. Put the default server 8.8.8.8 in use. Stop using the non-default server 192.168.0.2.

    -
    https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers?fw_instance_id=80e0f2df-24fd-49c2-8398-11f9a0299b3e
    +

    Example Requests

    Update the settings of the DNS resolver whose project ID is 2349ba469daf4b7daf268bb0261d18b0. Put the default server 8.8.8.8 in use. Stop using the non-default server 192.168.0.2.

    +
    https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers?fw_instance_id=80e0f2df-24fd-49c2-8398-11f9a0299b3e
     
     {
       "dns_server" : [ {
    @@ -229,60 +229,60 @@
       } ]
     }
    -

    Example Responses

    Status code: 200

    -

    Response to the request for updating the DNS server list.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Response to the request for updating the DNS server list.

    +
    {
       "data" : [ "100.95.150.83", "114.114.114.114", "223.5.5.5", "223.6.6.6", "119.29.29.29", "8.8.8.8", "100.79.1.250", "100.79.1.240" ]
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00109003",
       "error_msg" : "http to external service response status error"
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Response to the request for updating the DNS server list.

    +

    Response to the request for updating the DNS server 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/UpdateDomainSet.html b/docs/cfw/api-ref/UpdateDomainSet.html index 8a07c7c52..93b090790 100644 --- a/docs/cfw/api-ref/UpdateDomainSet.html +++ b/docs/cfw/api-ref/UpdateDomainSet.html @@ -1,220 +1,220 @@

    Updating a Domain Name Group

    -

    Function

    This API is used to update a domain name group.

    +

    Function

    This API is used to update a domain name group.

    -

    URI

    PUT /v1/{project_id}/domain-set/{set_id}

    +

    URI

    PUT /v1/{project_id}/domain-set/{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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    set_id

    +

    set_id

    Yes

    +

    Yes

    String

    +

    String

    Domain name group ID, which can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    Domain name group ID, which can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    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 for querying a firewall instance.

    +

    Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API for querying a firewall instance.

    -

    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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    Table 4 Request body parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    name

    +

    name

    Yes

    +

    Yes

    String

    +

    String

    Domain name group name.

    +

    Domain name group name.

    description

    +

    description

    No

    +

    No

    String

    +

    String

    Domain name group description.

    +

    Domain name group description.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 5 Response body parameters

    Parameter

    +
    - - - - -
    Table 5 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    data

    +

    data

    DomainSetResponseData object

    +

    DomainSetResponseData object

    Returned data of for updating a domain name group.

    +

    Returned data of for updating a domain name group.

    -
    Table 6 DomainSetResponseData

    Parameter

    +
    - - - - - - - -
    Table 6 DomainSetResponseData

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Domain name group ID.

    +

    Domain name group ID.

    name

    +

    name

    String

    +

    String

    Domain name group name.

    +

    Domain name group name.

    -

    Example Requests

    Change the name of the domain name group 94da194d-24b2-4f60-919e-cf0bc76c75b3 of firewall 7a004e79-0b8b-4679-ab20-267f3946e8ba in project 9d80d070b6d44942af73c9c3d38e0429 to test.

    -
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-set/94da194d-24b2-4f60-919e-cf0bc76c75b3?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default
    +

    Example Requests

    Change the name of the domain name group 94da194d-24b2-4f60-919e-cf0bc76c75b3 of firewall 7a004e79-0b8b-4679-ab20-267f3946e8ba in project 9d80d070b6d44942af73c9c3d38e0429 to test.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-set/94da194d-24b2-4f60-919e-cf0bc76c75b3?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default
     
     {
       "name" : "test",
       "description" : ""
     }
    -

    Example Responses

    Status code: 200

    -

    Return value for updating a domain name group.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for updating a domain name group.

    +
    {
       "data" : {
         "id" : "94da194d-24b2-4f60-919e-cf0bc76c75b3",
         "name" : "test"
       }
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for updating a domain name group.

    +

    Return value for updating a domain name group.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/cfw/api-ref/UpdateLogConfig.html b/docs/cfw/api-ref/UpdateLogConfig.html index fb75bcd42..f18796574 100644 --- a/docs/cfw/api-ref/UpdateLogConfig.html +++ b/docs/cfw/api-ref/UpdateLogConfig.html @@ -1,216 +1,216 @@

    Updating Log Configurations

    -

    Function

    This API is used to update log configurations.

    +

    Function

    This API is used to update log configurations.

    -

    URI

    PUT /v1/{project_id}/cfw/logs/configuration

    +

    URI

    PUT /v1/{project_id}/cfw/logs/configuration

    -
    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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    -
    Table 2 Query Parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    fw_instance_id

    +

    fw_instance_id

    Yes

    +

    Yes

    String

    +

    String

    Firewall ID, which can be obtained via API by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained via API by referring to Obtaining a Firewall ID.

    enterprise_project_id

    +

    enterprise_project_id

    No

    +

    No

    String

    +

    String

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    -

    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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    Table 4 Request body parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    fw_instance_id

    +

    fw_instance_id

    Yes

    +

    Yes

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    lts_enable

    +

    lts_enable

    Yes

    +

    Yes

    Integer

    +

    Integer

    Whether to enable LTS: 1 (yes), 0 (no).

    +

    Whether to enable LTS: 1 (yes), 0 (no). If the parameter is set to 1 then parameters lts_attack_log_stream_enable, lts_access_log_stream_enable, lts_flow_log_stream_enable must be mandatory.

    lts_log_group_id

    +

    lts_log_group_id

    Yes

    +

    Yes

    String

    +

    String

    Log Tank Service (LTS) log group ID, which can be obtained by calling the API for querying all the log groups of an account in LTS. Find the value in log_groups.log_group_id (The period [.] is used to separate different levels of objects).

    +

    Log Tank Service (LTS) log group ID, which can be obtained by calling the API for querying all the log groups of an account in LTS. Find the value in log_groups.log_group_id (The period [.] is used to separate different levels of objects).

    lts_attack_log_stream_id

    +

    lts_attack_log_stream_id

    No

    +

    No

    String

    +

    String

    Attack log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

    +

    Attack log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

    lts_attack_log_stream_enable

    +

    lts_attack_log_stream_enable

    No

    +

    No

    Integer

    +

    Integer

    Whether to enable the attack log stream: 1 (yes), 0 (no).

    +

    Whether to enable the attack log stream: 1 (yes), 0 (no).

    lts_access_log_stream_id

    +

    lts_access_log_stream_id

    No

    +

    No

    String

    +

    String

    Access control log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

    +

    Access control log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

    lts_access_log_stream_enable

    +

    lts_access_log_stream_enable

    No

    +

    No

    Integer

    +

    Integer

    Whether to enable the access control stream: 1 (yes), 0 (no).

    +

    Whether to enable the access control stream: 1 (yes), 0 (no).

    lts_flow_log_stream_id

    +

    lts_flow_log_stream_id

    No

    +

    No

    String

    +

    String

    Traffic log ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

    +

    Traffic log ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in log_streams.log_stream_id (The period [.] is used to separate different levels of objects).

    lts_flow_log_stream_enable

    +

    lts_flow_log_stream_enable

    No

    +

    No

    Integer

    +

    Integer

    Whether to enable the traffic log function: 1 (yes), 0 (no).

    +

    Whether to enable the traffic log function: 1 (yes), 0 (no).

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 5 Response body parameters

    Parameter

    +
    - - - - -
    Table 5 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    data

    +

    data

    String

    +

    String

    Return value for updating log configurations. The value is the firewall ID.

    +

    Return value for updating log configurations. The value is the firewall ID.

    -

    Example Requests

    Update the log configurations of firewall 22c4a5db-504c-471f-8187-5192bc11de0b in project 408972e72dcd4c1a9b033e955802a36b. The LTS log, flow log, access control log, and attack log functions are disabled.

    -
    https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=22c4a5db-504c-471f-8187-5192bc11de0b&enterprise_project_id=default
    +

    Example Requests

    Update the log configurations of firewall 22c4a5db-504c-471f-8187-5192bc11de0b in project 408972e72dcd4c1a9b033e955802a36b. The LTS log, flow log, access control log, and attack log functions are disabled.

    +
    https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=22c4a5db-504c-471f-8187-5192bc11de0b&enterprise_project_id=default
     
     {
       "fw_instance_id" : "22c4a5db-504c-471f-8187-5192bc11de0b",
    @@ -221,29 +221,29 @@
       "lts_flow_log_stream_enable" : 0
     }
    -

    Example Responses

    Status code: 200

    -

    Return value for updating log configurations.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for updating log configurations.

    +
    {
       "data" : "4e113415-7811-4bb3-bf5e-eb835953f7d4"
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for updating log configurations.

    +

    Return value for updating log configurations.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/cfw/api-ref/UpdateServiceSet.html b/docs/cfw/api-ref/UpdateServiceSet.html index bfcfacfc3..b4d0d2db6 100644 --- a/docs/cfw/api-ref/UpdateServiceSet.html +++ b/docs/cfw/api-ref/UpdateServiceSet.html @@ -1,277 +1,277 @@

    Modifying a Service Group

    -

    Function

    This API is used to update a service group.

    +

    Function

    This API is used to update a service group.

    -

    URI

    PUT /v1/{project_id}/service-sets/{set_id}

    +

    URI

    PUT /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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    +

    Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

    set_id

    +

    set_id

    Yes

    +

    Yes

    String

    +

    String

    Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    +

    Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

    -
    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, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    +

    Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

    fw_instance_id

    +

    fw_instance_id

    No

    +

    No

    String

    +

    String

    Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

    +

    Firewall ID, which can be obtained by referring to Obtaining a Firewall 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. You can obtain the token by referring to Obtaining a User Token.

    +

    User token. You can obtain the token by referring to Obtaining a User Token.

    Content-Type

    +

    Content-Type

    Yes

    +

    Yes

    String

    +

    String

    Content type. It can only be set to application/json.

    +

    Content type. It can only be set to application/json.

    -
    Table 4 Request body parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    name

    +

    name

    No

    +

    No

    String

    +

    String

    Service group name.

    +

    Service group name.

    description

    +

    description

    No

    +

    No

    String

    +

    String

    Service group description.

    +

    Service group description.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 5 Response body parameters

    Parameter

    +
    - - - - -
    Table 5 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    data

    +

    data

    ServiceSetId object

    +

    ServiceSetId object

    Update service group data.

    +

    Update service group data.

    -
    Table 6 ServiceSetId

    Parameter

    +
    - - - - - - - -
    Table 6 ServiceSetId

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Service group ID.

    +

    Service group ID.

    name

    +

    name

    String

    +

    String

    Service group name.

    +

    Service group name.

    -

    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.

    +

    Error code.

    error_msg

    +

    error_msg

    String

    +

    String

    Error description.

    +

    Error description.

    -

    Example Requests

    Change the name of the service group 221cfdca-3abf-4c30-ab0d-516a03c70866 in project 9d80d070b6d44942af73c9c3d38e0429 to ceshi2 and change its description to Description.

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

    Example Requests

    Change the name of the service group 221cfdca-3abf-4c30-ab0d-516a03c70866 in project 9d80d070b6d44942af73c9c3d38e0429 to ceshi2 and change its description to Description.

    +
    https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-sets/221cfdca-3abf-4c30-ab0d-516a03c70866
     
     {
       "name" : "ceshi2",
       "description" : "Description."
     }
    -

    Example Responses

    Status code: 200

    -

    Return value for updating a service group.

    -
    {
    +

    Example Responses

    Status code: 200

    +

    Return value for updating a service group.

    +
    {
       "data" : {
         "id" : "221cfdca-3abf-4c30-ab0d-516a03c70866"
       }
     }
    -

    Status code: 400

    -

    Bad Request

    -
    {
    +

    Status code: 400

    +

    Bad Request

    +
    {
       "error_code" : "CFW.00200005",
       "error_msg" : "Object not found."
     }
    -

    Status Codes

    -
    - + + + + + +

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Return value for updating a service group.

    +

    Return value for updating a service group.

    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/cfw_02_0017.html b/docs/cfw/api-ref/cfw_02_0017.html index 7bb785959..d9c1290c7 100644 --- a/docs/cfw/api-ref/cfw_02_0017.html +++ b/docs/cfw/api-ref/cfw_02_0017.html @@ -8,7 +8,24 @@

    2024-12-05

    +

    2025-02-18

    +

    This issue is the tenth official release.

    +

    Optimized:

    +
    • Description of the lts_enable parameter.
    • Modified parameter fw_instance_id in Deleting a Domain Name List to be mandatory.
    +

    Deleted:

    +

    APIs related to packet capture management.

    +

    2025-01-22

    +

    This is the ninth official release.

    +

    Added the header parameter Content-Type.

    +
    Optimized: +
    +

    2024-12-05

    This issue is the eighth official release.

    The value type in the parameter description has been rectified.

    diff --git a/docs/cfw/api-ref/cfw_02_0028.html b/docs/cfw/api-ref/cfw_02_0028.html index c35286128..08ce90140 100644 --- a/docs/cfw/api-ref/cfw_02_0028.html +++ b/docs/cfw/api-ref/cfw_02_0028.html @@ -2,7 +2,7 @@

    Obtaining a Firewall ID

    A firewall ID (fw_instance_Id) is a CFW instance ID. It is automatically generated by the system after CFW is created.

    -

    You can obtain the value by calling the API for Token Authentication.

    +

    You can obtain the value by calling the API for Querying the Firewall List.

    • 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.