Use PutDisableFwSwitch to disable a firewall switch - Cloud Firewall - Alibaba Cloud - Cloud Firewall

Disables the firewall switch.

Operation description

Disables the firewall switch. After the firewall switch is disabled, traffic does not pass through Cloud Firewall.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation as needed.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cloudfirewall:PutDisableFwSwitch

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp `deprecated`	string	No	The source IP address of the request.	192.0.XX.XX
Lang	string	No	The language type of the received message. Valid values: zh (default): Chinese en: English	zh
IpaddrList	array	No	The IP address list. Note The IpaddrList, RegionList, and ResourceTypeList parameters cannot all be empty. You must specify a value for at least one of these parameters.	["192.0.XX.XX","192.0.XX.XX"]
	string	No	The IP address.	192.0.XX.XX
RegionList	array	No	The region list. Note The IpaddrList, RegionList, and ResourceTypeList parameters cannot all be empty. You must specify a value for at least one of these parameters.	["cn-hangzhou","cn-shanghai"]
	string	No	The region ID.	cn-hangzhou
ResourceTypeList	array	No	The asset type list. Valid values: BastionHostEgressIP: bastion host egress IP address. BastionHostIngressIP: bastion host ingress IP address. EcsEIP: ECS EIP. EcsPublicIP: public IP addresses of Elastic Compute Service (ECS) instances. EIP: Elastic IP Address. EniEIP: network interface controller (NIC) EIP. NatEIP: NAT EIP. SlbEIP: SLB EIP (CLB EIP). SlbPublicIP: SLB public IP address (CLB public IP address). NatPublicIP: NAT public IP address. HAVIP: active virtual IP address. NlbEIP: NLB EIP. ApiGatewayEIP: API Gateway public IP address. AlbEIP: ALB EIP. AiGatewayEIP: AI Gateway public IP address. GaEIP: GA EIP. SwasEIP: simple application server public IP address. EcdEIP: Elastic Desktop Service public IP address. BastionHostIP: bastion host IP address. Note The IpaddrList, RegionList, and ResourceTypeList parameters cannot all be empty. You must specify a value in Settings for at least one of these parameters.	["EcsPublicIp","NatEip"]
	string	No	The asset type list. Valid values: BastionHostEgressIP: bastion host egress IP address. BastionHostIngressIP: bastion host ingress IP address. EcsEIP: ECS EIP. EcsPublicIP: public IP addresses of Elastic Compute Service (ECS) instances. EIP: Elastic IP Address. EniEIP: network interface controller (NIC) EIP. NatEIP: NAT EIP. SlbEIP: SLB EIP (CLB EIP). SlbPublicIP: SLB public IP address (CLB public IP address). NatPublicIP: NAT public IP address. HAVIP: active virtual IP address. NlbEIP: NLB EIP. ApiGatewayEIP: API Gateway public IP address. AlbEIP: ALB EIP. AiGatewayEIP: AI Gateway public IP address. GaEIP: GA EIP. SwasEIP: simple application server public IP address. EcdEIP: Elastic Desktop Service public IP address. BastionHostIP: bastion host IP address. Note The IpaddrList, RegionList, and ResourceTypeList parameters cannot all be empty. You must specify a value in Settings for at least one of these parameters.	EcsPublicIP
MemberUid	string	No	The unique identifier of the member account.	1234
IpVersion	string	No	The IP version.	4
ClientToken	string	No	The client token that ensures the idempotency of the request. Generated by the client, the token must be unique across different requests. The value is a case-sensitive string in the format of [0-9a-zA-Z-_]{1,64}. We recommend that you use a UUID. The server guarantees idempotency within the validity period (600 seconds): repeated requests with the same ClientToken and the same business parameters return the same result as the first request. If the same ClientToken is used with different business parameters, an HTTP 400 error with the IdempotentParameterMismatch error code is returned.	defefedxexxxx
DryRun	boolean	No	Specifies whether to perform only a dry run. If you set this parameter to true, the system performs pre-checks such as parameter validity, identity permissions, resource existence, quota limits, and dependency relationships without creating, updating, or deleting actual resources, triggering asynchronous traffic diversion tasks, or generating downstream side effects such as billing, notifications, or callbacks. If the dry run succeeds, DryRun=true is returned in the response, which can be distinguished from an actual call response. If the dry run fails, a machine-readable error code is returned (such as ErrorParamsInvalid for parameter errors, ErrorAuthentication for insufficient permissions, or ErrorInstanceOpenIpNumExceed for insufficient quota). Set this parameter to false (default) to initiate the request and perform the disable operation.	true

When you call this operation, you must include the Alibaba Cloud common request parameters in addition to the request parameters described in this topic. For more information about common parameters, see Common parameters. For the request format of this operation, see the request example in the Examples section.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	B2841452-CB8D-4F7D-B247-38E1CF7334F8
DryRun	boolean	Indicates whether only a dry run was performed. If this parameter is true, the system performed pre-checks such as parameter validity, identity permissions, resource existence, quota limits, and dependency relationships without creating, updating, or deleting actual resources, triggering asynchronous traffic diversion tasks, or generating downstream side effects such as billing, notifications, or callbacks. If the dry run succeeded, DryRun=true is returned in the response, which can be distinguished from an actual call response. If the dry run failed, a machine-readable error code is returned (such as ErrorParamsInvalid for parameter errors, ErrorAuthentication for insufficient permissions, or ErrorInstanceOpenIpNumExceed for insufficient quota). A value of false (default) indicates that the request was initiated and the enable operation was performed.	true

Examples

Success response

JSON format

{
  "RequestId": "B2841452-CB8D-4F7D-B247-38E1CF7334F8",
  "DryRun": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorParamsNotEnough	Parameters are insufficient.	Parameters are insufficient.
400	ErrorDBSelect	An error occurred while querying database.	An error occurred while querying database.
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	ErrorRecordLog	An error occurred while updating the operation log.	An error occurred while updating the operation log.
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.	This request uses the same client token as the previous request, but not the same. Do not reuse client tokens in different requests unless the request is the same.
400	InvalidClientToken	ClientToken format invalid. Only ASCII letters, digits, hyphens and underscores are allowed, max 64 characters.
401	ErrorAuthentication	An authentication error occurred.	An authentication error occurred.
409	IdempotentToken.Processing	A previous request with the same ClientToken is still being processed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.