PutEnableFwSwitch - Cloud Firewall - Alibaba Cloud Documentation Center

Enables firewalls for specific assets.

Operation description

You can call this operation to enable a firewall. After you enable a firewall, traffic passes through Cloud Firewall.

Limits

You can call this operation up to five times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-cloudfirewall:PutEnableFwSwitch	update	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
SourceIp`deprecated`	string	No	The source IP address of the request.	192.0.X.X
Lang	string	No	The language of the content within the response. zh: Chinese en: English	zh
IpaddrList	array	No	The IP addresses. Note You must specify at least one of the IpaddrList, RegionList, and ResourceTypeList parameters.
	string	No	The IP address. Note You must specify at least one of the IpaddrList, RegionList, and ResourceTypeList parameters.	192.0.XX.XX
RegionList	array	No	The regions. Note You must specify at least one of the IpaddrList, RegionList, and ResourceTypeList parameters.
	string	No	The region. Note You must specify at least one of the IpaddrList, RegionList, and ResourceTypeList parameters.	cn-hangzhou,cn-shanghai
ResourceTypeList	array	No	The types of the assets. Valid values: BastionHostIP: the egress IP address of a bastion host BastionHostIngressIP: the ingress IP address of a bastion host EcsEIP: the elastic IP address (EIP) of an Elastic Compute Service (ECS) instance EcsPublicIP: the public IP address of an ECS instance EIP: the EIP EniEIP: the EIP of an elastic network interface (ENI) NatEIP: the EIP of a NAT gateway SlbEIP: the EIP of a Server Load Balancer (SLB) instance SlbPublicIP: the public IP address of an SLB instance NatPublicIP: the public IP address of a NAT gateway HAVIP: the high-availability virtual IP address (HAVIP) Note You must specify at least one of the IpaddrList, RegionList, and ResourceTypeList parameters.
	string	No	The type of the asset. Valid values: BastionHostIP: the egress IP address of a bastion host BastionHostIngressIP: the ingress IP address of a bastion host EcsEIP: the EIP of an ECS instance EcsPublicIP: the public IP address of an ECS instance EIP: the EIP EniEIP: the EIP of an ENI NatEIP: the EIP of a NAT gateway SlbEIP: the EIP of an SLB instance SlbPublicIP: the public IP address of an SLB instance NatPublicIP: the public IP address of a NAT gateway HAVIP: the HAVIP Note You must specify at least one of the IpaddrList, RegionList, and ResourceTypeList parameters.	EcsPublicIp,NatEip

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	B2841452-CB8D-4F7D-B247-38E1CF7334F8
AbnormalResourceStatusList	array<object>	The status information of the asset when it is not synchronized to Cloud Firewall.
AbnormalResource	object
Resource	string	The IP address of the asset.	203.0.113.0
Status	string	The status of the asset when it is not synchronized to Cloud Firewall. Valid values: ip_not_sync: The asset is not synchronized.	ip_not_sync
Msg	string	The message displayed when the asset is not synchronized to Cloud Firewall. Valid values: cloudfirewall do not sync this ip address: This IP address is not synchronized to Cloud Firewall.	cloudfirewall do not sync this ip address

Examples

Sample success responses

JSONformat

{
  "RequestId": "B2841452-CB8D-4F7D-B247-38E1CF7334F8",
  "AbnormalResourceStatusList": [
    {
      "Resource": "203.0.113.0",
      "Status": "ip_not_sync",
      "Msg": "cloudfirewall do not sync this ip address"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorInstanceOpenIpNumExceed	The maximum number of protected assets has been reached.	The maximum number of protected assets has been reached.
400	ErrorInstanceStatusNotNormal	This operation is not supported when the instance is in the current state.	This operation is not supported when the instance is in the current state.
400	ErrorParamsNotEnough	Parameters are insufficient.	Parameters are insufficient.
400	ErrorDBTxError	A database transaction error occurred.	The error message returned because an internal error has occurred in the database transaction.
400	ErrorParamsInvalid	Invalid Params	The parameter is invalid.
400	ErrorInstanceOpenIpRegionNumExceed	open ip region num exceed.	Your zone protection quota is insufficient.
401	ErrorAuthentication	An authentication error occurred.	An authentication error occurred.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-08-29	The Error code has changed. The response structure of the API has changed	View Change Details