创建防火墙
功能介绍
创建防火墙
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/firewall
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户项目id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
X-Client-Token |
否 |
String |
保证客户端请求幂等性的标识。 该标识为32位UUID格式,由客户端生成,且需确保不同请求之间该标识具有唯一性。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
防火墙名称 |
enterprise_project_id |
否 |
String |
企业项目ID,租户未开启企业项目时传0 缺省值:0 |
tags |
否 |
Array of tags objects |
资源标签 |
flavor |
是 |
flavor object |
规格信息 |
charge_info |
是 |
charge_info object |
计费类型信息,支持包年/包月和按需,默认为按需。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
version |
是 |
String |
防火墙版本 “charge_mode”为“prePaid”时,仅支持专业版。 “charge_mode”为“postPaid”时,支持标准版、专业版。 Standard - 标准版 Professional - 专业版 枚举值:
|
extend_eip_count |
否 |
Integer |
扩展EIP数量,仅包周期场景下生效 最小值:0 最大值:2000 缺省值:0 |
extend_bandwidth |
否 |
Integer |
扩展带宽,步长为5,仅包周期场景下生效 最小值:0 最大值:5000 |
extend_vpc_count |
否 |
Integer |
扩展VPC数量,仅包周期场景下生效 最小值:0 最大值:100 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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,为不自动续订,默认该方式。 缺省值:false |
is_auto_pay |
是 |
Boolean |
创建包周期时可指定,表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。 true,为自动支付。(会自动选择折扣和优惠券进行优惠,然后自动从客户华为云账户中支付),自动支付失败后会生成订单成功(该订单应付金额是优惠后金额)、但订单状态为“待支付”,等待客户手动支付(手动支付时,客户还可以修改系统自动选择的折扣和优惠券) false,为手动支付,默认该方式。(需要客户手动去支付,客户可以选择折扣和优惠券) 缺省值:false |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
实例创建的任务id。 仅创建按需实例时会返回该参数。 |
order_id |
String |
订单号,创建包年包月时返回该参数。 |
data |
CreateFirewallReq object |
按需防火墙实体 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
防火墙名称 |
enterprise_project_id |
String |
企业项目ID,租户未开启企业项目时传0 缺省值:0 |
tags |
Array of tags objects |
资源标签 |
flavor |
flavor object |
规格信息 |
charge_info |
charge_info object |
计费类型信息,支持包年/包月和按需,默认为按需。 |
参数 |
参数类型 |
描述 |
---|---|---|
version |
String |
防火墙版本 “charge_mode”为“prePaid”时,仅支持专业版。 “charge_mode”为“postPaid”时,支持标准版、专业版。 Standard - 标准版 Professional - 专业版 枚举值:
|
extend_eip_count |
Integer |
扩展EIP数量,仅包周期场景下生效 最小值:0 最大值:2000 缺省值:0 |
extend_bandwidth |
Integer |
扩展带宽,步长为5,仅包周期场景下生效 最小值:0 最大值:5000 |
extend_vpc_count |
Integer |
扩展VPC数量,仅包周期场景下生效 最小值:0 最大值:100 |
参数 |
参数类型 |
描述 |
---|---|---|
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,为不自动续订,默认该方式。 缺省值:false |
is_auto_pay |
Boolean |
创建包周期时可指定,表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。 true,为自动支付。(会自动选择折扣和优惠券进行优惠,然后自动从客户华为云账户中支付),自动支付失败后会生成订单成功(该订单应付金额是优惠后金额)、但订单状态为“待支付”,等待客户手动支付(手动支付时,客户还可以修改系统自动选择的折扣和优惠券) false,为手动支付,默认该方式。(需要客户手动去支付,客户可以选择折扣和优惠券) 缺省值:false |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
请求示例
开通标准版防火墙,扩展防护EIP2000个,扩展防护带宽5000Mbps,扩展防护VCP100个,包周期计费模式,启用自动续费,启用自动付款,开通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
执行成功,返回JobID
{ "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" } ] }, "order_id" : "CS2403271050ZEM0L" }
状态码: 400
请求体错误
{ "error_code" : "CFW.00100001", "error_msg" : "系统繁忙,请稍后重试" }
SDK代码示例
SDK代码示例如下。
Java
开通标准版防火墙,扩展防护EIP2000个,扩展防护带宽5000Mbps,扩展防护VCP100个,包周期计费模式,启用自动续费,启用自动付款,开通1个月
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cfw.v1.region.CfwRegion; import com.huaweicloud.sdk.cfw.v1.*; import com.huaweicloud.sdk.cfw.v1.model.*; import java.util.List; import java.util.ArrayList; public class CreateFirewallSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("<YOUR REGION>")) .build(); CreateFirewallRequest request = new CreateFirewallRequest(); CreateFirewallReq body = new CreateFirewallReq(); CreateFirewallReqChargeInfo chargeInfobody = new CreateFirewallReqChargeInfo(); chargeInfobody.withChargeMode("prePaid") .withPeriodType("month") .withPeriodNum(1) .withIsAutoRenew(true) .withIsAutoPay(true); CreateFirewallReqFlavor flavorbody = new CreateFirewallReqFlavor(); flavorbody.withVersion(CreateFirewallReqFlavor.VersionEnum.fromValue("standard")) .withExtendEipCount(2000) .withExtendBandwidth(5000) .withExtendVpcCount(100); List<CreateFirewallReqTags> listbodyTags = new ArrayList<>(); listbodyTags.add( new CreateFirewallReqTags() .withKey("TagKey") .withValue("TagVal") ); body.withChargeInfo(chargeInfobody); body.withFlavor(flavorbody); body.withTags(listbodyTags); body.withEnterpriseProjectId("0"); body.withName("CFW-TEST"); request.withBody(body); try { CreateFirewallResponse response = client.createFirewall(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
开通标准版防火墙,扩展防护EIP2000个,扩展防护带宽5000Mbps,扩展防护VCP100个,包周期计费模式,启用自动续费,启用自动付款,开通1个月
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcfw.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateFirewallRequest() chargeInfobody = CreateFirewallReqChargeInfo( charge_mode="prePaid", period_type="month", period_num=1, is_auto_renew=True, is_auto_pay=True ) flavorbody = CreateFirewallReqFlavor( version="standard", extend_eip_count=2000, extend_bandwidth=5000, extend_vpc_count=100 ) listTagsbody = [ CreateFirewallReqTags( key="TagKey", value="TagVal" ) ] request.body = CreateFirewallReq( charge_info=chargeInfobody, flavor=flavorbody, tags=listTagsbody, enterprise_project_id="0", name="CFW-TEST" ) response = client.create_firewall(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
开通标准版防火墙,扩展防护EIP2000个,扩展防护带宽5000Mbps,扩展防护VCP100个,包周期计费模式,启用自动续费,启用自动付款,开通1个月
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cfw.NewCfwClient( cfw.CfwClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateFirewallRequest{} periodTypeChargeInfo:= "month" periodNumChargeInfo:= int32(1) chargeInfobody := &model.CreateFirewallReqChargeInfo{ ChargeMode: "prePaid", PeriodType: &periodTypeChargeInfo, PeriodNum: &periodNumChargeInfo, IsAutoRenew: true, IsAutoPay: true, } extendEipCountFlavor:= int32(2000) extendBandwidthFlavor:= int32(5000) extendVpcCountFlavor:= int32(100) flavorbody := &model.CreateFirewallReqFlavor{ Version: model.GetCreateFirewallReqFlavorVersionEnum().STANDARD, ExtendEipCount: &extendEipCountFlavor, ExtendBandwidth: &extendBandwidthFlavor, ExtendVpcCount: &extendVpcCountFlavor, } keyTags:= "TagKey" valueTags:= "TagVal" var listTagsbody = []model.CreateFirewallReqTags{ { Key: &keyTags, Value: &valueTags, }, } enterpriseProjectIdCreateFirewallReq:= "0" request.Body = &model.CreateFirewallReq{ ChargeInfo: chargeInfobody, Flavor: flavorbody, Tags: &listTagsbody, EnterpriseProjectId: &enterpriseProjectIdCreateFirewallReq, Name: "CFW-TEST", } response, err := client.CreateFirewall(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
执行成功,返回JobID |
400 |
请求体错误 |
错误码
请参见错误码。