All Products
Search
Document Center

Simple Application Server:CreateFirewallTemplateRules

Last Updated:Oct 30, 2024

Adds firewall rules to a firewall template based on your business requirements.

Operation description

Adding firewall rules to a firewall template does not affect the firewall rules that have been applied 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
swas-open:CreateFirewallTemplateRulescreate
  • FirewallTemplate
    acs:swas-open:{#regionId}:{#accountId}:firewalltemplate/{#FirewallTemplatId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the simple application server to which the firewall template is applied. You can call the ListRegions operation to query the most recent region list.

cn-hangzhou
FirewallTemplateIdstringYes

The ID of the firewall template.

ft-bcf1a7hrdq717****
FirewallRulearray<object>Yes

The details of the firewall rule.

objectYes
RuleProtocolstringYes

The transport layer protocol that the rule supports. Valid values:

  • TCP
  • UDP
  • TCP+UDP
  • ICMP
TCP
PortstringYes

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
SourceCidrIpstringYes

The source address to which you want to grant access permissions. CIDR blocks and IPv4 addresses are supported.

222.70.XX.XX
RemarkstringNo

The remarks of the firewall rule.

test

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

30637AD6-D977-4833-A54C-CC89483E****
FirewallTemplateRulesarray<object>

The firewall template rules.

FirewallTemplateRuleobject
FirewallTemplateRuleIdstring

The ID of the firewall template rule.

ft-bcf1a7hrdq717****
RuleProtocolstring

The transport layer protocol that the rule supports. Valid values:

  • TCP
  • UDP
  • TCP+UDP
  • ICMP: the ICMP protocol
TCP
Portstring

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
SourceCidrIpstring

The source address to which you want to grant access permissions. CIDR blocks and IPv4 addresses are supported.

171.233.XX.XX
Remarkstring

The remarks of the firewall rule.

test

Examples

Sample success responses

JSONformat

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "FirewallTemplateRules": [
    {
      "FirewallTemplateRuleId": "ft-bcf1a7hrdq717****",
      "RuleProtocol": "TCP",
      "Port": "8080",
      "SourceCidrIp": "171.233.XX.XX",
      "Remark": "test"
    }
  ]
}

Error codes

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