更新时间:2025-11-21 GMT+08:00

创建防火墙

功能介绍

创建防火墙

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/firewall

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,可以从调API处获取,也可以从控制台获取。项目ID获取方式

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。可通过如何获取用户Token获取。

X-Client-Token

String

保证客户端请求幂等性的标识。

该标识为32位UUID格式,由客户端生成,且需确保不同请求之间该标识具有唯一性。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

防火墙名称

enterprise_project_id

String

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,用户未开启企业项目时为0

tags

Array of tags objects

服务资源标签列表,防火墙资源添加标签后,可根据键、值组合查询资源,同时可根据键、值组合进行话单合并统计。

flavor

flavor object

防火墙规格信息

charge_info

charge_info object

计费类型信息,支持包年/包月和按需,默认为按需。

表4 tags

参数

是否必选

参数类型

描述

key

String

资源标签键

value

String

资源标签值

表5 flavor

参数

是否必选

参数类型

描述

version

String

防火墙版本

“charge_mode”为“prePaid”时,支持标准版、专业版。

“charge_mode”为“postPaid”时,仅支持专业版。

Standard - 标准版

Professional - 专业版

extend_eip_count

Integer

扩展EIP数量,仅包周期场景下生效,当用户需要在增加EIP使用时需要使用此参数。

extend_bandwidth

Integer

扩展带宽,步长为5,仅包周期场景下生效,当用户需要在增加带宽使用时需要使用此参数。

extend_vpc_count

Integer

扩展VPC数量,仅包周期场景下生效,当用户需要增加VPC使用时需要使用此参数。

表6 charge_info

参数

是否必选

参数类型

描述

charge_mode

String

计费模式。

取值范围:

prePaid:预付费,即包年/包月。

postPaid:后付费,即按需付费。

period_type

String

订购周期类型。

取值范围:

month:包月。

year:包年。

说明:“charge_mode”为“prePaid”时生效,且为必选值。

period_num

Integer

“charge_mode”为“prePaid”时生效,且为必选值,指定订购的时间。

取值范围:

  • 当“period_type”为“month”时,取值为1~9。

  • 当“period_type”为“year”时,取值为1~3。

is_auto_renew

Boolean

创建包周期实例时可指定,表示是否自动续订,续订的周期和原周期相同,且续订时会自动支付。

true,为自动续订。

false,为不自动续订,默认该方式。

is_auto_pay

Boolean

创建包周期时可指定,表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。

  • true,为自动支付。(会自动选择折扣和优惠券进行优惠,然后自动从客户华为云账户中支付),自动支付失败会生成、但订单状态为“待支付”,等待客户手动支付(手动支付时,可以修改系统自动选择的折扣和优惠券)

  • false,为手动支付,默认该方式。(需要客户手动去支付,客户可以选择折扣和优惠券)

响应参数

状态码:200

表7 响应Body参数

参数

参数类型

描述

job_id

String

实例创建的任务id。仅创建按需实例时会返回该参数。

order_id

String

订单号,创建包年包月时返回该参数。

data

CreateFirewallReq object

创建防火墙请求体

表8 CreateFirewallReq

参数

参数类型

描述

name

String

防火墙名称

enterprise_project_id

String

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,用户未开启企业项目时为0

tags

Array of tags objects

服务资源标签列表,防火墙资源添加标签后,可根据键、值组合查询资源,同时可根据键、值组合进行话单合并统计。

flavor

flavor object

防火墙规格信息

charge_info

charge_info object

计费类型信息,支持包年/包月和按需,默认为按需。

表9 tags

参数

参数类型

描述

key

String

资源标签键

value

String

资源标签值

表10 flavor

参数

参数类型

描述

version

String

防火墙版本

“charge_mode”为“prePaid”时,支持标准版、专业版。

“charge_mode”为“postPaid”时,仅支持专业版。

Standard - 标准版

Professional - 专业版

extend_eip_count

Integer

扩展EIP数量,仅包周期场景下生效,当用户需要在增加EIP使用时需要使用此参数。

extend_bandwidth

Integer

扩展带宽,步长为5,仅包周期场景下生效,当用户需要在增加带宽使用时需要使用此参数。

extend_vpc_count

Integer

扩展VPC数量,仅包周期场景下生效,当用户需要增加VPC使用时需要使用此参数。

表11 charge_info

参数

参数类型

描述

charge_mode

String

计费模式。

取值范围:

prePaid:预付费,即包年/包月。

postPaid:后付费,即按需付费。

period_type

String

订购周期类型。

取值范围:

month:包月。

year:包年。

说明:“charge_mode”为“prePaid”时生效,且为必选值。

period_num

Integer

“charge_mode”为“prePaid”时生效,且为必选值,指定订购的时间。

取值范围:

  • 当“period_type”为“month”时,取值为1~9。

  • 当“period_type”为“year”时,取值为1~3。

is_auto_renew

Boolean

创建包周期实例时可指定,表示是否自动续订,续订的周期和原周期相同,且续订时会自动支付。

true,为自动续订。

false,为不自动续订,默认该方式。

is_auto_pay

Boolean

创建包周期时可指定,表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。

  • true,为自动支付。(会自动选择折扣和优惠券进行优惠,然后自动从客户华为云账户中支付),自动支付失败会生成、但订单状态为“待支付”,等待客户手动支付(手动支付时,可以修改系统自动选择的折扣和优惠券)

  • false,为手动支付,默认该方式。(需要客户手动去支付,客户可以选择折扣和优惠券)

状态码:400

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

项目ID为124147da-5b08-471a-93d2-bc82acc290c6的客户开通标准版防火墙,防火墙名称为CFW-Test,企业项目ID为0,资源标签传入一个键值对,键为TagKey,值为TagValue,扩展防护EIP2000个,扩展EIP防护带宽5000Mbps,扩展防护VPC100个,包周期计费模式,启用自动续费,启用自动付款,开通1个月。

https://{Endpoint}/v2/124147da-5b08-471a-93d2-bc82acc290c6/firewall

{
  "name" : "CFW-TEST",
  "enterprise_project_id" : "0",
  "tags" : [ {
    "key" : "TagKey",
    "value" : "TagVal"
  } ],
  "flavor" : {
    "version" : "standard",
    "extend_eip_count" : 2000,
    "extend_bandwidth" : 5000,
    "extend_vpc_count" : 100
  },
  "charge_info" : {
    "charge_mode" : "prePaid",
    "period_type" : "month",
    "period_num" : 1,
    "is_auto_renew" : true,
    "is_auto_pay" : true
  }
}

响应示例

状态码:200

购买防火墙成功返回信息。

{
  "data" : {
    "charge_info" : {
      "charge_mode" : "prePaid",
      "is_auto_pay" : true,
      "is_auto_renew" : true,
      "period_num" : 1,
      "period_type" : "month"
    },
    "enterprise_project_id" : "0",
    "flavor" : {
      "extend_bandwidth" : 5000,
      "extend_eip_count" : 2000,
      "extend_vpc_count" : 100,
      "version" : "Standard"
    },
    "name" : "CFW-TEST",
    "tags" : [ {
      "key" : "TagKey",
      "value" : "TagVal"
    } ]
  },
  "job_id" : "CS2403271050ZEM0L"
}

状态码:400

错误返回信息。

{
  "error_code" : "CFW.00100001",
  "error_msg" : "系统繁忙,请稍后重试"
}

状态码

状态码

描述

200

购买防火墙成功返回信息。

400

错误返回信息。

错误码

请参见错误码