文档

CreateFirewallRule - 创建实例的防火墙规则

更新时间:

为指定的轻量应用服务器创建一条防火墙规则。

接口说明

防火墙可以控制轻量应用服务器的网络访问,用于在云端划分安全域。每台轻量应用服务器的防火墙默认放行了 22 端口(SSH 服务)、80 端口(HTTP 服务)以及 443 端口(HTTPS 加密访问服务),除默认放行的端口,其他端口默认是禁用状态。您可以通过添加防火墙规则来放行更多端口。

QPS 限制

本接口的单用户 QPS 限制为 10 次/分钟。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
swas-open:CreateFirewallRule
  • Instance
    acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}

请求参数

名称类型必填描述示例值
InstanceIdstring

指定的轻量应用服务器的实例 ID。

ace0706b2ac4454d984295a94213****
RegionIdstring

指定的轻量应用服务器所属的地域 ID。

cn-hangzhou
RuleProtocolstring

传输层协议。取值范围:

  • TCP:TCP 协议。
  • UDP:UDP 协议。
  • TCP+UDP:TCP 和 UDP 协议。
  • ICMP: ICMP 协议。
TCP
Portstring

端口范围。

  • TCP/UDP: 端口的取值范围:1~65535。使用正斜线(/)隔开起始端口和终止端口,例如:1024/1055 表示端口范围 1024~1055。
  • ICMP: -1/-1。代表全部端口。
3306/3306
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

123e4567-e89b-12d3-a456-426655440000
Remarkstring

防火墙规则的备注。

TEST

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

防火墙规则 ID。

8007e18c61024aafbd776d52d0****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidProtocol.ValueNotSupportedThe specified parameter Protocol is invalid.指定的防火墙协议不合法。
400InvalidPort.ValueNotSupportedThe specified parameter Port is invalid.指定的防火墙端口范围不合法。
400RegionIdNotMatchHostThe parameter regionId does not match the endpoint host.传入的regionId和请求的地址不匹配。
403FirewallRuleLimitExceedThe maximum number of firewall rules in an instance is exceeded.防火墙规则总数超过实例限制。
403FirewallRuleAlreadyExistThe specified Rule already exist防火墙规则已存在。
404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.指定的实例不存在,请您检查实例ID是否正确。
500InternalErrorAn error occurred while processing your request.内部错误,请重试。如果多次尝试失败,请提交工单。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-18OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情