# Alibaba Cloud Cloud Firewall API > Alibaba Cloud Cloud Firewall API on Apizie: 272 endpoints (Creates an access control backup, Creates an address book, including IPv4 address books, ECS tag-based address books, IPv6 address books,…, Creates an access control policy, Adds a DNS firewall ACL, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-cloudfw/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:aliyun-cloudfw` - Category: Cloud - Status: byok - Source: https://api.alibabacloud.com/product/cloudfw - Page: https://apizie.tech/api/cloud/aliyun-cloudfw - OpenAPI: https://apizie.tech/api/cloud/aliyun-cloudfw/openapi.json Alibaba Cloud OpenAPI for Cloud Firewall (cloudfw, version 2017-12-07). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret. ## Endpoints ### Creates an access control backup `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/add-acl-backup-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the request | | Lang | string | no | The language of the request and response | | Description | string | no | The description of the backup data | | BackUpTime | string | yes | The backup time, specified as a Unix timestamp (the number of seconds that have elapsed since 00:00:00 UTC on January 1, 1970) | ### Creates an address book, including IPv4 address books, ECS tag-based address books, IPv6 address books,… `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/add-address-book` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the request | | Lang | string | no | The language type of the address book description | | AddressList | string | no | The addresses in the address book. Separate multiple addresses with commas (,). Use a space to separate an address from its description… | | Description | string | yes | The description of the address book | | GroupName | string | yes | The name of the address book | | GroupType | string | yes | The type of the address book | | AutoAddTagEcs | string | no | Indicates whether to automatically add the public IP addresses of Elastic Compute Service (ECS) instances that match the specified tags to… | | TagRelation | string | no | The logical relationship among multiple ECS tags to match | | TagList | string | no | The ECS tag list (JSON-encoded) | | AckClusterConnectorId | string | no | The ACK cluster connector ID. You can obtain the value from the following operation:… | | AckNamespaces | string | no | The list of ACK cluster pod namespaces. A maximum of 10 namespaces are supported (JSON-encoded) | | AckLabels | string | no | The list of ACK cluster pod labels. A maximum of 10 labels are supported (JSON-encoded) | | AssetMemberUids | string | no | The list of member accounts for the asset address book (JSON-encoded) | | AssetRegionResourceTypes | string | no | The list of regions and resource types for the asset address book (JSON-encoded) | ### Creates an access control policy `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/add-control-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ClientToken | string | no | The client token that is used to ensure idempotence | | DryRun | string | no | Specifies whether to perform a dry run | | SourceIp | string | no | The source IP address of the requester | | Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese en: English | | AclAction | string | yes | The action that Cloud Firewall performs on traffic that matches the access control policy. Valid values: accept: allows the traffic. drop:… | | ApplicationName | string | no | The Protocol Type supported by the access control policy. Valid values: FTP HTTP HTTPS Memcache MongoDB MQTT MySQL RDP Redis SMTP SMTPS… | | Description | string | yes | The description of the access control policy | | DestPort | string | no | The destination port for traffic in the access control policy. Valid values: When the Protocol Type is ICMP, leave DestPort empty. When… | | Destination | string | yes | The destination address in the access control policy. Valid values: If DestinationType is set to net, set Destination to the destination… | | DestinationType | string | yes | The type of the destination address in the access control policy. Valid values: net: destination CIDR block group: destination address… | | Direction | string | yes | The traffic direction of the access control policy. Valid values: in: inbound traffic out: outbound traffic | | Proto | string | yes | The protocol type of traffic in the access control policy. Valid values: ANY: all protocols TCP UDP ICMP If the traffic direction is… | | Source | string | yes | The source address in the access control policy. Valid values: If SourceType is set to net, set Source to the source CIDR block. Example:… | | SourceType | string | yes | The source address type in the access control policy. Valid values: net: source CIDR block group: source address book location: source… | | NewOrder | string | yes | The priority of the access control policy. The priority value starts from 1 and increases sequentially. A smaller value indicates a higher… | | DestPortType | string | no | The type of the destination port in the access control policy. Valid values: port: port group: port address book | | DestPortGroup | string | no | The name of the destination port address book in the access control policy. If DestPortType is set to group, you must specify the name of… | | Release | string | no | Specifies whether to enable the access control policy. By default, the policy is enabled after it is created. Valid values: true: enables… | | IpVersion | string | no | The IP address version. Valid values: 4: IPv4 6: IPv6 | | ApplicationNameList | string | no | The list of application types supported by the access control policy (JSON-encoded) | | RepeatType | string | no | The recurrence type of the Policy Validity Period for the access control policy. Valid values: Permanent (default): always None: specified… | | RepeatDays | string | no | The set of recurrence days for the Policy Validity Period of the access control policy. If RepeatType is set to `Permanent`, `None`, or… | | RepeatStartTime | string | no | The recurrence start time of the Policy Validity Period for the access control policy. Example: 08:00. The time must be on the hour or… | | RepeatEndTime | string | no | The recurrence end time of the Policy Validity Period for the access control policy. Example: 23:30. The time must be on the hour or half… | | StartTime | integer | no | The start time of the Policy Validity Period for the access control policy. It is expressed in the format of a UNIX timestamp accurate to… | | EndTime | integer | no | The end time of the Policy Validity Period for the access control policy. It is expressed in the format of a UNIX timestamp accurate to… | | DomainResolveType | string | no | The domain name resolution mode of the access control policy. Valid values: FQDN: FQDN-based resolution DNS: DNS-based dynamic resolution… | ### Adds a DNS firewall ACL `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/add-dns-firewall-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the requester | | Lang | string | no | The language of the request and response. Valid values: zh: Chinese en: English | | AclAction | string | yes | The action that Cloud Firewall performs on traffic in the access control policy. Valid values: accept: Allows the traffic. drop: Denies… | | Description | string | yes | The description of the access control policy | | Destination | string | yes | The destination address in the access control policy. If DestinationType is set to net, Destination is the destination CIDR block.… | | DestinationType | string | yes | The type of the destination address in the DNS firewall access control policy. Only group (destination address book) and domain… | | Direction | string | no | The traffic direction of the DNS firewall access control policy. This parameter is not verified by the backend. When you create or modify… | | Source | string | yes | The source address in the access control policy. Valid values: If SourceType is set to `net`, Source is the source CIDR block. Example:… | | SourceType | string | yes | The type of the source address in the access control policy. Valid values: net: Source CIDR block group: Source address book | | Priority | string | yes | The policy priority of the new DNS firewall policy. Valid values: 1 to 20000. A smaller value indicates a higher policy priority | | Release | string | yes | Specifies whether to enable the access control policy. By default, the policy is enabled after it is created. Valid values: true: Enables… | | IpVersion | string | yes | The IP version. Valid values: 4: IPv4 6: IPv6 | ### Creates a real-time domain name resolution task `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/add-domain-resolve-realtime-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionNo | string | no | The region ID | | FirewallType | string | no | The Cloud Firewall type | | DomainName | string | no | The domain name | ### Adds member accounts to Cloud Firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/add-instance-members` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Members | string | yes | The list of Cloud Firewall member accounts to add. Call DescribeInstanceRdAccounts to obtain the available MemberUid values. You can add… | ### Adds a private DNS domain name `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/add-private-dns-domain-name` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | AccessInstanceId | string | yes | The ID of the private DNS resolution instance | | RegionNo | string | yes | The region ID of the instance. For more information about the regions supported by Cloud Firewall, see… | | DomainNameList | string | yes | The list of private domain names to add (JSON-encoded) | ### Deletes multiple access control policies for virtual private cloud (VPC) firewalls `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/batch-delete-vpc-firewall-control-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | VpcFirewallId | string | yes | The instance ID of the virtual private cloud (VPC) firewalls | | AclUuidList | string | yes | The list of ACL UUIDs (JSON-encoded) | ### Clears firewall audit logs `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/clear-log-store-storage` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Site | string | no | The site name for which to clear logs. If only one logStore exists, you can leave this parameter empty. If two logStores exist, set this… | ### Creates an ACK cluster connector `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-ack-cluster-connector` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | MemberUid | string | no | The Alibaba Cloud UID of the account to which the ACK cluster resource belongs | | RegionNo | string | yes | The region ID of the ACK cluster connector. You can call the following operation to obtain the value:… | | ConnectorName | string | yes | The name of the ACK cluster connector. The name must be 1 to 64 characters in length and can contain Chinese characters, uppercase and… | | ClusterId | string | yes | The ACK cluster ID. You can call the following operation to obtain the value: [DescribeAckClusters](~~DescribeAckClusters~~): Queries the… | | PrimaryVswitchId | string | yes | The primary vSwitch of the ACK cluster connector. You can call the following operation to obtain the value:… | | PrimaryVswitchIp | string | no | The IP address of the primary vSwitch of the ACK cluster connector | | StandbyVswitchId | string | no | The standby vSwitch of the ACK cluster connector. You can call the following operation to obtain the value:… | | StandbyVswitchIp | string | no | The IP address of the standby vSwitch of the ACK cluster connector | | Ttl | string | yes | The synchronization interval of the ACK cluster connector. Valid values: 2 to 60. Unit: seconds | ### Creates an ACL check `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-acl-check` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response messages | | AclType | string | yes | The ACL check type | | CheckNames | string | no | The list of ACL check names (JSON-encoded) | ### Creates a file download task `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-download-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language type for receiving messages. Valid values: zh: (default) Chinese. en: English | | TaskType | string | no | The task type. For valid values, refer to the API operation that queries file download task types | | TaskData | string | no | The query conditions for the download task. This parameter is required. If it is not provided, the API returns error code -340408… | | TimeZone | string | no | The time zone for time information in the downloaded file, using an IANA time zone identity. Default value: Asia/Shanghai (UTC+8) | ### Creates an Internet asset synchronization task `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-instance-sync-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the visitor | | Lang | string | no | The language type | ### Creates an IPS private IP tracing association `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-ips-private-assoc` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response | | ResourceId | string | no | The ID of the Internet NAT gateway instance to be associated. This parameter is required. If this parameter is not specified, the… | ### Creates an access control policy for a NAT firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-nat-firewall-control-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language for receiving messages. Valid values: zh: Chinese (default). en: English | | AclAction | string | yes | The action that Cloud Firewall performs on traffic in the access control policy. Valid values: accept: allows the traffic. drop: denies… | | ApplicationNameList | string | yes | The list of application types supported by the access control policy (JSON-encoded) | | Description | string | yes | The description of the access control policy | | DestPort | string | no | The destination port in the access control policy. Valid values: If the protocol type is ICMP, leave this parameter empty. When the… | | Destination | string | yes | The destination address in the access control policy. Valid values: If DestinationType is set to net, set Destination to the destination… | | DestinationType | string | yes | The type of the destination address in the access control policy. Valid values: net: destination CIDR block. group: destination address… | | NatGatewayId | string | yes | The instance ID of the NAT gateway | | Proto | string | yes | The protocol type of the traffic in the access control policy. Valid values: ANY: all protocol types. TCP UDP ICMP If the destination… | | Source | string | yes | The source address in the access control policy. Valid values: If SourceType is set to net, set Source to the source CIDR block. Example:… | | SourceType | string | yes | The type of the source address in the access control policy. Valid values: net: source CIDR block. group: source address book | | NewOrder | string | yes | The priority of the access control policy. The priority value starts from 1 and increments sequentially. A smaller value indicates a… | | DestPortType | string | no | The type of the destination port in the access control policy. Valid values: port: port. group: port address book | | DestPortGroup | string | no | The name of the destination port address book in the access control policy. If DestPortType is set to group, you must specify the name of… | | Release | string | no | Specifies whether to enable the access control policy. By default, the policy is enabled after it is created. Valid values: true: enables… | | DomainResolveType | integer | no | The domain name resolution mode of the access control policy. Valid values: 0: FQDN-based. 1: DNS-based dynamic resolution. 2: FQDN and… | | IpVersion | string | no | The IP address version. Valid values: 4: IPv4. (Default) | | Direction | string | yes | The traffic direction of the access control policy. Valid values: out: outbound traffic | | RepeatType | string | no | The recurrence type of the policy validity period for the access control policy. Valid values: Permanent: always. (Default) None:… | | RepeatDays | string | no | The recurrence days of the policy validity period for the access control policy. If RepeatType is set to Permanent, None, or Daily,… | | RepeatStartTime | string | no | The recurrence start time of the policy validity period for the access control policy. Example: 08:00. The time must be on the hour or… | | RepeatEndTime | string | no | The recurrence end time of the policy validity period for the access control policy. Example: 23:30. The time must be on the hour or… | | StartTime | integer | no | The start time of the policy validity period for the access control policy. The value is a UNIX timestamp in seconds. The time must be on… | | EndTime | integer | no | The end time of the policy validity period for the access control policy. The value is a UNIX timestamp in seconds. The time must be on… | ### Creates a dry run for a NAT firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-nat-firewall-pre-check` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the content within the response. Valid values: zh (default): Chinese en: English | | RegionNo | string | yes | The region ID of the NAT gateway. For more information about the regions supported by Cloud Firewall, see… | | VpcId | string | yes | The instance ID of the VPC-connected instance | | NatGatewayId | string | yes | The ID of the NAT gateway | ### Creates an asset synchronization task for a NAT firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-nat-firewall-sync-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language type of the response message | ### Creates a private DNS endpoint `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-private-dns-endpoint` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | AccessInstanceName | string | yes | The name of the private instance | | PrivateDnsType | string | yes | The private DNS type. If PrivateDnsType is set to Custom, Port and IpProtocol are conditionally required. If PrivateDnsType is set to… | | RegionNo | string | yes | The region ID of the instance | | VpcId | string | yes | The VPC-connected instance ID | | PrimaryVSwitchId | string | no | The ID of the primary vSwitch. This parameter is required. If this parameter is not specified, the error code -200103 is returned. The… | | StandbyVSwitchId | string | no | The ID of the secondary vSwitch. The zones of the primary and secondary vSwitches specified by PrimaryVSwitchId and StandbyVSwitchId must… | | PrimaryVSwitchIp | string | no | The IP address of the primary vSwitch | | StandbyVSwitchIp | string | no | The IP address of the secondary vSwitch | | IpProtocol | string | no | The IP protocol. Valid values: TCP UDP | | Port | integer | no | The port number | | FirewallType | string | yes | The Cloud Firewall type. Valid values: internet vpc nat (JSON-encoded) | | PrimaryDns | string | no | The primary DNS server. If PrivateDnsType is set to Custom, you must specify PrimaryDns and StandbyDns | | StandbyDns | string | no | The secondary DNS server. If PrivateDnsType is set to Custom, you must specify PrimaryDns and StandbyDns | | MemberUid | integer | no | The UID of the Alibaba Cloud member accounts | ### Creates a NAT firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-security-proxy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response message. Valid values: zh (default): Chinese. en: English | | ProxyName | string | yes | The name of the NAT firewall. The name must be 4 to 50 characters in length and can contain uppercase and lowercase letters, Chinese… | | RegionNo | string | yes | The region ID of the VPC. For more information about the regions supported by Cloud Firewall, see… | | VpcId | string | yes | The ID of the VPC | | NatGatewayId | string | yes | The ID of the NAT gateway | | VswitchAuto | string | no | Specifies whether to use the automatic mode for the vSwitch. Valid values: true: automatic mode. false: manual mode. Default value: true.… | | VswitchId | string | no | The ID of the vSwitch. This parameter is required when the manual mode is used for the vSwitch | | NatRouteEntryList | string | yes | The list of routes to be switched for the NAT gateway (JSON-encoded) | | FirewallSwitch | string | no | The security protection switch. Valid values: open: Enabled. close: Disabled | | StrictMode | integer | no | Specifies whether to enable strict mode. Valid values: 1: Enable strict mode. 0: Disable strict mode | | VswitchCidr | string | no | The CIDR block of the vSwitch. This parameter is required when the automatic mode is used for the vSwitch | | FirewallServiceMode | string | no | The deployment mode of the firewall service. Valid values: PrimaryStandby: primary/standby mode. MultiPrimary: active-active mode | | FirewallServiceZones | string | no | The list of zone IDs used by the firewall service (JSON-encoded) | | FwVswitchZoneId | string | no | The zone of the firewall vSwitch | ### Creates a log delivery configuration for Cloud Firewall to Simple Log Service (SLS) `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-sls-log-dispatch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SlsRegionId | string | no | The SLS region ID | | Ttl | integer | no | The storage duration of logs. Unit: days | ### Creates a VPC firewall for a transit router (TR). Before you begin: (1) Purchase Cloud Firewall. (2) Create… `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-tr-firewall-v2` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response. Valid values: zh (default): Chinese en: English | | FirewallName | string | no | The name of the Cloud Firewall instance | | RouteMode | string | no | The routing mode. Valid values: managed (automatic mode) and manual (manual mode). In managed mode, only FirewallVpcCidr is required. The… | | TransitRouterId | string | no | The ID of the Enterprise Edition transit router instance. The transit router must belong to the CEN instance specified by CenId. Note:… | | RegionNo | string | no | The region ID of the Enterprise Edition transit router. Note: Although this parameter is marked as not required in the schema, it is… | | FirewallVpcCidr | string | no | The CIDR block of the firewall VPC in automatic mode | | FirewallSubnetCidr | string | no | The subnet CIDR block used to store the firewall elastic network interface (ENI) in the firewall VPC in automatic mode | | TrAttachmentSlaveCidr | string | no | The secondary subnet CIDR block used to connect to the TR in the firewall VPC in automatic mode | | TrAttachmentMasterCidr | string | no | The primary subnet CIDR block used to connect to the TR in the firewall VPC in automatic mode | | CenId | string | no | The ID of the CEN instance. Create a CEN instance in the CEN console first and make sure that an Enterprise Edition transit router has… | | FirewallDescription | string | no | The description of the firewall | | FirewallVpcId | string | no | The ID of the VPC in which the firewall ENI is created in manual mode | | FirewallVswitchId | string | no | The ID of the vSwitch in which the firewall ENI is created in manual mode | | TrAttachmentSlaveZone | string | no | The secondary zone of the vSwitch | | TrAttachmentMasterZone | string | no | The primary zone of the vSwitch | | TrAttachmentZones | string | no | The list of zone IDs used by the TR connection (JSON-encoded) | | FirewallAttachmentZone | string | no | The zone ID used by the firewall connection | | FirewallServiceMode | string | no | The deployment mode of the firewall service. Valid values: PrimaryStandby: Primary/standby mode. MultiPrimary: Active-active mode. If this… | | FirewallServiceZones | string | no | The list of zone IDs used by the firewall service (JSON-encoded) | ### Creates a routing rule for a VPC firewall for a transit router. Prerequisites: Activate Cloud Firewall >… `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-tr-firewall-v2-route-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response message. Valid values: zh (default): Chinese. en: English | | PolicyType | string | no | The type of the traffic redirection scenario for virtual private cloud (VPC) border firewalls in CEN Enterprise Edition. Valid values:… | | PolicyName | string | no | The name of the traffic redirection policy | | PolicyDescription | string | no | The description of the traffic redirection policy | | FirewallId | string | no | The instance ID of the virtual private cloud (VPC) border firewall. FirewallId is required. If this parameter is not specified, an… | | SrcCandidateList | string | no | The list of primary traffic redirection instances. SrcCandidateList is required. If this parameter is not specified, an… | | DestCandidateList | string | no | The list of secondary traffic redirection instances. DestCandidateList is required. If this parameter is not specified, an… | ### Creates virtual private cloud (VPC) firewalls at the border to protect mutual access traffic between network… `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-vpc-firewall-cen-configure` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English | | VpcFirewallName | string | yes | The instance name of the virtual private cloud (VPC) firewalls at the border | | NetworkInstanceId | string | yes | The instance ID of the VPC-connected instance for which you want to create virtual private cloud (VPC) firewalls at the border.… | | VpcRegion | string | yes | The region ID of the VPC for which you want to create virtual private cloud (VPC) firewalls at the border. For more information about the… | | FirewallSwitch | string | yes | The settings for the switch status of the virtual private cloud (VPC) firewalls at the border. Valid values: open (default): Automatically… | | CenId | string | yes | The instance ID of the CEN. Prerequisite: The CEN instance must be created by invoking the CreateCen operation | | MemberUid | string | no | The UID of the member accounts of the current Alibaba Cloud account | | VSwitchId | string | no | The ID of the vSwitch to which the Cloud Firewall interface belongs | | FirewallVpcCidrBlock | string | no | The VPC CIDR block used by the firewall. You must configure a CIDR block with a subnet mask of no more than 28 bits to allocate to the VPC… | | FirewallVpcZoneId | string | no | The ID of the primary zone to which the firewall belongs. If your business is sensitive to latency, you can set the zone of the firewall… | | FirewallVSwitchCidrBlock | string | no | The vSwitch CIDR block used by the firewall. You must configure a CIDR block with a subnet mask of no more than 29 bits that does not… | | FirewallVpcStandbyZoneId | string | no | The ID of the secondary zone to which the firewall belongs. Only when the primary zone service is not active, the firewall will perform… | | FirewallVSwitchZoneId | string | no | The ID of the zone to which the firewall vSwitch belongs | ### Creates a virtual private cloud (VPC) firewall that protects traffic between two VPCs connected through… `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-vpc-firewall-configure` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English | | VpcFirewallName | string | yes | The instance name of the virtual private cloud (VPC) firewall | | LocalVpcId | string | yes | The instance ID of the local VPC | | LocalVpcRegion | string | yes | The region ID of the local VPC. For more information about the regions supported by Cloud Firewall, see… | | PeerVpcId | string | yes | The instance ID of the peer VPC | | PeerVpcRegion | string | yes | The region ID of the peer VPC. For more information about the regions supported by Cloud Firewall, see… | | FirewallSwitch | string | yes | Settings for the enabling status of the virtual private cloud (VPC) firewall after it is created. Valid values: open (default): Protection… | | LocalVpcCidrTableList | string | yes | The CIDR block list of the local VPC, in JSON format. This parameter contains the following fields: RouteTableId: the route table ID of… | | PeerVpcCidrTableList | string | yes | The CIDR block list of the peer VPC, in JSON format. This parameter contains the following fields: RouteTableId: the route table ID of the… | | MemberUid | string | no | The UID of the Alibaba Cloud member account | ### Adds an access control policy to a specified VPC firewall policy group `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-vpc-firewall-control-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese en: English | | AclAction | string | yes | The action that Cloud Firewall performs on the traffic in the virtual private cloud (VPC) firewall access control policy. Valid values:… | | ApplicationName | string | no | The application type supported by the virtual private cloud (VPC) firewall access control policy. Valid values: FTP HTTP HTTPS MySQL SMTP… | | Description | string | yes | The description of the virtual private cloud (VPC) firewall access control policy | | DestPort | string | no | The destination port in the virtual private cloud (VPC) firewall access control policy for traffic access. When DestPortType is set to… | | Destination | string | yes | The destination address in the virtual private cloud (VPC) firewall access control policy for traffic access. Valid values: If… | | DestinationType | string | yes | The type of the destination address in the virtual private cloud (VPC) firewall access control policy. Valid values: net: destination CIDR… | | VpcFirewallId | string | yes | The ID of the virtual private cloud (VPC) firewall access control policy group. If the VPC firewall protects traffic between two VPCs… | | Proto | string | yes | The security protocol type for traffic access in the virtual private cloud (VPC) firewall access control policy. Valid values: ANY: any… | | Source | string | yes | The source address in the virtual private cloud (VPC) firewall access control policy. If SourceType is set to `net`, the value of Source… | | SourceType | string | yes | The type of the source address in the virtual private cloud (VPC) firewall access control policy. Valid values: net: source CIDR block… | | NewOrder | string | yes | The priority of the virtual private cloud (VPC) firewall access control policy. The priority value starts from 1 and increases by… | | DestPortType | string | no | The type of the destination port for traffic access in the virtual private cloud (VPC) firewall access control policy. Valid values: port:… | | DestPortGroup | string | no | The name of the destination port address book for traffic access in the virtual private cloud (VPC) firewall access control policy. When… | | MemberUid | string | no | The UID of a member account of the current Alibaba Cloud account | | Release | string | no | Specifies whether to enable the access control policy. The policy is enabled by default after it is created. Valid values: true: enables… | | ApplicationNameList | string | no | The application types supported by the access control policy (JSON-encoded) | | RepeatType | string | no | The recurrence type of the policy validity period for the access control policy. Valid values: Permanent (default): always None: one-time… | | RepeatDays | string | no | The days of a week or of a month on which the access control policy takes effect. When RepeatType is set to `Permanent`, `None`, or… | | RepeatStartTime | string | no | The recurrence start time of the policy validity period for the access control policy. Example: 08:00. The value must be on the hour or on… | | RepeatEndTime | string | no | The recurrence end time of the policy validity period for the access control policy. Example: 23:30. The value must be on the hour or on… | | StartTime | integer | no | The start time of the policy validity period for the access control policy. The value is a UNIX timestamp in seconds. The value must be on… | | EndTime | integer | no | The end time of the policy validity period for the access control policy. The value is a UNIX timestamp in seconds. The value must be on… | | DomainResolveType | string | no | The domain name resolution method of the access control policy. Valid values: FQDN: FQDN-based DNS: DNS-based dynamic resolution… | ### Creates a precheck task before you create a VPC firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-vpc-firewall-precheck` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English | | NetworkInstanceType | string | no | The type of the network instance. Valid values: cen_firewall cen_tr_firewall ec_firewall | | VpcId | string | no | The ID of the VPC instance | | Region | string | no | The region | | CenId | string | no | The ID of the Cloud Enterprise Network (CEN) instance | | MemberUid | string | no | The UID of the member account of Cloud Firewall | | TransitRouterId | string | no | The ID of the transit router instance | ### Creates a sync task for VPC firewall assets `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/create-vpc-firewall-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response message. Valid values: zh (default): Chinese en: English | | TaskAction | string | yes | The name of the task | | Priority | string | no | The priority of the rule | | Content | string | no | The content of the task | ### Deletes an ACK cluster connector `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-ack-cluster-connector` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ConnectorId | string | yes | The ID of the ACK cluster connector | ### Deletes an ACL backup `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-acl-backup-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address | | Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English | | BackUpTime | string | yes | The time of the backup, specified as a UNIX timestamp (the number of seconds that have elapsed since 00:00:00 UTC on January 1, 1970) | ### Deletes an address book `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-address-book` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the request | | Lang | string | no | The language type. Valid values: en: English zh: Chinese (default) | | GroupUuid | string | yes | The unique ID of the address book. You can call the [DescribeAddressBook](~~DescribeAddressBook~~) operation to query the ID | ### Deletes an access control policy `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-control-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token. Make sure that the… | | DryRun | string | no | Specifies whether to only precheck the request. If you set this parameter to true, the system only performs prechecks on parameter… | | SourceIp | string | no | The source IP address of the traffic | | Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese en: English | | AclUuid | string | yes | The unique ID of the access control policy. To delete an access control policy, you must provide the unique ID of the policy. You can call… | | Direction | string | no | The traffic direction controlled by the access control policy. Valid values: in: inbound traffic out: outbound traffic | ### Deletes an access control policy template `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-control-policy-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address | | Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese en: English | | TemplateId | string | yes | The ID of the access control policy template | ### Deletes a DNS firewall policy `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-dns-firewall-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the request | | Lang | string | no | The language of the request and response. Valid values: zh for Chinese and en for English | | AclUuid | string | yes | The unique ID of the access control policy | ### Deletes a file download task `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-download-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English | | TaskId | string | no | The task ID of the file download task | ### Deletes a routing policy for a VPC firewall for a transit router `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-firewall-v2-route-policies` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response message. Valid values: zh (default): Chinese en: English | | FirewallId | string | no | The ID of the VPC firewall instance | | TrFirewallRoutePolicyId | string | no | The ID of the firewall routing policy | ### Deletes Cloud Firewall member accounts `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-instance-members` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | MemberUids | string | yes | The UIDs of the member accounts (JSON-encoded) | ### Creates a private network association for an IPS `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-ips-private-assoc` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response messages. Valid values: zh (default): Chinese. en: English | | ResourceId | string | no | The instance ID | ### Deletes a NAT firewall access control policy `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-nat-firewall-control-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language type of the response message. Valid values: zh (default): Chinese en: English | | AclUuid | string | yes | The unique ID of the access control policy. To delete a security access control policy, you must provide the unique ID of the policy. You… | | NatGatewayId | string | yes | The ID of the NAT gateway | | Direction | string | yes | The direction of traffic that the access control policy controls. Valid values: out: outbound traffic | ### Deletes a batch of NAT firewall policies `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-nat-firewall-control-policy-batch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese en: English | | AclUuidList | string | yes | A list of access control list (ACL) UUIDs (JSON-encoded) | | NatGatewayId | string | yes | The ID of the NAT Gateway | | Direction | string | no | The traffic direction for the access control policy. Valid value: out: outbound traffic | ### Deletes all private DNS domain names `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-private-dns-all-domain-name` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | AccessInstanceId | string | yes | The instance ID | | RegionNo | string | yes | The region ID of the instance | ### Delete private DNS domain names `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-private-dns-domain-name` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | AccessInstanceId | string | yes | The instance ID | | RegionNo | string | yes | The region ID of the instance | | DomainNameList | string | yes | The list of domain names (JSON-encoded) | ### Deletes a private DNS endpoint `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-private-dns-endpoint` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | AccessInstanceId | string | yes | The instance ID | | RegionNo | string | yes | The region ID of the instance | ### Deletes a NAT firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-security-proxy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese en: English | | ProxyId | string | yes | The ID of the NAT firewall | ### Deletes a VPC firewall for a transit router `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-tr-firewall-v2` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the content within the response. Valid values: zh (default): Chinese en: English | | FirewallId | string | no | The instance ID of the virtual private cloud (VPC) firewall | ### Deletes a virtual private cloud (VPC) firewall that protects mutual access traffic between a network… `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-vpc-firewall-cen-configure` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English | | VpcFirewallIdList | string | yes | The list of instance IDs of VPC border firewalls (JSON-encoded) | | MemberUid | string | no | The UID of a member account of the current Alibaba Cloud account | ### Deletes a virtual private cloud (VPC) firewall that protects traffic between two VPCs connected through… `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-vpc-firewall-configure` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English | | VpcFirewallIdList | string | yes | The list of instance IDs of the virtual private cloud (VPC) firewalls to delete (JSON-encoded) | | MemberUid | string | no | The UID of a member account of the current Alibaba Cloud account | ### Deletes an access control policy from a specified VPC firewall policy group `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/delete-vpc-firewall-control-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response. zh: Chinese en: English | | AclUuid | string | yes | The unique ID of the access control policy for the virtual private cloud (VPC) firewall. To delete an access control policy, you must… | | VpcFirewallId | string | yes | The ID of the access control policy group for the virtual private cloud (VPC) firewall. You can call the… | ### Queries the trend chart of Internet access control interceptions `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-aclprotect-trend` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | This parameter is deprecated | | Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English | | StartTime | string | no | The start time of the query. The value is a UNIX timestamp in seconds | | EndTime | string | no | The end time of the query. The value is a UNIX timestamp in seconds | | FirewallType | string | no | The type of the firewall border. Valid values: internet (default): Internet Border firewall, which monitors traffic between the Internet… | | Interval | integer | no | The time aggregation granularity for trend data, in seconds. Valid values: 60: 1-minute granularity (uses the minute-level detail table).… | ### Queries the enabling status of AI-powered traffic analysis `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-aitraffic-analysis-status` (byok) ### Queries the list of regions for sync nodes `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-access-instance-region-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | AccessInstanceStatus | string | no | The sync node status. Used to filter by status. Currently, only the "created" status is supported for filtering. Passing other values… | | AccessInstanceType | string | no | The sync node type. Valid values: PrivateDns: Private DNS (default value if not specified). AckClusterConnector: ACK cluster connector | ### Queries the task progress of a synchronization node `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-access-instance-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | AccessInstanceId | string | no | The synchronization node ID. You must specify at least one of AccessInstanceId and TaskId. If both are empty, the error… | | RegionNo | string | no | The region ID | | Lang | string | no | The language of the response message | | TaskId | string | no | The task ID. You must specify at least one of TaskId and AccessInstanceId. If both are empty, the error… | | AccessInstanceType | string | no | The synchronization node type | ### Queries the vSwitches for synchronization nodes `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-access-instance-vswitch-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionNo | string | yes | The region ID | | VpcId | string | no | The ID of the VPC | | ZoneId | string | no | The zone ID | | VSwitchId | string | no | The ID of the vSwitch | | MemberUid | integer | no | The UID of the Alibaba Cloud account to which the resource belongs | | PageNo | integer | no | The page number | | PageSize | integer | no | The number of entries per page | ### Queries the VPCs associated with synchronization nodes `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-access-instance-vpc-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionNo | string | yes | The region ID | | VpcId | string | no | The ID of the VPC instance | | MemberUid | integer | no | The UID of the Alibaba Cloud account that owns the resource | | PageNo | integer | no | The page number | | PageSize | integer | no | The number of entries per page | ### Returns a list of available zones for access instances `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-access-instance-zone-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionNo | string | no | The region of the access instance | | Lang | string | no | The language of the response | | AccessInstanceType | string | no | The type of the access instance | ### Queries the details of a specified ACK cluster connector `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-ack-cluster-connector` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ConnectorId | string | yes | The ID of the ACK cluster connector. You can obtain the value from: [DescribeAckClusterConnectors](~~DescribeAckClusterConnectors~~):… | | Lang | string | no | The language in which the health status error reason of the ACK cluster connector is displayed | ### Queries a list of ACK cluster connectors in batches `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-ack-cluster-connectors` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | PageNo | string | yes | The page number | | PageSize | string | yes | The number of entries per page | | MemberUid | string | no | The Alibaba Cloud UID of the account to which the ACK cluster resource belongs | | RegionNo | string | no | The region ID of the ACK cluster connector. You can call the following operation to obtain the value:… | | ConnectorName | string | no | The name of the ACK cluster connector | | VpcId | string | no | The instance ID of the VPC-connected instance to which the ACK cluster belongs | | ClusterId | string | no | The ACK cluster ID | | Lang | string | no | The language in which the unhealthy reason of the ACK cluster connector health status is displayed | ### Queries the namespaces in an Alibaba Cloud Container Service for Kubernetes (ACK) cluster `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-ack-cluster-namespaces` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ConnectorId | string | yes | The ID of the ACK cluster connector. To obtain this ID, call the [DescribeAckClusterConnectors](~~DescribeAckClusterConnectors~~)… | ### Queries the labels within an Alibaba Cloud Container Service for Kubernetes (ACK) cluster `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-ack-cluster-pod-labels` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ConnectorId | string | yes | The ID of the ACK cluster connector. You can obtain the ID by calling the following operation:… | ### Queries for Container Service for Kubernetes (ACK) clusters based on specified conditions, such as cluster… `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-ack-clusters` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionNo | string | yes | The region ID of the ACK cluster | | MemberUid | string | no | The Alibaba Cloud UID of the account to which the ACK cluster resources belong | | PageSize | string | yes | The number of entries per page | | PageNo | string | yes | The page number | | ClusterId | string | no | The ID of the ACK cluster | | ClusterName | string | no | The name of the ACK cluster | | ClusterSpec | string | no | The specification of the ACK cluster | | ConnectorStatus | string | no | The status of the ACK cluster connector | ### Queries multiple ACL applications `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-acl-apps` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response. Valid values: zh (default): Chinese en: English | | PageNo | integer | yes | The page number | | PageSize | integer | yes | The page size | | AclType | string | yes | The ACL type. Valid values: Internet NAT VPC All | | Popular | integer | no | Specifies whether the application is common. Valid values: 1: common 0: not common If you omit this parameter (the default), all… | | Protocols | string | no | The list of protocol types (JSON-encoded) | ### Queries a list of ACL backups `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-acl-backup-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the request | | Lang | string | no | The language of the response | | CurrentPage | string | yes | The current page number | | PageSize | string | yes | The number of entries per page | ### Queries the details of an Access Control List (ACL) check `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-acl-check` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response | | TaskId | string | yes | The task ID | | PageNo | integer | yes | The page number | | PageSize | integer | yes | The number of entries per page | ### Queries the quota for access control list (ACL) checks `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-acl-check-quota` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response | ### Queries Access Control List (ACL) checks in batches `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-acl-checks` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language | | AclType | string | yes | The type of ACL check | ### Retrieves the total number of access control policy configurations `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-acl-rule-count` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the request | | Lang | string | no | The language type. Valid values: zh (default): Chinese en: English | ### Retrieves the ACL whitelist `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-acl-whitelist` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the visitor | | Lang | string | no | The language of the messages to receive. Valid values: zh (default): Chinese en: English | ### Queries address books in batches `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-address-book` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language type for the address book description. Valid values: en: English. zh: Chinese (default) | | CurrentPage | string | no | The page number in a paged query. Default value: 1, which indicates that the first page of data is returned | | PageSize | string | no | The number of address books on each page in a paged query. Default value: 10, which indicates that each page contains 10 results. Maximum… | | Query | string | no | The search condition. Enter the address book information that you want to query | | GroupType | string | no | The type of the address book. If you do not set this parameter, IP address books and ECS tag-based address books are queried | | ContainPort | string | no | Queries address books that contain the specified port. This parameter takes effect only when the GroupType parameter is set to port | | GroupUuid | string | no | The unique ID of the address book | | AssetMemberUids | string | no | The list of member accounts for the asset address book (JSON-encoded) | ### Queries information about assets protected by Cloud Firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-asset-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language type of the response. Valid values: zh (default): Chinese. en: English | | CurrentPage | string | yes | The page number of the current page in a paginated query | | PageSize | string | yes | The number of Cloud Firewall-protected assets to display on each page in a paginated query | | RegionNo | string | no | The region ID of the Cloud Firewall. For more information about regions supported by Cloud Firewall, see… | | Status | string | no | The Cloud Firewall status. Valid values: open: Protected. opening: Protection enabling. closed: Not protected. closing: Protection… | | SearchItem | string | no | The IP address or instance ID of the asset | | Type | string | no | This parameter is deprecated | | ResourceType | string | no | The asset type. Valid values: BastionHostEgressIP: Bastion host egress IP. BastionHostIngressIP: Bastion host ingress IP. EcsEIP: ECS EIP.… | | SgStatus | string | no | The security group policy status. Valid values: pass: Delivered. block: Not delivered. unsupport: Not supported. If this parameter is not… | | IpVersion | string | no | The IP version of the assets protected by Cloud Firewall. Valid values: 4 (default): IPv4. 6: IPv6 | | MemberUid | integer | no | The UID of the Cloud Firewall member account | | UserType | string | no | The user type. Valid values: buy (default): Paid user. free: Free user | | NewResourceTag | string | no | The time when the asset was discovered. Valid values: discovered in 1 hour: The asset was discovered within 1 hour. discovered in 1 day:… | | OutStatistic | string | no | Specifies whether to query outbound traffic information | | SensitiveStatus | string | no | The status of data leakage detection | ### Retrieves the risk level list of assets `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-asset-risk-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the request | | Lang | string | no | The language type of the response message. Valid values: zh (default): Chinese en: English | | IpVersion | integer | yes | The IP version of the assets protected by Cloud Firewall. Valid values: 4 (default): IPv4 6: IPv6 | | IpAddrList | string | no | The list of IP addresses to query. Separate multiple IP addresses with commas (,). You can query up to 20 IP addresses at a time. This… | ### Queries the statistics information of assets protected by Cloud Firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-asset-statistic` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the request | | Lang | string | no | The language of the request and response. Valid values:- zh: Chinese- en: English | ### Queries the list of attack categories `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-attack-app-category` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English | ### Queries the status of log delivery `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-batch-sls-dispatch-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response message | ### Retrieves information about cleared authorizations `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-clear-auth-info` (byok) ### Queries outbound IPs `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-configured-destination-ip` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the visitor | | Lang | string | no | The language of the response | | DestinationIP | string | no | The destination IP address | | DestinationRegion | string | no | The destination region | | DestinationISP | string | no | The destination ISP | | GroupName | string | yes | The group name | | PageSize | string | no | The number of entries to return on each page | | CurrentPage | string | no | The page number of the returned page | | Direction | string | yes | The traffic direction | | SourceCode | string | yes | The trace code | ### Lists the active outbound domain names `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-configured-domain-names` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address | | Lang | string | no | The language of the response | | DomainName | string | no | The domain name | | GroupName | string | yes | The group name | | PageSize | string | no | The number of entries per page | | CurrentPage | string | no | The page number | | Direction | string | yes | The traffic direction | | SourceCode | string | yes | The trace code | ### Retrieves information about all access control policies `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-control-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language type for receiving messages. Valid values: | | Direction | string | no | The traffic direction controlled by the access control policy. Valid values: in (inbound) or out (outbound). You must specify at least one… | | CurrentPage | string | yes | The page number of the current page displayed in a paging query | | PageSize | string | yes | The maximum number of entries per page displayed in a paging query | | Source | string | no | The source address in the access control policy. Fuzzy queries are supported. The value varies depending on the SourceType (source type) | | Destination | string | no | The destination address in the access control policy. Fuzzy queries are supported. The value varies depending on the DestinationType… | | Description | string | no | The description of the access control policy. Fuzzy queries are supported | | Proto | string | no | The protocol type of the traffic in the access control policy. Valid values: | | AclAction | string | no | The action that Cloud Firewall performs on the traffic in the access control policy. Valid values: | | Release | string | no | The enabled status of the access control policy. Valid values: | | AclUuid | string | no | The unique ID of the access control policy. You must specify at least one of AclUuid and Direction. If AclUuid is specified, you can query… | | IpVersion | string | no | The supported IP address version. Valid values: | | RepeatType | string | no | The recurrence type of the policy validity period for the access control policy. Valid values: | ### Queries the domain name resolution results of an access control policy `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-control-policy-domain-resolve` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language type | | RegionNo | string | no | The region ID. This parameter is required. If this parameter is not specified, the error MissingParameter.RegionNo is returned (-200155,… | | Domain | string | no | The domain name. This parameter is required and must be specified when you call this operation | | IpVersion | integer | no | The IP address version. Valid values: 4 (IPv4) and 6 (IPv6). This parameter is unconditionally required and has no dependency on RegionNo.… | | FirewallType | string | no | The type of the cloud firewall | ### Retrieves a list of created NAT firewalls `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-created-nat-firewall` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the requester | | Lang | string | no | The language of the request and response | ### Queries a list of member accounts `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-ctrl-instance-member-accounts` (byok) ### Provides Intrusion Prevention System (IPS) protection for internet traffic `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-default-ipsconfig` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response. Valid values: zh: Chinese. This is the default value. en: English | ### Queries the list of access control lists (ACLs) for the DNS firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-dns-firewall-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the request | | Lang | string | no | The language of the response messages. Valid values: zh (Chinese) and en (English) | | CurrentPage | string | yes | The page number to return. Default value: 1 | | PageSize | string | yes | The number of entries to return on each page | | Source | string | no | The source address in the DNS firewall policy. Fuzzy match is supported. The value of Source can be a CIDR block or an address book | | Destination | string | no | The destination address in the DNS firewall policy. Fuzzy match is supported. The value of Destination can be a CIDR block, a domain name,… | | Description | string | no | The description of the DNS firewall policy | | AclAction | string | no | The action that is performed on traffic that hits the DNS firewall policy. Valid values: accept: allows the traffic. drop: denies the… | | Release | string | no | The status of the access control policy. The policy is enabled by default after it is created. Valid values: true: enables the access… | | AclUuid | string | no | The unique ID of the firewall rule | | IpVersion | string | no | The IP version that is supported. Valid values: 4: IPv4 6: IPv6 | ### Queries the information and download URLs of file download tasks `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-download-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response message. Valid values: zh (default): Chinese en: English | | PageSize | string | no | The maximum number of entries to return on each page for a paged query. The default value is 10. The maximum value is 50 | | CurrentPage | string | no | The page number for a paged query | | TaskType | string | no | The type of the task. This is an enumeration. For a list of valid values, see the API for querying file download task types. If you do not… | ### Queries download task types. This corresponds to the TaskType field in download task-related API operations `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-download-task-type` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language in which messages are received. Valid values: zh (default): Chinese en: English | | PageSize | string | no | The maximum number of entries to return on each page in a paged query. Default value: 10. Maximum value: 50 | | CurrentPage | string | no | The page number of the page to return in a paged query. Default value: 1, which indicates the first page | | TaskType | string | no | The task type | ### Retrieves the overall firewall interception trends, including Internet, VPC, and NAT traffic `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-firewall-drop-trend` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response. Valid values: zh (default): Chinese en: English | | StartTime | integer | no | The start time of the query. Specify a UNIX timestamp in seconds. This parameter is required and must be specified together with EndTime.… | | EndTime | integer | no | The end time of the query. Specify a UNIX timestamp in seconds. This parameter is required and must be specified together with StartTime.… | ### Retrieves firewall tasks `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-firewall-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language type. Valid values: zh (default): Chinese en: English | | ChildInstanceId | string | no | The ID of the child instance. You must specify at least one of ChildInstanceId and TaskId. If both are empty, the MissingParameter.TaskId… | | TaskType | string | no | The type of the task. Valid values: NAT: NAT firewall task VPC: VPC firewall task | | TaskId | string | no | The ID of the task. You must specify at least one of TaskId and ChildInstanceId. If both are empty, the MissingParameter.TaskId (-360448,… | ### Queries the traffic trend of a firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-firewall-traffic-trend` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response message. zh (default): Chinese en: English | | StartTime | integer | no | The start time of the query. Specify a UNIX timestamp in seconds. This parameter is required. If this parameter is not specified,… | | EndTime | integer | no | The end time of the query. Specify a UNIX timestamp in seconds. This parameter is required. If this parameter is not specified,… | ### Queries the vSwitches that are created by Cloud Firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-firewall-vswitch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response. Valid values: | | RegionNo | string | no | The region ID | | VpcId | string | no | The ID of the VPC instance | | VswitchId | string | no | The ID of the vSwitch | | FirewallId | string | no | The instance ID of the VPC border firewall | | MemberUid | string | no | The UID of the member account | | PageNo | string | no | The page number | | PageSize | string | no | The number of the page to return | ### Queries the vSwitch resources for Cloud Firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-firewall-vswitch-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response message | | RegionNo | string | yes | The region | | VpcId | string | yes | The ID of the VPC instance | | FirewallType | string | yes | The type of the Cloud Firewall | ### Queries IPS rules `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-ipsrules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the requester | | Lang | string | no | The language of the request message | | RuleType | string | yes | The rule type | | PageNo | integer | yes | The current page number | | PageSize | integer | yes | The number of entries per page | | QueryModify | string | no | Specifies whether the rule has been modified | | RuleLevel | integer | no | The rule level | | AttackType | string | no | The attack application type | | AttackApp | string | no | The attacked application | | RuleAction | string | no | The rule action | | RuleId | string | no | The rule ID | | RuleName | string | no | The rule name | | Cve | string | no | The CVE ID | | RuleClass | string | no | The supported engine mode | | DefaultAction | string | no | The enabling status | | Sort | string | no | The sorting method | | Order | string | no | The sorting order | | FirewallType | string | no | The Cloud Firewall type | | VpcFirewallId | string | no | The instance ID of the virtual private cloud (VPC) firewalls | | AttackApps | string | no | The list of attacked applications (JSON-encoded) | | AttackAppCategory | string | no | The list of categories of the attacked applications. Specify the value in the ["AttackAppCategory1","AttackAppCategory2"] format… | ### Retrieves information about the member accounts of Cloud Firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-instance-members` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | CurrentPage | string | no | The page number. The default value is 1 | | PageSize | string | no | The number of entries per page. The default value is 20 | | MemberUid | string | no | The UID of the Cloud Firewall member account | | MemberDisplayName | string | no | The name of the Cloud Firewall member account | | MemberDesc | string | no | The description of the Cloud Firewall member account. The description must be 1 to 256 characters in length | ### Retrieves the account in a resource directory for an instance `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-instance-rd-accounts` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The IP address of the requester | | Lang | string | no | The language type for the request and response messages | | CurrentPage | string | no | The page number of the current page | | PageSize | string | no | The number of entries per page | | MemberUid | string | no | The UID of the member accounts | | MemberDisplayName | string | no | The name of the Cloud Firewall member accounts | | MemberDesc | string | no | The remarks of the Cloud Firewall member accounts | ### Queries the risk levels of instances `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-instance-risk-levels` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response. Valid values: zh (default): Chinese en: English | | Instances | string | no | The list of instances (JSON-encoded) | ### Internet security trends `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-internet-drop-traffic-trend` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address | | Lang | string | no | The language of the response | | Direction | string | no | The traffic direction | | StartTime | string | yes | The start time, specified as a timestamp in seconds | | EndTime | string | yes | The end time of the query, specified as a timestamp in seconds | | SourceCode | string | yes | The traceability code | ### You can obtain details about Internet access `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-internet-open-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the access request | | Lang | string | no | The language of the content | | ServiceName | string | no | The name of the application for an exact match. If you leave this parameter empty, all applications are queried | | ServiceNameFuzzy | string | no | The name of the application for a fuzzy match. If you leave this parameter empty, all applications are queried | | RiskLevel | string | no | The risk level. If you leave this parameter empty, all risk levels are queried | | SuggestLevel | string | no | The recommended policy level | | Port | string | no | The port for an exact match. The value must be an integer from 1 to 65535. If you leave this parameter empty, all ports are queried | | AssetsInstanceId | string | no | The ID of the asset. Fuzzy search is supported | | AssetsInstanceName | string | no | The name of the asset. Fuzzy search is supported | | PublicIp | string | no | The public IP address for an exact match. If you leave this parameter empty, all public IP addresses are queried | | RegionNo | string | no | The region ID | | AssetsType | string | no | The type of the asset for an exact match. If you leave this parameter empty, all asset types are queried | | StartTime | string | no | The start of the time range to query. The value is a UNIX timestamp. Unit: seconds | | EndTime | string | no | The end of the time range to query. The value is a UNIX timestamp. Unit: seconds | | CurrentPage | string | no | The page number of the returned page | | PageSize | string | no | The number of the page to return | | SortList | string | no | The sorting conditions (JSON-encoded) | ### Queries the details of an access control policy group in Cloud Firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-internet-open-ip` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the content within the response. Valid values: zh (default): Chinese en: English | | ServiceName | string | no | The application name to query | | RiskLevel | string | no | The risk level. If this parameter is not specified, all risk levels are returned. Valid values: 3: high risk 2: medium risk 1: low risk 0:… | | Port | string | no | The port number | | AssetsInstanceId | string | no | The instance ID | | AssetsInstanceName | string | no | The instance name | | PublicIp | string | no | The public IP address of the instance | | RegionNo | string | no | The region ID of the instance | | AssetsType | string | no | The asset type of the instance | | StartTime | string | no | The start time of the public IP address exposure. Specify the value as a UNIX timestamp in seconds | | EndTime | string | no | The end time of the public IP address exposure. Specify the value as a UNIX timestamp in seconds | | CurrentPage | string | yes | The page number for a paged query | | PageSize | string | yes | The number of entries per page for a paged query | ### Queries the ports that are open to the Internet `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-internet-open-port` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address | | Lang | string | no | The language of the content | | ServiceName | string | no | The name of the application. This is an exact match. If you do not specify this parameter, all applications are queried | | ServiceNameFuzzy | string | no | The name of the application. This is a fuzzy match. If you do not specify this parameter, all applications are queried | | RiskLevel | string | no | The risk level | | SuggestLevel | string | no | The recommended policy level | | Port | string | no | The port number | | StartTime | string | no | The start of the time range to query. The value is a UNIX timestamp. Unit: seconds | | EndTime | string | no | The end of the time range to query. The value is a UNIX timestamp. Unit: seconds | | CurrentPage | string | no | The page number for a paged query | | PageSize | string | no | The number of entries per page for a paged query | ### Queries services exposed to the Internet `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-internet-open-service` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the visitor | | Lang | string | no | The language of the response | | ServiceName | string | no | The name of the application for an exact match. If you do not specify this parameter, all applications are queried | | ServiceNameFuzzy | string | no | The name of the application for a fuzzy match. If you do not specify this parameter, all applications are queried | | RiskLevel | string | no | The risk level | | SuggestLevel | string | no | The recommended policy level | | Port | string | no | The port number | | StartTime | string | no | The start of the time range to query. The value is a UNIX timestamp in seconds | | EndTime | string | no | The end of the time range to query. The value is a UNIX timestamp in seconds | | CurrentPage | string | no | The page number | | PageSize | string | no | The number of entries per page | ### Retrieves statistics about assets exposed to the Internet `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-internet-open-statistic` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the visitor | | Lang | string | no | The language of the request and response | | StartTime | string | no | The start of the time range to query. This value is a UNIX timestamp in seconds | | EndTime | string | no | The end of the time range to query. This value is a UNIX timestamp in seconds | ### Retrieves a list of Internet service names `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-internet-service-name-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the visitor | | Lang | string | no | The language of the response | ### Retrieves the details of Internet-facing SLB instances `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-internet-slb` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the visitor | | Lang | string | no | The language of the response message | | RegionNo | string | no | The region. If you do not specify this parameter, all regions are queried | | PublicIp | string | no | The public IP address. Fuzzy search is supported. If you do not specify this parameter, all public IP addresses are queried | | InstanceId | string | no | The ID of the SLB instance. Fuzzy search is supported | | InstanceName | string | no | The name of the SLB instance. Fuzzy search is supported | | Tag | string | no | The tag. If you do not specify this parameter, all tags are searched | | IpProtocol | string | no | The protocol type | | Port | string | no | The port | | CurrentPage | string | no | The number of the page to return | | PageSize | string | no | The number of the page to return | ### This operation queries the Top-N internet traffic over time `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-internet-time-top` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address | | Lang | string | no | The language of the response | | Direction | string | yes | The direction of the traffic | | SourceCode | string | yes | The identifier for the trace source | | Sort | string | no | The metric by which to sort the results | | TrafficTime | string | no | The traffic timestamp to query, specified as a Unix timestamp in seconds | | Limit | string | no | The maximum number of entries to return. The value must be between 1 and 50. Default value: 50 | | SrcIP | string | no | The source IP address | | NatIP | string | no | The NAT public IP address. If omitted, traffic data for all assets is returned | | Order | string | no | The sort order | | StartTime | string | no | The start of the query time range, specified as a Unix timestamp in seconds | | EndTime | string | no | The end of the query time range, specified as a Unix timestamp in seconds | | TrafficType | string | no | The traffic type | | IPType | string | no | The network type of the IP address | | Interval | integer | no | The time interval in seconds | ### Queries the top Internet traffic trends `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-internet-traffic-top` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address | | Lang | string | no | The language of the response | | Direction | string | no | The traffic direction | | StartTime | string | yes | The start time. The value is a UNIX timestamp. Unit: seconds | | EndTime | string | yes | The end time. The value is a UNIX timestamp. Unit: seconds | | SourceCode | string | yes | The tracing code for the source | | DataType | string | yes | The type of traffic data | | RuleResult | string | no | The action of the rule | | RuleSource | string | no | The source of the rule | | Sort | string | no | The sorting method | | ShowCountryName | string | no | The name of the country to display | | Limit | string | no | The maximum number of top entries to return. The default value is 50. Valid values: 1 to 50 | ### Queries Internet traffic trends `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-internet-traffic-trend` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the visitor | | Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese en: English | | Direction | string | no | The direction of the Internet traffic. Valid values: in: inbound out: outbound | | StartTime | string | yes | The start of the time range to query. This value is a UNIX timestamp in seconds | | EndTime | string | yes | The end of the time range to query. This value is a UNIX timestamp in seconds | | SourceCode | string | yes | The source tracking code | | SrcPublicIP | string | no | The source public IP address | | SrcPrivateIP | string | no | The source private IP address | | TrafficType | string | no | The type of traffic to query. Valid values: max (default): peak traffic avg: average traffic | ### Queries the trend of vulnerabilities on ECS instances `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-invade-ecs-trend` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the visitor | | Lang | string | no | The language of the response | | StartTime | string | no | The start of the time range to query. This is a UNIX timestamp. Unit: seconds | | EndTime | string | no | The end of the time range to query. This is a UNIX timestamp. Unit: seconds | ### Retrieves the details of a threat detection event `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-invade-event-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the visitor | | Lang | string | no | The language of the content within the response | | AssetsInstanceId | string | yes | The ID of the asset | | EventUuid | string | yes | The UUID of the threat detection event | | PublicIP | string | no | The public IP address | ### Queries information about compromise awareness events in Cloud Firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-invade-event-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language type of the received message. Valid values: | | SourceIp | string | no | The source IP address of the requester | | StartTime | string | no | Specifies the start time of the query. The value is a UNIX timestamp in seconds. If this parameter is not specified, the query starts from… | | EndTime | string | no | Specifies the end time of the query. The value is a UNIX timestamp in seconds. If this parameter is not specified, the current time is used | | CurrentPage | string | no | Specifies the page number to return in a paged query | | PageSize | string | no | Specifies the number of entries per page in a paged query | | AssetsInstanceId | string | no | The instance ID | | AssetsInstanceName | string | no | The instance name | | IsIgnore | string | no | Specifies whether the compromise awareness event is ignored. Valid values: | | AssetsIP | string | no | The IP address of the affected asset | | EventKey | string | no | The ID of the compromise awareness event | | EventName | string | no | The name of the compromise awareness event | | EventUuid | string | no | The UUID of the compromise awareness event | | MemberUid | integer | no | The UID of the member accounts | | ProcessStatusList | string | no | The list of processing statuses (JSON-encoded) | | RiskLevel | string | no | The risk assessment level (JSON-encoded) | ### Retrieves a list of vulnerability names `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-invade-event-name-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the visitor | | Lang | string | no | The language type | | StartTime | string | no | The start time. This is a UNIX timestamp in seconds | | EndTime | string | no | The end time. This is a UNIX timestamp in seconds | ### Queries statistics about intrusion events `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-invade-event-statistic` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the visitor | | Lang | string | no | The language of the response | | StartTime | string | no | The start time. This is a UNIX timestamp that is accurate to the second | | EndTime | string | no | The end time. This is a UNIX timestamp that is accurate to the second | ### Queries the list of IPS Private IP Tracing associations `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-ips-private-assoc` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response. Valid values: zh (default): Chinese. en: English | | ResourceId | string | no | The ID of the resource | | CurrentPage | string | no | The number of the page to return | | PageSize | string | no | The number of entries to return on each page | | PublicIp | string | no | The public IP address of the instance | | Status | string | no | The status of the asset | | MemberUid | integer | no | The Alibaba Cloud account ID of the resource owner | ### Queries the ISP information `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-isp-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the visitor | | Lang | string | no | The language type for receiving messages | | SourceCode | string | yes | The tracing code | ### Queries geolocation information `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-location-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the visitor | | Lang | string | no | The language type | | SourceCode | string | yes | The tracing code | ### Retrieves the details of the Logstore in Simple Log Service `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-log-store-info` (byok) ### Queries member information `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-member-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | MemberUid | string | no | The UID of the member accounts | ### Queries the pagination status of NAT firewalls `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-nat-acl-page-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response messages. Valid values: zh (default): Chinese. en: English | ### Queries the access control policy groups for NAT firewalls `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-nat-firewall-acl-group-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response | ### Queries the access control policies for NAT firewalls `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-nat-firewall-control-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response. Valid values: zh (default): Chinese en: English | | NatGatewayId | string | yes | The ID of the NAT Gateway | | CurrentPage | string | no | The page number of the current page for a paged query | | PageSize | string | no | The maximum number of entries to return on each page for a paged query. The default value is 10 | | Source | string | no | The source address in the access control policy. Fuzzy queries are supported. The value of this parameter varies based on the value of the… | | Destination | string | no | The destination address in the access control policy. Fuzzy queries are supported. The value of this parameter varies based on the value… | | Description | string | no | The description of the access control policy. Fuzzy queries are supported. If you do not set this parameter, the descriptions of all… | | Proto | string | no | The protocol type of the traffic in the access control policy. Valid values: TCP UDP ICMP ANY (all protocol types) If you do not set this… | | AclAction | string | no | The action that Cloud Firewall performs on the traffic. Valid values: accept: Allow drop: Deny log: Monitor | | AclUuid | string | no | The unique ID of the access control policy | | Release | string | no | The status of the access control policy. By default, an access control policy is enabled after it is created. Valid values: true: enabled… | | Direction | string | yes | The traffic direction of the access control policy. Valid values: out: outbound traffic | | RepeatType | string | no | The recurrence type for the policy validity period. Valid values: Permanent (default): always None: one-time Daily: daily Weekly: weekly… | ### Queries the NAT firewall interception trend on the overview page `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-nat-firewall-drop-traffic-trend` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SourceIp | string | no | The source IP address of the request | | StartTime | integer | no | The start time. Specify a UNIX timestamp in seconds. This parameter is required. If this parameter is not specified, the API returns… | | EndTime | integer | no | The end time. Specify a UNIX timestamp in seconds. This parameter is required. If this parameter is not specified, the API returns… | ### Retrieves the details of NAT firewalls `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-nat-firewall-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the response. Valid values: zh (default): Chinese en: English | | PageNo | integer | no | The page number of the current page | | PageSize | integer | no | The number of NAT firewalls to display on each page in a paged query. Default value: 10, which indicates that each page contains 10… | | ProxyId | string | no | The NAT firewall ID | | ProxyName | string | no | The NAT firewall name. The name can contain uppercase and lowercase letters, Chinese characters, digits, and underscores (_). The name… | | RegionNo | string | no | The region ID of the VPC. For more information about the regions supported by Cloud Firewall, see… | | VpcId | string | no | The VPC-connected instance ID | | NatGatewayId | string | no | The NAT gateway ID | | Status | string | no | The Cloud Firewall status. Valid values: configuring: being created deleting: being deleted normal: normal abnormal: abnormal opening:… | | MemberUid | integer | no | The UID of the member account of the current Alibaba Cloud account | ### Queries the priority range of an access control policy for a NAT firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-nat-firewall-policy-prior-used` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response. Valid values: zh (default): Chinese. en: English | | NatGatewayId | string | yes | The ID of the NAT Gateway | | Direction | string | yes | The traffic direction of the access control policy. Valid value: out: outbound traffic | | IpVersion | string | no | The IP version. Valid value: 4 (default): IPv4 | ### Queries the precheck details for a NAT firewall `POST https://apizie.tech/v1/cloud:aliyun-cloudfw/describe-nat-firewall-precheck-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Lang | string | no | The language of the request and response messages | | RegionNo | string | no | The region ID | | NatGatewayId | string | no | The ID of the NAT Gateway | …and 152 more. See the OpenAPI spec. ## Example ``` curl "https://apizie.tech/v1/cloud:aliyun-cloudfw/add-acl-backup-data" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Alibaba Cloud Cloud Firewall API? Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-cloudfw/add-acl-backup-data with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Alibaba Cloud Cloud Firewall API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Cloud Firewall itself also needs your own key from aliyuncs.com. ### Can AI agents use the Alibaba Cloud Cloud Firewall API? Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-cloudfw. ### What is the status of the Alibaba Cloud Cloud Firewall API? Needs your own provider key (bring your own key)