Queries the details about a virtual private cloud (VPC) firewall. The VPC firewall controls traffic between two VPCs that are connected by using an Express Connect circuit.
Operation description
You can call the DescribeVpcFirewallDetail operation to query the details about a VPC firewall. The VPC firewall controls traffic between two VPCs that are connected by using an Express Connect circuit.
Before you call the operation, make sure that you created a VPC firewall by calling the CreateVpcFirewallConfigure operation.
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:DescribeVpcFirewallDetail | get |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Lang | string | No | The natural language of the request and response. Valid values:
| zh |
| VpcFirewallId | string | Yes | The instance ID of the VPC firewall. Note
You can call the DescribeVpcFirewallList operation to query the instance IDs of VPC firewalls.
| vfw-m5e7dbc4y**** |
| LocalVpcId | string | No | The ID of the local VPC. | vpc-8vbwbo90rq0anm6t**** |
| PeerVpcId | string | No | The ID of the peer VPC. | vpc-90rq0anm6t8vbwbo**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"ConnectType": "expressconnect",
"VpcFirewallId": "vfw-m5e7dbc4y****",
"RequestId": "850A84D6-0DE4-4797-A1E8-00090125g4d2",
"Bandwidth": 2,
"VpcFirewallName": "tf-test",
"FirewallSwitchStatus": "opened",
"LocalVpc": {
"VpcId": "vpc-8vbwbo90rq0anm6t****",
"VpcName": "Vitasoy",
"RegionNo": "cn-hangzhou",
"EniPrivateIpAddress": "192.168.XX.XX",
"RouterInterfaceId": "vrt-m5eb5me6c3l5sezae****",
"EniId": "eni-8vbhfosfqv2rff42****",
"VpcCidrTableList": [
{
"RouteTableId": "vtb-1234",
"RouteEntryList": [
{
"NextHopInstanceId": "vrt-m5eb5me6c3l5sezae****",
"DestinationCidr": "192.168.XX.XX/24"
}
]
}
]
},
"PeerVpc": {
"VpcId": "vpc-90rq0anm6t8vbwbo****",
"VpcName": "zcy_prod",
"RegionNo": "cn-hangzhou",
"EniPrivateIpAddress": "192.168.XX.XX",
"RouterInterfaceId": "vrt-m5eb5me6c3l5sezae****",
"EniId": "eni-8vbhfosfqv2rff42****",
"VpcCidrTableList": [
{
"RouteTableId": "vtb-1256",
"RouteEntryList": [
{
"NextHopInstanceId": "vrt-m5eb5me6c3l5sezae****",
"DestinationCidr": "192.168.XX.XX/24"
}
]
}
]
},
"MemberUid": "258039427902****"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | ErrorAliUid | The aliuid is invalid. | The aliuid is invalid. |
| 400 | ErrorFirewallNotFound | Firewall not found | The firewall does not exist. |
| 400 | ErrorDBSelectError | A database select error occurred. | The error message returned because an internal error has occurred in querying the database. |
| 400 | ErrorInvalidMemberUid | Member uid is invalid | The member is invalid. |
| 400 | ErrorFirewallStatus | firewall status error. | Firewall status error, please try again later. |
| 400 | ErrorVpcIdPara | vpc id and firewall id parameter not exist. | The firewall VPC parameter is incorrect. Select another one. |
| 400 | ErrorLocalVpcIdPeerVpcIdError | local vpc id and peer vpc id cannot be empty at the same time. | The firewall VPC parameter is incorrect. Select another one. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-09-05 | The Error code has changed | View Change Details |
| 2022-12-08 | API Description Update. The Error code has changed. The response structure of the API has changed | View Change Details |