Creates a Virtual Private Cloud (VPC) firewall to protect traffic between two VPCs that are connected by using an Express Connect.
Operation description
You can call this operation to create a VPC firewall. The VPC firewall controls traffic between two VPCs that are connected by using an Express Connect circuit. The VPC firewall does not control the mutual access traffic between VPCs that reside in different regions or belong to different Alibaba Cloud accounts. The firewall also does not control the mutual access traffic between VPCs and virtual border routers (VBRs). For more information, see VPC firewall limits.
QPS limit
You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| yundun-cloudfirewall:CreateVpcFirewallConfigure | create |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Lang | string | No | The language of the content within the request and the response. Valid values:
| zh |
| VpcFirewallName | string | Yes | The instance name of the VPC firewall. | my-vpc-firewall |
| LocalVpcId | string | Yes | The ID of the local VPC. | vpc-8vbwbo90rq0anm6t**** |
| LocalVpcRegion | string | Yes | The region ID of the local VPC. Note
For more information about the regions in which Cloud Firewall is available, see Supported regions.
| cn-hangzhou |
| PeerVpcId | string | Yes | The ID of the peer VPC. | vpc-wb8vbo90rq0anm6t**** |
| PeerVpcRegion | string | Yes | The region ID of the peer VPC. Note
For more information about Cloud Firewall supported regions, see Supported regions.
| cn-shanghai |
| FirewallSwitch | string | Yes | The status of the VPC firewall after you create the firewall. Valid values:
| open |
| LocalVpcCidrTableList | string | Yes | The CIDR blocks of the local VPC. The value is a JSON string that contains the following parameters:
| [{"RouteTableId":"vtb-1234","RouteEntryList":[{"DestinationCidr":"192.168.XX.XX/24","NextHopInstanceId":"vrt-m5eb5me6c3l5sezae****"}]},{"RouteTableId":"vtb-1235","RouteEntryList":[{"DestinationCidr":"192.168.XX.XX/24","NextHopInstanceId":"vrt-m5eb5me6c3l5sezae****"}]}] |
| PeerVpcCidrTableList | string | Yes | The CIDR blocks of the peer VPC. The value is a JSON string that contains the following parameters:
| [{"RouteTableId":"vtb-1234","RouteEntryList":[{"DestinationCidr":"192.168.XX.XX/24","NextHopInstanceId":"vrt-m5eb5me6c3l5sezae****"}]},{"RouteTableId":"vtb-1235","RouteEntryList":[{"DestinationCidr":"192.168.XX.XX/24","NextHopInstanceId":"vrt-m5eb5me6c3l5sezae****"}]}] |
| MemberUid | string | No | The UID of the member that is managed by your Alibaba Cloud account. | 258039427902**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"VpcFirewallId": "vfw-m5e7dbc4y****",
"RequestId": "850A84D6-0DE4-4797-A1E8-00090125h4j6"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | ErrorAliUid | Aliuid invalid. | The aliuid is invalid. |
| 400 | ErrorInvalidMemberUid | Member uid is invalid | The member is invalid. |
| 400 | ErrorFirewallName | Firewall name invalid. | Firewall name error, please re-enter. |
| 400 | ErrorVpcFirewallExist | Vpc firewall already exist. | The firewall is already configured and cannot be configured repeatedly. |
| 400 | ErrorVpcIdError | Vpc ID invalid. | The VPC is incorrectly selected. Select another VPC. |
| 400 | ErrorRegionNoError | Region invalid. | Region selection error, please re-enter. |
| 400 | ErrorDestCidrError | The destination CIDR block is invalid. | The specified destination CIDR block is invalid. Enter another value. |
| 400 | ErrorDestCidrEmpty | The target network segment is empty and cannot be created | The destination CIDR block is not specified. The firewall cannot be created. |
| 400 | ErrorSameCidrIp | The same network segment cannot be configured repeatedly. Please reselect the network segment. | The CIDR block is already in use. Specify another CIDR block. |
| 400 | ErrorDBSelectError | A database select error occurred. | The error message returned because an internal error has occurred in querying the database. |
| 400 | ErrorCidrFormat | Cidr ip format error. | CIDR format error, please re-select |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-08-08 | The Error code has changed | View Change Details |