调用DescribeLayer4Rules查询DDoS高防实例端口转发规则的详细配置。

调试

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

请求参数

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

要执行的操作。取值:DescribeLayer4Rules

InstanceId String ddoscoo-cn-zvp2ay9b****

要查询的DDoS高防实例的ID。

说明 您可以调用DescribeInstances查询所有DDoS高防实例的ID。
Offset Integer 1

分页查询时,返回第几页数据。最小值为1,表示返回第1页数据。

PageSize String 10

分页查询时,每页包含结果的数量。最大值为50,表示每页最多包含50个结果。

RegionId String cn-hangzhou

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

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

转发协议类型。取值:

  • tcp:表示TCP协议。
  • udp:表示UDP协议。
FrontendPort Integer 233

转发端口。

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

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

返回数据

名称 类型 示例值 描述
Listeners Array of Listener

端口转发规则的详细配置,包含转发端口、转发协议、源站地址等。

BackendPort Integer 233

源站端口。

BakMode Integer 0

回源模式。取值:

  • 0:表示默认回源模式。
  • 1:表示主备回源模式。
CurrentIndex Integer 1

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

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

DDoS高防实例的IP。

FrontendPort Integer 233

转发端口。

InstanceId String ddoscoo-cn-zvp2ay9b****

DDoS高防实例的ID。

IsAutoCreate Boolean false

该规则是否自动创建。取值:

  • true:表示该规则由DDoS高防自动创建。
  • false:表示该规则由您手动创建。
Protocol String tcp

转发协议类型。

RealServers List ["192.0.XX.XX"]

源站IP地址。

Remark String test-remark

该端口转发规则的备注。

RequestId String 949919A2-6636-1444-9213-AB27DD88AAA8

本次请求的ID。

Total Long 1

返回结果的数量。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeLayer4Rules
&InstanceId=ddoscoo-cn-zvp2ay9b****
&Offset=1
&PageSize=10
&<公共请求参数>

正常返回示例

XML格式

<DescribeLayer4RulesResponse>
	  <Listeners>
		    <IsAutoCreate>false</IsAutoCreate>
		    <InstanceId>ddoscoo-cn-zvp2ay9b****</InstanceId>
		    <BackendPort>233</BackendPort>
		    <BakMode>0</BakMode>
		    <RealServers>192.0.XX.XX</RealServers>
		    <FrontendPort>233</FrontendPort>
		    <CurrentIndex>1</CurrentIndex>
		    <Protocol>udp</Protocol>
		    <Eip>203.107.XX.XX</Eip>
		    <Remark>test-remark</Remark>
	  </Listeners>
	  <RequestId>949919A2-6636-1444-9213-AB27DD88AAA8</RequestId>
	  <Total>1</Total>
</DescribeLayer4RulesResponse>

JSON格式

{
    "Listeners": [
        {
            "IsAutoCreate": false,
            "InstanceId": "ddoscoo-cn-zvp2ay9b****",
            "BackendPort": 233,
            "BakMode": 0,
            "RealServers": [
                "192.0.XX.XX"
            ],
            "FrontendPort": 233,
            "CurrentIndex": 1,
            "Protocol": "udp",
            "Eip": "203.107.XX.XX",
            "Remark": "test-remark"
        }
    ],
    "RequestId": "949919A2-6636-1444-9213-AB27DD88AAA8",
    "Total": 1
}

错误码

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