All Products
Search
Document Center

Simple Application Server:CreateFirewallRules

Last Updated:Oct 30, 2024

Creates multiple firewall rules for a simple application server at a time.

Operation description

Firewalls serve to control network access to simple application servers and isolate security domains in the cloud. By default, SSH port 22, HTTP port 80, and HTTPS port 443 are enabled for simple application servers. Other ports are disabled. You can add firewall rules to enable more ports.

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:CreateFirewallRulescreate
  • FirewallRule
    acs:swas-open:{#regionId}:{#accountId}:firewallrule/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the simple application server.

ace0706b2ac4454d984295a94213****
RegionIdstringYes

The region ID of the simple application server. You can call the ListRegions operation to query the most recent region list.

cn-hangzhou
ClientTokenstringNo

The client token.

123e4567-e89b-12d3-a456-426655440000
FirewallRulesarray<object>No

Details about the firewall rules.

objectNo

Details about the firewall rules.

RuleProtocolstringNo

The transport layer protocol. Valid values:

  • TCP
  • UDP
  • TCP+UDP
  • ICMP
TCP
PortstringNo

The port number.

  • When the transport layer protocol is TCP and/or UDP, the port number range is 1 to 65535. Specify a port range in the format of <Start port number>/<End port number>. Example: 1/200.
  • When the transport layer protocol is ICMP, the port number range is -1/-1, which indicates all ports.
3306
SourceCidrIpstringNo

The IP address or CIDR block that is allowed in the firewall rule.

47.101.XX.XX
RemarkstringNo

The description of the firewall rule.

TEST
Tagarray<object>No

The tags that you want to add to the firewall. You can specify up to 20 tags.

objectNo

The tags of the firewall rule.

KeystringNo

The tag key. Valid values of N: 1 to 20.

The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.

TestKey
ValuestringNo

The tag value. Valid values of N: 1 to 20.

The tag value can be an empty string. The tag value can be up to 64 characters in length and cannot contain http:// or https://.

TestValue

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

20758A-585D-4A41-A9B2-28DA8F4F534F
FirewallRuleIdsarray

The IDs of the firewall rules that you created.

FirewallRuleIdsstring

The ID of the firewall rule that you created.

1a16263ab0f541288312a15fa64280de

Examples

Sample success responses

JSONformat

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "FirewallRuleIds": [
    "1a16263ab0f541288312a15fa64280de"
  ]
}

Error codes

HTTP status codeError codeError message
400InvalidProtocol.ValueNotSupportedThe specified parameter Protocol is invalid.
400InvalidPort.ValueNotSupportedThe specified parameter Port is invalid.
400RegionIdNotMatchHostThe parameter regionId does not match the endpoint host.
403FirewallRuleLimitExceedThe maximum number of firewall rules in an instance is exceeded.
403FirewallRuleAlreadyExistThe specified Rule already exist
404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.
500InternalErrorAn error occurred while processing your request.

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

Change history

Change timeSummary of changesOperation
2024-02-20The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details