DescribeFirewallTemplateRulesApplyResult - Simple Application Server

Queries the result of applying a firewall template rule to simple application servers.

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

swas-open:DescribeFirewallTemplateRulesApplyResult

list

*FirewallTemplate

acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/{#FirewallTemplateId}

*Instance

acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the simple application server.	ace0706b2ac4454d984295a94213****
RegionId	string	Yes	The region ID of the simple application server. You can call the ListRegions operation to query the most recent region list.	cn-hangzhou
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, but you make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-426655440000
FirewallTemplateId	string	Yes	The ID of the firewall template.	ft-bcf1a7hrdq717****
TaskId	string	Yes	The ID of the execution to apply the template rule.	aft-ikgt0bynitvs3****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F534F
data	array<object>	The returned results.
	object
RuleProtocol	string	The transport layer protocol that the rule supports. Valid values: TCP UDP TCP+UDP ICMP	TCP
Port	string	The port range. Valid values: 1 to 65535. Specify a port range in the format of <start port number>/<end port number>. Example: `1024/1055`, which indicates that the port range of 1024 to 1055. Note If you set RuleProtocol to ICMP, you must set Port to -1/-1.	8080
SourceCidrIp	string	The source address to which you want to grant access permissions. CIDR blocks and IPv4 addresses are supported.	119.145.XX.XX
Remark	string	The remarks of the firewall rule.	test
Success	boolean	The status of applying the firewall template rule to the simple application servers. Pending: The template rule does not start to be applied to the simple application servers. Applying: The template rule is being applied to the simple application servers. Success: The template rule is successfully applied to the simple application servers. PartFailed: The template rule fails to be applied to some simple application servers.	true
ErrorCode	string	The error codes when the firewall template rule fails to be applied.	500
ErrorInfo	string	The error message that is displayed when the firewall template rule fails to be applied.	An error occurred while processing your request.

Examples

Success response

JSON format

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "data": [
    {
      "RuleProtocol": "TCP",
      "Port": "8080",
      "SourceCidrIp": "119.145.XX.XX",
      "Remark": "test",
      "Success": true,
      "ErrorCode": "500",
      "ErrorInfo": "An error occurred while processing your request."
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.