Loading
close

防火墙

time 更新时间:2022-04-26 20:29:15

删除防火墙策略

功能介绍

删除防火墙策略。

前提条件

该防火墙策略存在。

URI

DELETE /v2.0/fw/firewall_policies/{firewall_policy_id}

参数 是否必选 描述
firewall_policy_id 防火墙策略ID。

请求消息

请求示例

响应消息

响应示例

成功删除请求的响应没有内容。

正常响应代码

204

错误码

401,404,409

列举防火墙规则

功能介绍

列出所有防火墙规则。

URI

GET /v2.0/fw/firewall_rules

请求消息

请求示例

响应消息

参数 参数类型 描述
firewall_rules object firewall_rule对象列表。
action String API对匹配防火墙规则的流量执行的动作。有效值为allow或deny。默认是deny。
description String 人类可读的对防火墙规则的描述。
destination_ip_address String 防火墙规则的目的IPv4或IPv6地址或CIDR。没有默认值。
destination_port String 防火墙规则的目的端口或端口范围。有效的值可以是端口号,可以是整数形式,也可以是端口范围,格式为A:分隔的范围。对于端口范围,包括端口范围的两端。例如,80:90。
enabled boolean 设置为false将在防火墙策略中禁用此规则。便于有选择地关闭规则,而不必将规则与防火墙策略解除关联。取值为true或false。默认是true。
firewall_policy_id String 防火墙策略ID。
id String 防火墙规则的ID。
ip_version integer 防火墙规则的IP协议版本。有效值为4或6。默认为4。
name String 人类可读的防火墙规则名称。
project_id String 资源所属项目的ID。
protocol String 防火墙规则的IP协议。取值包括:icmp、tcp、udp或null。
shared boolean 指示此防火墙规则是否在所有项目之间共享。
source_ip_address String 防火墙规则的源IPv4或IPv6地址或CIDR。没有默认值。
source_port String 防火墙规则的源端口或端口范围。有效的值可以是端口号,可以是整数形式,也可以是端口范围,格式为A:分隔的范围。对于端口范围,包括端口范围的两端。例如,80:90。
tenant_id String 资源所属项目的ID。
position integer 当API将该规则与防火墙策略关联时,该API分配给该规则的只读属性。该值表示该规则在该防火墙策略中的位置。这个位置号从1开始。如果该防火墙规则没有关联任何策略,则该位置为null。

响应示例

{protocol
	"firewall_rules": [{
		"protocol": "tcp",
		"description": "",
		"source_port": "22",
		"source_ip_address": "192.168.0.0/24",
		"destination_ip_address": "192.168.1.0/24",
		"firewall_policy_id": null,
		"position": null,
		"destination_port": "22",
		"id": "a8f61530-d5db-4769-8f1b-fb154c3078f1",
		"name": "test-fwrule",
		"tenant_id": "870c5414baee43a4ba7adfb253e46018",
		"enabled": true,
		"action": "allow",
		"ip_version": 4,
		"shared": false,
		"project_id": "870c5414baee43a4ba7adfb253e46018"
	}]
}

正常响应代码

200

错误码

401,404

显示防火墙规则的详细信息

功能介绍

显示防火墙规则的详细信息。

URI

GET /v2.0/fw/firewall_rules/{firewall_rule_id}

参数 是否必选 描述
firewall_rule_id 防火墙规则的ID。

请求消息

请求示例

响应消息

参数 参数类型 描述
firewall_rule object 一个firewall_rule对象。
action String API对匹配防火墙规则的流量执行的动作。有效值为allow或deny。默认是deny。
description String 人类可读的对防火墙规则的描述。
destination_ip_address String 防火墙规则的目的IPv4或IPv6地址或CIDR。没有默认值。
destination_port String 防火墙规则的目的端口或端口范围。有效的值可以是端口号,可以是整数形式,也可以是端口范围,格式为A:分隔的范围。对于端口范围,包括端口范围的两端。例如,80:90。
enabled boolean 设置为false将在防火墙策略中禁用此规则。便于有选择地关闭规则,而不必将规则与防火墙策略解除关联。取值为true或false。默认是true。
firewall_policy_id String 防火墙策略ID。
id String 防火墙规则的ID。
ip_version integer 防火墙规则的IP协议版本。有效值为4或6。默认为4。
name String 人类可读的防火墙规则名称。
project_id String 资源所属项目的ID。
protocol String 防火墙规则的IP协议。取值包括:icmp、tcp、udp或null。
shared boolean 指示此防火墙规则是否在所有项目之间共享。
source_ip_address String 防火墙规则的源IPv4或IPv6地址或CIDR。没有默认值。
source_port String 防火墙规则的源端口或端口范围。有效的值可以是端口号,可以是整数形式,也可以是端口范围,格式为A:分隔的范围。对于端口范围,包括端口范围的两端。例如,80:90。
tenant_id String 资源所属项目的ID。
position integer 当API将该规则与防火墙策略关联时,该API分配给该规则的只读属性。该值表示该规则在该防火墙策略中的位置。这个位置号从1开始。如果该防火墙规则没有关联任何策略,则该位置为null。

响应示例

{
	"firewall_rule": {
		"protocol": "tcp",
		"description": "",
		"source_port": "22",
		"source_ip_address": "192.168.0.0/24",
		"destination_ip_address": "192.168.1.0/24",
		"firewall_policy_id": null,
		"position": null,
		"destination_port": "22",
		"id": "a8f61530-d5db-4769-8f1b-fb154c3078f1",
		"name": "test_fwrule",
		"tenant_id": "870c5414baee43a4ba7adfb253e46018",
		"enabled": true,
		"action": "allow",
		"ip_version": 4,
		"shared": false,
		"project_id": "870c5414baee43a4ba7adfb253e46018"
	}
}

正常响应代码

200

错误码

401,403

创建防火墙规则

功能介绍

创建防火墙规则。

URI

POST /v2.0/fw/firewall_rules

请求消息

参数 参数类型 是否必选 描述
firewall_rule object 一个firewall_rul防火墙规则的源端口或端口范围。有效的值可以是端口号,可以是整数形式,也可以是端口范围,格式为A:分隔的范围。对于端口范围,包括端口范围的两端。例如,80:90。
资源所属项目的ID。e对象。
action String API对匹配防火墙规则的流量执行的动作。有效值为allow、deny或reject。
description String 人类可读的对防火墙规则的描述。
destination_ip_address String 防火墙规则的目的IPv4或IPv6地址或CIDR。没有默认值。
destination_port String 防火墙规则的目的端口或端口范围。有效的值可以是端口号,可以是整数形式,也可以是端口范围,格式为A:分隔的范围。对于端口范围,包括端口范围的两端。例如,80:90。
name String 人类可读的防火墙规则名称。
protocol String 防火墙规则的IP协议。取值包括:icmp、tcp、udp或any。
shared boolean 指示此防火墙规则是否在所有项目之间共享。
source_ip_address String 防火墙规则的源IPv4或IPv6地址或CIDR。没有默认值。
source_port String 防火墙规则的源端口或端口范围。有效的值可以是端口号,可以是整数形式,也可以是端口范围,格式为A:分隔的范围。对于端口范围,包括端口范围的两端。例如,80:90。

请求示例

{
    "firewall_rule": {
        "action": "allow",
        "destination_port": "80",
        "enabled": true,
        "name": "test-fw-rule",
        "protocol": "tcp"
    }
}

响应消息

参数 参数类型 描述
firewall_rule object 一个firewall_rule对象。
action String API对匹配防火墙规则的流量执行的动作。有效值为allow、deny或reject。
description String 人类可读的对防火墙规则的描述。
destination_ip_address String 防火墙规则的目的IPv4或IPv6地址或CIDR。没有默认值。
destination_port String 防火墙规则的目的端口或端口范围。有效的值可以是端口号,可以是整数形式,也可以是端口范围,格式为A:分隔的范围。对于端口范围,包括端口范围的两端。例如,80:90。
enabled boolean 设置为false将在防火墙策略中禁用此规则。便于有选择地关闭规则,而不必将规则与防火墙策略解除关联。取值为true或false。默认是true。
firewall_policy_id String 防火墙策略ID。
id String 防火墙规则的ID。
ip_version integer 防火墙规则的IP协议版本。有效值为4或6。默认为4。
name String 人类可读的防火墙规则名称。
project_id String 资源所属项目的ID。
protocol String 防火墙规则的IP协议。取值包括:icmp、tcp、udp或any。
shared boolean 指示此防火墙规则是否在所有项目之间共享。
source_ip_address String 防火墙规则的源IPv4或IPv6地址或CIDR。没有默认值。
source_port String 防火墙规则的源端口或端口范围。有效的值可以是端口号,可以是整数形式,也可以是端口范围,格式为A:分隔的范围。对于端口范围,包括端口范围的两端。例如,80:90。
tenant_id String 资源所属项目的ID。

响应示例

{
	"firewall_rule": {
		"protocol": "tcp",
		"description": "",
		"source_port": null,
		"source_ip_address": null,
		"destination_ip_address": null,
		"firewall_policy_id": null,
		"position": null,
		"destination_port": null,
		"id": "bacd75ec-9f27-4d65-a681-0df2cfcc70a6",
		"name": "test-fw-rule",
		"tenant_id": "89f60564953c48068513503e4cf4b12f",
		"enabled": true,
		"action": "allow",
		"ip_version": 4,
		"shared": false,
		"project_id": "89f60564953c48068513503e4cf4b12f"
	}
}

错误码

400,401

更新防火墙规则

功能介绍

更新防火墙的规则。

前提条件

该防火墙规则存在。

URI

PUT /v2.0/fw/firewall_rules/{firewall_rule_id}

参数 是否必选 描述
firewall_rule_id 防火墙规则的ID。

请求消息

参数 参数类型 是否必选 描述
firewall_rule object 一个firewall_rul防火墙规则的源端口或端口范围。有效的值可以是端口号,可以是整数形式,也可以是端口范围,格式为A:分隔的范围。对于端口范围,包括端口范围的两端。例如,80:90。
资源所属项目的ID。e对象。
action String API对匹配防火墙规则的流量执行的动作。有效值为allow或deny或reject。
description String 人类可读的对防火墙规则的描述。
destination_ip_address String 防火墙规则的目的IPv4或IPv6地址或CIDR。没有默认值。
destination_port String 防火墙规则的目的端口或端口范围。有效的值可以是端口号,可以是整数形式,也可以是端口范围,格式为A:分隔的范围。对于端口范围,包括端口范围的两端。例如,80:90。
name String 人类可读的防火墙规则名称。
protocol String 防火墙规则的IP协议。取值包括:icmp、tcp、udp或any。
shared boolean 指示此防火墙规则是否在所有项目之间共享。
source_ip_address String 防火墙规则的源IPv4或IPv6地址或CIDR。没有默认值。
source_port String 防火墙规则的源端口或端口范围。有效的值可以是端口号,可以是整数形式,也可以是端口范围,格式为A:分隔的范围。对于端口范围,包括端口范围的两端。例如,80:90。

请求示例

{
    "firewall_rule": {
        "name": "new-name"
    }
}

响应消息

参数 参数类型 描述
firewall_rule object 一个firewall_rule对象。
action String API对匹配防火墙规则的流量执行的动作。有效值为allow或deny。默认是deny。
description String 人类可读的对防火墙规则的描述。
destination_ip_address String 防火墙规则的目的IPv4或IPv6地址或CIDR。没有默认值。
destination_port String 防火墙规则的目的端口或端口范围。有效的值可以是端口号,可以是整数形式,也可以是端口范围,格式为A:分隔的范围。对于端口范围,包括端口范围的两端。例如,80:90。
enabled boolean 设置为false将在防火墙策略中禁用此规则。便于有选择地关闭规则,而不必将规则与防火墙策略解除关联。取值为true或false。默认是true。
firewall_policy_id String 防火墙策略ID。
id String 防火墙规则的ID。
ip_version integer 防火墙规则的IP协议版本。有效值为4或6。默认为4。
name String 人类可读的防火墙规则名称。
project_id String 资源所属项目的ID。
protocol String 防火墙规则的IP协议。取值包括:icmp、tcp、udp或null。
shared boolean 指示此防火墙规则是否在所有项目之间共享。
source_ip_address String 防火墙规则的源IPv4或IPv6地址或CIDR。没有默认值。
source_port String 防火墙规则的源端口或端口范围。有效的值可以是端口号,可以是整数形式,也可以是端口范围,格式为A:分隔的范围。对于端口范围,包括端口范围的两端。例如,80:90。
tenant_id String 资源所属项目的ID。

响应示例

{
	"firewall_rule": {
		"protocol": "tcp",
		"description": "",
		"source_port": null,
		"source_ip_address": null,
		"destination_ip_address": null,
		"firewall_policy_id": null,
		"position": null,
		"destination_port": null,
		"id": "bacd75ec-9f27-4d65-a681-0df2cfcc70a6",
		"name": "test-rule",
		"tenant_id": "89f60564953c48068513503e4cf4b12f",
		"enabled": true,
		"action": "allow",
		"ip_version": 4,
		"shared": false,
		"project_id": "89f60564953c48068513503e4cf4b12f"
	}
}

正常响应代码

200

错误码

400,401,404

删除防火墙规则

功能介绍

删除防火墙规则。

前提条件

该防火墙规则存在。

URI

DELETE /v2.0/fw/firewall_rules/{firewall_rule_id}

参数 是否必选 描述
firewall_rule_id 防火墙规则的ID。

请求消息

请求示例

响应消息

响应示例

正常响应代码

204

错误码

401,404,409

将防火墙规则插入到防火墙策略中

功能介绍

将防火墙规则插入到策略中。

前提条件

该防火墙规则和策略均存在,且该规则未在该策略中。

URI

PUT /v2.0/fw/firewall_policies/{firewall_policy_id}/insert_rule

参数 是否必选 描述
firewall_policy_id 防火墙策略ID。

请求消息

参数 参数类型 是否必选 描述
firewall_rule_id String 防火墙规则的ID。

请求示例

{
    "firewall_rule_id": "a8f61530-d5db-4769-8f1b-fb154c3078f1"
}

响应消息

参数 参数类型 描述
audited boolean 每次修改防火墙策略或相关规则时,API都会将该属性设置为false。要审计策略,请显式地将此属性设置为true。
description String 人类可读的防火墙策略名称。
firewall_rules array 与防火墙策略相关联的防火墙规则id列表。
id String 防火墙策略ID。
name String 人类可读的防火墙策略名称。
project_id String 资源所属项目的ID。
shared boolean 设置为true可使该防火墙策略对其他项目可见。默认是false。
tenant_id String 资源所属项目的ID。
firewall_list array 与该策略关链的防火墙列表。

响应示例

{
	"name": "my_policy",
	"firewall_rules": ["e246115e-a447-49ec-bc53-fa4dc5e140be", "a8f61530-d5db-4769-8f1b-fb154c3078f1"],
	"shared": false,
	"audited": false,
	"tenant_id": "870c5414baee43a4ba7adfb253e46018",
	"project_id": "870c5414baee43a4ba7adfb253e46018",
	"id": "f0129d8e-4820-4998-872c-4f576e9a49fe",
	"firewall_list": ["7821061b-94b8-4aa1-a391-0fdd6b119ffb"],
	"description": ""
}

正常响应代码

200

错误码

400,401,404,409

从策略中删除防火墙规则

功能介绍

从策略中删除防火墙规则。

前提条件

该防火墙规则需要已经存在于该策略中。

URI

PUT /v2.0/fw/firewall_policies/{firewall_policy_id}/remove_rule

参数 是否必选 描述
firewall_policy_id 防火墙策略ID。

请求消息

参数 参数类型 是否必选 描述
firewall_rule_id String 防火墙规则的ID。

请求示例

{
    "firewall_rule_id": "a8f61530-d5db-4769-8f1b-fb154c3078f1"
}

响应消息

参数 参数类型 描述
audited boolean 每次修改防火墙策略或相关规则时,API都会将该属性设置为false。要审计策略,请显式地将此属性设置为true。
description String 人类可读的防火墙策略名称。
firewall_rules array 与防火墙策略相关联的防火墙规则id列表。
id String 防火墙策略ID。
name String 人类可读的防火墙策略名称。
project_id String 资源所属项目的ID。
shared boolean 设置为true可使该防火墙策略对其他项目可见。默认是false。
tenant_id String 资源所属项目的ID。
firewall_list array 与该策略关链的防火墙列表。

响应示例

{
	"name": "my_policy",
	"firewall_rules": ["e246115e-a447-49ec-bc53-fa4dc5e140be"],
	"shared": false,
	"audited": false,
	"tenant_id": "870c5414baee43a4ba7adfb253e46018",
	"project_id": "870c5414baee43a4ba7adfb253e46018",
	"id": "f0129d8e-4820-4998-872c-4f576e9a49fe",
	"firewall_list": ["7821061b-94b8-4aa1-a391-0fdd6b119ffb"],
	"description": ""
}

正常响应代码

200

错误码

401,403

列举所有防火墙

功能介绍

列举所有的防火墙。

URI

GET /v2.0/fw/firewalls

请求消息

请求示例

响应消息

参数 参数类型 描述
status String 防火墙状态。
router_ids array 与防火墙相关联的路由器的uuid列表。
name String
admin_state_up boolean 资源的管理状态,即up (true)或down (false)。
tenant_id String 资源所属项目的ID。
firewall_policy_id String 只读属性,当您将此防火墙规则与策略关联时,API使用防火墙策略的UUID填充该属性。您一次可以将一条防火墙规则与一个策略关联。您可以将此关联更新为其他防火墙策略。如果不将规则与任何策略关联,则此属性为空。
project_id String 资源所属项目的ID。
id String 防火墙的ID。
description String 人类可读的资源描述。

响应示例

{
	"firewalls": [{
		"status": "INACTIVE",
		"router_ids": [],
		"name": "my_fw",
		"admin_state_up": true,
		"tenant_id": "870c5414baee43a4ba7adfb253e46018",
		"firewall_policy_id": "f0129d8e-4820-4998-872c-4f576e9a49fe",
		"project_id": "870c5414baee43a4ba7adfb253e46018",
		"id": "7821061b-94b8-4aa1-a391-0fdd6b119ffb",
		"description": ""
	}]
}

正常响应代码

200

错误码

401,403

显示防火墙的详细信息

功能介绍

显示防火墙的详细信息。

前提条件

该防火墙存在。

URI

GET /v2.0/fw/firewalls/{firewall_id}

参数 是否必选 描述
firewall_id 防火墙ID。

请求消息

请求示例

响应消息

参数 参数类型 描述
status String 防火墙状态。
router_ids array 与防火墙相关联的路由器的uuid列表。
name String 人类可读的资源名称。
admin_state_up boolean 资源的管理状态,即up (true)或down (false)。
tenant_id String 资源所属项目的ID。
firewall_policy_id String 只读属性,当您将此防火墙规则与策略关联时,API使用防火墙策略的UUID填充该属性。您一次可以将一条防火墙规则与一个策略关联。您可以将此关联更新为其他防火墙策略。如果不将规则与任何策略关联,则此属性为空。
project_id String 资源所属项目的ID。人类可读的资源描述。
id String 防火墙的ID。
description String 人类可读的资源描述。

响应示例

{
	"firewall": {
		"status": "INACTIVE",
		"router_ids": [],
		"name": "my_fw",
		"admin_state_up": true,
		"tenant_id": "870c5414baee43a4ba7adfb253e46018",
		"firewall_policy_id": "f0129d8e-4820-4998-872c-4f576e9a49fe",
		"project_id": "870c5414baee43a4ba7adfb253e46018",
		"id": "7821061b-94b8-4aa1-a391-0fdd6b119ffb",
		"description": ""
	}
}

正常响应代码

200

错误码

401,403

创建防火墙

功能介绍

创建防火墙。

前提条件

  • 需要有可用的防火墙策略。
  • 防火墙必须与防火墙策略相关联。

    URI

    POST /v2.0/fw/firewalls

    请求消息

    参数 参数类型 是否必选 描述
    name String 人类可读的资源名称。
    description String 人类可读的资源描述。
    firewall_policy_id String 只读属性,当您将此防火墙规则与策略关联时,API使用防火墙策略的UUID填充该属性。您一次可以将一条防火墙规则与一个策略关联。您可以将此关联更新为其他防火墙策略。如果不将规则与任何策略关联,则此属性为空。
    router_ids array 与防火墙相关联的路由器的uuid列表。

请求示例

{
    "firewall": {
        "firewall_policy_id": "b8d2c21e-586f-4212-aecb-aa11ca919003"
    }
}

响应消息

参数 参数类型 描述
status String 防火墙状态。
router_ids array 与防火墙相关联的路由器的uuid列表。
name String 人类可读的资源名称。
admin_state_up boolean 资源的管理状态,即up (true)或down (false)。
tenant_id String 资源所属项目的ID。
firewall_policy_id String 只读属性,当您将此防火墙规则与策略关联时,API使用防火墙策略的UUID填充该属性。您一次可以将一条防火墙规则与一个策略关联。您可以将此关联更新为其他防火墙策略。如果不将规则与任何策略关联,则此属性为空。
project_id String 资源所属项目的ID。人类可读的资源描述。
id String 防火墙的ID。
description String 人类可读的资源描述。

响应示例

{
	"firewall": {
		"status": "INACTIVE",
		"router_ids": [],
		"name": "",
		"admin_state_up": true,
		"tenant_id": "89f60564953c48068513503e4cf4b12f",
		"firewall_policy_id": "b8d2c21e-586f-4212-aecb-aa11ca919003",
		"project_id": "89f60564953c48068513503e4cf4b12f",
		"id": "6d3bdbc4-407e-4902-b696-bb741a342890",
		"description": ""
	}
}

正常响应代码

200

错误码

401,403

更新防火墙

功能介绍

更新防火墙。

前提条件

该防火墙已存在。

URI

PUT /v2.0/fw/firewalls/{firewall_id}

参数 是否必选 描述
firewall_id 防火墙ID。

请求消息

参数 参数类型 是否必选 描述
name String 人类可读的资源名称。
description String 人类可读的资源描述。

请求示例

{
    "firewall": {
        "name": "my_fw"
    }
}

响应消息

参数 参数类型 描述
status String 防火墙状态。
router_ids array 与防火墙相关联的路由器的uuid列表。
name String 人类可读的资源名称。
admin_state_up boolean 资源的管理状态,即up (true)或down (false)。
tenant_id String 资源所属项目的ID。
firewall_policy_id String 只读属性,当您将此防火墙规则与策略关联时,API使用防火墙策略的UUID填充该属性。您一次可以将一条防火墙规则与一个策略关联。您可以将此关联更新为其他防火墙策略。如果不将规则与任何策略关联,则此属性为空。
project_id String 资源所属项目的ID。人类可读的资源描述。
id String 防火墙的ID。
description String 人类可读的资源描述。

响应示例

{
	"firewall": {
		"status": "INACTIVE",
		"router_ids": [],
		"name": "my_fw",
		"admin_state_up": true,
		"tenant_id": "89f60564953c48068513503e4cf4b12f",
		"firewall_policy_id": "b8d2c21e-586f-4212-aecb-aa11ca919003",
		"project_id": "89f60564953c48068513503e4cf4b12f",
		"id": "6d3bdbc4-407e-4902-b696-bb741a342890",
		"description": ""
	}
}

正常响应代码

200

错误码

401,403

删除防火墙

功能介绍

删除防火墙。

前提条件

该防火墙存在。

URI

DELETE /v2.0/fw/firewalls/{firewall_id}

参数 是否必选 描述
firewall_id 防火墙ID。

请求消息

请求示例

响应消息

响应示例

正常响应代码

204

错误码

401,404,409

此篇文章对你是否有帮助?
没帮助
locked-file

您暂无权限访问该产品