Queries the virtual private cloud (VPC) firewalls that are created for transit routers.
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:DescribeTrFirewallsV2List | get | *VpcCenTrFirewall acs:yundun-cloudfirewall::{#accountId}:vpccentrfirewall/{#FirewallId} |
| 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 transit router. | cn-hangzhou |
| 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 |
| CurrentPage | integer | No | The page number. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries per page. Default value: 10. | 10 |
| FirewallId | string | No | The instance ID of the VPC firewall. | vfw-tr-f1799baa9e254651**** |
| FirewallName | string | No | The name of the VPC firewall. | test |
| 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.
| managed |
| CenId | string | No | The ID of the Cloud Enterprise Network (CEN) instance. | cen-rig0t5zi96crkl**** |
| TransitRouterId | string | No | The ID of the transit router. | tr-uf6egtvyaedvt20xl**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"TotalCount": "6",
"RequestId": "1471E2EC-F706-5F11-A79B-BD583ACB8297",
"VpcTrFirewalls": [
{
"CenId": "cen-03f8s0z052ka3v****",
"CenName": "cen_swas",
"CloudFirewallVpcOrderType": "PayByCenOwner",
"FirewallId": "vfw-tr-99bc4f0fc88b4d00****",
"FirewallSwitchStatus": "opened",
"IpsConfig": {
"BasicRules": 1,
"EnableAllPatch": 1,
"RuleClass": 3,
"RunMode": 1
},
"OwnerId": 0,
"PrecheckStatus": "passed",
"ProtectedResource": {
"Count": 1,
"EcrList": [
"[\n \"ecr-d6yi3kl5qxmvkz****\"\n]"
],
"PeerTrList": [
"[\n \"tr-2zegxdvs5f2je81ph****\"\n]"
],
"VbrList": [
"[\n \"vbr-2zegxdvs5f2je81ph****\"\n]"
],
"VpcList": [
"[\"vpc-2zegxdvs5f2je81ph****\"]"
],
"VpnList": [
"[\n \"vpn-2zegxdvs5f2je81ph****\"\n]"
]
},
"RegionNo": "cn-hangzhou",
"RegionStatus": "enable",
"ResultCode": " RegionDisable",
"RouteMode": "managed",
"TransitRouterId": "tr-2vcmhjs88nil55fvu****",
"UnprotectedResource": {
"Count": 1,
"EcrList": [
"[\n \"ecr-d6yi3kl5qxmvkz****\"\n]"
],
"PeerTrList": [
"[\n \"tr-2zegxdvs5f2je81ph****\"\n]"
],
"VbrList": [
"[\n \"vbr-2zegxdvs5f2je81ph****\"\n]"
],
"VpcList": [
"[\n \"vpc-2zegxdvs5f2je81ph****\"\n]"
],
"VpnList": [
"[\n \"vpn-2zegxdvs5f2je81ph****\"\n]"
]
},
"VpcFirewallName": "test"
}
]
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | ErrorUserNotFound | User not found | The user does not exist. |
| 400 | ErrorUserCredentials | User credentials failed. | Unauthorized, not accessible, please first authorize firewall permissions. |
| 400 | ErrorDBTxError | A database transaction error occurred. | The error message returned because an internal error has occurred in the database transaction. |
| 400 | ErrorDBSelectError | A database select error occurred. | The error message returned because an internal error has occurred in querying the database. |
| 400 | ErrorUnMarshalJSON | internal error. | Internal Error |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-09-06 | API Description Update. The Error code has changed | View Change Details |
| 2024-08-15 | The response structure of the API has changed | View Change Details |
| 2023-06-13 | The response structure of the API has changed | View Change Details |