Creates a firewall rule for a simple application server.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateFirewallRule

The operation that you want to perform. Set the value to CreateFirewallRule.

InstanceId String Yes ace0706b2ac4454d984295a94213****

The ID of the simple application server.

Port String Yes 3306

The port range. Valid values of port numbers: 1 to 65535. Specify a port range in the format of <start port number>/<end port number>. Example: 1024/1055, which indicates the port range of 1024 through 1055.

RegionId String Yes cn-hangzhou

The region ID of the simple application server.

RuleProtocol String Yes TCP

The transport layer protocol. Valid values:

  • Tcp: TCP
  • Udp: UDP
  • TcpAndUdp: TCP and UDP
Remark String No test-default port of the MySQL server

The remarks of the firewall rule.

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

Response parameters

Parameter Type Example Description
FirewallId String 8007e18c61024aafbd776d52d0****

The ID of the firewall rule.

RequestId String 20758A-585D-4A41-A9B2-28DA8F4F534F

The ID of the request.

Examples

Sample requests

https://swas.cn-hangzhou.aliyuncs.com/?Action=CreateFirewallRule
&InstanceId=ace0706b2ac4454d984295a94213****
&Port=3306
&RuleProtocol=Tcp
&Remark=test-default port of the MySQL server
&<Common request parameters>

Sample success responses

XML format

<CreateFirewallRuleResponse>
      <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>
      <FirewallId>8007e18c61024aafbd776d52d0****</FirewallId>
</CreateFirewallRuleResponse>

JSON format

{
    "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
    "FirewallId": "8007e18c61024aafbd776d52d0****"
}

Error codes

HTTP status code Error code Error message Description
400 InvalidProtocol.ValueNotSupported The specified parameter Protocol is invalid. The error message returned because the specified RuleProtocol parameter is invalid.
400 InvalidPort.ValueNotSupported The specified parameter Port is invalid. The error message returned because the specified Port parameter is invalid.
403 FirewallRuleLimitExceed The maximum number of firewall rules in an instance is exceeded. The error message returned because the maximum number of firewall rules that can be created for the simple application server is reached.
404 InvalidInstanceId.NotFound The specified InstanceId does not exist. The error message returned because the specified InstanceId parameter does not exist.
500 InternalError An error occurred while processing your request. The error message returned because an internal error has occurred. Try again later. If the error persists, submit a ticket.
403 FirewallRuleAlreadyExist The specified Rule already exist The error message returned because the firewall rule already exists.

For a list of error codes, visit the API Error Center.