All Products
Search
Document Center

Simple Application Server:CreateFirewallRule

Last Updated:Mar 19, 2024

Creates a firewall rule for a simple application server.

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.

QPS limits

You can call this API operation up to 10 times per minute per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the simple application server.

ace0706b2ac4454d984295a94213****
RegionIdstringYes

The region ID of the simple application server.

cn-hangzhou
RuleProtocolstringYes

The transport layer protocol. Valid values:

  • TCP: the TCP protocol
  • UDP: the UDP protocol
  • TCP+UDP: the TCP and UDP protocols
TCP
PortstringYes

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 to 1055.

3306
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of ClientToken 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
RemarkstringNo

The remarks of the firewall rule.

TEST

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

The ID of the firewall rule.

8007e18c61024aafbd776d52d0****

Examples

Sample success responses

JSONformat

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

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
2023-09-18API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 500