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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeLayer4RulePolicy

要执行的操作。取值:DescribeLayer4RulePolicy

Listeners String [{\"InstanceId\":\"ddosDip-sg-4hr2b3l****\",\"FrontendPort\":2020,\"Protocol\":\"udp\"}]

要查询的端口转发规则。

该参数使用JSON数组转换的字符串表示。JSON数组的每个元素表示一个已创建的端口转发规则。一次最多可以查询1个端口转发规则。

说明 您可以调用DescribeNetworkRules查询所有已创建的端口转发规则。

每个端口转发规则包含以下字段:

  • InstanceId:String类型,必选,DDoS高防实例的ID。
  • Protocol:String类型,必选,端口转发协议类型。取值:tcpudp
  • FrontendPort:Integer类型,必选,转发端口。
RegionId String cn-hangzhou

DDoS高防实例所属地域ID。取值:

  • cn-hangzhou(默认):表示中国内地,即DDoS高防(新BGP)实例。
  • ap-southeast-1:表示非中国内地,即DDoS高防(国际)实例。

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

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

返回数据

名称 类型 示例值 描述
BackendPort Integer 2022

源站端口。

BakMode String 1

回源模式。取值:

  • 0:表示默认回源模式,即DDoS高防将业务流量转发到您调用CreateNetworkRules创建该端口转发规则时指定的源站IP。
  • 1:表示主备回源模式,即DDoS高防将业务流量转发到您调用ConfigLayer4RulePolicy设置的主源站IP地址或备源站IP地址。
CurrentIndex Integer 1

当前生效的源站类型。取值:

  • 1:表示主源站设置生效(DDoS高防将业务流量转发到主源站IP地址)。
  • 2:表示备源站设置生效(DDoS高防将业务流量转发到备源站IP地址)。
ForwardProtocol String udp

转发协议类型。

FrontendPort Integer 2020

转发端口。

InstanceId String ddosDip-sg-4hr2b3l****

DDoS高防实例的ID。

PriRealServers Array of PriRealServers

主源站信息,包括主源站IP地址、转发协议类型、转发端口等。

CurrentIndex Integer 1

当前生效的源站类型。取值:

  • 1:表示主源站设置生效(DDoS高防将业务流量转发到主源站IP地址)。
  • 2:表示备源站设置生效(DDoS高防将业务流量转发到备源站IP地址)。
Eip String 203.107.XX.XX

DDoS高防实例的IP。

FrontendPort Integer 2020

转发端口。

InstanceId String ddosDip-sg-4hr2b3l****

DDoS高防实例的ID。

Protocol String udp

转发协议类型。

RealServer String 192.0.2.1

主源站IP地址。

RequestId String 6E46CC51-36BE-1100-B14C-DAF8381B8F73

本次请求的ID。

SecRealServers Array of SecRealServers

备源站信息,包括备源站IP地址、转发协议类型、转发端口等。

CurrentIndex Integer 1

当前生效的源站类型。取值:

  • 1:表示主源站设置生效(DDoS高防将业务流量转发到主源站IP地址)。
  • 2:表示备源站设置生效(DDoS高防将业务流量转发到备源站IP地址)。
Eip String 203.107.XX.XX

DDoS高防实例的IP。

FrontendPort Integer 2020

转发端口。

InstanceId String ddosDip-sg-4hr2b3l****

DDoS高防实例的ID。

Protocol String udp

转发协议类型。

RealServer String 192.0.2.3

备源站IP地址。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeLayer4RulePolicy
&Listeners=[{\"InstanceId\":\"ddosDip-sg-4hr2b3l****\",\"FrontendPort\":2020,\"Protocol\":\"udp\"}]
&<公共请求参数>

正常返回示例

XML格式

<DescribeLayer4RulePolicyResponse>
	  <RequestId>BB95151E-FCAD-1C3C-872F-77166555E396</RequestId>
	  <InstanceId>ddosDip-sg-4hr2b3l****</InstanceId>
	  <BackendPort>2022</BackendPort>
	  <FrontendPort>2020</FrontendPort>
	  <CurrentIndex>1</CurrentIndex>
	  <bakMode>1</bakMode>
	  <ForwardProtocol>udp</ForwardProtocol>
	  <PriRealServers>
		    <RealServer>192.0.2.1</RealServer>
		    <InstanceId>ddosDip-sg-4hr2b3l****</InstanceId>
		    <FrontendPort>2020</FrontendPort>
		    <CurrentIndex>1</CurrentIndex>
		    <Protocol>udp</Protocol>
		    <Eip>203.107.XX.XX</Eip>
	  </PriRealServers>
	  <PriRealServers>
		    <RealServer>192.0.2.2</RealServer>
		    <InstanceId>ddosDip-sg-4hr2b3l****</InstanceId>
		    <FrontendPort>2020</FrontendPort>
		    <CurrentIndex>1</CurrentIndex>
		    <Protocol>udp</Protocol>
		    <Eip>203.107.XX.XX</Eip>
	  </PriRealServers>
	  <SecRealServers>
		    <RealServer>192.0.2.3</RealServer>
		    <InstanceId>ddosDip-sg-4hr2b3l****</InstanceId>
		    <FrontendPort>2020</FrontendPort>
		    <CurrentIndex>1</CurrentIndex>
		    <Protocol>udp</Protocol>
		    <Eip>203.107.XX.XX</Eip>
	  </SecRealServers>
	  <SecRealServers>
		    <RealServer>192.0.2.4</RealServer>
		    <InstanceId>ddosDip-sg-4hr2b3l****</InstanceId>
		    <FrontendPort>2020</FrontendPort>
		    <CurrentIndex>1</CurrentIndex>
		    <Protocol>udp</Protocol>
		    <Eip>203.107.XX.XX</Eip>
	  </SecRealServers>
</DescribeLayer4RulePolicyResponse>

JSON格式

{
    "RequestId": "BB95151E-FCAD-1C3C-872F-77166555E396",
    "InstanceId": "ddosDip-sg-4hr2b3l****",
    "BackendPort": 2022,
    "FrontendPort": 2020,
    "CurrentIndex": 1,
    "bakMode": 1,
    "ForwardProtocol": "udp",
    "PriRealServers": [
        {
            "RealServer": "192.0.2.1",
            "InstanceId": "ddosDip-sg-4hr2b3l****",
            "FrontendPort": 2020,
            "CurrentIndex": 1,
            "Protocol": "udp",
            "Eip": "203.107.XX.XX"
        },
        {
            "RealServer": "192.0.2.2",
            "InstanceId": "ddosDip-sg-4hr2b3l****",
            "FrontendPort": 2020,
            "CurrentIndex": 1,
            "Protocol": "udp",
            "Eip": "203.107.XX.XX"
        }
    ],
    "SecRealServers": [
        {
            "RealServer": "192.0.2.3",
            "InstanceId": "ddosDip-sg-4hr2b3l****",
            "FrontendPort": 2020,
            "CurrentIndex": 1,
            "Protocol": "udp",
            "Eip": "203.107.XX.XX"
        },
        {
            "RealServer": "192.0.2.4",
            "InstanceId": "ddosDip-sg-4hr2b3l****",
            "FrontendPort": 2020,
            "CurrentIndex": 1,
            "Protocol": "udp",
            "Eip": "203.107.XX.XX"
        }
    ]
}

错误码

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