一键逃生/一键恢复开关
功能介绍
一键逃生/一键恢复开关
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/eip/protect/all/{fw_instance_id}/operation
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
bypass_operation |
否 |
Integer |
防护操作类型,1表示一键关闭防护,0表示一键恢复防护 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
data object |
一键逃生/一键恢复返回数据 |
fail_reason |
String |
一键逃生失败原因 |
参数 |
参数类型 |
描述 |
---|---|---|
protection_status |
Integer |
参数解释: 防火墙防护状态,0: 正常状态, 1: bypass进行中, 2: bypass成功, 3: bypass失败, 4: 恢复中, 5: 恢复失败 取值范围: 不涉及 |
id |
String |
参数解释: 防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
object_id |
String |
参数解释: 防护对象ID,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口获得,通过返回值中的data.records.protect_objects.object_id(.表示各对象之间层级的区分)获得,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
一键关闭EIP防护
https://{Endpoint}/v1/eefb11b22d5944f2aa067954516df1cf/eip/protect/all/175572ed-67e8-4837-9776-e2e07080ea45/operation { "bypass_operation" : 1 }
响应示例
状态码:200
OK
{ "data" : { "protection_status" : 1, "id" : "175572ed-67e8-4837-9776-e2e07080ea45", "object_id" : "af30c598-b185-4b3e-9271-3d1393acd43e" } }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
错误码
请参见错误码。