获取TR防火墙路由策略列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Lang |
string |
否 |
接收消息的语言类型。取值:
|
zh |
| FirewallId |
string |
否 |
VPC 边界防火墙实例 ID。 |
vfw-tr-d5ba592ac6c84aff**** |
| PageSize |
integer |
否 |
分页查询时,显示的每页数据的最大条数。默认值为 10. |
10 |
| CurrentPage |
integer |
否 |
分页查询时的页码。默认值为 1。 |
1 |
| PolicyId |
string |
否 |
防火墙路由策略 ID。 |
policy-7b66257c14e141fb**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| TrFirewallRoutePolicies |
array<object> |
防火墙路由策略列表。 |
|
|
array<object> |
防火墙路由策略。 |
||
| PolicyType |
string |
VPC 边界防火墙云企业网企业版引流场景类型。取值:
|
fullmesh |
| PolicyName |
string |
策略名称。 |
新加坡点到多点 |
| PolicyDescription |
string |
策略描述。 |
点到多点 |
| SrcCandidateList |
array<object> |
主引流实例列表。 |
|
|
object |
主引流实例。 |
||
| CandidateId |
string |
引流实例的 ID。 |
vpc-2ze9epancaw8t4sha**** |
| CandidateType |
string |
引流实例类型。 |
VPC |
| DestCandidateList |
array<object> |
子引流实例列表。 |
|
|
object |
子引流实例。 |
||
| CandidateId |
string |
引流实例的 ID。 |
vpc-2ze9epancaw8t4sha**** |
| CandidateType |
string |
引流实例类型。 |
VPC |
| TrFirewallRoutePolicyId |
string |
防火墙路由策略 ID。 |
policy-7b66257c14e141fb**** |
| PolicyStatus |
string |
策略状态。取值:
|
opened |
| RequestId |
string |
返回结果的请求 ID。 |
95EB5F3A-67FE-5780-92BD-5ECBA772AB7E |
| TotalCount |
string |
返回结果的总条数。 |
1 |
示例
正常返回示例
JSON格式
{
"TrFirewallRoutePolicies": [
{
"PolicyType": "fullmesh",
"PolicyName": "新加坡点到多点",
"PolicyDescription": "点到多点",
"SrcCandidateList": [
{
"CandidateId": "vpc-2ze9epancaw8t4sha****",
"CandidateType": "VPC"
}
],
"DestCandidateList": [
{
"CandidateId": "vpc-2ze9epancaw8t4sha****",
"CandidateType": "VPC"
}
],
"TrFirewallRoutePolicyId": "policy-7b66257c14e141fb****",
"PolicyStatus": "opened"
}
],
"RequestId": "95EB5F3A-67FE-5780-92BD-5ECBA772AB7E",
"TotalCount": "1"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | ErrorAliUid | Aliuid invalid. | aliuid无效 |
| 400 | ErrorParameters | Error Parameters | 参数错误 |
| 400 | ErrorAuthentication | authentication error | 鉴权失败 |
| 400 | ErrorDBSelectError | A database select error occurred. | 内部错误:数据库查询错误 |
| 400 | ErrorTrFirewallNotExist | Cen TR firewall not exist | 云企业网企业版防火墙不存在 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。