DescribeFirewallTemplateRulesApplyResult - Simple Application Server

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

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
swas-open:DescribeFirewallTemplateRulesApplyResult	list	FirewallTemplate acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/{#FirewallTemplateId} Instance acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}	none	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 parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F534F
data	array<object>	The returned results.
InstanceApplyFirewallTemplateRulesResult	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

Sample success responses

JSONformat

{
  "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

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