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
Authorization information
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. | cn-hangzhou |
RuleProtocol | string | Yes | The transport layer protocol. Valid values:
| TCP |
Port | string | Yes | 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 |
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 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 |
Remark | string | No | The remarks of the firewall rule. | TEST |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
"FirewallId": "8007e18c61024aafbd776d52d0****"
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
400 | InvalidProtocol.ValueNotSupported | The specified parameter Protocol is invalid. |
400 | InvalidPort.ValueNotSupported | The specified parameter Port is invalid. |
400 | RegionIdNotMatchHost | The parameter regionId does not match the endpoint host. |
403 | FirewallRuleLimitExceed | The maximum number of firewall rules in an instance is exceeded. |
403 | FirewallRuleAlreadyExist | The specified Rule already exist |
404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. |
500 | InternalError | An error occurred while processing your request. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-09-18 | API Description Update. The Error code has changed | see changesets | ||||||||||||
|