创建网络ACL
功能介绍
网络ACL是一个子网级别的可选安全防护层,用户可以创建网络ACL,设置入方向和出方向规则,并将网络ACL绑定至子网,来精准控制出入子网的流量。
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/vpc/firewalls
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 网络ACL所属的项目ID。获取方式请参见获取项目ID。 取值范围: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
firewall |
是 |
CreateFirewallOption object |
参数解释: 创建网络ACL的请求体。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
dry_run |
否 |
Boolean |
参数解释: 是否只预检此次请求。 约束限制: 不涉及。 取值范围:
默认取值: false |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
参数解释: 网络ACL的名称。 约束限制: 1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。 取值范围: 不涉及。 默认取值: 不涉及。 |
description |
否 |
String |
参数解释: 网络ACL的描述信息。 约束限制: 0-255个字符,不能包含“<”和“>”。 取值范围: 不涉及。 默认取值: 不涉及。 |
enterprise_project_id |
否 |
String |
参数解释: 网络ACL所属的企业项目ID。 约束限制:
取值范围: 不涉及。 默认取值: “0”表示默认企业项目。 |
tags |
否 |
Array of RequestTag objects |
参数解释: 网络ACL的标签信息,包括标签键和标签值,可用来分类和标识资源。详情请参见Tag对象。 约束限制: 最大支持20组标签键值对。 取值范围: 不涉及。 默认取值: 不涉及。 |
admin_state_up |
否 |
Boolean |
参数解释: 网络ACL的管理状态。 约束限制: 不涉及。 取值范围:
默认取值: true |
type |
否 |
String |
参数解释: 网络ACL支持关联的子网类型。 约束限制: 不涉及。 取值范围:
默认取值: normal |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
key |
是 |
String |
参数解释: 标签键。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
value |
是 |
String |
参数解释: 标签值。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
响应参数
状态码:201
参数 |
参数类型 |
描述 |
---|---|---|
firewall |
FirewallDetail object |
参数解释: 创建ACL的响应体。 取值范围: 不涉及。 |
request_id |
String |
参数解释: 请求ID。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 网络ACL的资源ID。网络ACL创建成功后,会生成一个网络ACL ID,是网络ACL对应的唯一标识。 取值范围: 带“-”的标准UUID格式。 |
name |
String |
参数解释: 网络ACL的名称。 取值范围: 1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。 |
description |
String |
参数解释: 网络ACL的描述信息。 取值范围: 0-255个字符,不能包含“<”和“>”。 |
project_id |
String |
参数解释: 网络ACL所属的项目ID。 取值范围: 不涉及。 |
created_at |
String |
参数解释: 网络ACL的创建时间,系统自动生成。 取值范围: UTC时间格式,yyyy-MM-ddTHH:mm:ssZ。 |
updated_at |
String |
参数解释: 网络ACL的最近一次更新的时间,系统自动生成。 取值范围: UTC时间格式,yyyy-MM-ddTHH:mm:ssZ。 |
admin_state_up |
Boolean |
参数解释: 网络ACL的管理状态。 取值范围:
|
status |
String |
参数解释: 网络ACL的状态。 取值范围:
|
enterprise_project_id |
String |
参数解释: 网络ACL所属的企业项目ID。 取值范围: 最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。 |
type |
String |
参数解释: 网络ACL支持绑定的子网类型。 取值范围:
|
tags |
Array of ResponseTag objects |
参数解释: 网络ACL的标签信息,包括标签键和标签值,可用来分类和标识资源。详情请参见Tag对象。 取值范围: 不涉及。 |
associations |
Array of FirewallAssociation objects |
参数解释: 网络ACL绑定的子网列表。 取值范围: 不涉及。 |
ingress_rules |
Array of FirewallRuleDetail objects |
参数解释: 网络ACL入方向规则列表。 取值范围: 不涉及。 |
egress_rules |
Array of FirewallRuleDetail objects |
参数解释: 网络ACL出方向规则列表。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
参数解释: 标签键。 取值范围:
|
value |
String |
参数解释: 标签值。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
virsubnet_id |
String |
参数解释: 网络ACL绑定的子网ID。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 网络ACL规则的资源ID。网络ACL规则创建成功后,会生成一个网络ACL规则ID,是网络ACL规则对应的唯一标识。 取值范围: 带“-”的标准UUID格式。 |
name |
String |
参数解释: 网络ACL规则的名称。 取值范围: 0-255个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。 |
description |
String |
参数解释: 网络ACL规则的描述信息。 取值范围: 0-255个字符,不能包含“<”和“>”。 |
action |
String |
参数解释: 网络ACL规则对流量执行的操作放通或拒绝。 取值范围:
|
project_id |
String |
参数解释: 网络ACL规则所属的项目ID。 取值范围: 不涉及。 |
protocol |
String |
参数解释: 网络ACL规则的通信协议类型。 取值范围:
|
ip_version |
Integer |
参数解释: 网络ACL规则的IP地址协议类型。 取值范围:
|
source_ip_address |
String |
参数解释: 网络ACL规则的源IP地址或源IP网段。 取值范围: source_ip_address和source_address_group_id不能同时设置。 |
destination_ip_address |
String |
参数解释: 网络ACL规则的目的IP地址或目的IP网段。 取值范围: destination_ip_address和destination_address_group_id不能同时设置。 |
source_port |
String |
参数解释: 网络ACL规则的源端口。 取值范围:
|
destination_port |
String |
参数解释: 网络ACL规则的目的端口。 取值范围:
|
source_address_group_id |
String |
参数解释: 网络ACL规则源地址对应的IP地址组ID。 取值范围: source_ip_address和source_address_group_id不能同时设置。 |
destination_address_group_id |
String |
参数解释: 网络ACL规则目的地址对应的IP地址组ID。 取值范围: destination_ip_address和destination_address_group_id不能同时设置。 |
enabled |
Boolean |
参数解释: 是否启用网络ACL规则。 取值范围:
|
请求示例
创建网络ACL,命名为network_acl_test1。
POST https://{Endpoint}/v3/{project_id}/vpc/firewalls { "firewall" : { "name" : "network_acl_test1", "description" : "network_acl_test1", "enterprise_project_id" : "158ad39a-dab7-45a3-9b5a-2836b3cf93f9" } }
响应示例
状态码:201
POST操作正常返回,更多状态码请参见状态码。
-
{ "firewall" : { "id" : "e9a7731d-5bd9-4250-a524-b9a076fd5629", "name" : "network_acl_test1", "description" : "network_acl_test1", "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12", "created_at" : "2022-04-07T07:30:46.000+00:00", "updated_at" : "2022-04-07T07:30:46.000+00:00", "admin_state_up" : true, "enterprise_project_id" : "158ad39a-dab7-45a3-9b5a-2836b3cf93f9", "status" : "ACTIVE", "tags" : [ ], "ingress_rules" : [ ], "egress_rules" : [ ], "associations" : [ ] } }
SDK代码示例
SDK代码示例如下。
创建网络ACL,命名为network_acl_test1。
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 |
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.vpc.v3.region.VpcRegion; import com.huaweicloud.sdk.vpc.v3.*; import com.huaweicloud.sdk.vpc.v3.model.*; 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); VpcClient client = VpcClient.newBuilder() .withCredential(auth) .withRegion(VpcRegion.valueOf("<YOUR REGION>")) .build(); CreateFirewallRequest request = new CreateFirewallRequest(); CreateFirewallRequestBody body = new CreateFirewallRequestBody(); CreateFirewallOption firewallbody = new CreateFirewallOption(); firewallbody.withName("network_acl_test1") .withDescription("network_acl_test1") .withEnterpriseProjectId("158ad39a-dab7-45a3-9b5a-2836b3cf93f9"); body.withFirewall(firewallbody); 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()); } } } |
创建网络ACL,命名为network_acl_test1。
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkvpc.v3.region.vpc_region import VpcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkvpc.v3 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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = VpcClient.new_builder() \ .with_credentials(credentials) \ .with_region(VpcRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateFirewallRequest() firewallbody = CreateFirewallOption( name="network_acl_test1", description="network_acl_test1", enterprise_project_id="158ad39a-dab7-45a3-9b5a-2836b3cf93f9" ) request.body = CreateFirewallRequestBody( firewall=firewallbody ) 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) |
创建网络ACL,命名为network_acl_test1。
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := vpc.NewVpcClient( vpc.VpcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateFirewallRequest{} descriptionFirewall:= "network_acl_test1" enterpriseProjectIdFirewall:= "158ad39a-dab7-45a3-9b5a-2836b3cf93f9" firewallbody := &model.CreateFirewallOption{ Name: "network_acl_test1", Description: &descriptionFirewall, EnterpriseProjectId: &enterpriseProjectIdFirewall, } request.Body = &model.CreateFirewallRequestBody{ Firewall: firewallbody, } response, err := client.CreateFirewall(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
201 |
POST操作正常返回,更多状态码请参见状态码。 |
错误码
请参见错误码。