DescribeTrFirewallV2RoutePolicyList - 获取TR防火墙路由策略列表 - 云防火墙

获取TR防火墙路由策略列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-cloudfirewall:DescribeTrFirewallV2RoutePolicyList	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	接收消息的语言类型。取值： zh（默认）：中文 en：英文	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>	防火墙路由策略列表。
	object	防火墙路由策略。
PolicyType	string	VPC 边界防火墙云企业网企业版引流场景类型。取值： fullmesh：多点间互联 one_to_one：点到点 end_to_end：点到多点	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	策略状态。取值： creating：创建中 deleting：删除中 opening：开启中 opened：已开启 closing：关闭中 closed：已关闭	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.	内部错误：数据库查询错误

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-06-08	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情