DescribeLayer4RulePolicy - 查询端口转发规则的回源设置 - DDoS 防护

查询端口转发规则的回源设置。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
Listeners	string	是	要查询的端口转发规则。该参数使用 JSON 数组转换的字符串表示。JSON 数组的每个元素表示一个已创建的端口转发规则。一次最多可以查询 1 个端口转发规则。说明您可以调用 DescribeNetworkRules 查询所有已创建的端口转发规则。每个端口转发规则包含以下字段： InstanceId：String 类型，必选，DDoS 高防实例的 ID。 Protocol：String 类型，必选，端口转发协议类型。取值：tcp、udp。 FrontendPort：Integer 类型，必选，转发端口。	[{\"InstanceId\":\"ddosDip-sg-4hr2b3l****\",\"FrontendPort\":2020,\"Protocol\":\"udp\"}]

调用 API 时，除了本文中该 API 的请求参数，还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍，请参见公共参数。

调用 API 的请求格式，请参见本文示例中的请求示例。

返回参数

名称	类型	描述	示例值
	object
FrontendPort	integer	转发端口。	2020
BakMode	string	回源模式。取值： 0：表示默认回源模式，即 DDoS 高防将业务流量转发到您调用 CreateNetworkRules 创建该端口转发规则时指定的源站 IP。 1：表示主备回源模式，即 DDoS 高防将业务流量转发到您调用 ConfigLayer4RulePolicy 设置的主源站 IP 地址或备源站 IP 地址。	1
RequestId	string	本次请求的 ID。	6E46CC51-36BE-1100-B14C-DAF8381B8F73
CurrentIndex	integer	当前生效的源站类型。取值： 1：表示主源站设置生效（DDoS 高防将业务流量转发到主源站 IP 地址）。 2：表示备源站设置生效（DDoS 高防将业务流量转发到备源站 IP 地址）。	1
ForwardProtocol	string	转发协议类型。	udp
InstanceId	string	DDoS 高防实例的 ID。	ddosDip-sg-4hr2b3l****
BackendPort	integer	源站端口。	2022
PriRealServers	array<object>	主源站信息，包括主源站 IP 地址、转发协议类型、转发端口等。
PriRealServers	object
FrontendPort	integer	转发端口。	2020
Eip	string	DDoS 高防实例的 IP。	203.107.XX.XX
Protocol	string	转发协议类型。	udp
CurrentIndex	integer	当前生效的源站类型。取值： 1：表示主源站设置生效（DDoS 高防将业务流量转发到主源站 IP 地址）。 2：表示备源站设置生效（DDoS 高防将业务流量转发到备源站 IP 地址）。	1
InstanceId	string	DDoS 高防实例的 ID。	ddosDip-sg-4hr2b3l****
RealServer	string	主源站 IP 地址。	192.0.2.1
SecRealServers	array<object>	备源站信息，包括备源站 IP 地址、转发协议类型、转发端口等。
SecRealServers	object
FrontendPort	integer	转发端口。	2020
Eip	string	DDoS 高防实例的 IP。	203.107.XX.XX
Protocol	string	转发协议类型。	udp
CurrentIndex	integer	当前生效的源站类型。取值： 1：表示主源站设置生效（DDoS 高防将业务流量转发到主源站 IP 地址）。 2：表示备源站设置生效（DDoS 高防将业务流量转发到备源站 IP 地址）。	1
InstanceId	string	DDoS 高防实例的 ID。	ddosDip-sg-4hr2b3l****
RealServer	string	备源站 IP 地址。	192.0.2.3

示例

正常返回示例

JSON格式

{
  "FrontendPort": 2020,
  "BakMode": "1",
  "RequestId": "6E46CC51-36BE-1100-B14C-DAF8381B8F73",
  "CurrentIndex": 1,
  "ForwardProtocol": "udp",
  "InstanceId": "ddosDip-sg-4hr2b3l****",
  "BackendPort": 2022,
  "PriRealServers": [
    {
      "FrontendPort": 2020,
      "Eip": "203.107.XX.XX",
      "Protocol": "udp",
      "CurrentIndex": 1,
      "InstanceId": "ddosDip-sg-4hr2b3l****",
      "RealServer": "192.0.2.1"
    }
  ],
  "SecRealServers": [
    {
      "FrontendPort": 2020,
      "Eip": "203.107.XX.XX",
      "Protocol": "udp",
      "CurrentIndex": 1,
      "InstanceId": "ddosDip-sg-4hr2b3l****",
      "RealServer": "192.0.2.3"
    }
  ]
}

JSON格式

{
  "FrontendPort": 2020,
  "BakMode": "1",
  "RequestId": "6E46CC51-36BE-1100-B14C-DAF8381B8F73",
  "CurrentIndex": 1,
  "ForwardProtocol": "udp",
  "InstanceId": "ddosDip-sg-4hr2b3l****",
  "BackendPort": 2022,
  "PriRealServers": [
    {
      "FrontendPort": 2020,
      "Eip": "203.107.XX.XX",
      "Protocol": "udp",
      "CurrentIndex": 1,
      "InstanceId": "ddosDip-sg-4hr2b3l****",
      "RealServer": "192.0.2.1"
    }
  ],
  "SecRealServers": [
    {
      "FrontendPort": 2020,
      "Eip": "203.107.XX.XX",
      "Protocol": "udp",
      "CurrentIndex": 1,
      "InstanceId": "ddosDip-sg-4hr2b3l****",
      "RealServer": "192.0.2.3"
    }
  ]
}

错误码

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