volcenginecc.gtm.Rule

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

name string

The unique name of the resource.

args RuleArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

resource_name str

The unique name of the resource.

args RuleArgs

The arguments to resource properties.

opts ResourceOptions

Bag of options to control resource's behavior.

ctx Context

Context object for the current deployment.

name string

The unique name of the resource.

args RuleArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args RuleArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args RuleArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

GtmId string

UUID of the GTM instance.

Name string

Route rule name.

PolicyType string

The policy type corresponding to the routing rule. geo: basic routing. perf: intelligent routing.

Disable bool

Whether this route rule is disabled. true: The route rule is disabled. false: The route rule is enabled.

EffectivePoolSetIndex int

Index of the effective address pool set.

Line string

Route rule applicable lines.

PoolSetMode string

Address pool set effective mode. auto: Automatically sets the effective address pool set. The highest-priority available address pool becomes effective automatically. If all address pools are unavailable, the highest-priority address pool becomes effective. manual: Manually sets the effective address pool set. In this mode, you need to set the index of the effective address pool set in the EffectivePoolSetIndex parameter.

PoolSets List<Volcengine.RulePoolSet>

Probe Volcengine.RuleProbe

Health check parameters for the route rule.

Remark string

Route rule remarks.

UsePolicyProbeNodes bool

Whether to inherit instance-level health check nodes.

UseRuleProbeConfig bool

Whether to use route rule-level probe configuration.

Weight int

Routing rule weight.

GtmId string

UUID of the GTM instance.

Name string

Route rule name.

PolicyType string

The policy type corresponding to the routing rule. geo: basic routing. perf: intelligent routing.

Disable bool

Whether this route rule is disabled. true: The route rule is disabled. false: The route rule is enabled.

EffectivePoolSetIndex int

Index of the effective address pool set.

Line string

Route rule applicable lines.

PoolSetMode string

Address pool set effective mode. auto: Automatically sets the effective address pool set. The highest-priority available address pool becomes effective automatically. If all address pools are unavailable, the highest-priority address pool becomes effective. manual: Manually sets the effective address pool set. In this mode, you need to set the index of the effective address pool set in the EffectivePoolSetIndex parameter.

PoolSets []RulePoolSetArgs

Probe RuleProbeArgs

Health check parameters for the route rule.

Remark string

Route rule remarks.

UsePolicyProbeNodes bool

Whether to inherit instance-level health check nodes.

UseRuleProbeConfig bool

Whether to use route rule-level probe configuration.

Weight int

Routing rule weight.

gtm_id string

UUID of the GTM instance.

name string

Route rule name.

policy_type string

The policy type corresponding to the routing rule. geo: basic routing. perf: intelligent routing.

disable bool

Whether this route rule is disabled. true: The route rule is disabled. false: The route rule is enabled.

effective_pool_set_index number

Index of the effective address pool set.

line string

Route rule applicable lines.

pool_set_mode string

Address pool set effective mode. auto: Automatically sets the effective address pool set. The highest-priority available address pool becomes effective automatically. If all address pools are unavailable, the highest-priority address pool becomes effective. manual: Manually sets the effective address pool set. In this mode, you need to set the index of the effective address pool set in the EffectivePoolSetIndex parameter.

pool_sets list(object)

probe object

Health check parameters for the route rule.

remark string

Route rule remarks.

use_policy_probe_nodes bool

Whether to inherit instance-level health check nodes.

use_rule_probe_config bool

Whether to use route rule-level probe configuration.

weight number

Routing rule weight.

gtmId String

UUID of the GTM instance.

name String

Route rule name.

policyType String

The policy type corresponding to the routing rule. geo: basic routing. perf: intelligent routing.

disable Boolean

Whether this route rule is disabled. true: The route rule is disabled. false: The route rule is enabled.

effectivePoolSetIndex Integer

Index of the effective address pool set.

line String

Route rule applicable lines.

poolSetMode String

Address pool set effective mode. auto: Automatically sets the effective address pool set. The highest-priority available address pool becomes effective automatically. If all address pools are unavailable, the highest-priority address pool becomes effective. manual: Manually sets the effective address pool set. In this mode, you need to set the index of the effective address pool set in the EffectivePoolSetIndex parameter.

poolSets List<RulePoolSet>

probe RuleProbe

Health check parameters for the route rule.

remark String

Route rule remarks.

usePolicyProbeNodes Boolean

Whether to inherit instance-level health check nodes.

useRuleProbeConfig Boolean

Whether to use route rule-level probe configuration.

weight Integer

Routing rule weight.

gtmId string

UUID of the GTM instance.

name string

Route rule name.

policyType string

The policy type corresponding to the routing rule. geo: basic routing. perf: intelligent routing.

disable boolean

Whether this route rule is disabled. true: The route rule is disabled. false: The route rule is enabled.

effectivePoolSetIndex number

Index of the effective address pool set.

line string

Route rule applicable lines.

poolSetMode string

Address pool set effective mode. auto: Automatically sets the effective address pool set. The highest-priority available address pool becomes effective automatically. If all address pools are unavailable, the highest-priority address pool becomes effective. manual: Manually sets the effective address pool set. In this mode, you need to set the index of the effective address pool set in the EffectivePoolSetIndex parameter.

poolSets RulePoolSet[]

probe RuleProbe

Health check parameters for the route rule.

remark string

Route rule remarks.

usePolicyProbeNodes boolean

Whether to inherit instance-level health check nodes.

useRuleProbeConfig boolean

Whether to use route rule-level probe configuration.

weight number

Routing rule weight.

gtm_id str

UUID of the GTM instance.

name str

Route rule name.

policy_type str

The policy type corresponding to the routing rule. geo: basic routing. perf: intelligent routing.

disable bool

Whether this route rule is disabled. true: The route rule is disabled. false: The route rule is enabled.

effective_pool_set_index int

Index of the effective address pool set.

line str

Route rule applicable lines.

pool_set_mode str

Address pool set effective mode. auto: Automatically sets the effective address pool set. The highest-priority available address pool becomes effective automatically. If all address pools are unavailable, the highest-priority address pool becomes effective. manual: Manually sets the effective address pool set. In this mode, you need to set the index of the effective address pool set in the EffectivePoolSetIndex parameter.

pool_sets Sequence[RulePoolSetArgs]

probe RuleProbeArgs

Health check parameters for the route rule.

remark str

Route rule remarks.

use_policy_probe_nodes bool

Whether to inherit instance-level health check nodes.

use_rule_probe_config bool

Whether to use route rule-level probe configuration.

weight int

Routing rule weight.

gtmId String

UUID of the GTM instance.

name String

Route rule name.

policyType String

The policy type corresponding to the routing rule. geo: basic routing. perf: intelligent routing.

disable Boolean

Whether this route rule is disabled. true: The route rule is disabled. false: The route rule is enabled.

effectivePoolSetIndex Number

Index of the effective address pool set.

line String

Route rule applicable lines.

poolSetMode String

Address pool set effective mode. auto: Automatically sets the effective address pool set. The highest-priority available address pool becomes effective automatically. If all address pools are unavailable, the highest-priority address pool becomes effective. manual: Manually sets the effective address pool set. In this mode, you need to set the index of the effective address pool set in the EffectivePoolSetIndex parameter.

poolSets List<Property Map>

probe Property Map

Health check parameters for the route rule.

remark String

Route rule remarks.

usePolicyProbeNodes Boolean

Whether to inherit instance-level health check nodes.

useRuleProbeConfig Boolean

Whether to use route rule-level probe configuration.

weight Number

Routing rule weight.

CreateTime string

Route rule creation time.

Id string

The provider-assigned unique ID for this managed resource.

ProbeMode string

Health check mode.

RuleId string

Routing rule ID.

UpdateTime string

Route rule update time.

CreateTime string

Route rule creation time.

Id string

The provider-assigned unique ID for this managed resource.

ProbeMode string

Health check mode.

RuleId string

Routing rule ID.

UpdateTime string

Route rule update time.

create_time string

Route rule creation time.

id string

The provider-assigned unique ID for this managed resource.

probe_mode string

Health check mode.

rule_id string

Routing rule ID.

update_time string

Route rule update time.

createTime String

Route rule creation time.

id String

The provider-assigned unique ID for this managed resource.

probeMode String

Health check mode.

ruleId String

Routing rule ID.

updateTime String

Route rule update time.

createTime string

Route rule creation time.

id string

The provider-assigned unique ID for this managed resource.

probeMode string

Health check mode.

ruleId string

Routing rule ID.

updateTime string

Route rule update time.

create_time str

Route rule creation time.

id str

The provider-assigned unique ID for this managed resource.

probe_mode str

Health check mode.

rule_id str

Routing rule ID.

update_time str

Route rule update time.

createTime String

Route rule creation time.

id String

The provider-assigned unique ID for this managed resource.

probeMode String

Health check mode.

ruleId String

Routing rule ID.

updateTime String

Route rule update time.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

resource_name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

ActiveAddrThr int

Minimum number of available addresses required for the address pool collection to be considered available.

Name string

Address pool name.

Pools List<Volcengine.RulePoolSetPool>

ActiveAddrThr int

Minimum number of available addresses required for the address pool collection to be considered available.

Name string

Address pool name.

Pools []RulePoolSetPool

active_addr_thr number

Minimum number of available addresses required for the address pool collection to be considered available.

name string

Address pool name.

pools list(object)

activeAddrThr Integer

Minimum number of available addresses required for the address pool collection to be considered available.

name String

Address pool name.

pools List<RulePoolSetPool>

activeAddrThr number

Minimum number of available addresses required for the address pool collection to be considered available.

name string

Address pool name.

pools RulePoolSetPool[]

active_addr_thr int

Minimum number of available addresses required for the address pool collection to be considered available.

name str

Address pool name.

pools Sequence[RulePoolSetPool]

activeAddrThr Number

Minimum number of available addresses required for the address pool collection to be considered available.

name String

Address pool name.

pools List<Property Map>

Addresses List<Volcengine.RulePoolSetPoolAddress>

InactiveAddrCount int

The number of unavailable addresses in the address pool.

Name string

Address pool name.

PoolId string

Address pool ID.

Weight int

Address pool weight.

Addresses []RulePoolSetPoolAddress

InactiveAddrCount int

The number of unavailable addresses in the address pool.

Name string

Address pool name.

PoolId string

Address pool ID.

Weight int

Address pool weight.

addresses list(object)

inactive_addr_count number

The number of unavailable addresses in the address pool.

name string

Address pool name.

pool_id string

Address pool ID.

weight number

Address pool weight.

addresses List<RulePoolSetPoolAddress>

inactiveAddrCount Integer

The number of unavailable addresses in the address pool.

name String

Address pool name.

poolId String

Address pool ID.

weight Integer

Address pool weight.

addresses RulePoolSetPoolAddress[]

inactiveAddrCount number

The number of unavailable addresses in the address pool.

name string

Address pool name.

poolId string

Address pool ID.

weight number

Address pool weight.

addresses Sequence[RulePoolSetPoolAddress]

inactive_addr_count int

The number of unavailable addresses in the address pool.

name str

Address pool name.

pool_id str

Address pool ID.

weight int

Address pool weight.

addresses List<Property Map>

inactiveAddrCount Number

The number of unavailable addresses in the address pool.

name String

Address pool name.

poolId String

Address pool ID.

weight Number

Address pool weight.

Active bool

Whether the address is available. true: The address is available. false: The address is unavailable.

Capacity int

The capacity of the address. For addresses without a set capacity value, this parameter returns the default capacity value of 1000.

Geo string

This parameter has no practical significance. You can ignore this parameter.

Latency int

Latency (ms) for health check probe accessing the target address.

Mode string

The mechanism for determining whether an address is available. auto: automatic mode. Cloud Scheduling GTM determines address availability based on health check results. alwayson: address is always available. alwaysoff: address is always unavailable.

RectifiedGeos List<string>

The assigned region for the target address. See line codes for the mapping between line codes and specific regions (i.e., lines).

Value string

Address.

Weight int

Address weight. For addresses without a specified weight, this parameter returns the default weight value of 1.

Active bool

Whether the address is available. true: The address is available. false: The address is unavailable.

Capacity int

The capacity of the address. For addresses without a set capacity value, this parameter returns the default capacity value of 1000.

Geo string

This parameter has no practical significance. You can ignore this parameter.

Latency int

Latency (ms) for health check probe accessing the target address.

Mode string

The mechanism for determining whether an address is available. auto: automatic mode. Cloud Scheduling GTM determines address availability based on health check results. alwayson: address is always available. alwaysoff: address is always unavailable.

RectifiedGeos []string

The assigned region for the target address. See line codes for the mapping between line codes and specific regions (i.e., lines).

Value string

Address.

Weight int

Address weight. For addresses without a specified weight, this parameter returns the default weight value of 1.

active bool

Whether the address is available. true: The address is available. false: The address is unavailable.

capacity number

The capacity of the address. For addresses without a set capacity value, this parameter returns the default capacity value of 1000.

geo string

This parameter has no practical significance. You can ignore this parameter.

latency number

Latency (ms) for health check probe accessing the target address.

mode string

The mechanism for determining whether an address is available. auto: automatic mode. Cloud Scheduling GTM determines address availability based on health check results. alwayson: address is always available. alwaysoff: address is always unavailable.

rectified_geos list(string)

The assigned region for the target address. See line codes for the mapping between line codes and specific regions (i.e., lines).

value string

Address.

weight number

Address weight. For addresses without a specified weight, this parameter returns the default weight value of 1.

active Boolean

Whether the address is available. true: The address is available. false: The address is unavailable.

capacity Integer

The capacity of the address. For addresses without a set capacity value, this parameter returns the default capacity value of 1000.

geo String

This parameter has no practical significance. You can ignore this parameter.

latency Integer

Latency (ms) for health check probe accessing the target address.

mode String

The mechanism for determining whether an address is available. auto: automatic mode. Cloud Scheduling GTM determines address availability based on health check results. alwayson: address is always available. alwaysoff: address is always unavailable.

rectifiedGeos List<String>

The assigned region for the target address. See line codes for the mapping between line codes and specific regions (i.e., lines).

value String

Address.

weight Integer

Address weight. For addresses without a specified weight, this parameter returns the default weight value of 1.

active boolean

Whether the address is available. true: The address is available. false: The address is unavailable.

capacity number

The capacity of the address. For addresses without a set capacity value, this parameter returns the default capacity value of 1000.

geo string

This parameter has no practical significance. You can ignore this parameter.

latency number

Latency (ms) for health check probe accessing the target address.

mode string

The mechanism for determining whether an address is available. auto: automatic mode. Cloud Scheduling GTM determines address availability based on health check results. alwayson: address is always available. alwaysoff: address is always unavailable.

rectifiedGeos string[]

The assigned region for the target address. See line codes for the mapping between line codes and specific regions (i.e., lines).

value string

Address.

weight number

Address weight. For addresses without a specified weight, this parameter returns the default weight value of 1.

active bool

Whether the address is available. true: The address is available. false: The address is unavailable.

capacity int

The capacity of the address. For addresses without a set capacity value, this parameter returns the default capacity value of 1000.

geo str

This parameter has no practical significance. You can ignore this parameter.

latency int

Latency (ms) for health check probe accessing the target address.

mode str

The mechanism for determining whether an address is available. auto: automatic mode. Cloud Scheduling GTM determines address availability based on health check results. alwayson: address is always available. alwaysoff: address is always unavailable.

rectified_geos Sequence[str]

The assigned region for the target address. See line codes for the mapping between line codes and specific regions (i.e., lines).

value str

Address.

weight int

Address weight. For addresses without a specified weight, this parameter returns the default weight value of 1.

active Boolean

Whether the address is available. true: The address is available. false: The address is unavailable.

capacity Number

The capacity of the address. For addresses without a set capacity value, this parameter returns the default capacity value of 1000.

geo String

This parameter has no practical significance. You can ignore this parameter.

latency Number

Latency (ms) for health check probe accessing the target address.

mode String

The mechanism for determining whether an address is available. auto: automatic mode. Cloud Scheduling GTM determines address availability based on health check results. alwayson: address is always available. alwaysoff: address is always unavailable.

rectifiedGeos List<String>

The assigned region for the target address. See line codes for the mapping between line codes and specific regions (i.e., lines).

value String

Address.

weight Number

Address weight. For addresses without a specified weight, this parameter returns the default weight value of 1.

AdvisedNodeCount int

Recommended number of health check probe points.

Disable bool

Whether health checks are disabled. true: disabled. false: not disabled.

FailedCount int

The threshold for the number of health check failures before a single target address is considered faulty. For example, if you set this parameter to 3, a target address is marked as faulty after 3 consecutive health check failures. The default value is 3.

Host string

Domain name of the health check target address. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

HttpMethod string

HTTP request method. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

HttpUsabilityCodes List<Volcengine.RuleProbeHttpUsabilityCode>

Interval int

The interval between each health check, in seconds.

IsManualNodes bool

Whether to manually configure the health check probe. true: Manually configure the health check probe. false: Use recommended health check probe.

Nodes List<string>

Health check probe point.

PingCount int

Packet count. If you set this parameter to 10, each ping check sends 10 packets simultaneously. This parameter is only valid when the health check protocol is set to ping.

PingLossPercent int

Packet loss rate, expressed as a percentage. If the packet loss rate exceeds this parameter, the result is considered abnormal. For example, if this parameter is set to 10 and the packet loss rate during the health check is 11%, the result is considered abnormal. This parameter is only valid when the health check protocol is set to ping.

Port int

Port of the health check target address. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

Protocol string

Protocol used for health checks. ping: ICMP protocol. tcp: TCP protocol. http: HTTP protocol. https: HTTPS protocol.

Timeout int

The timeout period for the health check task, in seconds. ping: If the latency exceeds the value of Timeout, it is considered packet loss. http/https: If the latency exceeds the value of Timeout, it is considered an abnormal result.

Url string

Path part of the health check target address, starting with /. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

AdvisedNodeCount int

Recommended number of health check probe points.

Disable bool

Whether health checks are disabled. true: disabled. false: not disabled.

FailedCount int

The threshold for the number of health check failures before a single target address is considered faulty. For example, if you set this parameter to 3, a target address is marked as faulty after 3 consecutive health check failures. The default value is 3.

Host string

Domain name of the health check target address. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

HttpMethod string

HTTP request method. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

HttpUsabilityCodes []RuleProbeHttpUsabilityCode

Interval int

The interval between each health check, in seconds.

IsManualNodes bool

Whether to manually configure the health check probe. true: Manually configure the health check probe. false: Use recommended health check probe.

Nodes []string

Health check probe point.

PingCount int

Packet count. If you set this parameter to 10, each ping check sends 10 packets simultaneously. This parameter is only valid when the health check protocol is set to ping.

PingLossPercent int

Packet loss rate, expressed as a percentage. If the packet loss rate exceeds this parameter, the result is considered abnormal. For example, if this parameter is set to 10 and the packet loss rate during the health check is 11%, the result is considered abnormal. This parameter is only valid when the health check protocol is set to ping.

Port int

Port of the health check target address. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

Protocol string

Protocol used for health checks. ping: ICMP protocol. tcp: TCP protocol. http: HTTP protocol. https: HTTPS protocol.

Timeout int

The timeout period for the health check task, in seconds. ping: If the latency exceeds the value of Timeout, it is considered packet loss. http/https: If the latency exceeds the value of Timeout, it is considered an abnormal result.

Url string

Path part of the health check target address, starting with /. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

advised_node_count number

Recommended number of health check probe points.

disable bool

Whether health checks are disabled. true: disabled. false: not disabled.

failed_count number

The threshold for the number of health check failures before a single target address is considered faulty. For example, if you set this parameter to 3, a target address is marked as faulty after 3 consecutive health check failures. The default value is 3.

host string

Domain name of the health check target address. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

http_method string

HTTP request method. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

http_usability_codes list(object)

interval number

The interval between each health check, in seconds.

is_manual_nodes bool

Whether to manually configure the health check probe. true: Manually configure the health check probe. false: Use recommended health check probe.

nodes list(string)

Health check probe point.

ping_count number

Packet count. If you set this parameter to 10, each ping check sends 10 packets simultaneously. This parameter is only valid when the health check protocol is set to ping.

ping_loss_percent number

Packet loss rate, expressed as a percentage. If the packet loss rate exceeds this parameter, the result is considered abnormal. For example, if this parameter is set to 10 and the packet loss rate during the health check is 11%, the result is considered abnormal. This parameter is only valid when the health check protocol is set to ping.

port number

Port of the health check target address. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

protocol string

Protocol used for health checks. ping: ICMP protocol. tcp: TCP protocol. http: HTTP protocol. https: HTTPS protocol.

timeout number

The timeout period for the health check task, in seconds. ping: If the latency exceeds the value of Timeout, it is considered packet loss. http/https: If the latency exceeds the value of Timeout, it is considered an abnormal result.

url string

Path part of the health check target address, starting with /. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

advisedNodeCount Integer

Recommended number of health check probe points.

disable Boolean

Whether health checks are disabled. true: disabled. false: not disabled.

failedCount Integer

The threshold for the number of health check failures before a single target address is considered faulty. For example, if you set this parameter to 3, a target address is marked as faulty after 3 consecutive health check failures. The default value is 3.

host String

Domain name of the health check target address. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

httpMethod String

HTTP request method. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

httpUsabilityCodes List<RuleProbeHttpUsabilityCode>

interval Integer

The interval between each health check, in seconds.

isManualNodes Boolean

Whether to manually configure the health check probe. true: Manually configure the health check probe. false: Use recommended health check probe.

nodes List<String>

Health check probe point.

pingCount Integer

Packet count. If you set this parameter to 10, each ping check sends 10 packets simultaneously. This parameter is only valid when the health check protocol is set to ping.

pingLossPercent Integer

Packet loss rate, expressed as a percentage. If the packet loss rate exceeds this parameter, the result is considered abnormal. For example, if this parameter is set to 10 and the packet loss rate during the health check is 11%, the result is considered abnormal. This parameter is only valid when the health check protocol is set to ping.

port Integer

Port of the health check target address. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

protocol String

Protocol used for health checks. ping: ICMP protocol. tcp: TCP protocol. http: HTTP protocol. https: HTTPS protocol.

timeout Integer

The timeout period for the health check task, in seconds. ping: If the latency exceeds the value of Timeout, it is considered packet loss. http/https: If the latency exceeds the value of Timeout, it is considered an abnormal result.

url String

Path part of the health check target address, starting with /. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

advisedNodeCount number

Recommended number of health check probe points.

disable boolean

Whether health checks are disabled. true: disabled. false: not disabled.

failedCount number

The threshold for the number of health check failures before a single target address is considered faulty. For example, if you set this parameter to 3, a target address is marked as faulty after 3 consecutive health check failures. The default value is 3.

host string

Domain name of the health check target address. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

httpMethod string

HTTP request method. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

httpUsabilityCodes RuleProbeHttpUsabilityCode[]

interval number

The interval between each health check, in seconds.

isManualNodes boolean

Whether to manually configure the health check probe. true: Manually configure the health check probe. false: Use recommended health check probe.

nodes string[]

Health check probe point.

pingCount number

Packet count. If you set this parameter to 10, each ping check sends 10 packets simultaneously. This parameter is only valid when the health check protocol is set to ping.

pingLossPercent number

Packet loss rate, expressed as a percentage. If the packet loss rate exceeds this parameter, the result is considered abnormal. For example, if this parameter is set to 10 and the packet loss rate during the health check is 11%, the result is considered abnormal. This parameter is only valid when the health check protocol is set to ping.

port number

Port of the health check target address. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

protocol string

Protocol used for health checks. ping: ICMP protocol. tcp: TCP protocol. http: HTTP protocol. https: HTTPS protocol.

timeout number

The timeout period for the health check task, in seconds. ping: If the latency exceeds the value of Timeout, it is considered packet loss. http/https: If the latency exceeds the value of Timeout, it is considered an abnormal result.

url string

Path part of the health check target address, starting with /. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

advised_node_count int

Recommended number of health check probe points.

disable bool

Whether health checks are disabled. true: disabled. false: not disabled.

failed_count int

The threshold for the number of health check failures before a single target address is considered faulty. For example, if you set this parameter to 3, a target address is marked as faulty after 3 consecutive health check failures. The default value is 3.

host str

Domain name of the health check target address. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

http_method str

HTTP request method. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

http_usability_codes Sequence[RuleProbeHttpUsabilityCode]

interval int

The interval between each health check, in seconds.

is_manual_nodes bool

Whether to manually configure the health check probe. true: Manually configure the health check probe. false: Use recommended health check probe.

nodes Sequence[str]

Health check probe point.

ping_count int

Packet count. If you set this parameter to 10, each ping check sends 10 packets simultaneously. This parameter is only valid when the health check protocol is set to ping.

ping_loss_percent int

Packet loss rate, expressed as a percentage. If the packet loss rate exceeds this parameter, the result is considered abnormal. For example, if this parameter is set to 10 and the packet loss rate during the health check is 11%, the result is considered abnormal. This parameter is only valid when the health check protocol is set to ping.

port int

Port of the health check target address. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

protocol str

Protocol used for health checks. ping: ICMP protocol. tcp: TCP protocol. http: HTTP protocol. https: HTTPS protocol.

timeout int

The timeout period for the health check task, in seconds. ping: If the latency exceeds the value of Timeout, it is considered packet loss. http/https: If the latency exceeds the value of Timeout, it is considered an abnormal result.

url str

Path part of the health check target address, starting with /. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

advisedNodeCount Number

Recommended number of health check probe points.

disable Boolean

Whether health checks are disabled. true: disabled. false: not disabled.

failedCount Number

The threshold for the number of health check failures before a single target address is considered faulty. For example, if you set this parameter to 3, a target address is marked as faulty after 3 consecutive health check failures. The default value is 3.

host String

Domain name of the health check target address. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

httpMethod String

HTTP request method. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

httpUsabilityCodes List<Property Map>

interval Number

The interval between each health check, in seconds.

isManualNodes Boolean

Whether to manually configure the health check probe. true: Manually configure the health check probe. false: Use recommended health check probe.

nodes List<String>

Health check probe point.

pingCount Number

Packet count. If you set this parameter to 10, each ping check sends 10 packets simultaneously. This parameter is only valid when the health check protocol is set to ping.

pingLossPercent Number

Packet loss rate, expressed as a percentage. If the packet loss rate exceeds this parameter, the result is considered abnormal. For example, if this parameter is set to 10 and the packet loss rate during the health check is 11%, the result is considered abnormal. This parameter is only valid when the health check protocol is set to ping.

port Number

Port of the health check target address. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

protocol String

Protocol used for health checks. ping: ICMP protocol. tcp: TCP protocol. http: HTTP protocol. https: HTTPS protocol.

timeout Number

The timeout period for the health check task, in seconds. ping: If the latency exceeds the value of Timeout, it is considered packet loss. http/https: If the latency exceeds the value of Timeout, it is considered an abnormal result.

url String

Path part of the health check target address, starting with /. This parameter is only valid when the health check protocol is set to HTTP or HTTPS.

Codes List<int>

HTTP status code list.

Operator string

Operator. interval: Matches values within the range. include: Matches specified values. exclude: Matches values other than the specified values.

Codes []int

HTTP status code list.

Operator string

Operator. interval: Matches values within the range. include: Matches specified values. exclude: Matches values other than the specified values.

codes list(number)

HTTP status code list.

operator string

Operator. interval: Matches values within the range. include: Matches specified values. exclude: Matches values other than the specified values.

codes List<Integer>

HTTP status code list.

operator String

Operator. interval: Matches values within the range. include: Matches specified values. exclude: Matches values other than the specified values.

codes number[]

HTTP status code list.

operator string

Operator. interval: Matches values within the range. include: Matches specified values. exclude: Matches values other than the specified values.

codes Sequence[int]

HTTP status code list.

operator str

Operator. interval: Matches values within the range. include: Matches specified values. exclude: Matches values other than the specified values.

codes List<Number>

HTTP status code list.

operator String

Operator. interval: Matches values within the range. include: Matches specified values. exclude: Matches values other than the specified values.