Queries virtual private cloud (VPC) firewalls. Each VPC firewall protects mutual access traffic between a specified VPC and a network instance that is attached to a Cloud Enterprise Network (CEN) instance.
Operation description
You can call the DescribeVpcFirewallCenList operation to query VPC firewalls. A VPC firewall protects mutual access traffic between a specified VPC and a network instance that is attached to a CEN instance. The network instance can be a VPC, a virtual border router (VBR), or a Cloud Connect Network (CCN) instance.
Limits
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:DescribeVpcFirewallCenList | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Lang | string | No | The language of the content within the response. Valid values:
| zh |
| RegionNo | string | No | The region ID of the VPC. Note
For more information about the regions, see Supported regions.
| cn-hangzhou |
| NetworkInstanceId | string | No | The ID of the network instance. | vpc-8vbwbo90rq0anm6t**** |
| FirewallSwitchStatus | string | No | The status of the VPC firewall. Valid values:
Note
If you do not specify this parameter, VPC firewalls in all states are queried.
| opened |
| VpcFirewallId | string | No | The instance ID of the VPC firewall. | vfw-m5e7dbc4y**** |
| VpcFirewallName | string | No | The instance name of the VPC firewall. | Test firewall |
| CenId | string | No | The ID of the CEN instance. | cen-x5jayxou71ad73**** |
| CurrentPage | string | No | The number of the page to return. Pages start from page 1. Default value: 1. | 1 |
| PageSize | string | No | The number of entries to return on each page. Default value: 10. Maximum value: 50. | 10 |
| RouteMode | string | No | The routing mode of the VPC firewall. Valid values:
Note
If you do not specify this parameter, VPC firewalls in all routing modes are queried.
| auto |
| MemberUid | string | No | The UID of the member that is managed by your Alibaba Cloud account. The member is also an Alibaba Cloud account. | 258039427902**** |
| TransitRouterType | string | No | The type of the transit router. Valid values:
| Basic |
Response parameters
Examples
Sample success responses
JSONformat
{
"TotalCount": 10,
"RequestId": "850A84D6-0DE4-4797-A1E8-00090125k8g2",
"VpcFirewalls": [
{
"ConnectType": "cen",
"VpcFirewallId": "vfw-m5e7dbc4y****",
"RegionStatus": "enable",
"CenId": "cen-x5jayxou71ad73****",
"VpcFirewallName": "Test firewall\n",
"ResultCode": "Unauthorized",
"CenName": "Test CEN instance\n",
"FirewallSwitchStatus": "opened",
"LocalVpc": {
"VpcId": "vpc-8vbwbo90rq0anm6t****",
"TransitRouterType": "Basic",
"NetworkInstanceId": "vpc-2zefk9fbn8j7v585g****",
"RouteMode": "auto",
"RegionNo": "cn-hangzhou",
"AuthorizationStatus": "authorized",
"ManualVSwitchId": "vsw-zeq4o875u****",
"OwnerId": 0,
"NetworkInstanceType": "VPC",
"VpcName": "Test instance\n",
"SupportManualMode": "0",
"NetworkInstanceName": "Test VPC\n",
"VpcCidrTableList": [
{
"RouteTableId": "vtb-1234",
"RouteEntryList": [
{
"NextHopInstanceId": "vrt-m5eb5me6c3l5sezae****",
"DestinationCidr": "192.168.XX.XX/24"
}
]
}
],
"DefendCidrList": [
"10.0.XX.XX/24"
]
},
"IpsConfig": {
"BasicRules": 1,
"EnableAllPatch": 1,
"RunMode": 0,
"RuleClass": 1
},
"MemberUid": "258039427902****",
"PrecheckStatus": "failed"
}
]
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | ErrorAliUid | The aliuid is invalid. | The aliuid is invalid. |
| 400 | ErrorDBSelectError | A database select error occurred. | The error message returned because an internal error has occurred in querying the database. |
| 400 | ErrorPageNo | Either page number or page size is invalid. | Either page number or page size is invalid. |
| 400 | ErrorUserNotFound | User not found | The user does not exist. |
| 400 | ErrorFirewallStatus | firewall status error. | Firewall status error, please try again later. |
| 400 | ErrorOwnerId | owner id invalid. | The account is incorrect, please re-enter. |
| 400 | ErrorInvalidMemberUid | Member uid is invalid | The member is invalid. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-10-08 | API Description Update. The Error code has changed | View Change Details |
| 2024-08-15 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2021-11-15 | Add Operation | View Change Details |