Class: TencentCloud::Tse::V20201207::CloudNativeAPIGatewayRateLimitDetail

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

Overview

云原生网关Tse 限流插件配置

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(enabled = nil, qpsthresholds = nil, path = nil, header = nil, limitby = nil, externalredis = nil, policy = nil, ratelimitresponse = nil, ratelimitresponseurl = nil, responsetype = nil, hideclientheaders = nil, lineuptime = nil, isdelay = nil, basiclimitqpsthresholds = nil, limitrules = nil) ⇒ CloudNativeAPIGatewayRateLimitDetail

Returns a new instance of CloudNativeAPIGatewayRateLimitDetail.



742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
# File 'lib/v20201207/models.rb', line 742

def initialize(enabled=nil, qpsthresholds=nil, path=nil, header=nil, limitby=nil, externalredis=nil, policy=nil, ratelimitresponse=nil, ratelimitresponseurl=nil, responsetype=nil, hideclientheaders=nil, lineuptime=nil, isdelay=nil, basiclimitqpsthresholds=nil, limitrules=nil)
  @Enabled = enabled
  @QpsThresholds = qpsthresholds
  @Path = path
  @Header = header
  @LimitBy = limitby
  @ExternalRedis = externalredis
  @Policy = policy
  @RateLimitResponse = ratelimitresponse
  @RateLimitResponseUrl = ratelimitresponseurl
  @ResponseType = responsetype
  @HideClientHeaders = hideclientheaders
  @LineUpTime = lineuptime
  @IsDelay = isdelay
  @BasicLimitQpsThresholds = basiclimitqpsthresholds
  @LimitRules = limitrules
end

Instance Attribute Details

#BasicLimitQpsThresholdsObject

ip service consumer credential path header local 单机redis 默认redis external_redis 外部redis url请求转发text 响应配置default 直接返回注意:此字段可能返回 null,表示取不到有效值。注意:此字段可能返回 null,表示取不到有效值。

Parameters:

  • Enabled:

    插件启用状态

  • QpsThresholds:

    qps阈值

  • Path:

    需要进行流量控制的请求路径

  • Header:

    需要进行流量控制的请求头Key

  • LimitBy:

    限流依据

  • ExternalRedis:

    外部redis配置

  • Policy:

    计数器策略

  • RateLimitResponse:

    响应配置,响应策略为text

  • RateLimitResponseUrl:

    请求转发地址

  • ResponseType:

    响应策略

  • HideClientHeaders:

    是否隐藏限流客户端响应头

  • LineUpTime:

    排队时间

  • IsDelay:

    是否开启请求排队

  • BasicLimitQpsThresholds:

    基础限流

  • LimitRules:

    参数限流的规则



740
741
742
# File 'lib/v20201207/models.rb', line 740

def BasicLimitQpsThresholds
  @BasicLimitQpsThresholds
end

#EnabledObject

ip service consumer credential path header local 单机redis 默认redis external_redis 外部redis url请求转发text 响应配置default 直接返回注意:此字段可能返回 null,表示取不到有效值。注意:此字段可能返回 null,表示取不到有效值。

Parameters:

  • Enabled:

    插件启用状态

  • QpsThresholds:

    qps阈值

  • Path:

    需要进行流量控制的请求路径

  • Header:

    需要进行流量控制的请求头Key

  • LimitBy:

    限流依据

  • ExternalRedis:

    外部redis配置

  • Policy:

    计数器策略

  • RateLimitResponse:

    响应配置,响应策略为text

  • RateLimitResponseUrl:

    请求转发地址

  • ResponseType:

    响应策略

  • HideClientHeaders:

    是否隐藏限流客户端响应头

  • LineUpTime:

    排队时间

  • IsDelay:

    是否开启请求排队

  • BasicLimitQpsThresholds:

    基础限流

  • LimitRules:

    参数限流的规则



740
741
742
# File 'lib/v20201207/models.rb', line 740

def Enabled
  @Enabled
end

#ExternalRedisObject

ip service consumer credential path header local 单机redis 默认redis external_redis 外部redis url请求转发text 响应配置default 直接返回注意:此字段可能返回 null,表示取不到有效值。注意:此字段可能返回 null,表示取不到有效值。

Parameters:

  • Enabled:

    插件启用状态

  • QpsThresholds:

    qps阈值

  • Path:

    需要进行流量控制的请求路径

  • Header:

    需要进行流量控制的请求头Key

  • LimitBy:

    限流依据

  • ExternalRedis:

    外部redis配置

  • Policy:

    计数器策略

  • RateLimitResponse:

    响应配置,响应策略为text

  • RateLimitResponseUrl:

    请求转发地址

  • ResponseType:

    响应策略

  • HideClientHeaders:

    是否隐藏限流客户端响应头

  • LineUpTime:

    排队时间

  • IsDelay:

    是否开启请求排队

  • BasicLimitQpsThresholds:

    基础限流

  • LimitRules:

    参数限流的规则



740
741
742
# File 'lib/v20201207/models.rb', line 740

def ExternalRedis
  @ExternalRedis
end

#HeaderObject

ip service consumer credential path header local 单机redis 默认redis external_redis 外部redis url请求转发text 响应配置default 直接返回注意:此字段可能返回 null,表示取不到有效值。注意:此字段可能返回 null,表示取不到有效值。

Parameters:

  • Enabled:

    插件启用状态

  • QpsThresholds:

    qps阈值

  • Path:

    需要进行流量控制的请求路径

  • Header:

    需要进行流量控制的请求头Key

  • LimitBy:

    限流依据

  • ExternalRedis:

    外部redis配置

  • Policy:

    计数器策略

  • RateLimitResponse:

    响应配置,响应策略为text

  • RateLimitResponseUrl:

    请求转发地址

  • ResponseType:

    响应策略

  • HideClientHeaders:

    是否隐藏限流客户端响应头

  • LineUpTime:

    排队时间

  • IsDelay:

    是否开启请求排队

  • BasicLimitQpsThresholds:

    基础限流

  • LimitRules:

    参数限流的规则



740
741
742
# File 'lib/v20201207/models.rb', line 740

def Header
  @Header
end

#HideClientHeadersObject

ip service consumer credential path header local 单机redis 默认redis external_redis 外部redis url请求转发text 响应配置default 直接返回注意:此字段可能返回 null,表示取不到有效值。注意:此字段可能返回 null,表示取不到有效值。

Parameters:

  • Enabled:

    插件启用状态

  • QpsThresholds:

    qps阈值

  • Path:

    需要进行流量控制的请求路径

  • Header:

    需要进行流量控制的请求头Key

  • LimitBy:

    限流依据

  • ExternalRedis:

    外部redis配置

  • Policy:

    计数器策略

  • RateLimitResponse:

    响应配置,响应策略为text

  • RateLimitResponseUrl:

    请求转发地址

  • ResponseType:

    响应策略

  • HideClientHeaders:

    是否隐藏限流客户端响应头

  • LineUpTime:

    排队时间

  • IsDelay:

    是否开启请求排队

  • BasicLimitQpsThresholds:

    基础限流

  • LimitRules:

    参数限流的规则



740
741
742
# File 'lib/v20201207/models.rb', line 740

def HideClientHeaders
  @HideClientHeaders
end

#IsDelayObject

ip service consumer credential path header local 单机redis 默认redis external_redis 外部redis url请求转发text 响应配置default 直接返回注意:此字段可能返回 null,表示取不到有效值。注意:此字段可能返回 null,表示取不到有效值。

Parameters:

  • Enabled:

    插件启用状态

  • QpsThresholds:

    qps阈值

  • Path:

    需要进行流量控制的请求路径

  • Header:

    需要进行流量控制的请求头Key

  • LimitBy:

    限流依据

  • ExternalRedis:

    外部redis配置

  • Policy:

    计数器策略

  • RateLimitResponse:

    响应配置,响应策略为text

  • RateLimitResponseUrl:

    请求转发地址

  • ResponseType:

    响应策略

  • HideClientHeaders:

    是否隐藏限流客户端响应头

  • LineUpTime:

    排队时间

  • IsDelay:

    是否开启请求排队

  • BasicLimitQpsThresholds:

    基础限流

  • LimitRules:

    参数限流的规则



740
741
742
# File 'lib/v20201207/models.rb', line 740

def IsDelay
  @IsDelay
end

#LimitByObject

ip service consumer credential path header local 单机redis 默认redis external_redis 外部redis url请求转发text 响应配置default 直接返回注意:此字段可能返回 null,表示取不到有效值。注意:此字段可能返回 null,表示取不到有效值。

Parameters:

  • Enabled:

    插件启用状态

  • QpsThresholds:

    qps阈值

  • Path:

    需要进行流量控制的请求路径

  • Header:

    需要进行流量控制的请求头Key

  • LimitBy:

    限流依据

  • ExternalRedis:

    外部redis配置

  • Policy:

    计数器策略

  • RateLimitResponse:

    响应配置,响应策略为text

  • RateLimitResponseUrl:

    请求转发地址

  • ResponseType:

    响应策略

  • HideClientHeaders:

    是否隐藏限流客户端响应头

  • LineUpTime:

    排队时间

  • IsDelay:

    是否开启请求排队

  • BasicLimitQpsThresholds:

    基础限流

  • LimitRules:

    参数限流的规则



740
741
742
# File 'lib/v20201207/models.rb', line 740

def LimitBy
  @LimitBy
end

#LimitRulesObject

ip service consumer credential path header local 单机redis 默认redis external_redis 外部redis url请求转发text 响应配置default 直接返回注意:此字段可能返回 null,表示取不到有效值。注意:此字段可能返回 null,表示取不到有效值。

Parameters:

  • Enabled:

    插件启用状态

  • QpsThresholds:

    qps阈值

  • Path:

    需要进行流量控制的请求路径

  • Header:

    需要进行流量控制的请求头Key

  • LimitBy:

    限流依据

  • ExternalRedis:

    外部redis配置

  • Policy:

    计数器策略

  • RateLimitResponse:

    响应配置,响应策略为text

  • RateLimitResponseUrl:

    请求转发地址

  • ResponseType:

    响应策略

  • HideClientHeaders:

    是否隐藏限流客户端响应头

  • LineUpTime:

    排队时间

  • IsDelay:

    是否开启请求排队

  • BasicLimitQpsThresholds:

    基础限流

  • LimitRules:

    参数限流的规则



740
741
742
# File 'lib/v20201207/models.rb', line 740

def LimitRules
  @LimitRules
end

#LineUpTimeObject

ip service consumer credential path header local 单机redis 默认redis external_redis 外部redis url请求转发text 响应配置default 直接返回注意:此字段可能返回 null,表示取不到有效值。注意:此字段可能返回 null,表示取不到有效值。

Parameters:

  • Enabled:

    插件启用状态

  • QpsThresholds:

    qps阈值

  • Path:

    需要进行流量控制的请求路径

  • Header:

    需要进行流量控制的请求头Key

  • LimitBy:

    限流依据

  • ExternalRedis:

    外部redis配置

  • Policy:

    计数器策略

  • RateLimitResponse:

    响应配置,响应策略为text

  • RateLimitResponseUrl:

    请求转发地址

  • ResponseType:

    响应策略

  • HideClientHeaders:

    是否隐藏限流客户端响应头

  • LineUpTime:

    排队时间

  • IsDelay:

    是否开启请求排队

  • BasicLimitQpsThresholds:

    基础限流

  • LimitRules:

    参数限流的规则



740
741
742
# File 'lib/v20201207/models.rb', line 740

def LineUpTime
  @LineUpTime
end

#PathObject

ip service consumer credential path header local 单机redis 默认redis external_redis 外部redis url请求转发text 响应配置default 直接返回注意:此字段可能返回 null,表示取不到有效值。注意:此字段可能返回 null,表示取不到有效值。

Parameters:

  • Enabled:

    插件启用状态

  • QpsThresholds:

    qps阈值

  • Path:

    需要进行流量控制的请求路径

  • Header:

    需要进行流量控制的请求头Key

  • LimitBy:

    限流依据

  • ExternalRedis:

    外部redis配置

  • Policy:

    计数器策略

  • RateLimitResponse:

    响应配置,响应策略为text

  • RateLimitResponseUrl:

    请求转发地址

  • ResponseType:

    响应策略

  • HideClientHeaders:

    是否隐藏限流客户端响应头

  • LineUpTime:

    排队时间

  • IsDelay:

    是否开启请求排队

  • BasicLimitQpsThresholds:

    基础限流

  • LimitRules:

    参数限流的规则



740
741
742
# File 'lib/v20201207/models.rb', line 740

def Path
  @Path
end

#PolicyObject

ip service consumer credential path header local 单机redis 默认redis external_redis 外部redis url请求转发text 响应配置default 直接返回注意:此字段可能返回 null,表示取不到有效值。注意:此字段可能返回 null,表示取不到有效值。

Parameters:

  • Enabled:

    插件启用状态

  • QpsThresholds:

    qps阈值

  • Path:

    需要进行流量控制的请求路径

  • Header:

    需要进行流量控制的请求头Key

  • LimitBy:

    限流依据

  • ExternalRedis:

    外部redis配置

  • Policy:

    计数器策略

  • RateLimitResponse:

    响应配置,响应策略为text

  • RateLimitResponseUrl:

    请求转发地址

  • ResponseType:

    响应策略

  • HideClientHeaders:

    是否隐藏限流客户端响应头

  • LineUpTime:

    排队时间

  • IsDelay:

    是否开启请求排队

  • BasicLimitQpsThresholds:

    基础限流

  • LimitRules:

    参数限流的规则



740
741
742
# File 'lib/v20201207/models.rb', line 740

def Policy
  @Policy
end

#QpsThresholdsObject

ip service consumer credential path header local 单机redis 默认redis external_redis 外部redis url请求转发text 响应配置default 直接返回注意:此字段可能返回 null,表示取不到有效值。注意:此字段可能返回 null,表示取不到有效值。

Parameters:

  • Enabled:

    插件启用状态

  • QpsThresholds:

    qps阈值

  • Path:

    需要进行流量控制的请求路径

  • Header:

    需要进行流量控制的请求头Key

  • LimitBy:

    限流依据

  • ExternalRedis:

    外部redis配置

  • Policy:

    计数器策略

  • RateLimitResponse:

    响应配置,响应策略为text

  • RateLimitResponseUrl:

    请求转发地址

  • ResponseType:

    响应策略

  • HideClientHeaders:

    是否隐藏限流客户端响应头

  • LineUpTime:

    排队时间

  • IsDelay:

    是否开启请求排队

  • BasicLimitQpsThresholds:

    基础限流

  • LimitRules:

    参数限流的规则



740
741
742
# File 'lib/v20201207/models.rb', line 740

def QpsThresholds
  @QpsThresholds
end

#RateLimitResponseObject

ip service consumer credential path header local 单机redis 默认redis external_redis 外部redis url请求转发text 响应配置default 直接返回注意:此字段可能返回 null,表示取不到有效值。注意:此字段可能返回 null,表示取不到有效值。

Parameters:

  • Enabled:

    插件启用状态

  • QpsThresholds:

    qps阈值

  • Path:

    需要进行流量控制的请求路径

  • Header:

    需要进行流量控制的请求头Key

  • LimitBy:

    限流依据

  • ExternalRedis:

    外部redis配置

  • Policy:

    计数器策略

  • RateLimitResponse:

    响应配置,响应策略为text

  • RateLimitResponseUrl:

    请求转发地址

  • ResponseType:

    响应策略

  • HideClientHeaders:

    是否隐藏限流客户端响应头

  • LineUpTime:

    排队时间

  • IsDelay:

    是否开启请求排队

  • BasicLimitQpsThresholds:

    基础限流

  • LimitRules:

    参数限流的规则



740
741
742
# File 'lib/v20201207/models.rb', line 740

def RateLimitResponse
  @RateLimitResponse
end

#RateLimitResponseUrlObject

ip service consumer credential path header local 单机redis 默认redis external_redis 外部redis url请求转发text 响应配置default 直接返回注意:此字段可能返回 null,表示取不到有效值。注意:此字段可能返回 null,表示取不到有效值。

Parameters:

  • Enabled:

    插件启用状态

  • QpsThresholds:

    qps阈值

  • Path:

    需要进行流量控制的请求路径

  • Header:

    需要进行流量控制的请求头Key

  • LimitBy:

    限流依据

  • ExternalRedis:

    外部redis配置

  • Policy:

    计数器策略

  • RateLimitResponse:

    响应配置,响应策略为text

  • RateLimitResponseUrl:

    请求转发地址

  • ResponseType:

    响应策略

  • HideClientHeaders:

    是否隐藏限流客户端响应头

  • LineUpTime:

    排队时间

  • IsDelay:

    是否开启请求排队

  • BasicLimitQpsThresholds:

    基础限流

  • LimitRules:

    参数限流的规则



740
741
742
# File 'lib/v20201207/models.rb', line 740

def RateLimitResponseUrl
  @RateLimitResponseUrl
end

#ResponseTypeObject

ip service consumer credential path header local 单机redis 默认redis external_redis 外部redis url请求转发text 响应配置default 直接返回注意:此字段可能返回 null,表示取不到有效值。注意:此字段可能返回 null,表示取不到有效值。

Parameters:

  • Enabled:

    插件启用状态

  • QpsThresholds:

    qps阈值

  • Path:

    需要进行流量控制的请求路径

  • Header:

    需要进行流量控制的请求头Key

  • LimitBy:

    限流依据

  • ExternalRedis:

    外部redis配置

  • Policy:

    计数器策略

  • RateLimitResponse:

    响应配置,响应策略为text

  • RateLimitResponseUrl:

    请求转发地址

  • ResponseType:

    响应策略

  • HideClientHeaders:

    是否隐藏限流客户端响应头

  • LineUpTime:

    排队时间

  • IsDelay:

    是否开启请求排队

  • BasicLimitQpsThresholds:

    基础限流

  • LimitRules:

    参数限流的规则



740
741
742
# File 'lib/v20201207/models.rb', line 740

def ResponseType
  @ResponseType
end

Instance Method Details

#deserialize(params) ⇒ Object



760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
# File 'lib/v20201207/models.rb', line 760

def deserialize(params)
  @Enabled = params['Enabled']
  unless params['QpsThresholds'].nil?
    @QpsThresholds = []
    params['QpsThresholds'].each do |i|
      qpsthreshold_tmp = QpsThreshold.new
      qpsthreshold_tmp.deserialize(i)
      @QpsThresholds << qpsthreshold_tmp
    end
  end
  @Path = params['Path']
  @Header = params['Header']
  @LimitBy = params['LimitBy']
  unless params['ExternalRedis'].nil?
    @ExternalRedis = ExternalRedis.new
    @ExternalRedis.deserialize(params['ExternalRedis'])
  end
  @Policy = params['Policy']
  unless params['RateLimitResponse'].nil?
    @RateLimitResponse = RateLimitResponse.new
    @RateLimitResponse.deserialize(params['RateLimitResponse'])
  end
  @RateLimitResponseUrl = params['RateLimitResponseUrl']
  @ResponseType = params['ResponseType']
  @HideClientHeaders = params['HideClientHeaders']
  @LineUpTime = params['LineUpTime']
  @IsDelay = params['IsDelay']
  unless params['BasicLimitQpsThresholds'].nil?
    @BasicLimitQpsThresholds = []
    params['BasicLimitQpsThresholds'].each do |i|
      qpsthreshold_tmp = QpsThreshold.new
      qpsthreshold_tmp.deserialize(i)
      @BasicLimitQpsThresholds << qpsthreshold_tmp
    end
  end
  unless params['LimitRules'].nil?
    @LimitRules = []
    params['LimitRules'].each do |i|
      limitrule_tmp = LimitRule.new
      limitrule_tmp.deserialize(i)
      @LimitRules << limitrule_tmp
    end
  end
end