All Products
Search

This Product

    Cloud Firewall:CreateVpcFirewallConfigure

    Document Center

    Cloud Firewall:CreateVpcFirewallConfigure

    Last Updated:Mar 19, 2024

    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

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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 Resources is 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.
    OperationAccess levelResource typeCondition keyAssociated operation
    yundun-cloudfirewall:CreateVpcFirewallConfigureWrite
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    LangstringNo

    The language of the content within the request and the response. Valid values:

    • zh: Chinese (default)
    • en: English.
    		zh
    VpcFirewallNamestringYes

    The instance name of the VPC firewall.

    		my-vpc-firewall
    LocalVpcIdstringYes

    The ID of the local VPC.

    		vpc-8vbwbo90rq0anm6t****
    LocalVpcRegionstringYes

    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
    PeerVpcIdstringYes

    The ID of the peer VPC.

    		vpc-wb8vbo90rq0anm6t****
    PeerVpcRegionstringYes

    The region ID of the peer VPC.

    Note For more information about Cloud Firewall supported regions, see Supported regions.
    		cn-shanghai
    FirewallSwitchstringYes

    The status of the VPC firewall after you create the firewall. Valid values:

    • open: After you create the VPC firewall, the VPC firewall is automatically enabled. This is the default value.
    • close: After you create the VPC firewall, the VPC firewall is disabled. To enable the firewall, you can call the ModifyVpcFirewallSwitchStatus operation.
    		open
    LocalVpcCidrTableListstringYes

    The CIDR blocks of the local VPC. The value is a JSON string that contains the following parameters:

    • RouteTableId: the ID of the route table for the local VPC.
    • RouteEntryList: The value is a JSON string that contains the DestinationCidr and NextHopInstanceId parameters. The DestinationCidr parameter indicates the destination CIDR block of the local VPC. The NextHopInstanceId parameter indicates the instance ID of the next hop for the local VPC.
    		[{"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****"}]}]
    PeerVpcCidrTableListstringYes

    The CIDR blocks of the peer VPC. The value is a JSON string that contains the following parameters:

    • RouteTableId: the ID of the route table for the peer VPC.
    • RouteEntryList: The value is a JSON string that contains the DestinationCidr and NextHopInstanceId parameters. The DestinationCidr parameter indicates the destination CIDR block of the peer VPC. The NextHopInstanceId parameter indicates the instance ID of the next hop for the peer VPC.
    		[{"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****"}]}]
    MemberUidstringNo

    The UID of the member that is managed by your Alibaba Cloud account.

    		258039427902****

    Response parameters

    ParameterTypeDescriptionExample
    object
    VpcFirewallIdstring

    The instance ID of the VPC firewall.

    		vfw-m5e7dbc4y****
    RequestIdstring

    The request ID.

    		850A84D6-0DE4-4797-A1E8-00090125h4j6

    Examples

    Sample success responses

    JSONformat

    {
  "VpcFirewallId": "vfw-m5e7dbc4y****",
  "RequestId": "850A84D6-0DE4-4797-A1E8-00090125h4j6"
}

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history