文档

PutEnableFwSwitch - 开启防火墙开关

更新时间:

开启防火墙开关。

接口说明

本接口用于开启防火墙开关,防火墙开关开启后流量才会经过云防火墙。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

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

授权信息

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

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

请求参数

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

访问者源 IP 地址。

192.0.X.X
Langstring

接收消息的语言类型。

  • zh:中文
  • en:英文
zh
IpaddrListarray

IP 地址列表。

说明 IpaddrList、RegionList、ResourceTypeList 三个参数不允许同时为空,必须为其中一个参数设置取值。
string

IP 地址列表。

说明 IpaddrList、RegionList、ResourceTypeList 三个参数不允许同时为空,必须为其中一个参数设置取值。
["192.0.XX.XX","192.0.XX.XX"]
RegionListarray

区域列表。

说明 IpaddrList、RegionList、ResourceTypeList 三个参数不允许同时为空,必须为其中一个参数设置取值。
string

区域列表。

说明 IpaddrList、RegionList、ResourceTypeList 三个参数不允许同时为空,必须为其中一个参数设置取值。
cn-hangzhou,cn-shanghai
ResourceTypeListarray

资产类型列表。

取值:

  • BastionHostIP:堡垒机出口 IP。
  • BastionHostIngressIP:堡垒机入口 IP。
  • EcsEIP:ECS EIP。
  • EcsPublicIP :ECS 公网 IP。
  • EIP:弹性公网 IP。
  • EniEIP:弹性网卡 EIP。
  • NatEIP:NAT EIP。
  • SlbEIP:SLB EIP。
  • SlbPublicIP:SLB 公网 IP。
  • NatPublicIP:NAT 公网 IP。
  • HAVIP:高可用虚拟 IP。
说明 IpaddrList、RegionList、ResourceTypeList 三个参数不允许同时为空,必须为其中一个参数设置取值。
string

资产类型列表。

取值:

  • BastionHostIP:堡垒机出口 IP。
  • BastionHostIngressIP:堡垒机入口 IP。
  • EcsEIP:ECS EIP。
  • EcsPublicIP :ECS 公网 IP。
  • EIP:弹性公网 IP。
  • EniEIP:弹性网卡 EIP。
  • NatEIP:NAT EIP。
  • SlbEIP:SLB EIP。
  • SlbPublicIP:SLB 公网 IP。
  • NatPublicIP:NAT 公网 IP。
  • HAVIP:高可用虚拟 IP。
说明 IpaddrList、RegionList、ResourceTypeList 三个参数不允许同时为空,必须为其中一个参数设置取值。
EcsPublicIp,NatEip

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

B2841452-CB8D-4F7D-B247-38E1CF7334F8
AbnormalResourceStatusListobject []

资产未同步时的状态信息列表。

Resourcestring

资产 IP。

203.0.113.0
Statusstring

资产未同步时的状态。取值:

  • ip_not_sync:资产未同步。
ip_not_sync
Msgstring

资产未同步时的信息。取值:

  • cloudfirewall do not sync this ip address:云防火墙没有同步这个资产 IP。
cloudfirewall do not sync this ip address

示例

正常返回示例

JSON格式

{
  "RequestId": "B2841452-CB8D-4F7D-B247-38E1CF7334F8",
  "AbnormalResourceStatusList": [
    {
      "Resource": "203.0.113.0",
      "Status": "ip_not_sync",
      "Msg": "cloudfirewall do not sync this ip address"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ErrorInstanceOpenIpNumExceedThe maximum number of protected assets has been reached.防护资产的个数达到上限
400ErrorInstanceStatusNotNormalThis operation is not supported when the instance is in the current state.实例状态不允许当前操作
400ErrorParamsNotEnoughParameters are insufficient.参数不足
400ErrorDBTxErrorA database transaction error occurred.内部错误:数据库事务错误
401ErrorAuthenticationAn authentication error occurred.认证失败

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

变更历史

变更时间变更内容概要操作
2023-08-29OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:401
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈