开启防火墙开关。
接口说明
本接口用于开启防火墙开关，防火墙开关开启后流量才会经过云防火墙。
QPS 限制
本接口的单用户 QPS 限制为 5 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
yundun-cloudfirewall:PutEnableFwSwitch |
update |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
SourceIp
deprecated
|
string |
否 |
访问者源 IP 地址。 |
192.0.XX.XX |
| Lang |
string |
否 |
接收消息的语言类型。
|
zh |
| IpaddrList |
array |
否 |
IP 地址列表。 说明
IpaddrList、RegionList、ResourceTypeList 三个参数不允许同时为空，必须为其中一个参数设置取值。 |
["192.0.X.X","192.0.X.X"] |
|
string |
否 |
IP 地址列表。 说明
IpaddrList、RegionList、ResourceTypeList 三个参数不允许同时为空，必须为其中一个参数设置取值。 |
192.0.XX.XX |
|
| RegionList |
array |
否 |
区域列表。 说明
IpaddrList、RegionList、ResourceTypeList 三个参数不允许同时为空，必须为其中一个参数设置取值。 |
["cn-hangzhou","cn-shanghai"] |
|
string |
否 |
区域列表。 说明
IpaddrList、RegionList、ResourceTypeList 三个参数不允许同时为空，必须为其中一个参数设置取值。 |
cn-hangzhou,cn-shanghai |
|
| ResourceTypeList |
array |
否 |
资产类型列表。 取值：
说明
IpaddrList、RegionList、ResourceTypeList 三个参数不允许同时为空，必须为其中一个参数设置取值。 |
["EcsPublicIp","NatEip"] |
|
string |
否 |
资产类型列表。 取值：
说明
IpaddrList、RegionList、ResourceTypeList 三个参数不允许同时为空，必须为其中一个参数设置取值。 |
EcsPublicIp,NatEip |
|
| MemberUid |
string |
否 |
成员唯一标识符 |
1234 |
| IpVersion |
string |
否 |
IP 版本号 |
4 |
| ClientToken |
string |
否 |
保证请求幂等性的客户端令牌。由客户端生成，需保证在不同请求间唯一；数据类型 String，大小写敏感，格式为 [0-9a-zA-Z-_]{1,64}，建议使用 UUID。服务端在有效期内（600 秒）保证幂等：相同 ClientToken 且相同业务参数的重复请求返回与首次一致的结果；相同 ClientToken 但业务参数不同时返回 HTTP 400 及 IdempotentParameterMismatch 错误码 |
ddadxefexxxx |
| DryRun |
boolean |
否 |
是否只预检此次请求。取值 true 时仅执行参数合法性、身份权限、资源存在性、配额限制与依赖关系等执行前校验，不创建/更新/删除真实资源、不触发真实异步引流任务、不产生计费/通知/回调等下游副作用；预检成功时响应中 DryRun=true，与真实调用响应可区分；预检失败返回可机器识别的错误码（如 ErrorParamsInvalid 参数错误、ErrorAuthentication 权限不足、ErrorInstanceOpenIpNumExceed 配额不足）。取值 false（默认）表示正常发起请求并执行开启操作。 |
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| AbnormalResourceStatusList |
array<object> |
资产未同步时的状态信息列表。 |
|
|
object |
|||
| Msg |
string |
资产未同步时的信息。取值：
|
cloudfirewall do not sync this ip address |
| Resource |
string |
资产 IP。 |
203.0.113.0 |
| Status |
string |
资产未同步时的状态。取值：
|
ip_not_sync |
| DryRun |
boolean |
标识本次为 DryRun 预检成功响应；取值 true 表示仅完成预检、未执行真实变更。真实调用不返回该字段或为 false。 |
true |
| RequestId |
string |
请求 ID。 |
B2841452-CB8D-4F7D-B247-38E1CF7334F8 |
示例
正常返回示例
JSON格式
{
"AbnormalResourceStatusList": [
{
"Msg": "cloudfirewall do not sync this ip address",
"Resource": "203.0.113.0",
"Status": "ip_not_sync"
}
],
"DryRun": true,
"RequestId": "B2841452-CB8D-4F7D-B247-38E1CF7334F8"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | ErrorInstanceOpenIpNumExceed | The maximum number of protected assets has been reached. | 防护资产的个数达到上限 |
| 400 | ErrorInstanceStatusNotNormal | This operation is not supported when the instance is in the current state. | 实例状态不允许当前操作 |
| 400 | ErrorParamsNotEnough | Parameters are insufficient. | Parameters are insufficient. |
| 400 | ErrorDBTxError | A database transaction error occurred. | 内部错误：数据库事务错误 |
| 400 | ErrorParamsInvalid | Invalid Params | 无效的参数 |
| 400 | ErrorInstanceOpenIpRegionNumExceed | open ip region num exceed. | 您的区域防护配额不足。 |
| 400 | ErrorBandwidthPenalty | Cloud Firewall bandwidth is being overused. | 云防火墙带宽超量使用处置中。 |
| 400 | ErrorGeneralInstanceSpecFull | Cloud Firewall instance specifications are full. | 云防火墙实例规格已满。 |
| 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. |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。