tencentcloud-sdk-python 3.0.1373__py2.py3-none-any.whl → 3.0.1374__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/aiart/v20221229/models.py +2 -0
  3. tencentcloud/cbs/v20170312/models.py +27 -2
  4. tencentcloud/chc/v20230418/models.py +84 -2
  5. tencentcloud/ckafka/v20190819/models.py +0 -24
  6. tencentcloud/clb/v20180317/clb_client.py +14 -14
  7. tencentcloud/clb/v20180317/models.py +289 -164
  8. tencentcloud/cvm/v20170312/models.py +2 -2
  9. tencentcloud/cynosdb/v20190107/models.py +15 -15
  10. tencentcloud/dlc/v20210125/models.py +30 -0
  11. tencentcloud/domain/v20180808/domain_client.py +4 -0
  12. tencentcloud/domain/v20180808/errorcodes.py +3 -0
  13. tencentcloud/domain/v20180808/models.py +184 -78
  14. tencentcloud/es/v20250101/es_client.py +4 -2
  15. tencentcloud/es/v20250101/models.py +70 -70
  16. tencentcloud/iss/v20230517/models.py +0 -40
  17. tencentcloud/lowcode/v20210108/models.py +17 -2
  18. tencentcloud/tke/v20180525/models.py +72 -72
  19. tencentcloud/tsf/v20180326/errorcodes.py +3 -0
  20. tencentcloud/tsf/v20180326/models.py +2 -2
  21. tencentcloud/vod/v20180717/models.py +15 -0
  22. tencentcloud/vpc/v20170312/errorcodes.py +12 -0
  23. tencentcloud/vpc/v20170312/models.py +142 -118
  24. tencentcloud/vpc/v20170312/vpc_client.py +10 -10
  25. tencentcloud/wedata/v20210820/models.py +30 -0
  26. tencentcloud/wedata/v20210820/wedata_client.py +4 -4
  27. {tencentcloud_sdk_python-3.0.1373.dist-info → tencentcloud_sdk_python-3.0.1374.dist-info}/METADATA +1 -1
  28. {tencentcloud_sdk_python-3.0.1373.dist-info → tencentcloud_sdk_python-3.0.1374.dist-info}/RECORD +31 -31
  29. {tencentcloud_sdk_python-3.0.1373.dist-info → tencentcloud_sdk_python-3.0.1374.dist-info}/LICENSE +0 -0
  30. {tencentcloud_sdk_python-3.0.1373.dist-info → tencentcloud_sdk_python-3.0.1374.dist-info}/WHEEL +0 -0
  31. {tencentcloud_sdk_python-3.0.1373.dist-info → tencentcloud_sdk_python-3.0.1374.dist-info}/top_level.txt +0 -0
@@ -769,7 +769,7 @@ class BasicTargetGroupInfo(AbstractModel):
769
769
  :type TargetGroupId: str
770
770
  :param _TargetGroupName: 目标组名称
771
771
  :type TargetGroupName: str
772
- :param _Weight: 权重
772
+ :param _Weight: 目标组权重
773
773
  :type Weight: int
774
774
  """
775
775
  self._TargetGroupId = None
@@ -800,7 +800,7 @@ class BasicTargetGroupInfo(AbstractModel):
800
800
 
801
801
  @property
802
802
  def Weight(self):
803
- """权重
803
+ """目标组权重
804
804
  :rtype: int
805
805
  """
806
806
  return self._Weight
@@ -1797,11 +1797,12 @@ class CertificateInput(AbstractModel):
1797
1797
 
1798
1798
  def __init__(self):
1799
1799
  r"""
1800
- :param _SSLMode: 认证类型,UNIDIRECTIONAL:单向认证,MUTUAL:双向认证
1800
+ :param _SSLMode: 认证类型,UNIDIRECTIONAL:单向认证,MUTUAL:双向认证。
1801
+ 默认为 UNIDIRECTIONAL。
1801
1802
  :type SSLMode: str
1802
1803
  :param _SSLVerifyClient: 双向认证时,是否开启客户端认证,ON:开启,OPTIONAL:自适应,默认ON。
1803
1804
  :type SSLVerifyClient: str
1804
- :param _CertId: 服务端证书的 ID,如果不填写此项则必须上传证书,包括 CertContentCertKeyCertName
1805
+ :param _CertId: 服务端证书的 ID,如果不填写此项则必须上传证书,包括 CertContent(服务端证书内容),CertKey(服务端证书密钥),CertName(服务端证书名称)。
1805
1806
  :type CertId: str
1806
1807
  :param _CertCaId: 客户端证书的 ID,当监听器采用双向认证,即 SSLMode=MUTUAL 时,如果不填写此项则必须上传客户端证书,包括 CertCaContent,CertCaName。
1807
1808
  :type CertCaId: str
@@ -1828,7 +1829,8 @@ class CertificateInput(AbstractModel):
1828
1829
 
1829
1830
  @property
1830
1831
  def SSLMode(self):
1831
- """认证类型,UNIDIRECTIONAL:单向认证,MUTUAL:双向认证
1832
+ """认证类型,UNIDIRECTIONAL:单向认证,MUTUAL:双向认证。
1833
+ 默认为 UNIDIRECTIONAL。
1832
1834
  :rtype: str
1833
1835
  """
1834
1836
  return self._SSLMode
@@ -1850,7 +1852,7 @@ class CertificateInput(AbstractModel):
1850
1852
 
1851
1853
  @property
1852
1854
  def CertId(self):
1853
- """服务端证书的 ID,如果不填写此项则必须上传证书,包括 CertContentCertKeyCertName
1855
+ """服务端证书的 ID,如果不填写此项则必须上传证书,包括 CertContent(服务端证书内容),CertKey(服务端证书密钥),CertName(服务端证书名称)。
1854
1856
  :rtype: str
1855
1857
  """
1856
1858
  return self._CertId
@@ -2666,20 +2668,20 @@ class CloneLoadBalancerRequest(AbstractModel):
2666
2668
 
2667
2669
  def __init__(self):
2668
2670
  r"""
2669
- :param _LoadBalancerId: 负载均衡ID
2671
+ :param _LoadBalancerId: 负载均衡ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
2670
2672
  :type LoadBalancerId: str
2671
2673
  :param _LoadBalancerName: 克隆出负载均衡实例的名称,规则:1-60 个英文、汉字、数字、连接线“-”或下划线“_”。
2672
2674
  注意:如果名称与系统中已有负载均衡实例的名称相同,则系统将会自动生成此次创建的负载均衡实例的名称。
2673
2675
  :type LoadBalancerName: str
2674
- :param _ProjectId: 负载均衡实例所属的项目 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。不传此参数则视为默认项目。
2676
+ :param _ProjectId: 负载均衡实例所属的项目 ID,默认项目 ID 为0,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。不传此参数则视为默认项目。
2675
2677
  :type ProjectId: int
2676
- :param _MasterZoneId: 仅适用于公网负载均衡。设置跨可用区容灾时的主可用区ID,例如 100001 或 ap-guangzhou-1
2678
+ :param _MasterZoneId: 仅适用于公网负载均衡。设置跨可用区容灾时的主可用区ID,可用区 ID 和名称均支持,例如 100001 或 ap-guangzhou-1
2677
2679
  注:主可用区是需要承载流量的可用区,备可用区默认不承载流量,主可用区不可用时才使用备可用区,平台将为您自动选择最佳备可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主可用区的列表。
2678
2680
  :type MasterZoneId: str
2679
- :param _SlaveZoneId: 仅适用于公网负载均衡。设置跨可用区容灾时的备可用区ID,例如 100001 或 ap-guangzhou-1
2681
+ :param _SlaveZoneId: 仅适用于公网负载均衡。设置跨可用区容灾时的备可用区ID,可用区 ID 和名称均支持,例如 100001 或 ap-guangzhou-1
2680
2682
  注:备可用区是主可用区故障后,需要承载流量的可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主/备可用区的列表。
2681
2683
  :type SlaveZoneId: str
2682
- :param _ZoneId: 仅适用于公网负载均衡。可用区ID,指定可用区以创建负载均衡实例。如:ap-guangzhou-1。不传则查询所有可用区的 CVM 实例。如需指定可用区,可调用查询可用区列表[DescribeZones](https://cloud.tencent.com/document/product/213/15707)接口查询。
2684
+ :param _ZoneId: 仅适用于公网负载均衡。可用区ID,可用区 ID 和名称均支持,指定可用区以创建负载均衡实例。如:100001 或 ap-guangzhou-1。不传则查询所有可用区的 CVM 实例。如需指定可用区,可调用查询可用区列表 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 接口查询。
2683
2685
  :type ZoneId: str
2684
2686
  :param _InternetAccessible: 仅适用于公网负载均衡。负载均衡的网络计费模式。
2685
2687
  :type InternetAccessible: :class:`tencentcloud.clb.v20180317.models.InternetAccessible`
@@ -2691,13 +2693,13 @@ class CloneLoadBalancerRequest(AbstractModel):
2691
2693
  :type Tags: list of TagInfo
2692
2694
  :param _ExclusiveCluster: 独占集群信息。
2693
2695
  :type ExclusiveCluster: :class:`tencentcloud.clb.v20180317.models.ExclusiveCluster`
2694
- :param _BandwidthPackageId: 带宽包ID,指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE)。
2696
+ :param _BandwidthPackageId: 带宽包ID,可以通过 [DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209) 接口获取。指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE)。
2695
2697
  :type BandwidthPackageId: str
2696
2698
  :param _SnatPro: 是否支持绑定跨地域/跨Vpc绑定IP的功能。
2697
2699
  :type SnatPro: bool
2698
2700
  :param _SnatIps: 开启绑定跨地域/跨Vpc绑定IP的功能后,创建SnatIp。
2699
2701
  :type SnatIps: list of SnatIp
2700
- :param _ClusterIds: 公网独占集群ID或者CDCId
2702
+ :param _ClusterIds: 公网独占集群ID或者CDCId,可以通过 [DescribeExclusiveClusters](https://cloud.tencent.com/document/product/214/49278) 接口获取。
2701
2703
  :type ClusterIds: list of str
2702
2704
  :param _SlaType: 性能容量型规格。<li>clb.c2.medium(标准型)</li><li>clb.c3.small(高阶型1)</li><li>clb.c3.medium(高阶型2)</li><li>clb.c4.small(超强型1)</li><li>clb.c4.medium(超强型2)</li><li>clb.c4.large(超强型3)</li><li>clb.c4.xlarge(超强型4)</li>
2703
2705
  :type SlaType: str
@@ -2705,7 +2707,7 @@ class CloneLoadBalancerRequest(AbstractModel):
2705
2707
  :type ClusterTag: str
2706
2708
  :param _Zones: 仅适用于私有网络内网负载均衡。内网就近接入时,选择可用区下发。可调用[DescribeZones](https://cloud.tencent.com/document/product/213/15707)接口查询可用区列表。
2707
2709
  :type Zones: list of str
2708
- :param _EipAddressId: EIP 的唯一 ID,形如:eip-11112222,仅适用于内网负载均衡绑定EIP
2710
+ :param _EipAddressId: EIP 的唯一 ID,形如:eip-qhx8udkc,仅适用于内网负载均衡绑定EIP,可以通过 [DescribeAddresses](https://cloud.tencent.com/document/product/215/16702) 接口查询。
2709
2711
  :type EipAddressId: str
2710
2712
  """
2711
2713
  self._LoadBalancerId = None
@@ -2730,7 +2732,7 @@ class CloneLoadBalancerRequest(AbstractModel):
2730
2732
 
2731
2733
  @property
2732
2734
  def LoadBalancerId(self):
2733
- """负载均衡ID
2735
+ """负载均衡ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
2734
2736
  :rtype: str
2735
2737
  """
2736
2738
  return self._LoadBalancerId
@@ -2753,7 +2755,7 @@ class CloneLoadBalancerRequest(AbstractModel):
2753
2755
 
2754
2756
  @property
2755
2757
  def ProjectId(self):
2756
- """负载均衡实例所属的项目 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。不传此参数则视为默认项目。
2758
+ """负载均衡实例所属的项目 ID,默认项目 ID 为0,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。不传此参数则视为默认项目。
2757
2759
  :rtype: int
2758
2760
  """
2759
2761
  return self._ProjectId
@@ -2764,7 +2766,7 @@ class CloneLoadBalancerRequest(AbstractModel):
2764
2766
 
2765
2767
  @property
2766
2768
  def MasterZoneId(self):
2767
- """仅适用于公网负载均衡。设置跨可用区容灾时的主可用区ID,例如 100001 或 ap-guangzhou-1
2769
+ """仅适用于公网负载均衡。设置跨可用区容灾时的主可用区ID,可用区 ID 和名称均支持,例如 100001 或 ap-guangzhou-1
2768
2770
  注:主可用区是需要承载流量的可用区,备可用区默认不承载流量,主可用区不可用时才使用备可用区,平台将为您自动选择最佳备可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主可用区的列表。
2769
2771
  :rtype: str
2770
2772
  """
@@ -2776,7 +2778,7 @@ class CloneLoadBalancerRequest(AbstractModel):
2776
2778
 
2777
2779
  @property
2778
2780
  def SlaveZoneId(self):
2779
- """仅适用于公网负载均衡。设置跨可用区容灾时的备可用区ID,例如 100001 或 ap-guangzhou-1
2781
+ """仅适用于公网负载均衡。设置跨可用区容灾时的备可用区ID,可用区 ID 和名称均支持,例如 100001 或 ap-guangzhou-1
2780
2782
  注:备可用区是主可用区故障后,需要承载流量的可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主/备可用区的列表。
2781
2783
  :rtype: str
2782
2784
  """
@@ -2788,7 +2790,7 @@ class CloneLoadBalancerRequest(AbstractModel):
2788
2790
 
2789
2791
  @property
2790
2792
  def ZoneId(self):
2791
- """仅适用于公网负载均衡。可用区ID,指定可用区以创建负载均衡实例。如:ap-guangzhou-1。不传则查询所有可用区的 CVM 实例。如需指定可用区,可调用查询可用区列表[DescribeZones](https://cloud.tencent.com/document/product/213/15707)接口查询。
2793
+ """仅适用于公网负载均衡。可用区ID,可用区 ID 和名称均支持,指定可用区以创建负载均衡实例。如:100001 或 ap-guangzhou-1。不传则查询所有可用区的 CVM 实例。如需指定可用区,可调用查询可用区列表 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 接口查询。
2792
2794
  :rtype: str
2793
2795
  """
2794
2796
  return self._ZoneId
@@ -2854,7 +2856,7 @@ class CloneLoadBalancerRequest(AbstractModel):
2854
2856
 
2855
2857
  @property
2856
2858
  def BandwidthPackageId(self):
2857
- """带宽包ID,指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE)。
2859
+ """带宽包ID,可以通过 [DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209) 接口获取。指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE)。
2858
2860
  :rtype: str
2859
2861
  """
2860
2862
  return self._BandwidthPackageId
@@ -2887,7 +2889,7 @@ class CloneLoadBalancerRequest(AbstractModel):
2887
2889
 
2888
2890
  @property
2889
2891
  def ClusterIds(self):
2890
- """公网独占集群ID或者CDCId
2892
+ """公网独占集群ID或者CDCId,可以通过 [DescribeExclusiveClusters](https://cloud.tencent.com/document/product/214/49278) 接口获取。
2891
2893
  :rtype: list of str
2892
2894
  """
2893
2895
  return self._ClusterIds
@@ -2931,7 +2933,7 @@ class CloneLoadBalancerRequest(AbstractModel):
2931
2933
 
2932
2934
  @property
2933
2935
  def EipAddressId(self):
2934
- """EIP 的唯一 ID,形如:eip-11112222,仅适用于内网负载均衡绑定EIP
2936
+ """EIP 的唯一 ID,形如:eip-qhx8udkc,仅适用于内网负载均衡绑定EIP,可以通过 [DescribeAddresses](https://cloud.tencent.com/document/product/215/16702) 接口查询。
2935
2937
  :rtype: str
2936
2938
  """
2937
2939
  return self._EipAddressId
@@ -3945,9 +3947,10 @@ class CreateListenerRequest(AbstractModel):
3945
3947
 
3946
3948
  def __init__(self):
3947
3949
  r"""
3948
- :param _LoadBalancerId: 负载均衡实例 ID
3950
+ :param _LoadBalancerId: 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
3949
3951
  :type LoadBalancerId: str
3950
3952
  :param _Ports: 要将监听器创建到哪些端口,每个端口对应一个新的监听器。
3953
+ 端口范围:1~65535
3951
3954
  :type Ports: list of int
3952
3955
  :param _Protocol: 监听器协议: TCP | UDP | HTTP | HTTPS | TCP_SSL | QUIC。
3953
3956
  :type Protocol: str
@@ -3959,10 +3962,10 @@ class CreateListenerRequest(AbstractModel):
3959
3962
  <li>此参数仅适用于TCP_SSL监听器和未开启SNI特性的HTTPS监听器。</li>
3960
3963
  <li>创建TCP_SSL监听器和未开启SNI特性的HTTPS监听器时,此参数和参数MultiCertInfo至少需要传一个, 但不能同时传入。</li>
3961
3964
  :type Certificate: :class:`tencentcloud.clb.v20180317.models.CertificateInput`
3962
- :param _SessionExpireTime: 会话保持时间,单位:秒。可选值:30~3600,默认 0,表示不开启。此参数仅适用于TCP/UDP监听器。
3965
+ :param _SessionExpireTime: 会话保持时间,单位:秒。可选值:30~3600,默认为0,默认不开启。此参数仅适用于TCP/UDP监听器。
3963
3966
  :type SessionExpireTime: int
3964
- :param _Scheduler: 监听器转发的方式。可选值:WRRLEAST_CONN
3965
- 分别表示按权重轮询、最小连接数, 默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL/QUIC监听器。
3967
+ :param _Scheduler: 监听器转发的方式。可选值:WRR(按权重轮询)、LEAST_CONN(按最小连接数)、IP_HASH(按 IP 地址哈希)
3968
+ 默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL/QUIC监听器。
3966
3969
  :type Scheduler: str
3967
3970
  :param _SniSwitch: 是否开启SNI特性,此参数仅适用于HTTPS监听器。0表示未开启,1表示开启。
3968
3971
  :type SniSwitch: int
@@ -3985,17 +3988,17 @@ class CreateListenerRequest(AbstractModel):
3985
3988
  :type MaxConn: int
3986
3989
  :param _MaxCps: 监听器最大新增连接数,当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持,不传或者传-1表示监听器维度不限速。基础网络实例不支持该参数。
3987
3990
  :type MaxCps: int
3988
- :param _IdleConnectTimeout: 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。取值范围:共享型实例和独占型实例支持:300-900,性能容量型实例支持:300-2000。如需设置请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)。
3991
+ :param _IdleConnectTimeout: 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。取值范围:共享型实例和独占型实例支持:300-900,性能容量型实例支持:300-1980。如需设置请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)。
3989
3992
  :type IdleConnectTimeout: int
3990
- :param _SnatEnable: 是否开启SNAT
3993
+ :param _SnatEnable: 是否开启SNAT,True(开启)、False(关闭)
3991
3994
  :type SnatEnable: bool
3992
- :param _FullEndPorts: 全端口段监听器的结束端口
3995
+ :param _FullEndPorts: 全端口段监听器的结束端口,端口范围:2 - 65535
3993
3996
  :type FullEndPorts: list of int
3994
- :param _H2cSwitch: 内网http监听器开启h2c开关
3997
+ :param _H2cSwitch: 内网http监听器开启h2c开关,True(开启)、False(关闭)
3995
3998
  :type H2cSwitch: bool
3996
- :param _SslCloseSwitch: TCP_SSL监听器支持关闭SSL后仍然支持混绑,此参数为关闭开关
3999
+ :param _SslCloseSwitch: TCP_SSL监听器支持关闭SSL后仍然支持混绑,此参数为关闭开关。True(关闭)、False(开启)
3997
4000
  :type SslCloseSwitch: bool
3998
- :param _DataCompressMode: 数据压缩模式
4001
+ :param _DataCompressMode: 数据压缩模式。可选值:transparent(透传模式)、compatibility(兼容模式)
3999
4002
  :type DataCompressMode: str
4000
4003
  """
4001
4004
  self._LoadBalancerId = None
@@ -4024,7 +4027,7 @@ class CreateListenerRequest(AbstractModel):
4024
4027
 
4025
4028
  @property
4026
4029
  def LoadBalancerId(self):
4027
- """负载均衡实例 ID
4030
+ """负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
4028
4031
  :rtype: str
4029
4032
  """
4030
4033
  return self._LoadBalancerId
@@ -4036,6 +4039,7 @@ class CreateListenerRequest(AbstractModel):
4036
4039
  @property
4037
4040
  def Ports(self):
4038
4041
  """要将监听器创建到哪些端口,每个端口对应一个新的监听器。
4042
+ 端口范围:1~65535
4039
4043
  :rtype: list of int
4040
4044
  """
4041
4045
  return self._Ports
@@ -4092,7 +4096,7 @@ class CreateListenerRequest(AbstractModel):
4092
4096
 
4093
4097
  @property
4094
4098
  def SessionExpireTime(self):
4095
- """会话保持时间,单位:秒。可选值:30~3600,默认 0,表示不开启。此参数仅适用于TCP/UDP监听器。
4099
+ """会话保持时间,单位:秒。可选值:30~3600,默认为0,默认不开启。此参数仅适用于TCP/UDP监听器。
4096
4100
  :rtype: int
4097
4101
  """
4098
4102
  return self._SessionExpireTime
@@ -4103,8 +4107,8 @@ class CreateListenerRequest(AbstractModel):
4103
4107
 
4104
4108
  @property
4105
4109
  def Scheduler(self):
4106
- """监听器转发的方式。可选值:WRRLEAST_CONN
4107
- 分别表示按权重轮询、最小连接数, 默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL/QUIC监听器。
4110
+ """监听器转发的方式。可选值:WRR(按权重轮询)、LEAST_CONN(按最小连接数)、IP_HASH(按 IP 地址哈希)
4111
+ 默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL/QUIC监听器。
4108
4112
  :rtype: str
4109
4113
  """
4110
4114
  return self._Scheduler
@@ -4217,7 +4221,7 @@ class CreateListenerRequest(AbstractModel):
4217
4221
 
4218
4222
  @property
4219
4223
  def IdleConnectTimeout(self):
4220
- """空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。取值范围:共享型实例和独占型实例支持:300-900,性能容量型实例支持:300-2000。如需设置请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)。
4224
+ """空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。取值范围:共享型实例和独占型实例支持:300-900,性能容量型实例支持:300-1980。如需设置请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)。
4221
4225
  :rtype: int
4222
4226
  """
4223
4227
  return self._IdleConnectTimeout
@@ -4228,7 +4232,7 @@ class CreateListenerRequest(AbstractModel):
4228
4232
 
4229
4233
  @property
4230
4234
  def SnatEnable(self):
4231
- """是否开启SNAT
4235
+ """是否开启SNAT,True(开启)、False(关闭)
4232
4236
  :rtype: bool
4233
4237
  """
4234
4238
  return self._SnatEnable
@@ -4239,7 +4243,7 @@ class CreateListenerRequest(AbstractModel):
4239
4243
 
4240
4244
  @property
4241
4245
  def FullEndPorts(self):
4242
- """全端口段监听器的结束端口
4246
+ """全端口段监听器的结束端口,端口范围:2 - 65535
4243
4247
  :rtype: list of int
4244
4248
  """
4245
4249
  return self._FullEndPorts
@@ -4250,7 +4254,7 @@ class CreateListenerRequest(AbstractModel):
4250
4254
 
4251
4255
  @property
4252
4256
  def H2cSwitch(self):
4253
- """内网http监听器开启h2c开关
4257
+ """内网http监听器开启h2c开关,True(开启)、False(关闭)
4254
4258
  :rtype: bool
4255
4259
  """
4256
4260
  return self._H2cSwitch
@@ -4261,7 +4265,7 @@ class CreateListenerRequest(AbstractModel):
4261
4265
 
4262
4266
  @property
4263
4267
  def SslCloseSwitch(self):
4264
- """TCP_SSL监听器支持关闭SSL后仍然支持混绑,此参数为关闭开关
4268
+ """TCP_SSL监听器支持关闭SSL后仍然支持混绑,此参数为关闭开关。True(关闭)、False(开启)
4265
4269
  :rtype: bool
4266
4270
  """
4267
4271
  return self._SslCloseSwitch
@@ -4272,7 +4276,7 @@ class CreateListenerRequest(AbstractModel):
4272
4276
 
4273
4277
  @property
4274
4278
  def DataCompressMode(self):
4275
- """数据压缩模式
4279
+ """数据压缩模式。可选值:transparent(透传模式)、compatibility(兼容模式)
4276
4280
  :rtype: str
4277
4281
  """
4278
4282
  return self._DataCompressMode
@@ -4384,16 +4388,16 @@ OPEN:公网属性, INTERNAL:内网属性。
4384
4388
  :type VpcId: str
4385
4389
  :param _SubnetId: 在私有网络内购买内网负载均衡实例的情况下,必须指定子网 ID,内网负载均衡实例的 VIP 将从这个子网中产生。创建内网负载均衡实例时,此参数必填,创建公网IPv4负载均衡实例时,不支持指定该参数。
4386
4390
  :type SubnetId: str
4387
- :param _ProjectId: 负载均衡实例所属的项目 ID,可以通过 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 接口获取。不填此参数则视为默认项目。
4391
+ :param _ProjectId: 负载均衡实例所属的项目 ID,默认项目 ID 为0。可以通过 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 接口获取。不填此参数则视为默认项目。
4388
4392
  :type ProjectId: int
4389
4393
  :param _AddressIPVersion: 仅适用于公网负载均衡。IP版本,可取值:IPV4、IPV6、IPv6FullChain,不区分大小写,默认值 IPV4。说明:取值为IPV6表示为IPV6 NAT64版本;取值为IPv6FullChain,表示为IPv6版本。
4390
4394
  :type AddressIPVersion: str
4391
- :param _Number: 创建负载均衡的个数,默认值 1。
4395
+ :param _Number: 创建负载均衡的个数,默认值 1。创建个数不能超过帐号所能创建的最大值,默认创建最大值为20
4392
4396
  :type Number: int
4393
- :param _MasterZoneId: 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的主可用区ID,例如 100001 或 ap-guangzhou-1
4397
+ :param _MasterZoneId: 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的主可用区ID 可用区 ID 和名称均支持,例如 100001 或 ap-guangzhou-1
4394
4398
  注:主可用区是需要承载流量的可用区,备可用区默认不承载流量,主可用区不可用时才使用备可用区。目前仅广州、上海、南京、北京、成都、深圳金融、中国香港、首尔、法兰克福、新加坡地域的 IPv4 版本的 CLB 支持主备可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主可用区的列表。【如果您需要体验该功能,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】
4395
4399
  :type MasterZoneId: str
4396
- :param _ZoneId: 仅适用于公网且IP版本为IPv4的负载均衡。可用区ID,指定可用区以创建负载均衡实例。如:ap-guangzhou-1。
4400
+ :param _ZoneId: 仅适用于公网且IP版本为IPv4的负载均衡。可用区ID,可用区 ID 和名称均支持,指定可用区以创建负载均衡实例。如:100001 或 ap-guangzhou-1。
4397
4401
  :type ZoneId: str
4398
4402
  :param _InternetAccessible: 网络计费模式,最大出带宽。仅对内网属性的性能容量型实例和公网属性的所有实例生效。API接口购买包年包月实例还在灰度中,如您需要体验该功能,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)
4399
4403
  :type InternetAccessible: :class:`tencentcloud.clb.v20180317.models.InternetAccessible`
@@ -4404,7 +4408,7 @@ OPEN:公网属性, INTERNAL:内网属性。
4404
4408
  :param _Vip: 指定VIP申请负载均衡。此参数选填,不填写此参数时自动分配VIP。IPv4和IPv6类型支持此参数,IPv6 NAT64类型不支持。
4405
4409
  注意:当指定VIP创建内网实例、或公网IPv6 BGP实例时,若VIP不属于指定VPC子网的网段内时,会创建失败;若VIP已被占用,也会创建失败。
4406
4410
  :type Vip: str
4407
- :param _BandwidthPackageId: 带宽包ID,指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE),带宽包的属性即为其结算方式。非上移用户购买的 IPv6 负载均衡实例,且运营商类型非 BGP 时 ,不支持指定具体带宽包id。
4411
+ :param _BandwidthPackageId: 带宽包ID,可以通过 [DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209) 接口获取。指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE),带宽包的属性即为其结算方式。非上移用户购买的 IPv6 负载均衡实例,且运营商类型非 BGP 时 ,不支持指定具体带宽包id。
4408
4412
  :type BandwidthPackageId: str
4409
4413
  :param _ExclusiveCluster: 独占型实例信息。若创建独占型的内网负载均衡实例,则此参数必填。
4410
4414
  :type ExclusiveCluster: :class:`tencentcloud.clb.v20180317.models.ExclusiveCluster`
@@ -4421,10 +4425,10 @@ OPEN:公网属性, INTERNAL:内网属性。
4421
4425
  :type SnatIps: list of SnatIp
4422
4426
  :param _ClusterTag: Stgw独占集群的标签。
4423
4427
  :type ClusterTag: str
4424
- :param _SlaveZoneId: 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的备可用区ID,例如 100001 或 ap-guangzhou-1
4428
+ :param _SlaveZoneId: 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的备可用区ID,可用区 ID 和名称均支持,例如 100001 或 ap-guangzhou-1
4425
4429
  注:备可用区是主可用区故障后,需要承载流量的可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主/备可用区的列表。【如果您需要体验该功能,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】
4426
4430
  :type SlaveZoneId: str
4427
- :param _EipAddressId: EIP 的唯一 ID,形如:eip-11112222,仅适用于内网负载均衡绑定EIP。
4431
+ :param _EipAddressId: EIP 的唯一 ID,可以通过 [DescribeAddresses](https://cloud.tencent.com/document/product/215/16702) 接口查询。形如:eip-qhx8udkc,仅适用于内网负载均衡绑定EIP。
4428
4432
  :type EipAddressId: str
4429
4433
  :param _LoadBalancerPassToTarget: Target是否放通来自CLB的流量。开启放通(true):只验证CLB上的安全组;不开启放通(false):需同时验证CLB和后端实例上的安全组。
4430
4434
  :type LoadBalancerPassToTarget: bool
@@ -4529,7 +4533,7 @@ OPEN:公网属性, INTERNAL:内网属性。
4529
4533
 
4530
4534
  @property
4531
4535
  def ProjectId(self):
4532
- """负载均衡实例所属的项目 ID,可以通过 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 接口获取。不填此参数则视为默认项目。
4536
+ """负载均衡实例所属的项目 ID,默认项目 ID 为0。可以通过 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 接口获取。不填此参数则视为默认项目。
4533
4537
  :rtype: int
4534
4538
  """
4535
4539
  return self._ProjectId
@@ -4551,7 +4555,7 @@ OPEN:公网属性, INTERNAL:内网属性。
4551
4555
 
4552
4556
  @property
4553
4557
  def Number(self):
4554
- """创建负载均衡的个数,默认值 1。
4558
+ """创建负载均衡的个数,默认值 1。创建个数不能超过帐号所能创建的最大值,默认创建最大值为20
4555
4559
  :rtype: int
4556
4560
  """
4557
4561
  return self._Number
@@ -4562,7 +4566,7 @@ OPEN:公网属性, INTERNAL:内网属性。
4562
4566
 
4563
4567
  @property
4564
4568
  def MasterZoneId(self):
4565
- """仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的主可用区ID,例如 100001 或 ap-guangzhou-1
4569
+ """仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的主可用区ID 可用区 ID 和名称均支持,例如 100001 或 ap-guangzhou-1
4566
4570
  注:主可用区是需要承载流量的可用区,备可用区默认不承载流量,主可用区不可用时才使用备可用区。目前仅广州、上海、南京、北京、成都、深圳金融、中国香港、首尔、法兰克福、新加坡地域的 IPv4 版本的 CLB 支持主备可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主可用区的列表。【如果您需要体验该功能,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】
4567
4571
  :rtype: str
4568
4572
  """
@@ -4574,7 +4578,7 @@ OPEN:公网属性, INTERNAL:内网属性。
4574
4578
 
4575
4579
  @property
4576
4580
  def ZoneId(self):
4577
- """仅适用于公网且IP版本为IPv4的负载均衡。可用区ID,指定可用区以创建负载均衡实例。如:ap-guangzhou-1。
4581
+ """仅适用于公网且IP版本为IPv4的负载均衡。可用区ID,可用区 ID 和名称均支持,指定可用区以创建负载均衡实例。如:100001 或 ap-guangzhou-1。
4578
4582
  :rtype: str
4579
4583
  """
4580
4584
  return self._ZoneId
@@ -4630,7 +4634,7 @@ OPEN:公网属性, INTERNAL:内网属性。
4630
4634
 
4631
4635
  @property
4632
4636
  def BandwidthPackageId(self):
4633
- """带宽包ID,指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE),带宽包的属性即为其结算方式。非上移用户购买的 IPv6 负载均衡实例,且运营商类型非 BGP 时 ,不支持指定具体带宽包id。
4637
+ """带宽包ID,可以通过 [DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209) 接口获取。指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE),带宽包的属性即为其结算方式。非上移用户购买的 IPv6 负载均衡实例,且运营商类型非 BGP 时 ,不支持指定具体带宽包id。
4634
4638
  :rtype: str
4635
4639
  """
4636
4640
  return self._BandwidthPackageId
@@ -4719,7 +4723,7 @@ OPEN:公网属性, INTERNAL:内网属性。
4719
4723
 
4720
4724
  @property
4721
4725
  def SlaveZoneId(self):
4722
- """仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的备可用区ID,例如 100001 或 ap-guangzhou-1
4726
+ """仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的备可用区ID,可用区 ID 和名称均支持,例如 100001 或 ap-guangzhou-1
4723
4727
  注:备可用区是主可用区故障后,需要承载流量的可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主/备可用区的列表。【如果您需要体验该功能,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】
4724
4728
  :rtype: str
4725
4729
  """
@@ -4731,7 +4735,7 @@ OPEN:公网属性, INTERNAL:内网属性。
4731
4735
 
4732
4736
  @property
4733
4737
  def EipAddressId(self):
4734
- """EIP 的唯一 ID,形如:eip-11112222,仅适用于内网负载均衡绑定EIP。
4738
+ """EIP 的唯一 ID,可以通过 [DescribeAddresses](https://cloud.tencent.com/document/product/215/16702) 接口查询。形如:eip-qhx8udkc,仅适用于内网负载均衡绑定EIP。
4735
4739
  :rtype: str
4736
4740
  """
4737
4741
  return self._EipAddressId
@@ -5717,9 +5721,9 @@ class DeleteListenerRequest(AbstractModel):
5717
5721
 
5718
5722
  def __init__(self):
5719
5723
  r"""
5720
- :param _LoadBalancerId: 负载均衡实例ID
5724
+ :param _LoadBalancerId: 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
5721
5725
  :type LoadBalancerId: str
5722
- :param _ListenerId: 要删除的监听器ID
5726
+ :param _ListenerId: 要删除的监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
5723
5727
  :type ListenerId: str
5724
5728
  """
5725
5729
  self._LoadBalancerId = None
@@ -5727,7 +5731,7 @@ class DeleteListenerRequest(AbstractModel):
5727
5731
 
5728
5732
  @property
5729
5733
  def LoadBalancerId(self):
5730
- """负载均衡实例ID
5734
+ """负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
5731
5735
  :rtype: str
5732
5736
  """
5733
5737
  return self._LoadBalancerId
@@ -5738,7 +5742,7 @@ class DeleteListenerRequest(AbstractModel):
5738
5742
 
5739
5743
  @property
5740
5744
  def ListenerId(self):
5741
- """要删除的监听器ID
5745
+ """要删除的监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
5742
5746
  :rtype: str
5743
5747
  """
5744
5748
  return self._ListenerId
@@ -5796,9 +5800,9 @@ class DeleteLoadBalancerListenersRequest(AbstractModel):
5796
5800
 
5797
5801
  def __init__(self):
5798
5802
  r"""
5799
- :param _LoadBalancerId: 负载均衡实例ID
5803
+ :param _LoadBalancerId: 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
5800
5804
  :type LoadBalancerId: str
5801
- :param _ListenerIds: 指定删除的监听器ID数组,最大为20个。若不填则删除负载均衡的所有监听器。
5805
+ :param _ListenerIds: 指定删除的监听器ID数组,最大为20个。若不填则删除负载均衡的所有监听器,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
5802
5806
  :type ListenerIds: list of str
5803
5807
  """
5804
5808
  self._LoadBalancerId = None
@@ -5806,7 +5810,7 @@ class DeleteLoadBalancerListenersRequest(AbstractModel):
5806
5810
 
5807
5811
  @property
5808
5812
  def LoadBalancerId(self):
5809
- """负载均衡实例ID
5813
+ """负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
5810
5814
  :rtype: str
5811
5815
  """
5812
5816
  return self._LoadBalancerId
@@ -5817,7 +5821,7 @@ class DeleteLoadBalancerListenersRequest(AbstractModel):
5817
5821
 
5818
5822
  @property
5819
5823
  def ListenerIds(self):
5820
- """指定删除的监听器ID数组,最大为20个。若不填则删除负载均衡的所有监听器。
5824
+ """指定删除的监听器ID数组,最大为20个。若不填则删除负载均衡的所有监听器,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
5821
5825
  :rtype: list of str
5822
5826
  """
5823
5827
  return self._ListenerIds
@@ -5875,9 +5879,10 @@ class DeleteLoadBalancerRequest(AbstractModel):
5875
5879
 
5876
5880
  def __init__(self):
5877
5881
  r"""
5878
- :param _LoadBalancerIds: 要删除的负载均衡实例 ID数组,数组大小最大支持20。
5882
+ :param _LoadBalancerIds: 要删除的负载均衡实例 ID 数组,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取数组大小最大支持20。
5879
5883
  :type LoadBalancerIds: list of str
5880
- :param _ForceDelete: 是否强制删除clb。为true表示强制删除,为false表示不是强制删除,需要做拦截校验。
5884
+ :param _ForceDelete: 是否强制删除clb。True表示强制删除,False表示不是强制删除,需要做拦截校验。
5885
+ 默认为 False
5881
5886
  :type ForceDelete: bool
5882
5887
  """
5883
5888
  self._LoadBalancerIds = None
@@ -5885,7 +5890,7 @@ class DeleteLoadBalancerRequest(AbstractModel):
5885
5890
 
5886
5891
  @property
5887
5892
  def LoadBalancerIds(self):
5888
- """要删除的负载均衡实例 ID数组,数组大小最大支持20。
5893
+ """要删除的负载均衡实例 ID 数组,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取数组大小最大支持20。
5889
5894
  :rtype: list of str
5890
5895
  """
5891
5896
  return self._LoadBalancerIds
@@ -5896,7 +5901,8 @@ class DeleteLoadBalancerRequest(AbstractModel):
5896
5901
 
5897
5902
  @property
5898
5903
  def ForceDelete(self):
5899
- """是否强制删除clb。为true表示强制删除,为false表示不是强制删除,需要做拦截校验。
5904
+ """是否强制删除clb。True表示强制删除,False表示不是强制删除,需要做拦截校验。
5905
+ 默认为 False
5900
5906
  :rtype: bool
5901
5907
  """
5902
5908
  return self._ForceDelete
@@ -6147,17 +6153,17 @@ class DeleteRuleRequest(AbstractModel):
6147
6153
 
6148
6154
  def __init__(self):
6149
6155
  r"""
6150
- :param _LoadBalancerId: 负载均衡实例ID
6156
+ :param _LoadBalancerId: 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
6151
6157
  :type LoadBalancerId: str
6152
- :param _ListenerId: 负载均衡监听器ID
6158
+ :param _ListenerId: 负载均衡监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
6153
6159
  :type ListenerId: str
6154
- :param _LocationIds: 要删除的转发规则的ID组成的数组。
6160
+ :param _LocationIds: 要删除的转发规则的ID组成的数组,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
6155
6161
  :type LocationIds: list of str
6156
- :param _Domain: 要删除的转发规则的域名,如果是多域名,可以指定多域名列表中的任意一个。
6162
+ :param _Domain: 要删除的转发规则的域名,如果是多域名,可以指定多域名列表中的任意一个,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
6157
6163
  :type Domain: str
6158
- :param _Url: 要删除的转发规则的转发路径。
6164
+ :param _Url: 要删除的转发规则的转发路径,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
6159
6165
  :type Url: str
6160
- :param _NewDefaultServerDomain: 监听器下必须配置一个默认域名,当需要删除默认域名时,可以指定另一个域名作为新的默认域名,如果新的默认域名是多域名,可以指定多域名列表中的任意一个。
6166
+ :param _NewDefaultServerDomain: 监听器下必须配置一个默认域名,当需要删除默认域名时,可以指定另一个域名作为新的默认域名,如果新的默认域名是多域名,可以指定多域名列表中的任意一个,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
6161
6167
  :type NewDefaultServerDomain: str
6162
6168
  """
6163
6169
  self._LoadBalancerId = None
@@ -6169,7 +6175,7 @@ class DeleteRuleRequest(AbstractModel):
6169
6175
 
6170
6176
  @property
6171
6177
  def LoadBalancerId(self):
6172
- """负载均衡实例ID
6178
+ """负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
6173
6179
  :rtype: str
6174
6180
  """
6175
6181
  return self._LoadBalancerId
@@ -6180,7 +6186,7 @@ class DeleteRuleRequest(AbstractModel):
6180
6186
 
6181
6187
  @property
6182
6188
  def ListenerId(self):
6183
- """负载均衡监听器ID
6189
+ """负载均衡监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
6184
6190
  :rtype: str
6185
6191
  """
6186
6192
  return self._ListenerId
@@ -6191,7 +6197,7 @@ class DeleteRuleRequest(AbstractModel):
6191
6197
 
6192
6198
  @property
6193
6199
  def LocationIds(self):
6194
- """要删除的转发规则的ID组成的数组。
6200
+ """要删除的转发规则的ID组成的数组,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
6195
6201
  :rtype: list of str
6196
6202
  """
6197
6203
  return self._LocationIds
@@ -6202,7 +6208,7 @@ class DeleteRuleRequest(AbstractModel):
6202
6208
 
6203
6209
  @property
6204
6210
  def Domain(self):
6205
- """要删除的转发规则的域名,如果是多域名,可以指定多域名列表中的任意一个。
6211
+ """要删除的转发规则的域名,如果是多域名,可以指定多域名列表中的任意一个,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
6206
6212
  :rtype: str
6207
6213
  """
6208
6214
  return self._Domain
@@ -6213,7 +6219,7 @@ class DeleteRuleRequest(AbstractModel):
6213
6219
 
6214
6220
  @property
6215
6221
  def Url(self):
6216
- """要删除的转发规则的转发路径。
6222
+ """要删除的转发规则的转发路径,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
6217
6223
  :rtype: str
6218
6224
  """
6219
6225
  return self._Url
@@ -6224,7 +6230,7 @@ class DeleteRuleRequest(AbstractModel):
6224
6230
 
6225
6231
  @property
6226
6232
  def NewDefaultServerDomain(self):
6227
- """监听器下必须配置一个默认域名,当需要删除默认域名时,可以指定另一个域名作为新的默认域名,如果新的默认域名是多域名,可以指定多域名列表中的任意一个。
6233
+ """监听器下必须配置一个默认域名,当需要删除默认域名时,可以指定另一个域名作为新的默认域名,如果新的默认域名是多域名,可以指定多域名列表中的任意一个,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
6228
6234
  :rtype: str
6229
6235
  """
6230
6236
  return self._NewDefaultServerDomain
@@ -8480,13 +8486,13 @@ class DescribeListenersRequest(AbstractModel):
8480
8486
 
8481
8487
  def __init__(self):
8482
8488
  r"""
8483
- :param _LoadBalancerId: 负载均衡实例 ID
8489
+ :param _LoadBalancerId: 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/api/214/30685) 接口获取。
8484
8490
  :type LoadBalancerId: str
8485
- :param _ListenerIds: 要查询的负载均衡监听器 ID 数组,最大为100个。
8491
+ :param _ListenerIds: 要查询的负载均衡监听器 ID 数组,最大为100个,可以通过 [DescribeListeners](https://cloud.tencent.com/document/api/214/30686) 接口获取。
8486
8492
  :type ListenerIds: list of str
8487
8493
  :param _Protocol: 要查询的监听器协议类型,取值 TCP | UDP | HTTP | HTTPS | TCP_SSL | QUIC。
8488
8494
  :type Protocol: str
8489
- :param _Port: 要查询的监听器的端口。
8495
+ :param _Port: 要查询的监听器的端口,端口范围:1-65535
8490
8496
  :type Port: int
8491
8497
  """
8492
8498
  self._LoadBalancerId = None
@@ -8496,7 +8502,7 @@ class DescribeListenersRequest(AbstractModel):
8496
8502
 
8497
8503
  @property
8498
8504
  def LoadBalancerId(self):
8499
- """负载均衡实例 ID
8505
+ """负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/api/214/30685) 接口获取。
8500
8506
  :rtype: str
8501
8507
  """
8502
8508
  return self._LoadBalancerId
@@ -8507,7 +8513,7 @@ class DescribeListenersRequest(AbstractModel):
8507
8513
 
8508
8514
  @property
8509
8515
  def ListenerIds(self):
8510
- """要查询的负载均衡监听器 ID 数组,最大为100个。
8516
+ """要查询的负载均衡监听器 ID 数组,最大为100个,可以通过 [DescribeListeners](https://cloud.tencent.com/document/api/214/30686) 接口获取。
8511
8517
  :rtype: list of str
8512
8518
  """
8513
8519
  return self._ListenerIds
@@ -8529,7 +8535,7 @@ class DescribeListenersRequest(AbstractModel):
8529
8535
 
8530
8536
  @property
8531
8537
  def Port(self):
8532
- """要查询的监听器的端口。
8538
+ """要查询的监听器的端口,端口范围:1-65535
8533
8539
  :rtype: int
8534
8540
  """
8535
8541
  return self._Port
@@ -8895,16 +8901,53 @@ class DescribeLoadBalancersDetailRequest(AbstractModel):
8895
8901
  :param _TargetType: 当Fields包含TargetId、TargetAddress、TargetPort、TargetWeight、ListenerId、Protocol、Port、LocationId、Domain、Url等Fields时,必选选择导出目标组的Target或者非目标组Target,取值范围NODE、GROUP。
8896
8902
  :type TargetType: str
8897
8903
  :param _Filters: 查询负载均衡详细信息列表条件,详细的过滤条件如下:
8898
- <li> loadbalancer-id - String - 是否必填:否 - (过滤条件)按照 负载均衡ID 过滤,如:"lb-12345678"。</li>
8899
- <li> project-id - String - 是否必填:否 - (过滤条件)按照 项目ID 过滤,如:"0","123"。</li>
8900
- <li> network - String - 是否必填:否 - (过滤条件)按照 负载均衡网络类型 过滤,如:"Public","Private"。</li>
8901
- <li> vip - String - 是否必填:否 - (过滤条件)按照 负载均衡Vip 过滤,如:"1.1.1.1","2204::22:3"。</li>
8902
- <li> target-ip - String - 是否必填:否 - (过滤条件)按照 后端目标内网Ip 过滤,如:"1.1.1.1","2203::214:4"。</li>
8903
- <li> vpcid - String - 是否必填:否 - (过滤条件)按照 负载均衡所属vpcId 过滤,如:"vpc-12345678"。</li>
8904
- <li> zone - String - 是否必填:否 - (过滤条件)按照 负载均衡所属的可用区 过滤,如:"ap-guangzhou-1"。</li>
8905
- <li> tag-key - String - 是否必填:否 - (过滤条件)按照 负载均衡标签的标签键 过滤,如:"name"。</li>
8906
- <li> tag:* - String - 是否必填:否 - (过滤条件)按照 负载均衡的标签 过滤,':' 后面跟的是标签键。如:过滤标签键name,标签值zhangsan,lisi,{"Name": "tag:name","Values": ["zhangsan", "lisi"]}。</li>
8907
- <li> fuzzy-search - String - 是否必填:否 - (过滤条件)按照 负载均衡Vip,负载均衡名称 模糊搜索,如:"1.1"。</li>
8904
+ - loadbalancer-id
8905
+ 按照【负载均衡ID】进行过滤。例如:lb-rbw5skde。
8906
+ 类型:String
8907
+ 必选:否
8908
+ 获取方式:[DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459)
8909
+ - project-id
8910
+ 按照【项目ID】进行过滤。例如: "0"、"123"。
8911
+ 类型:String
8912
+ 必选:否
8913
+ 获取方式:[DescribeProject](https://cloud.tencent.com/document/api/651/78725)
8914
+ - network
8915
+ 按照【负载均衡网络类型】进行过滤。例如:Public。
8916
+ 类型:String
8917
+ 必选:否
8918
+ 可选值:Private(内网)、Public(公网)
8919
+ - vip
8920
+ 按照【负载均衡 VIP】进行过滤。例如:"1.1.1.1","2204::22:3"。
8921
+ 类型:String
8922
+ 必选:否
8923
+ - vpcid
8924
+ 按照【负载均衡所属 VPCID】进行过滤。例如:"vpc-12345678"。
8925
+ 类型:String
8926
+ 必选:否
8927
+ 获取方式:[DescribeZones](https://cloud.tencent.com/document/product/213/15707)
8928
+ - target-ip
8929
+ 按照【后端目标内网 IP】进行过滤。例如:"1.1.1.1","2203::214:4"。
8930
+ 类型:String
8931
+ 必选:否
8932
+ - zone
8933
+ 按照【负载均衡所属的可用区】进行过滤。例如:"ap-guangzhou-1"。
8934
+ 类型:String
8935
+ 必选:否
8936
+ 获取方式:[DescribeZones](https://cloud.tencent.com/document/product/213/15707)
8937
+ - tag-key
8938
+ 按照【负载均衡标签的标签键】进行过滤,例如:"name"。
8939
+ 类型:String
8940
+ 必选:否
8941
+ 获取方式:[DescribeTags](https://cloud.tencent.com/document/api/651/35316)
8942
+ - tag:*
8943
+ 按照【负载均衡的标签】进行过滤,':' 后面跟的是标签键。如过滤标签键name,标签值zhangsan,lisi,{"Name": "tag:name","Values": ["zhangsan", "lisi"]}。
8944
+ 类型:String
8945
+ 必选:否
8946
+ 获取方式:[DescribeTagKeys](https://cloud.tencent.com/document/api/651/35318)
8947
+ - fuzzy-search
8948
+ 按照【负载均衡VIP,负载均衡名称】模糊搜索,例如:"1.1"。
8949
+ 类型:String
8950
+ 必选:否
8908
8951
  :type Filters: list of Filter
8909
8952
  """
8910
8953
  self._Limit = None
@@ -8960,16 +9003,53 @@ class DescribeLoadBalancersDetailRequest(AbstractModel):
8960
9003
  @property
8961
9004
  def Filters(self):
8962
9005
  """查询负载均衡详细信息列表条件,详细的过滤条件如下:
8963
- <li> loadbalancer-id - String - 是否必填:否 - (过滤条件)按照 负载均衡ID 过滤,如:"lb-12345678"。</li>
8964
- <li> project-id - String - 是否必填:否 - (过滤条件)按照 项目ID 过滤,如:"0","123"。</li>
8965
- <li> network - String - 是否必填:否 - (过滤条件)按照 负载均衡网络类型 过滤,如:"Public","Private"。</li>
8966
- <li> vip - String - 是否必填:否 - (过滤条件)按照 负载均衡Vip 过滤,如:"1.1.1.1","2204::22:3"。</li>
8967
- <li> target-ip - String - 是否必填:否 - (过滤条件)按照 后端目标内网Ip 过滤,如:"1.1.1.1","2203::214:4"。</li>
8968
- <li> vpcid - String - 是否必填:否 - (过滤条件)按照 负载均衡所属vpcId 过滤,如:"vpc-12345678"。</li>
8969
- <li> zone - String - 是否必填:否 - (过滤条件)按照 负载均衡所属的可用区 过滤,如:"ap-guangzhou-1"。</li>
8970
- <li> tag-key - String - 是否必填:否 - (过滤条件)按照 负载均衡标签的标签键 过滤,如:"name"。</li>
8971
- <li> tag:* - String - 是否必填:否 - (过滤条件)按照 负载均衡的标签 过滤,':' 后面跟的是标签键。如:过滤标签键name,标签值zhangsan,lisi,{"Name": "tag:name","Values": ["zhangsan", "lisi"]}。</li>
8972
- <li> fuzzy-search - String - 是否必填:否 - (过滤条件)按照 负载均衡Vip,负载均衡名称 模糊搜索,如:"1.1"。</li>
9006
+ - loadbalancer-id
9007
+ 按照【负载均衡ID】进行过滤。例如:lb-rbw5skde。
9008
+ 类型:String
9009
+ 必选:否
9010
+ 获取方式:[DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459)
9011
+ - project-id
9012
+ 按照【项目ID】进行过滤。例如: "0"、"123"。
9013
+ 类型:String
9014
+ 必选:否
9015
+ 获取方式:[DescribeProject](https://cloud.tencent.com/document/api/651/78725)
9016
+ - network
9017
+ 按照【负载均衡网络类型】进行过滤。例如:Public。
9018
+ 类型:String
9019
+ 必选:否
9020
+ 可选值:Private(内网)、Public(公网)
9021
+ - vip
9022
+ 按照【负载均衡 VIP】进行过滤。例如:"1.1.1.1","2204::22:3"。
9023
+ 类型:String
9024
+ 必选:否
9025
+ - vpcid
9026
+ 按照【负载均衡所属 VPCID】进行过滤。例如:"vpc-12345678"。
9027
+ 类型:String
9028
+ 必选:否
9029
+ 获取方式:[DescribeZones](https://cloud.tencent.com/document/product/213/15707)
9030
+ - target-ip
9031
+ 按照【后端目标内网 IP】进行过滤。例如:"1.1.1.1","2203::214:4"。
9032
+ 类型:String
9033
+ 必选:否
9034
+ - zone
9035
+ 按照【负载均衡所属的可用区】进行过滤。例如:"ap-guangzhou-1"。
9036
+ 类型:String
9037
+ 必选:否
9038
+ 获取方式:[DescribeZones](https://cloud.tencent.com/document/product/213/15707)
9039
+ - tag-key
9040
+ 按照【负载均衡标签的标签键】进行过滤,例如:"name"。
9041
+ 类型:String
9042
+ 必选:否
9043
+ 获取方式:[DescribeTags](https://cloud.tencent.com/document/api/651/35316)
9044
+ - tag:*
9045
+ 按照【负载均衡的标签】进行过滤,':' 后面跟的是标签键。如过滤标签键name,标签值zhangsan,lisi,{"Name": "tag:name","Values": ["zhangsan", "lisi"]}。
9046
+ 类型:String
9047
+ 必选:否
9048
+ 获取方式:[DescribeTagKeys](https://cloud.tencent.com/document/api/651/35318)
9049
+ - fuzzy-search
9050
+ 按照【负载均衡VIP,负载均衡名称】模糊搜索,例如:"1.1"。
9051
+ 类型:String
9052
+ 必选:否
8973
9053
  :rtype: list of Filter
8974
9054
  """
8975
9055
  return self._Filters
@@ -12633,9 +12713,9 @@ class Listener(AbstractModel):
12633
12713
  r"""
12634
12714
  :param _ListenerId: 负载均衡监听器 ID
12635
12715
  :type ListenerId: str
12636
- :param _Protocol: 监听器协议
12716
+ :param _Protocol: 监听器协议,可选值:TCP、UDP、HTTP、HTTPS、TCP_SSL、QUIC
12637
12717
  :type Protocol: str
12638
- :param _Port: 监听器端口
12718
+ :param _Port: 监听器端口,端口范围:1-65535
12639
12719
  :type Port: int
12640
12720
  :param _Certificate: 监听器绑定的证书信息
12641
12721
  注意:此字段可能返回 null,表示取不到有效值。
@@ -12646,7 +12726,7 @@ class Listener(AbstractModel):
12646
12726
  :param _Scheduler: 请求的调度方式。 WRR、LEAST_CONN、IP_HASH分别表示按权重轮询、最小连接数、IP Hash。
12647
12727
  注意:此字段可能返回 null,表示取不到有效值。
12648
12728
  :type Scheduler: str
12649
- :param _SessionExpireTime: 会话保持时间
12729
+ :param _SessionExpireTime: 会话保持时间,单位:秒。可选值:30~3600,默认 0,默认不开启。此参数仅适用于TCP/UDP监听器。
12650
12730
  注意:此字段可能返回 null,表示取不到有效值。
12651
12731
  :type SessionExpireTime: int
12652
12732
  :param _SniSwitch: 是否开启SNI特性,1:表示开启,0:表示不开启(本参数仅对于HTTPS监听器有意义)
@@ -12658,9 +12738,9 @@ class Listener(AbstractModel):
12658
12738
  :type ListenerName: str
12659
12739
  :param _CreateTime: 监听器的创建时间。
12660
12740
  :type CreateTime: str
12661
- :param _EndPort: 端口段结束端口
12741
+ :param _EndPort: 端口段结束端口,端口范围:2-65535
12662
12742
  :type EndPort: int
12663
- :param _TargetType: 后端服务器类型
12743
+ :param _TargetType: 后端服务器类型,可选值:NODE、POLARIS、TARGETGROUP、TARGETGROUP-V2
12664
12744
  注意:此字段可能返回 null,表示取不到有效值。
12665
12745
  :type TargetType: str
12666
12746
  :param _TargetGroup: 绑定的目标组基本信息;当监听器绑定目标组时,会返回该字段
@@ -12731,7 +12811,7 @@ class Listener(AbstractModel):
12731
12811
 
12732
12812
  @property
12733
12813
  def Protocol(self):
12734
- """监听器协议
12814
+ """监听器协议,可选值:TCP、UDP、HTTP、HTTPS、TCP_SSL、QUIC
12735
12815
  :rtype: str
12736
12816
  """
12737
12817
  return self._Protocol
@@ -12742,7 +12822,7 @@ class Listener(AbstractModel):
12742
12822
 
12743
12823
  @property
12744
12824
  def Port(self):
12745
- """监听器端口
12825
+ """监听器端口,端口范围:1-65535
12746
12826
  :rtype: int
12747
12827
  """
12748
12828
  return self._Port
@@ -12789,7 +12869,7 @@ class Listener(AbstractModel):
12789
12869
 
12790
12870
  @property
12791
12871
  def SessionExpireTime(self):
12792
- """会话保持时间
12872
+ """会话保持时间,单位:秒。可选值:30~3600,默认 0,默认不开启。此参数仅适用于TCP/UDP监听器。
12793
12873
  注意:此字段可能返回 null,表示取不到有效值。
12794
12874
  :rtype: int
12795
12875
  """
@@ -12846,7 +12926,7 @@ class Listener(AbstractModel):
12846
12926
 
12847
12927
  @property
12848
12928
  def EndPort(self):
12849
- """端口段结束端口
12929
+ """端口段结束端口,端口范围:2-65535
12850
12930
  :rtype: int
12851
12931
  """
12852
12932
  return self._EndPort
@@ -12857,7 +12937,7 @@ class Listener(AbstractModel):
12857
12937
 
12858
12938
  @property
12859
12939
  def TargetType(self):
12860
- """后端服务器类型
12940
+ """后端服务器类型,可选值:NODE、POLARIS、TARGETGROUP、TARGETGROUP-V2
12861
12941
  注意:此字段可能返回 null,表示取不到有效值。
12862
12942
  :rtype: str
12863
12943
  """
@@ -15804,21 +15884,24 @@ class ModifyDomainAttributesRequest(AbstractModel):
15804
15884
 
15805
15885
  def __init__(self):
15806
15886
  r"""
15807
- :param _LoadBalancerId: 负载均衡实例ID
15887
+ :param _LoadBalancerId: 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
15808
15888
  :type LoadBalancerId: str
15809
- :param _ListenerId: 负载均衡监听器ID
15889
+ :param _ListenerId: 负载均衡监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
15810
15890
  :type ListenerId: str
15811
- :param _Domain: 域名(必须是已经创建的转发规则下的域名),如果是多域名,可以指定多域名列表中的任意一个。
15891
+ :param _Domain: 域名(必须是已经创建的转发规则下的域名),如果是多域名,可以指定多域名列表中的任意一个,可以通过[DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
15812
15892
  :type Domain: str
15813
15893
  :param _NewDomain: 要修改的新域名。NewDomain和NewDomains只能传一个。
15814
15894
  :type NewDomain: str
15815
15895
  :param _Certificate: 域名相关的证书信息,注意,仅对启用SNI的监听器适用,不可和MultiCertInfo 同时传入。
15816
15896
  :type Certificate: :class:`tencentcloud.clb.v20180317.models.CertificateInput`
15817
- :param _Http2: 是否开启Http2,注意,只有HTTPS域名才能开启Http2
15897
+ :param _Http2: 是否开启HTTP2,注意,只有HTTPS域名才能开启HTTP2
15898
+ True: 开启HTTP2,Fasle: 不开启HTTP2。
15818
15899
  :type Http2: bool
15819
15900
  :param _DefaultServer: 是否设为默认域名,注意,一个监听器下只能设置一个默认域名。
15901
+ True: 设为默认域名,Fasle: 不设置为默认域名。
15820
15902
  :type DefaultServer: bool
15821
- :param _Quic: 是否开启Quic,注意,只有HTTPS域名才能开启Quic
15903
+ :param _Quic: 是否开启 QUIC,注意,只有 HTTPS 域名才能开启 QUIC。
15904
+ True: 开启 QUIC,False: 不开启QUIC。
15822
15905
  :type Quic: bool
15823
15906
  :param _NewDefaultServerDomain: 监听器下必须配置一个默认域名,若要关闭原默认域名,必须同时指定另一个域名作为新的默认域名,如果新的默认域名是多域名,可以指定多域名列表中的任意一个。
15824
15907
  :type NewDefaultServerDomain: str
@@ -15841,7 +15924,7 @@ class ModifyDomainAttributesRequest(AbstractModel):
15841
15924
 
15842
15925
  @property
15843
15926
  def LoadBalancerId(self):
15844
- """负载均衡实例ID
15927
+ """负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
15845
15928
  :rtype: str
15846
15929
  """
15847
15930
  return self._LoadBalancerId
@@ -15852,7 +15935,7 @@ class ModifyDomainAttributesRequest(AbstractModel):
15852
15935
 
15853
15936
  @property
15854
15937
  def ListenerId(self):
15855
- """负载均衡监听器ID
15938
+ """负载均衡监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
15856
15939
  :rtype: str
15857
15940
  """
15858
15941
  return self._ListenerId
@@ -15863,7 +15946,7 @@ class ModifyDomainAttributesRequest(AbstractModel):
15863
15946
 
15864
15947
  @property
15865
15948
  def Domain(self):
15866
- """域名(必须是已经创建的转发规则下的域名),如果是多域名,可以指定多域名列表中的任意一个。
15949
+ """域名(必须是已经创建的转发规则下的域名),如果是多域名,可以指定多域名列表中的任意一个,可以通过[DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
15867
15950
  :rtype: str
15868
15951
  """
15869
15952
  return self._Domain
@@ -15896,7 +15979,8 @@ class ModifyDomainAttributesRequest(AbstractModel):
15896
15979
 
15897
15980
  @property
15898
15981
  def Http2(self):
15899
- """是否开启Http2,注意,只有HTTPS域名才能开启Http2
15982
+ """是否开启HTTP2,注意,只有HTTPS域名才能开启HTTP2
15983
+ True: 开启HTTP2,Fasle: 不开启HTTP2。
15900
15984
  :rtype: bool
15901
15985
  """
15902
15986
  return self._Http2
@@ -15908,6 +15992,7 @@ class ModifyDomainAttributesRequest(AbstractModel):
15908
15992
  @property
15909
15993
  def DefaultServer(self):
15910
15994
  """是否设为默认域名,注意,一个监听器下只能设置一个默认域名。
15995
+ True: 设为默认域名,Fasle: 不设置为默认域名。
15911
15996
  :rtype: bool
15912
15997
  """
15913
15998
  return self._DefaultServer
@@ -15918,7 +16003,8 @@ class ModifyDomainAttributesRequest(AbstractModel):
15918
16003
 
15919
16004
  @property
15920
16005
  def Quic(self):
15921
- """是否开启Quic,注意,只有HTTPS域名才能开启Quic
16006
+ """是否开启 QUIC,注意,只有 HTTPS 域名才能开启 QUIC。
16007
+ True: 开启 QUIC,False: 不开启QUIC。
15922
16008
  :rtype: bool
15923
16009
  """
15924
16010
  return self._Quic
@@ -16022,11 +16108,11 @@ class ModifyDomainRequest(AbstractModel):
16022
16108
 
16023
16109
  def __init__(self):
16024
16110
  r"""
16025
- :param _LoadBalancerId: 负载均衡实例 ID
16111
+ :param _LoadBalancerId: 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
16026
16112
  :type LoadBalancerId: str
16027
- :param _ListenerId: 负载均衡监听器 ID
16113
+ :param _ListenerId: 负载均衡监听器 ID, 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
16028
16114
  :type ListenerId: str
16029
- :param _Domain: 监听器下的某个旧域名。
16115
+ :param _Domain: 监听器下的某个旧域名, 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 查询。
16030
16116
  :type Domain: str
16031
16117
  :param _NewDomain: 新域名, 长度限制为:1-120。有三种使用格式:非正则表达式格式,通配符格式,正则表达式格式。非正则表达式格式只能使用字母、数字、‘-’、‘.’。通配符格式的使用 ‘*’ 只能在开头或者结尾。正则表达式以'~'开头。
16032
16118
  :type NewDomain: str
@@ -16038,7 +16124,7 @@ class ModifyDomainRequest(AbstractModel):
16038
16124
 
16039
16125
  @property
16040
16126
  def LoadBalancerId(self):
16041
- """负载均衡实例 ID
16127
+ """负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
16042
16128
  :rtype: str
16043
16129
  """
16044
16130
  return self._LoadBalancerId
@@ -16049,7 +16135,7 @@ class ModifyDomainRequest(AbstractModel):
16049
16135
 
16050
16136
  @property
16051
16137
  def ListenerId(self):
16052
- """负载均衡监听器 ID
16138
+ """负载均衡监听器 ID, 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
16053
16139
  :rtype: str
16054
16140
  """
16055
16141
  return self._ListenerId
@@ -16060,7 +16146,7 @@ class ModifyDomainRequest(AbstractModel):
16060
16146
 
16061
16147
  @property
16062
16148
  def Domain(self):
16063
- """监听器下的某个旧域名。
16149
+ """监听器下的某个旧域名, 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 查询。
16064
16150
  :rtype: str
16065
16151
  """
16066
16152
  return self._Domain
@@ -16275,11 +16361,11 @@ class ModifyListenerRequest(AbstractModel):
16275
16361
 
16276
16362
  def __init__(self):
16277
16363
  r"""
16278
- :param _LoadBalancerId: 负载均衡实例ID
16364
+ :param _LoadBalancerId: 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
16279
16365
  :type LoadBalancerId: str
16280
- :param _ListenerId: 负载均衡监听器ID
16366
+ :param _ListenerId: 负载均衡监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
16281
16367
  :type ListenerId: str
16282
- :param _ListenerName: 新的监听器名称。
16368
+ :param _ListenerName: 新的监听器名称,最大长度255。
16283
16369
  :type ListenerName: str
16284
16370
  :param _SessionExpireTime: 会话保持时间,单位:秒。可选值:30~3600,默认 0,表示不开启。此参数仅适用于TCP/UDP监听器。
16285
16371
  :type SessionExpireTime: int
@@ -16287,7 +16373,7 @@ class ModifyListenerRequest(AbstractModel):
16287
16373
  :type HealthCheck: :class:`tencentcloud.clb.v20180317.models.HealthCheck`
16288
16374
  :param _Certificate: 证书相关信息,此参数仅适用于HTTPS/TCP_SSL/QUIC监听器;此参数和MultiCertInfo不能同时传入。
16289
16375
  :type Certificate: :class:`tencentcloud.clb.v20180317.models.CertificateInput`
16290
- :param _Scheduler: 监听器转发的方式。可选值:WRRLEAST_CONN
16376
+ :param _Scheduler: 监听器转发的方式。可选值:WRR(按权重轮询)、LEAST_CONN(按最小连接数)、IP_HASH(按 IP 地址哈希)
16291
16377
  分别表示按权重轮询、最小连接数, 默认为 WRR。
16292
16378
  使用场景:适用于TCP/UDP/TCP_SSL/QUIC监听器。七层监听器的均衡方式应在转发规则中修改。
16293
16379
  :type Scheduler: str
@@ -16297,22 +16383,29 @@ class ModifyListenerRequest(AbstractModel):
16297
16383
  :type TargetType: str
16298
16384
  :param _KeepaliveEnable: 是否开启长连接,此参数仅适用于HTTP/HTTPS监听器。
16299
16385
  默认值0表示不开启,1表示开启。
16386
+ 若后端服务对连接数上限有限制,则建议谨慎开启。此功能目前处于内测中,如需使用,请提交 [内测申请](https://cloud.tencent.com/apply/p/tsodp6qm21)。
16300
16387
  :type KeepaliveEnable: int
16301
16388
  :param _DeregisterTargetRst: 解绑后端目标时,是否发RST给客户端,此参数仅适用于TCP监听器。
16389
+ True表示发送 RST 给客户端,False表示不发送 RST 给客户端。
16302
16390
  :type DeregisterTargetRst: bool
16303
16391
  :param _SessionType: 会话保持类型。NORMAL表示默认会话保持类型。QUIC_CID表示根据Quic Connection ID做会话保持。QUIC_CID只支持UDP协议。
16304
16392
  使用场景:适用于TCP/UDP/TCP_SSL/QUIC监听器。
16393
+ 默认为 NORMAL。
16305
16394
  :type SessionType: str
16306
16395
  :param _MultiCertInfo: 证书信息,支持同时传入不同算法类型的多本服务端证书;此参数仅适用于未开启SNI特性的HTTPS监听器。此参数和Certificate不能同时传入。
16307
16396
  :type MultiCertInfo: :class:`tencentcloud.clb.v20180317.models.MultiCertInfo`
16308
16397
  :param _MaxConn: 监听器粒度并发连接数上限,当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持。取值范围:1-实例规格并发连接上限,其中-1表示关闭监听器粒度并发连接数限速。基础网络实例不支持该参数。
16398
+ 默认为 -1,表示不限速。
16309
16399
  :type MaxConn: int
16310
16400
  :param _MaxCps: 监听器粒度新建连接数上限,当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持。取值范围:1-实例规格新建连接上限,其中-1表示关闭监听器粒度新建连接数限速。基础网络实例不支持该参数。
16401
+ 默认为 -1 表示不限速。
16311
16402
  :type MaxCps: int
16312
- :param _IdleConnectTimeout: 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。默认值:900,取值范围:共享型实例和独占型实例支持:300~900,性能容量型实例支持:300~2000。如需设置超过2000s,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category),最大可设置到3600s。
16403
+ :param _IdleConnectTimeout: 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。默认值:900,取值范围:共享型实例和独占型实例支持:300~900,性能容量型实例支持:300~1980。如需设置超过2000s,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category),最大可设置到3600s。
16313
16404
  :type IdleConnectTimeout: int
16314
- :param _SnatEnable: 是否开启SNAT。
16405
+ :param _SnatEnable: 是否开启SNAT, True 表示开启 SNAT,False 表示不开启 SNAT
16315
16406
  :type SnatEnable: bool
16407
+ :param _DataCompressMode: 数据压缩模式
16408
+ :type DataCompressMode: str
16316
16409
  """
16317
16410
  self._LoadBalancerId = None
16318
16411
  self._ListenerId = None
@@ -16331,10 +16424,11 @@ class ModifyListenerRequest(AbstractModel):
16331
16424
  self._MaxCps = None
16332
16425
  self._IdleConnectTimeout = None
16333
16426
  self._SnatEnable = None
16427
+ self._DataCompressMode = None
16334
16428
 
16335
16429
  @property
16336
16430
  def LoadBalancerId(self):
16337
- """负载均衡实例ID
16431
+ """负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
16338
16432
  :rtype: str
16339
16433
  """
16340
16434
  return self._LoadBalancerId
@@ -16345,7 +16439,7 @@ class ModifyListenerRequest(AbstractModel):
16345
16439
 
16346
16440
  @property
16347
16441
  def ListenerId(self):
16348
- """负载均衡监听器ID
16442
+ """负载均衡监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
16349
16443
  :rtype: str
16350
16444
  """
16351
16445
  return self._ListenerId
@@ -16356,7 +16450,7 @@ class ModifyListenerRequest(AbstractModel):
16356
16450
 
16357
16451
  @property
16358
16452
  def ListenerName(self):
16359
- """新的监听器名称。
16453
+ """新的监听器名称,最大长度255。
16360
16454
  :rtype: str
16361
16455
  """
16362
16456
  return self._ListenerName
@@ -16400,7 +16494,7 @@ class ModifyListenerRequest(AbstractModel):
16400
16494
 
16401
16495
  @property
16402
16496
  def Scheduler(self):
16403
- """监听器转发的方式。可选值:WRRLEAST_CONN
16497
+ """监听器转发的方式。可选值:WRR(按权重轮询)、LEAST_CONN(按最小连接数)、IP_HASH(按 IP 地址哈希)
16404
16498
  分别表示按权重轮询、最小连接数, 默认为 WRR。
16405
16499
  使用场景:适用于TCP/UDP/TCP_SSL/QUIC监听器。七层监听器的均衡方式应在转发规则中修改。
16406
16500
  :rtype: str
@@ -16437,6 +16531,7 @@ class ModifyListenerRequest(AbstractModel):
16437
16531
  def KeepaliveEnable(self):
16438
16532
  """是否开启长连接,此参数仅适用于HTTP/HTTPS监听器。
16439
16533
  默认值0表示不开启,1表示开启。
16534
+ 若后端服务对连接数上限有限制,则建议谨慎开启。此功能目前处于内测中,如需使用,请提交 [内测申请](https://cloud.tencent.com/apply/p/tsodp6qm21)。
16440
16535
  :rtype: int
16441
16536
  """
16442
16537
  return self._KeepaliveEnable
@@ -16448,6 +16543,7 @@ class ModifyListenerRequest(AbstractModel):
16448
16543
  @property
16449
16544
  def DeregisterTargetRst(self):
16450
16545
  """解绑后端目标时,是否发RST给客户端,此参数仅适用于TCP监听器。
16546
+ True表示发送 RST 给客户端,False表示不发送 RST 给客户端。
16451
16547
  :rtype: bool
16452
16548
  """
16453
16549
  return self._DeregisterTargetRst
@@ -16460,6 +16556,7 @@ class ModifyListenerRequest(AbstractModel):
16460
16556
  def SessionType(self):
16461
16557
  """会话保持类型。NORMAL表示默认会话保持类型。QUIC_CID表示根据Quic Connection ID做会话保持。QUIC_CID只支持UDP协议。
16462
16558
  使用场景:适用于TCP/UDP/TCP_SSL/QUIC监听器。
16559
+ 默认为 NORMAL。
16463
16560
  :rtype: str
16464
16561
  """
16465
16562
  return self._SessionType
@@ -16482,6 +16579,7 @@ class ModifyListenerRequest(AbstractModel):
16482
16579
  @property
16483
16580
  def MaxConn(self):
16484
16581
  """监听器粒度并发连接数上限,当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持。取值范围:1-实例规格并发连接上限,其中-1表示关闭监听器粒度并发连接数限速。基础网络实例不支持该参数。
16582
+ 默认为 -1,表示不限速。
16485
16583
  :rtype: int
16486
16584
  """
16487
16585
  return self._MaxConn
@@ -16493,6 +16591,7 @@ class ModifyListenerRequest(AbstractModel):
16493
16591
  @property
16494
16592
  def MaxCps(self):
16495
16593
  """监听器粒度新建连接数上限,当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持。取值范围:1-实例规格新建连接上限,其中-1表示关闭监听器粒度新建连接数限速。基础网络实例不支持该参数。
16594
+ 默认为 -1 表示不限速。
16496
16595
  :rtype: int
16497
16596
  """
16498
16597
  return self._MaxCps
@@ -16503,7 +16602,7 @@ class ModifyListenerRequest(AbstractModel):
16503
16602
 
16504
16603
  @property
16505
16604
  def IdleConnectTimeout(self):
16506
- """空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。默认值:900,取值范围:共享型实例和独占型实例支持:300~900,性能容量型实例支持:300~2000。如需设置超过2000s,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category),最大可设置到3600s。
16605
+ """空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。默认值:900,取值范围:共享型实例和独占型实例支持:300~900,性能容量型实例支持:300~1980。如需设置超过2000s,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category),最大可设置到3600s。
16507
16606
  :rtype: int
16508
16607
  """
16509
16608
  return self._IdleConnectTimeout
@@ -16514,7 +16613,7 @@ class ModifyListenerRequest(AbstractModel):
16514
16613
 
16515
16614
  @property
16516
16615
  def SnatEnable(self):
16517
- """是否开启SNAT。
16616
+ """是否开启SNAT, True 表示开启 SNAT,False 表示不开启 SNAT
16518
16617
  :rtype: bool
16519
16618
  """
16520
16619
  return self._SnatEnable
@@ -16523,6 +16622,17 @@ class ModifyListenerRequest(AbstractModel):
16523
16622
  def SnatEnable(self, SnatEnable):
16524
16623
  self._SnatEnable = SnatEnable
16525
16624
 
16625
+ @property
16626
+ def DataCompressMode(self):
16627
+ """数据压缩模式
16628
+ :rtype: str
16629
+ """
16630
+ return self._DataCompressMode
16631
+
16632
+ @DataCompressMode.setter
16633
+ def DataCompressMode(self, DataCompressMode):
16634
+ self._DataCompressMode = DataCompressMode
16635
+
16526
16636
 
16527
16637
  def _deserialize(self, params):
16528
16638
  self._LoadBalancerId = params.get("LoadBalancerId")
@@ -16548,6 +16658,7 @@ class ModifyListenerRequest(AbstractModel):
16548
16658
  self._MaxCps = params.get("MaxCps")
16549
16659
  self._IdleConnectTimeout = params.get("IdleConnectTimeout")
16550
16660
  self._SnatEnable = params.get("SnatEnable")
16661
+ self._DataCompressMode = params.get("DataCompressMode")
16551
16662
  memeber_set = set(params.keys())
16552
16663
  for name, value in vars(self).items():
16553
16664
  property_name = name[1:]
@@ -16593,21 +16704,24 @@ class ModifyLoadBalancerAttributesRequest(AbstractModel):
16593
16704
 
16594
16705
  def __init__(self):
16595
16706
  r"""
16596
- :param _LoadBalancerId: 负载均衡的唯一ID
16707
+ :param _LoadBalancerId: 负载均衡的唯一ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
16597
16708
  :type LoadBalancerId: str
16598
- :param _LoadBalancerName: 负载均衡实例名称
16709
+ :param _LoadBalancerName: 负载均衡实例名称,规则:1-60 个英文、汉字、数字、连接线“-”或下划线“_”。
16599
16710
  :type LoadBalancerName: str
16600
16711
  :param _TargetRegionInfo: 设置负载均衡跨地域绑定1.0的后端服务信息
16601
16712
  :type TargetRegionInfo: :class:`tencentcloud.clb.v20180317.models.TargetRegionInfo`
16602
16713
  :param _InternetChargeInfo: 网络计费相关参数
16603
16714
  :type InternetChargeInfo: :class:`tencentcloud.clb.v20180317.models.InternetAccessible`
16604
- :param _LoadBalancerPassToTarget: Target是否放通来自CLB的流量。开启放通(true):只验证CLB上的安全组;不开启放通(false):需同时验证CLB和后端实例上的安全组。
16715
+ :param _LoadBalancerPassToTarget: Target是否放通来自CLB的流量。
16716
+ 开启放通(true):只验证CLB上的安全组;
16717
+ 不开启放通(false):需同时验证CLB和后端实例上的安全组。
16718
+ 不填则不修改。
16605
16719
  :type LoadBalancerPassToTarget: bool
16606
- :param _SnatPro: 是否开启跨地域绑定2.0功能
16720
+ :param _SnatPro: 是否开启跨地域绑定2.0功能。不填则不修改。
16607
16721
  :type SnatPro: bool
16608
- :param _DeleteProtect: 是否开启删除保护
16722
+ :param _DeleteProtect: 是否开启删除保护,不填则不修改。
16609
16723
  :type DeleteProtect: bool
16610
- :param _ModifyClassicDomain: 将负载均衡二级域名由mycloud.com改为tencentclb.com,子域名也会变换。修改后mycloud.com域名将失效。
16724
+ :param _ModifyClassicDomain: 将负载均衡二级域名由mycloud.com改为tencentclb.com,子域名也会变换,修改后mycloud.com域名将失效。不填则不修改。
16611
16725
  :type ModifyClassicDomain: bool
16612
16726
  """
16613
16727
  self._LoadBalancerId = None
@@ -16621,7 +16735,7 @@ class ModifyLoadBalancerAttributesRequest(AbstractModel):
16621
16735
 
16622
16736
  @property
16623
16737
  def LoadBalancerId(self):
16624
- """负载均衡的唯一ID
16738
+ """负载均衡的唯一ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
16625
16739
  :rtype: str
16626
16740
  """
16627
16741
  return self._LoadBalancerId
@@ -16632,7 +16746,7 @@ class ModifyLoadBalancerAttributesRequest(AbstractModel):
16632
16746
 
16633
16747
  @property
16634
16748
  def LoadBalancerName(self):
16635
- """负载均衡实例名称
16749
+ """负载均衡实例名称,规则:1-60 个英文、汉字、数字、连接线“-”或下划线“_”。
16636
16750
  :rtype: str
16637
16751
  """
16638
16752
  return self._LoadBalancerName
@@ -16665,7 +16779,10 @@ class ModifyLoadBalancerAttributesRequest(AbstractModel):
16665
16779
 
16666
16780
  @property
16667
16781
  def LoadBalancerPassToTarget(self):
16668
- """Target是否放通来自CLB的流量。开启放通(true):只验证CLB上的安全组;不开启放通(false):需同时验证CLB和后端实例上的安全组。
16782
+ """Target是否放通来自CLB的流量。
16783
+ 开启放通(true):只验证CLB上的安全组;
16784
+ 不开启放通(false):需同时验证CLB和后端实例上的安全组。
16785
+ 不填则不修改。
16669
16786
  :rtype: bool
16670
16787
  """
16671
16788
  return self._LoadBalancerPassToTarget
@@ -16676,7 +16793,7 @@ class ModifyLoadBalancerAttributesRequest(AbstractModel):
16676
16793
 
16677
16794
  @property
16678
16795
  def SnatPro(self):
16679
- """是否开启跨地域绑定2.0功能
16796
+ """是否开启跨地域绑定2.0功能。不填则不修改。
16680
16797
  :rtype: bool
16681
16798
  """
16682
16799
  return self._SnatPro
@@ -16687,7 +16804,7 @@ class ModifyLoadBalancerAttributesRequest(AbstractModel):
16687
16804
 
16688
16805
  @property
16689
16806
  def DeleteProtect(self):
16690
- """是否开启删除保护
16807
+ """是否开启删除保护,不填则不修改。
16691
16808
  :rtype: bool
16692
16809
  """
16693
16810
  return self._DeleteProtect
@@ -16698,7 +16815,7 @@ class ModifyLoadBalancerAttributesRequest(AbstractModel):
16698
16815
 
16699
16816
  @property
16700
16817
  def ModifyClassicDomain(self):
16701
- """将负载均衡二级域名由mycloud.com改为tencentclb.com,子域名也会变换。修改后mycloud.com域名将失效。
16818
+ """将负载均衡二级域名由mycloud.com改为tencentclb.com,子域名也会变换,修改后mycloud.com域名将失效。不填则不修改。
16702
16819
  :rtype: bool
16703
16820
  """
16704
16821
  return self._ModifyClassicDomain
@@ -17025,11 +17142,11 @@ class ModifyRuleRequest(AbstractModel):
17025
17142
 
17026
17143
  def __init__(self):
17027
17144
  r"""
17028
- :param _LoadBalancerId: 负载均衡实例 ID
17145
+ :param _LoadBalancerId: 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
17029
17146
  :type LoadBalancerId: str
17030
- :param _ListenerId: 负载均衡监听器 ID
17147
+ :param _ListenerId: 负载均衡监听器 ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口获取。
17031
17148
  :type ListenerId: str
17032
- :param _LocationId: 要修改的转发规则的 ID
17149
+ :param _LocationId: 要修改的转发规则的 ID, 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口获取。
17033
17150
  :type LocationId: str
17034
17151
  :param _Url: 转发规则的新的转发路径,如不需修改Url,则不需提供此参数。
17035
17152
  :type Url: str
@@ -17039,6 +17156,7 @@ class ModifyRuleRequest(AbstractModel):
17039
17156
  分别表示按权重轮询、最小连接数、按IP哈希, 默认为 WRR。
17040
17157
  :type Scheduler: str
17041
17158
  :param _SessionExpireTime: 会话保持时间。取值范围0或30-86400(单位:秒)。
17159
+ 默认为0。
17042
17160
  :type SessionExpireTime: int
17043
17161
  :param _ForwardType: 负载均衡实例与后端服务之间的转发协议,默认HTTP,可取值:HTTP、HTTPS、GRPC。仅HTTPS监听器该参数有效。
17044
17162
  :type ForwardType: str
@@ -17063,7 +17181,7 @@ class ModifyRuleRequest(AbstractModel):
17063
17181
 
17064
17182
  @property
17065
17183
  def LoadBalancerId(self):
17066
- """负载均衡实例 ID
17184
+ """负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
17067
17185
  :rtype: str
17068
17186
  """
17069
17187
  return self._LoadBalancerId
@@ -17074,7 +17192,7 @@ class ModifyRuleRequest(AbstractModel):
17074
17192
 
17075
17193
  @property
17076
17194
  def ListenerId(self):
17077
- """负载均衡监听器 ID
17195
+ """负载均衡监听器 ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口获取。
17078
17196
  :rtype: str
17079
17197
  """
17080
17198
  return self._ListenerId
@@ -17085,7 +17203,7 @@ class ModifyRuleRequest(AbstractModel):
17085
17203
 
17086
17204
  @property
17087
17205
  def LocationId(self):
17088
- """要修改的转发规则的 ID
17206
+ """要修改的转发规则的 ID, 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口获取。
17089
17207
  :rtype: str
17090
17208
  """
17091
17209
  return self._LocationId
@@ -17131,6 +17249,7 @@ class ModifyRuleRequest(AbstractModel):
17131
17249
  @property
17132
17250
  def SessionExpireTime(self):
17133
17251
  """会话保持时间。取值范围0或30-86400(单位:秒)。
17252
+ 默认为0。
17134
17253
  :rtype: int
17135
17254
  """
17136
17255
  return self._SessionExpireTime
@@ -17922,9 +18041,12 @@ class OAuth(AbstractModel):
17922
18041
  :param _OAuthEnable: 开启或关闭鉴权。
17923
18042
  True: 开启;
17924
18043
  False: 关闭
18044
+ 默认为关闭。
17925
18045
  :type OAuthEnable: bool
17926
- :param _OAuthFailureStatus: IAP全部故障后,拒绝请求还是放行。BYPASS:通过,
18046
+ :param _OAuthFailureStatus: IAP全部故障后,拒绝请求还是放行。
18047
+ BYPASS: 通过
17927
18048
  REJECT: 拒绝
18049
+ 默认为 BYPASS
17928
18050
  :type OAuthFailureStatus: str
17929
18051
  """
17930
18052
  self._OAuthEnable = None
@@ -17935,6 +18057,7 @@ REJECT: 拒绝
17935
18057
  """开启或关闭鉴权。
17936
18058
  True: 开启;
17937
18059
  False: 关闭
18060
+ 默认为关闭。
17938
18061
  :rtype: bool
17939
18062
  """
17940
18063
  return self._OAuthEnable
@@ -17945,8 +18068,10 @@ False: 关闭
17945
18068
 
17946
18069
  @property
17947
18070
  def OAuthFailureStatus(self):
17948
- """IAP全部故障后,拒绝请求还是放行。BYPASS:通过,
18071
+ """IAP全部故障后,拒绝请求还是放行。
18072
+ BYPASS: 通过
17949
18073
  REJECT: 拒绝
18074
+ 默认为 BYPASS
17950
18075
  :rtype: str
17951
18076
  """
17952
18077
  return self._OAuthFailureStatus