GetTransportLayerApplication - 查询四层加速应用

更新时间:
复制为 MD 格式

查询四层应用详情。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

SiteId

integer

站点 ID,可通过调用 ListSites 接口获取。

123456****

ApplicationId

integer

应用 ID,可通过调用 ListTransportLayerApplications 接口获取。

170997271816****

返回参数

名称

类型

描述

示例值

object

请求响应。

RequestId

string

Id of the request

EB635996-1FD6-5DFD-BA57-27A849599940

SiteId

integer

站点 ID。

123456****

ApplicationId

integer

四层应用 ID。

17099311410****

RulesCount

integer

四层加速应用包含的转发规则数量。

1

Rules

array<object>

转发规则列表。

object

转发规则详情。

Source

string

源站具体的值,需要与源站类型相匹配。

1.1.1.1

Protocol

string

转发规则协议,取值:

  • TCP:TCP 协议。

  • UDP:UDP 协议。

TCP

EdgePort

string

边缘端口。支持:

  • 单个端口,例如 80。

  • 端口范围,例如 81-85,代表端口 81、82、83、84、85。

  • 端口和端口范围组合,端口、端口范围之间用逗号分隔,例如 80,81-85,90,代表端口 80、81、82、83、84、85、90。

80

SourceType

string

源站类型,支持:

  • ip: IP。

  • domain: 域名。

  • OP: 源地址池。

  • LB: 负载均衡器。

domain

SourcePort

string

源站端口。支持:

  • 单个端口,当源站端口为单个端口时,支持任意合法的边缘端口组合。

  • 端口范围,仅当边缘端口为端口段时,源站端口才允许设置为端口范围且范围大小需要与边缘端口一致。例如边缘端口若为 90-93,则不允许将源站端口设置为 81-85,因为源站端口范围为 5,边缘端口范围为 3,两者不一致。

80

ClientIPPassThroughMode

string

客户端 IP 传递协议,支持:

  • off: 不传递。

  • PPv1: PROXY Protocol v1 协议,支持 TCP 协议的客户端 IP 传递。

  • PPv2: PROXY Protocol v2 协议,支持 TCP 和 UDP 协议的客户端 IP 传递。

  • SPP: Simple Proxy Protocol 协议,支持 UDP 协议的客户端 IP 传递。

off

Comment

string

规则的备注信息。

测试

RuleId

integer

规则 ID。

1234323***

Cname

string

四层加速应用对应的 CNAME 域名。只有站点是 CNAME 方式接入时,该字段才不为空。

example.com.ialicdn.com

RecordName

string

四层应用的域名。

test.example.com

IpAccessRule

string

IP 访问规则开关,开启后,WAF 中的 IP 访问规则对四层应用生效。

  • on: 开启。

  • off:关闭。

枚举值:

  • off :

    off

  • on :

    on

on

Ipv6

string

Ipv6 开关。

枚举值:

  • off :

    off

  • on :

    on

on

Status

string

四层应用状态

  • deploying:部署中,在此状态下不允许修改和删除。

  • active:已生效。

枚举值:

  • deploying :

    deploying

  • active :

    active

active

CrossBorderOptimization

string

是否开启中国大陆网络接入优化,默认关闭。取值范围:

  • on:开启。

  • off:关闭。

枚举值:

  • off :

    off

  • on :

    on

on

StaticIp

string

StaticIpV4List

array<object>

object

Address

string

Status

string

示例

正常返回示例

JSON格式

{
  "RequestId": "EB635996-1FD6-5DFD-BA57-27A849599940",
  "SiteId": 0,
  "ApplicationId": 0,
  "RulesCount": 1,
  "Rules": [
    {
      "Source": "1.1.1.1",
      "Protocol": "TCP",
      "EdgePort": "80",
      "SourceType": "domain",
      "SourcePort": "80",
      "ClientIPPassThroughMode": "off",
      "Comment": "测试",
      "RuleId": 0
    }
  ],
  "Cname": "example.com.ialicdn.com",
  "RecordName": "test.example.com",
  "IpAccessRule": "on",
  "Ipv6": "on",
  "Status": "active",
  "CrossBorderOptimization": "on",
  "StaticIp": "",
  "StaticIpV4List": [
    {
      "Address": "",
      "Status": ""
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 InternalException Failed to call the service. Try again later or contact technical support. 调用服务失败,请稍后重试或联系客服咨询详情。
400 TransportLayerApplicationNotExist The layer -4 accelerated application of the current operation does not exist. Modify it and try again. 当前操作的四层加速应用不存在,请修改后重试。

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

变更历史

更多信息,参考变更详情