public class L4ProxyRule extends AbstractModel
header, skipSign| Constructor and Description |
|---|
L4ProxyRule() |
L4ProxyRule(L4ProxyRule source)
NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
|
| Modifier and Type | Method and Description |
|---|---|
String |
getBuId()
Get BuID。
|
String |
getClientIPPassThroughMode()
Get 传递客户端 IP 的形式，取值有：
TOA：TOA（仅 Protocol = TCP 时可选）；
PPV1：Proxy Protocol 传递，协议版本 V1（仅 Protocol = TCP 时可选）；
PPV2：Proxy Protocol 传递，协议版本 V2；
SPP：Simple Proxy Protocol 传递，（仅 Protocol = UDP 时可选）；
OFF：不传递。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 OFF；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。
|
String |
getOriginPortRange()
Get 源站端口，支持按照以下形式填写：
单端口，如：80；
端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。
|
String |
getOriginType()
Get 源站类型，取值有：
IP_DOMAIN：IP/域名源站；
ORIGIN_GROUP：源站组；
LB：负载均衡，当前仅白名单开放。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。
|
String[] |
getOriginValue()
Get 源站地址：
当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ；
当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41；
当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。
|
String[] |
getPortRange()
Get 转发端口，支持按照以下形式填写：
单端口，如：80；
端口段，如：81-85。表示 81、82、83、84、85 五个端口。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。
|
String |
getProtocol()
Get 转发协议。取值有：
TCP：TCP 协议；
UDP：UDP 协议。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。
|
L4ProxyRemoteAuth |
getRemoteAuth()
Get 远程鉴权信息。
注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。
注意：此字段可能返回 null，表示取不到有效值。
|
String |
getRuleId()
Get 转发规则 ID。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。
|
String |
getRuleTag()
Get 规则标签。可输入1-50 个任意字符。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。
|
String |
getSessionPersist()
Get 是否开启会话保持，取值有：
on：开启；
off：关闭。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。
|
Long |
getSessionPersistTime()
Get 会话保持时间，取值范围为 30-3600，单位为秒。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。
|
String |
getStatus()
Get 规则状态，取值有：
online：已启用；
offline：已停用；
progress：部署中；
stopping：停用中；
fail：部署失败/停用失败。
注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。
|
void |
setBuId(String BuId)
Set BuID。
|
void |
setClientIPPassThroughMode(String ClientIPPassThroughMode)
Set 传递客户端 IP 的形式，取值有：
TOA：TOA（仅 Protocol = TCP 时可选）；
PPV1：Proxy Protocol 传递，协议版本 V1（仅 Protocol = TCP 时可选）；
PPV2：Proxy Protocol 传递，协议版本 V2；
SPP：Simple Proxy Protocol 传递，（仅 Protocol = UDP 时可选）；
OFF：不传递。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 OFF；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。
|
void |
setOriginPortRange(String OriginPortRange)
Set 源站端口，支持按照以下形式填写：
单端口，如：80；
端口段，如：81-85，表示 81、82、83、84、85 五个端口。填写端口段时，则需要与转发端口段长度保持一致，例如转发端口：80-90，则转发端口：90-100。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。
|
void |
setOriginType(String OriginType)
Set 源站类型，取值有：
IP_DOMAIN：IP/域名源站；
ORIGIN_GROUP：源站组；
LB：负载均衡，当前仅白名单开放。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。
|
void |
setOriginValue(String[] OriginValue)
Set 源站地址：
当 OriginType 为 IP_DOMAIN 时，填写 IP 或域名，如 8.8.8.8 或 test.com ；
当 OriginType 为 ORIGIN_GROUP 时，填写源站组 ID，如 og-537y24vf5b41；
当 OriginType 为 LB 时，填写负载均衡实例 ID，如 lb-2qwk30xf7s9g。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。
|
void |
setPortRange(String[] PortRange)
Set 转发端口，支持按照以下形式填写：
单端口，如：80；
端口段，如：81-85。表示 81、82、83、84、85 五个端口。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。
|
void |
setProtocol(String Protocol)
Set 转发协议。取值有：
TCP：TCP 协议；
UDP：UDP 协议。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数必填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写时表示不修改。
|
void |
setRemoteAuth(L4ProxyRemoteAuth RemoteAuth)
Set 远程鉴权信息。
注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。
注意：此字段可能返回 null，表示取不到有效值。
|
void |
setRuleId(String RuleId)
Set 转发规则 ID。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。
|
void |
setRuleTag(String RuleTag)
Set 规则标签。可输入1-50 个任意字符。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。
|
void |
setSessionPersist(String SessionPersist)
Set 是否开启会话保持，取值有：
on：开启；
off：关闭。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，不填写时默认为 off；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。
|
void |
setSessionPersistTime(Long SessionPersistTime)
Set 会话保持时间，取值范围为 30-3600，单位为秒。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。
|
void |
setStatus(String Status)
Set 规则状态，取值有：
online：已启用；
offline：已停用；
progress：部署中；
stopping：停用中；
fail：部署失败/停用失败。
注意：L4ProxyRule 在 CreateL4ProxyRules、ModifyL4ProxyRules 作为入参使用时，该参数请勿填写。
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonStringpublic L4ProxyRule()
public L4ProxyRule(L4ProxyRule source)
public String getRuleId()
public void setRuleId(String RuleId)
RuleId - 转发规则 ID。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数请勿填写；在 ModifyL4ProxyRules 作为入参使用时，该参数必填。public String getProtocol()
public void setProtocol(String Protocol)
Protocol - 转发协议。取值有：
public String[] getPortRange()
public void setPortRange(String[] PortRange)
PortRange - 转发端口，支持按照以下形式填写：
public String getOriginType()
public void setOriginType(String OriginType)
OriginType - 源站类型，取值有：
public String[] getOriginValue()
public void setOriginValue(String[] OriginValue)
OriginValue - 源站地址：
public String getOriginPortRange()
public void setOriginPortRange(String OriginPortRange)
OriginPortRange - 源站端口，支持按照以下形式填写：
public String getClientIPPassThroughMode()
public void setClientIPPassThroughMode(String ClientIPPassThroughMode)
ClientIPPassThroughMode - 传递客户端 IP 的形式，取值有：
public String getSessionPersist()
public void setSessionPersist(String SessionPersist)
SessionPersist - 是否开启会话保持，取值有：
public Long getSessionPersistTime()
public void setSessionPersistTime(Long SessionPersistTime)
SessionPersistTime - 会话保持时间，取值范围为 30-3600，单位为秒。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填，仅当 SessionPersist = on 时，该值才会生效，且当 SessionPersist = on ，该值不填写默认为 3600；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。public String getRuleTag()
public void setRuleTag(String RuleTag)
RuleTag - 规则标签。可输入1-50 个任意字符。
注意：L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时，该参数选填；在 ModifyL4ProxyRules 作为入参使用时，该参数选填，不填写表示不修改。public String getStatus()
public void setStatus(String Status)
Status - 规则状态，取值有：
public String getBuId()
public void setBuId(String BuId)
BuId - BuID。public L4ProxyRemoteAuth getRemoteAuth()
public void setRemoteAuth(L4ProxyRemoteAuth RemoteAuth)
RemoteAuth - 远程鉴权信息。
注意：RemoteAuth 在 CreateL4ProxyRules 或 ModifyL4ProxyRules 不可作为入参使用，如有传此参数，会忽略。在 DescribeL4ProxyRules 返回为空时，表示没有开启远程鉴权。
注意：此字段可能返回 null，表示取不到有效值。Copyright © 2025. All rights reserved.