Class: TencentCloud::Teo::V20220901::L4ProxyRule

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20220901/models.rb

Overview

四层代理转发规则详情。

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ruleid = nil, protocol = nil, portrange = nil, origintype = nil, originvalue = nil, originportrange = nil, clientippassthroughmode = nil, sessionpersist = nil, sessionpersisttime = nil, ruletag = nil, status = nil, buid = nil, remoteauth = nil) ⇒ L4ProxyRule

Returns a new instance of L4ProxyRule.



14761
14762
14763
14764
14765
14766
14767
14768
14769
14770
14771
14772
14773
14774
14775
 
# File 'lib/v20220901/models.rb', line 14761

def initialize(ruleid=nil, protocol=nil, portrange=nil, origintype=nil, originvalue=nil, originportrange=nil, clientippassthroughmode=nil, sessionpersist=nil, sessionpersisttime=nil, ruletag=nil, status=nil, buid=nil, remoteauth=nil)
  @RuleId = ruleid
  @Protocol = protocol
  @PortRange = portrange
  @OriginType = origintype
  @OriginValue = originvalue
  @OriginPortRange = originportrange
  @ClientIPPassThroughMode = clientippassthroughmode
  @SessionPersist = sessionpersist
  @SessionPersistTime = sessionpersisttime
  @RuleTag = ruletag
  @Status = status
  @BuId = buid
  @RemoteAuth = remoteauth
end

Instance Attribute Details

#BuId ⇒ Object

注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。<li>TCP：TCP 协议；</li> <li>UDP：UDP 协议。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85。表示 81、82、83、84、85 五个端口。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>IP_DOMAIN：IP/域名源站；</li> <li>ORIGIN_GROUP：源站组；</li> <li>LB：负载均衡，当前仅白名单开放。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ；</li> <li>当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41；</li> <li>当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>TOA：TOA（仅 Protocol = TCP 时可选）；</li> <li>PPV1：Proxy Protocol 传递，协议版本 V1（仅 Protocol = TCP 时可选）；</li> <li>PPV2：Proxy Protocol 传递，协议版本 V2；</li> <li>SPP：Simple Proxy Protocol 传递，（仅 Protocol = UDP 时可选）；</li> <li>OFF：不传递。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 OFF；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>on：开启；</li> <li>off：关闭。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>online：已启用；</li> <li>offline：已停用；</li> <li>progress：部署中；</li> <li>stopping：停用中；</li> <li>fail：部署失败/停用失败。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • RuleId: —

    转发规则 ID。

  • Protocol: —

    转发协议。取值有：

  • PortRange: —

    转发端口，支持按照以下形式填写：

  • OriginType: —

    源站类型，取值有：

  • OriginValue: —

    源站地址：

  • OriginPortRange: —

    源站端口，支持按照以下形式填写：

  • ClientIPPassThroughMode: —

    传递客户端 IP 的形式，取值有：

  • SessionPersist: —

    是否开启会话保持，取值有：

  • SessionPersistTime: —

    会话保持时间，取值范围为 30-3600，单位为秒。

  • RuleTag: —

    规则标签。可输入1-50 个任意字符。

  • Status: —

    规则状态，取值有：

  • BuId: —

    BuID。

  • RemoteAuth: —

    远程鉴权信息。



14759
14760
14761
 
# File 'lib/v20220901/models.rb', line 14759

def BuId
  @BuId
end

#ClientIPPassThroughMode ⇒ Object

注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。<li>TCP：TCP 协议；</li> <li>UDP：UDP 协议。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85。表示 81、82、83、84、85 五个端口。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>IP_DOMAIN：IP/域名源站；</li> <li>ORIGIN_GROUP：源站组；</li> <li>LB：负载均衡，当前仅白名单开放。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ；</li> <li>当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41；</li> <li>当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>TOA：TOA（仅 Protocol = TCP 时可选）；</li> <li>PPV1：Proxy Protocol 传递，协议版本 V1（仅 Protocol = TCP 时可选）；</li> <li>PPV2：Proxy Protocol 传递，协议版本 V2；</li> <li>SPP：Simple Proxy Protocol 传递，（仅 Protocol = UDP 时可选）；</li> <li>OFF：不传递。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 OFF；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>on：开启；</li> <li>off：关闭。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>online：已启用；</li> <li>offline：已停用；</li> <li>progress：部署中；</li> <li>stopping：停用中；</li> <li>fail：部署失败/停用失败。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • RuleId: —

    转发规则 ID。

  • Protocol: —

    转发协议。取值有：

  • PortRange: —

    转发端口，支持按照以下形式填写：

  • OriginType: —

    源站类型，取值有：

  • OriginValue: —

    源站地址：

  • OriginPortRange: —

    源站端口，支持按照以下形式填写：

  • ClientIPPassThroughMode: —

    传递客户端 IP 的形式，取值有：

  • SessionPersist: —

    是否开启会话保持，取值有：

  • SessionPersistTime: —

    会话保持时间，取值范围为 30-3600，单位为秒。

  • RuleTag: —

    规则标签。可输入1-50 个任意字符。

  • Status: —

    规则状态，取值有：

  • BuId: —

    BuID。

  • RemoteAuth: —

    远程鉴权信息。



14759
14760
14761
 
# File 'lib/v20220901/models.rb', line 14759

def ClientIPPassThroughMode
  @ClientIPPassThroughMode
end

#OriginPortRange ⇒ Object

注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。<li>TCP：TCP 协议；</li> <li>UDP：UDP 协议。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85。表示 81、82、83、84、85 五个端口。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>IP_DOMAIN：IP/域名源站；</li> <li>ORIGIN_GROUP：源站组；</li> <li>LB：负载均衡，当前仅白名单开放。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ；</li> <li>当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41；</li> <li>当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>TOA：TOA（仅 Protocol = TCP 时可选）；</li> <li>PPV1：Proxy Protocol 传递，协议版本 V1（仅 Protocol = TCP 时可选）；</li> <li>PPV2：Proxy Protocol 传递，协议版本 V2；</li> <li>SPP：Simple Proxy Protocol 传递，（仅 Protocol = UDP 时可选）；</li> <li>OFF：不传递。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 OFF；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>on：开启；</li> <li>off：关闭。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>online：已启用；</li> <li>offline：已停用；</li> <li>progress：部署中；</li> <li>stopping：停用中；</li> <li>fail：部署失败/停用失败。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • RuleId: —

    转发规则 ID。

  • Protocol: —

    转发协议。取值有：

  • PortRange: —

    转发端口，支持按照以下形式填写：

  • OriginType: —

    源站类型，取值有：

  • OriginValue: —

    源站地址：

  • OriginPortRange: —

    源站端口，支持按照以下形式填写：

  • ClientIPPassThroughMode: —

    传递客户端 IP 的形式，取值有：

  • SessionPersist: —

    是否开启会话保持，取值有：

  • SessionPersistTime: —

    会话保持时间，取值范围为 30-3600，单位为秒。

  • RuleTag: —

    规则标签。可输入1-50 个任意字符。

  • Status: —

    规则状态，取值有：

  • BuId: —

    BuID。

  • RemoteAuth: —

    远程鉴权信息。



14759
14760
14761
 
# File 'lib/v20220901/models.rb', line 14759

def OriginPortRange
  @OriginPortRange
end

#OriginType ⇒ Object

注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。<li>TCP：TCP 协议；</li> <li>UDP：UDP 协议。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85。表示 81、82、83、84、85 五个端口。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>IP_DOMAIN：IP/域名源站；</li> <li>ORIGIN_GROUP：源站组；</li> <li>LB：负载均衡，当前仅白名单开放。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ；</li> <li>当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41；</li> <li>当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>TOA：TOA（仅 Protocol = TCP 时可选）；</li> <li>PPV1：Proxy Protocol 传递，协议版本 V1（仅 Protocol = TCP 时可选）；</li> <li>PPV2：Proxy Protocol 传递，协议版本 V2；</li> <li>SPP：Simple Proxy Protocol 传递，（仅 Protocol = UDP 时可选）；</li> <li>OFF：不传递。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 OFF；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>on：开启；</li> <li>off：关闭。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>online：已启用；</li> <li>offline：已停用；</li> <li>progress：部署中；</li> <li>stopping：停用中；</li> <li>fail：部署失败/停用失败。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • RuleId: —

    转发规则 ID。

  • Protocol: —

    转发协议。取值有：

  • PortRange: —

    转发端口，支持按照以下形式填写：

  • OriginType: —

    源站类型，取值有：

  • OriginValue: —

    源站地址：

  • OriginPortRange: —

    源站端口，支持按照以下形式填写：

  • ClientIPPassThroughMode: —

    传递客户端 IP 的形式，取值有：

  • SessionPersist: —

    是否开启会话保持，取值有：

  • SessionPersistTime: —

    会话保持时间，取值范围为 30-3600，单位为秒。

  • RuleTag: —

    规则标签。可输入1-50 个任意字符。

  • Status: —

    规则状态，取值有：

  • BuId: —

    BuID。

  • RemoteAuth: —

    远程鉴权信息。



14759
14760
14761
 
# File 'lib/v20220901/models.rb', line 14759

def OriginType
  @OriginType
end

#OriginValue ⇒ Object

注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。<li>TCP：TCP 协议；</li> <li>UDP：UDP 协议。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85。表示 81、82、83、84、85 五个端口。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>IP_DOMAIN：IP/域名源站；</li> <li>ORIGIN_GROUP：源站组；</li> <li>LB：负载均衡，当前仅白名单开放。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ；</li> <li>当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41；</li> <li>当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>TOA：TOA（仅 Protocol = TCP 时可选）；</li> <li>PPV1：Proxy Protocol 传递，协议版本 V1（仅 Protocol = TCP 时可选）；</li> <li>PPV2：Proxy Protocol 传递，协议版本 V2；</li> <li>SPP：Simple Proxy Protocol 传递，（仅 Protocol = UDP 时可选）；</li> <li>OFF：不传递。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 OFF；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>on：开启；</li> <li>off：关闭。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>online：已启用；</li> <li>offline：已停用；</li> <li>progress：部署中；</li> <li>stopping：停用中；</li> <li>fail：部署失败/停用失败。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • RuleId: —

    转发规则 ID。

  • Protocol: —

    转发协议。取值有：

  • PortRange: —

    转发端口，支持按照以下形式填写：

  • OriginType: —

    源站类型，取值有：

  • OriginValue: —

    源站地址：

  • OriginPortRange: —

    源站端口，支持按照以下形式填写：

  • ClientIPPassThroughMode: —

    传递客户端 IP 的形式，取值有：

  • SessionPersist: —

    是否开启会话保持，取值有：

  • SessionPersistTime: —

    会话保持时间，取值范围为 30-3600，单位为秒。

  • RuleTag: —

    规则标签。可输入1-50 个任意字符。

  • Status: —

    规则状态，取值有：

  • BuId: —

    BuID。

  • RemoteAuth: —

    远程鉴权信息。



14759
14760
14761
 
# File 'lib/v20220901/models.rb', line 14759

def OriginValue
  @OriginValue
end

#PortRange ⇒ Object

注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。<li>TCP：TCP 协议；</li> <li>UDP：UDP 协议。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85。表示 81、82、83、84、85 五个端口。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>IP_DOMAIN：IP/域名源站；</li> <li>ORIGIN_GROUP：源站组；</li> <li>LB：负载均衡，当前仅白名单开放。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ；</li> <li>当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41；</li> <li>当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>TOA：TOA（仅 Protocol = TCP 时可选）；</li> <li>PPV1：Proxy Protocol 传递，协议版本 V1（仅 Protocol = TCP 时可选）；</li> <li>PPV2：Proxy Protocol 传递，协议版本 V2；</li> <li>SPP：Simple Proxy Protocol 传递，（仅 Protocol = UDP 时可选）；</li> <li>OFF：不传递。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 OFF；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>on：开启；</li> <li>off：关闭。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>online：已启用；</li> <li>offline：已停用；</li> <li>progress：部署中；</li> <li>stopping：停用中；</li> <li>fail：部署失败/停用失败。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • RuleId: —

    转发规则 ID。

  • Protocol: —

    转发协议。取值有：

  • PortRange: —

    转发端口，支持按照以下形式填写：

  • OriginType: —

    源站类型，取值有：

  • OriginValue: —

    源站地址：

  • OriginPortRange: —

    源站端口，支持按照以下形式填写：

  • ClientIPPassThroughMode: —

    传递客户端 IP 的形式，取值有：

  • SessionPersist: —

    是否开启会话保持，取值有：

  • SessionPersistTime: —

    会话保持时间，取值范围为 30-3600，单位为秒。

  • RuleTag: —

    规则标签。可输入1-50 个任意字符。

  • Status: —

    规则状态，取值有：

  • BuId: —

    BuID。

  • RemoteAuth: —

    远程鉴权信息。



14759
14760
14761
 
# File 'lib/v20220901/models.rb', line 14759

def PortRange
  @PortRange
end

#Protocol ⇒ Object

注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。<li>TCP：TCP 协议；</li> <li>UDP：UDP 协议。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85。表示 81、82、83、84、85 五个端口。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>IP_DOMAIN：IP/域名源站；</li> <li>ORIGIN_GROUP：源站组；</li> <li>LB：负载均衡，当前仅白名单开放。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ；</li> <li>当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41；</li> <li>当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>TOA：TOA（仅 Protocol = TCP 时可选）；</li> <li>PPV1：Proxy Protocol 传递，协议版本 V1（仅 Protocol = TCP 时可选）；</li> <li>PPV2：Proxy Protocol 传递，协议版本 V2；</li> <li>SPP：Simple Proxy Protocol 传递，（仅 Protocol = UDP 时可选）；</li> <li>OFF：不传递。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 OFF；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>on：开启；</li> <li>off：关闭。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>online：已启用；</li> <li>offline：已停用；</li> <li>progress：部署中；</li> <li>stopping：停用中；</li> <li>fail：部署失败/停用失败。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • RuleId: —

    转发规则 ID。

  • Protocol: —

    转发协议。取值有：

  • PortRange: —

    转发端口，支持按照以下形式填写：

  • OriginType: —

    源站类型，取值有：

  • OriginValue: —

    源站地址：

  • OriginPortRange: —

    源站端口，支持按照以下形式填写：

  • ClientIPPassThroughMode: —

    传递客户端 IP 的形式，取值有：

  • SessionPersist: —

    是否开启会话保持，取值有：

  • SessionPersistTime: —

    会话保持时间，取值范围为 30-3600，单位为秒。

  • RuleTag: —

    规则标签。可输入1-50 个任意字符。

  • Status: —

    规则状态，取值有：

  • BuId: —

    BuID。

  • RemoteAuth: —

    远程鉴权信息。



14759
14760
14761
 
# File 'lib/v20220901/models.rb', line 14759

def Protocol
  @Protocol
end

#RemoteAuth ⇒ Object

注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。<li>TCP：TCP 协议；</li> <li>UDP：UDP 协议。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85。表示 81、82、83、84、85 五个端口。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>IP_DOMAIN：IP/域名源站；</li> <li>ORIGIN_GROUP：源站组；</li> <li>LB：负载均衡，当前仅白名单开放。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ；</li> <li>当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41；</li> <li>当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>TOA：TOA（仅 Protocol = TCP 时可选）；</li> <li>PPV1：Proxy Protocol 传递，协议版本 V1（仅 Protocol = TCP 时可选）；</li> <li>PPV2：Proxy Protocol 传递，协议版本 V2；</li> <li>SPP：Simple Proxy Protocol 传递，（仅 Protocol = UDP 时可选）；</li> <li>OFF：不传递。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 OFF；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>on：开启；</li> <li>off：关闭。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>online：已启用；</li> <li>offline：已停用；</li> <li>progress：部署中；</li> <li>stopping：停用中；</li> <li>fail：部署失败/停用失败。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • RuleId: —

    转发规则 ID。

  • Protocol: —

    转发协议。取值有：

  • PortRange: —

    转发端口，支持按照以下形式填写：

  • OriginType: —

    源站类型，取值有：

  • OriginValue: —

    源站地址：

  • OriginPortRange: —

    源站端口，支持按照以下形式填写：

  • ClientIPPassThroughMode: —

    传递客户端 IP 的形式，取值有：

  • SessionPersist: —

    是否开启会话保持，取值有：

  • SessionPersistTime: —

    会话保持时间，取值范围为 30-3600，单位为秒。

  • RuleTag: —

    规则标签。可输入1-50 个任意字符。

  • Status: —

    规则状态，取值有：

  • BuId: —

    BuID。

  • RemoteAuth: —

    远程鉴权信息。



14759
14760
14761
 
# File 'lib/v20220901/models.rb', line 14759

def RemoteAuth
  @RemoteAuth
end

#RuleId ⇒ Object

注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。<li>TCP：TCP 协议；</li> <li>UDP：UDP 协议。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85。表示 81、82、83、84、85 五个端口。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>IP_DOMAIN：IP/域名源站；</li> <li>ORIGIN_GROUP：源站组；</li> <li>LB：负载均衡，当前仅白名单开放。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ；</li> <li>当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41；</li> <li>当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>TOA：TOA（仅 Protocol = TCP 时可选）；</li> <li>PPV1：Proxy Protocol 传递，协议版本 V1（仅 Protocol = TCP 时可选）；</li> <li>PPV2：Proxy Protocol 传递，协议版本 V2；</li> <li>SPP：Simple Proxy Protocol 传递，（仅 Protocol = UDP 时可选）；</li> <li>OFF：不传递。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 OFF；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>on：开启；</li> <li>off：关闭。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>online：已启用；</li> <li>offline：已停用；</li> <li>progress：部署中；</li> <li>stopping：停用中；</li> <li>fail：部署失败/停用失败。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • RuleId: —

    转发规则 ID。

  • Protocol: —

    转发协议。取值有：

  • PortRange: —

    转发端口，支持按照以下形式填写：

  • OriginType: —

    源站类型，取值有：

  • OriginValue: —

    源站地址：

  • OriginPortRange: —

    源站端口，支持按照以下形式填写：

  • ClientIPPassThroughMode: —

    传递客户端 IP 的形式，取值有：

  • SessionPersist: —

    是否开启会话保持，取值有：

  • SessionPersistTime: —

    会话保持时间，取值范围为 30-3600，单位为秒。

  • RuleTag: —

    规则标签。可输入1-50 个任意字符。

  • Status: —

    规则状态，取值有：

  • BuId: —

    BuID。

  • RemoteAuth: —

    远程鉴权信息。



14759
14760
14761
 
# File 'lib/v20220901/models.rb', line 14759

def RuleId
  @RuleId
end

#RuleTag ⇒ Object

注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。<li>TCP：TCP 协议；</li> <li>UDP：UDP 协议。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85。表示 81、82、83、84、85 五个端口。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>IP_DOMAIN：IP/域名源站；</li> <li>ORIGIN_GROUP：源站组；</li> <li>LB：负载均衡，当前仅白名单开放。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ；</li> <li>当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41；</li> <li>当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>TOA：TOA（仅 Protocol = TCP 时可选）；</li> <li>PPV1：Proxy Protocol 传递，协议版本 V1（仅 Protocol = TCP 时可选）；</li> <li>PPV2：Proxy Protocol 传递，协议版本 V2；</li> <li>SPP：Simple Proxy Protocol 传递，（仅 Protocol = UDP 时可选）；</li> <li>OFF：不传递。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 OFF；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>on：开启；</li> <li>off：关闭。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>online：已启用；</li> <li>offline：已停用；</li> <li>progress：部署中；</li> <li>stopping：停用中；</li> <li>fail：部署失败/停用失败。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • RuleId: —

    转发规则 ID。

  • Protocol: —

    转发协议。取值有：

  • PortRange: —

    转发端口，支持按照以下形式填写：

  • OriginType: —

    源站类型，取值有：

  • OriginValue: —

    源站地址：

  • OriginPortRange: —

    源站端口，支持按照以下形式填写：

  • ClientIPPassThroughMode: —

    传递客户端 IP 的形式，取值有：

  • SessionPersist: —

    是否开启会话保持，取值有：

  • SessionPersistTime: —

    会话保持时间，取值范围为 30-3600，单位为秒。

  • RuleTag: —

    规则标签。可输入1-50 个任意字符。

  • Status: —

    规则状态，取值有：

  • BuId: —

    BuID。

  • RemoteAuth: —

    远程鉴权信息。



14759
14760
14761
 
# File 'lib/v20220901/models.rb', line 14759

def RuleTag
  @RuleTag
end

#SessionPersist ⇒ Object

注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。<li>TCP：TCP 协议；</li> <li>UDP：UDP 协议。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85。表示 81、82、83、84、85 五个端口。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>IP_DOMAIN：IP/域名源站；</li> <li>ORIGIN_GROUP：源站组；</li> <li>LB：负载均衡，当前仅白名单开放。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ；</li> <li>当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41；</li> <li>当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>TOA：TOA（仅 Protocol = TCP 时可选）；</li> <li>PPV1：Proxy Protocol 传递，协议版本 V1（仅 Protocol = TCP 时可选）；</li> <li>PPV2：Proxy Protocol 传递，协议版本 V2；</li> <li>SPP：Simple Proxy Protocol 传递，（仅 Protocol = UDP 时可选）；</li> <li>OFF：不传递。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 OFF；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>on：开启；</li> <li>off：关闭。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>online：已启用；</li> <li>offline：已停用；</li> <li>progress：部署中；</li> <li>stopping：停用中；</li> <li>fail：部署失败/停用失败。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • RuleId: —

    转发规则 ID。

  • Protocol: —

    转发协议。取值有：

  • PortRange: —

    转发端口，支持按照以下形式填写：

  • OriginType: —

    源站类型，取值有：

  • OriginValue: —

    源站地址：

  • OriginPortRange: —

    源站端口，支持按照以下形式填写：

  • ClientIPPassThroughMode: —

    传递客户端 IP 的形式，取值有：

  • SessionPersist: —

    是否开启会话保持，取值有：

  • SessionPersistTime: —

    会话保持时间，取值范围为 30-3600，单位为秒。

  • RuleTag: —

    规则标签。可输入1-50 个任意字符。

  • Status: —

    规则状态，取值有：

  • BuId: —

    BuID。

  • RemoteAuth: —

    远程鉴权信息。



14759
14760
14761
 
# File 'lib/v20220901/models.rb', line 14759

def SessionPersist
  @SessionPersist
end

#SessionPersistTime ⇒ Object

注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。<li>TCP：TCP 协议；</li> <li>UDP：UDP 协议。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85。表示 81、82、83、84、85 五个端口。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>IP_DOMAIN：IP/域名源站；</li> <li>ORIGIN_GROUP：源站组；</li> <li>LB：负载均衡，当前仅白名单开放。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ；</li> <li>当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41；</li> <li>当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>TOA：TOA（仅 Protocol = TCP 时可选）；</li> <li>PPV1：Proxy Protocol 传递，协议版本 V1（仅 Protocol = TCP 时可选）；</li> <li>PPV2：Proxy Protocol 传递，协议版本 V2；</li> <li>SPP：Simple Proxy Protocol 传递，（仅 Protocol = UDP 时可选）；</li> <li>OFF：不传递。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 OFF；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>on：开启；</li> <li>off：关闭。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>online：已启用；</li> <li>offline：已停用；</li> <li>progress：部署中；</li> <li>stopping：停用中；</li> <li>fail：部署失败/停用失败。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • RuleId: —

    转发规则 ID。

  • Protocol: —

    转发协议。取值有：

  • PortRange: —

    转发端口，支持按照以下形式填写：

  • OriginType: —

    源站类型，取值有：

  • OriginValue: —

    源站地址：

  • OriginPortRange: —

    源站端口，支持按照以下形式填写：

  • ClientIPPassThroughMode: —

    传递客户端 IP 的形式，取值有：

  • SessionPersist: —

    是否开启会话保持，取值有：

  • SessionPersistTime: —

    会话保持时间，取值范围为 30-3600，单位为秒。

  • RuleTag: —

    规则标签。可输入1-50 个任意字符。

  • Status: —

    规则状态，取值有：

  • BuId: —

    BuID。

  • RemoteAuth: —

    远程鉴权信息。



14759
14760
14761
 
# File 'lib/v20220901/models.rb', line 14759

def SessionPersistTime
  @SessionPersistTime
end

#Status ⇒ Object

注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。<li>TCP：TCP 协议；</li> <li>UDP：UDP 协议。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85。表示 81、82、83、84、85 五个端口。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>IP_DOMAIN：IP/域名源站；</li> <li>ORIGIN_GROUP：源站组；</li> <li>LB：负载均衡，当前仅白名单开放。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ；</li> <li>当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41；</li> <li>当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>单端口，如：80；</li> <li>端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。<li>TOA：TOA（仅 Protocol = TCP 时可选）；</li> <li>PPV1：Proxy Protocol 传递，协议版本 V1（仅 Protocol = TCP 时可选）；</li> <li>PPV2：Proxy Protocol 传递，协议版本 V2；</li> <li>SPP：Simple Proxy Protocol 传递，（仅 Protocol = UDP 时可选）；</li> <li>OFF：不传递。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 OFF；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>on：开启；</li> <li>off：关闭。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。<li>online：已启用；</li> <li>offline：已停用；</li> <li>progress：部署中；</li> <li>stopping：停用中；</li> <li>fail：部署失败/停用失败。</li> 注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • RuleId: —

    转发规则 ID。

  • Protocol: —

    转发协议。取值有：

  • PortRange: —

    转发端口，支持按照以下形式填写：

  • OriginType: —

    源站类型，取值有：

  • OriginValue: —

    源站地址：

  • OriginPortRange: —

    源站端口，支持按照以下形式填写：

  • ClientIPPassThroughMode: —

    传递客户端 IP 的形式，取值有：

  • SessionPersist: —

    是否开启会话保持，取值有：

  • SessionPersistTime: —

    会话保持时间，取值范围为 30-3600，单位为秒。

  • RuleTag: —

    规则标签。可输入1-50 个任意字符。

  • Status: —

    规则状态，取值有：

  • BuId: —

    BuID。

  • RemoteAuth: —

    远程鉴权信息。



14759
14760
14761
 
# File 'lib/v20220901/models.rb', line 14759

def Status
  @Status
end

Instance Method Details

#deserialize(params) ⇒ Object 



14777
14778
14779
14780
14781
14782
14783
14784
14785
14786
14787
14788
14789
14790
14791
14792
14793
14794
 
# File 'lib/v20220901/models.rb', line 14777

def deserialize(params)
  @RuleId = params['RuleId']
  @Protocol = params['Protocol']
  @PortRange = params['PortRange']
  @OriginType = params['OriginType']
  @OriginValue = params['OriginValue']
  @OriginPortRange = params['OriginPortRange']
  @ClientIPPassThroughMode = params['ClientIPPassThroughMode']
  @SessionPersist = params['SessionPersist']
  @SessionPersistTime = params['SessionPersistTime']
  @RuleTag = params['RuleTag']
  @Status = params['Status']
  @BuId = params['BuId']
  unless params['RemoteAuth'].nil?
    @RemoteAuth = L4ProxyRemoteAuth.new
    @RemoteAuth.deserialize(params['RemoteAuth'])
  end
end