PutDisableFwSwitch - 关闭防火墙开关

更新时间:
复制 MD 格式

关闭防火墙开关。

接口说明

本接口用于关闭防火墙开关,关闭防火墙开关后流量不经过云防火墙。

QPS 限制

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cloudfirewall:PutDisableFwSwitch

update

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

SourceIp deprecated

string

访问者源 IP 地址。

192.0.XX.XX

Lang

string

接收消息的语言类型。取值:

  • zh(默认):中文

  • en:英文

zh

IpaddrList

array

IP 地址列表。

说明

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

["192.0.XX.XX","192.0.XX.XX"]

string

IP 地址。

192.0.XX.XX

RegionList

array

区域列表。

说明

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

["cn-hangzhou","cn-shanghai"]

string

区域 ID。

cn-hangzhou

ResourceTypeList

array

资产类型列表。取值:

  • BastionHostEgressIP:堡垒机出口 IP。

  • BastionHostIngressIP:堡垒机入口 IP。

  • EcsEIP:ECS EIP。

  • EcsPublicIP:ECS 公网 IP。

  • EIP:弹性公网 IP。

  • EniEIP:弹性网卡 EIP。

  • NatEIP:NAT EIP。

  • SlbEIP:SLB EIP(CLB EIP)。

  • SlbPublicIP:SLB 公网 IP(CLB 公网 IP)。

  • NatPublicIP:NAT 公网 IP。

  • HAVIP:高可用虚拟 IP。

  • NlbEIP:NLB EIP。

  • ApiGatewayEIP:API 网关公网 IP。

  • AlbEIP:ALB EIP。

  • AiGatewayEIP:AI 网关公网 IP。

  • GaEIP:GA EIP。

  • SwasEIP:轻量应用服务器公网 IP。

  • EcdEIP:无影公网 IP。

  • BastionHostIP:堡垒机 IP。

说明

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

["EcsPublicIp","NatEip"]

string

资产类型列表。取值:

  • BastionHostEgressIP:堡垒机出口 IP。

  • BastionHostIngressIP:堡垒机入口 IP。

  • EcsEIP:ECS EIP。

  • EcsPublicIP:ECS 公网 IP。

  • EIP:弹性公网 IP。

  • EniEIP:弹性网卡 EIP。

  • NatEIP:NAT EIP。

  • SlbEIP:SLB EIP(CLB EIP)。

  • SlbPublicIP:SLB 公网 IP(CLB 公网 IP)。

  • NatPublicIP:NAT 公网 IP。

  • HAVIP:高可用虚拟 IP。

  • NlbEIP:NLB EIP。

  • ApiGatewayEIP:API 网关公网 IP。

  • AlbEIP:ALB EIP。

  • AiGatewayEIP:AI 网关公网 IP。

  • GaEIP:GA EIP。

  • SwasEIP:轻量应用服务器公网 IP。

  • EcdEIP:无影公网 IP。

  • BastionHostIP:堡垒机 IP。

说明

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

EcsPublicIP

MemberUid

string

成员唯一标识符

1234

IpVersion

string

IP 版本号

4

ClientToken

string

保证请求幂等性的客户端令牌。由客户端生成,需保证在不同请求间唯一;数据类型 String,大小写敏感,格式为 [0-9a-zA-Z-_]{1,64},建议使用 UUID。服务端在有效期内(600 秒)保证幂等:相同 ClientToken 且相同业务参数的重复请求返回与首次一致的结果;相同 ClientToken 但业务参数不同时返回 HTTP 400 及 IdempotentParameterMismatch 错误码。

defefedxexxxx

DryRun

boolean

是否只预检此次请求。取值 true 时仅执行参数合法性、身份权限、资源存在性、配额限制与依赖关系等执行前校验,不创建/更新/删除真实资源、不触发真实异步引流任务、不产生计费/通知/回调等下游副作用;预检成功时响应中 DryRun=true,与真实调用响应可区分;预检失败返回可机器识别的错误码(如 ErrorParamsInvalid 参数错误、ErrorAuthentication 权限不足、ErrorInstanceOpenIpNumExceed 配额不足)。取值 false(默认)表示正常发起请求并执行关闭操作。

true

调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍,请参见公共参数。 调用 API 的请求格式,请参见本文示例中的请求示例。

返回参数

名称

类型

描述

示例值

object

RequestId

string

本次请求的 ID。

B2841452-CB8D-4F7D-B247-38E1CF7334F8

DryRun

boolean

是否只预检此次请求。取值 true 时仅执行参数合法性、身份权限、资源存在性、配额限制与依赖关系等执行前校验,不创建/更新/删除真实资源、不触发真实异步引流任务、不产生计费/通知/回调等下游副作用;预检成功时响应中 DryRun=true,与真实调用响应可区分;预检失败返回可机器识别的错误码(如 ErrorParamsInvalid 参数错误、ErrorAuthentication 权限不足、ErrorInstanceOpenIpNumExceed 配额不足)。取值 false(默认)表示正常发起请求并执行开启操作。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "B2841452-CB8D-4F7D-B247-38E1CF7334F8",
  "DryRun": true
}

错误码

HTTP status code

错误码

错误信息

描述

400 ErrorParamsNotEnough Parameters are insufficient. 参数不足
400 ErrorDBSelect An error occurred while querying database. 内部错误:数据库查询错误
400 ErrorInstanceStatusNotNormal This operation is not supported when the instance is in the current state. 实例状态不允许当前操作
400 ErrorRecordLog An error occurred while updating the operation log. 写日志失败
400 IdempotentParameterMismatch The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical. 该请求使用与上一个请求相同但不相同的客户端令牌。不要在不同的请求中重复使用客户端令牌,除非请求相同。
400 InvalidClientToken ClientToken format invalid. Only ASCII letters, digits, hyphens and underscores are allowed, max 64 characters.
401 ErrorAuthentication An authentication error occurred. 认证失败
409 IdempotentToken.Processing A previous request with the same ClientToken is still being processed.

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

变更历史

更多信息,参考变更详情