文档

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

更新时间:

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Langstring

接收消息的语言类型。取值:

  • zh(默认):中文
  • en:英文
zh
FirewallIdstring

VPC 边界防火墙实例 ID。

vfw-tr-d5ba592ac6c84aff****
PageSizeinteger

分页查询时,显示的每页数据的最大条数。默认值为 10.

10
CurrentPageinteger

分页查询时的页码。默认值为 1。

1
PolicyIdstring

防火墙路由策略 ID。

policy-7b66257c14e141fb****

返回参数

名称类型描述示例值
object
TrFirewallRoutePoliciesobject []

防火墙路由策略列表。

PolicyTypestring

VPC 边界防火墙云企业网企业版引流场景类型。取值:

  • fullmesh:多点间互联

  • one_to_one:点到点

  • end_to_end:点到多点

fullmesh
PolicyNamestring

策略名称。

新加坡点到多点
PolicyDescriptionstring

策略描述。

点到多点
SrcCandidateListobject []

主引流实例列表。

CandidateIdstring

引流实例的 ID。

vpc-2ze9epancaw8t4sha****
CandidateTypestring

引流实例类型。

VPC
DestCandidateListobject []

子引流实例列表。

CandidateIdstring

引流实例的 ID。

vpc-2ze9epancaw8t4sha****
CandidateTypestring

引流实例类型。

VPC
TrFirewallRoutePolicyIdstring

防火墙路由策略 ID。

policy-7b66257c14e141fb****
PolicyStatusstring

策略状态。取值:

  • creating:创建中

  • deleting:删除中

  • opening:开启中

  • opened:已开启

  • closing:关闭中

  • closed:已关闭

opened
RequestIdstring

返回结果的请求 ID。

95EB5F3A-67FE-5780-92BD-5ECBA772AB7E
TotalCountstring

返回结果的总条数。

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"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-06-08OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:PolicyId
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈