getGtm

bytepluscc v0.0.39, Jul 9 26

Viewing docs for bytepluscc v0.0.39
published on Thursday, Jul 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.39
published on Thursday, Jul 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Using getGtm

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGtm(args: GetGtmArgs, opts?: InvokeOptions): Promise<GetGtmResult>
function getGtmOutput(args: GetGtmOutputArgs, opts?: InvokeOptions): Output<GetGtmResult>

def get_gtm(id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetGtmResult
def get_gtm_output(id: pulumi.Input[Optional[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetGtmResult]

func LookupGtm(ctx *Context, args *LookupGtmArgs, opts ...InvokeOption) (*LookupGtmResult, error)
func LookupGtmOutput(ctx *Context, args *LookupGtmOutputArgs, opts ...InvokeOption) LookupGtmResultOutput

> Note: This function is named LookupGtm in the Go SDK.

public static class GetGtm 
{
    public static Task<GetGtmResult> InvokeAsync(GetGtmArgs args, InvokeOptions? opts = null)
    public static Output<GetGtmResult> Invoke(GetGtmInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGtmResult> getGtm(GetGtmArgs args, InvokeOptions options)
public static Output<GetGtmResult> getGtm(GetGtmArgs args, InvokeOptions options)

fn::invoke:
  function: bytepluscc:gtm/getGtm:getGtm
  arguments:
    # arguments dictionary

data "bytepluscc_gtm_getgtm" "name" {
    # arguments
}

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getGtm Result

The following output properties are available:

AccessMode string: Access method for the GTM instance. cname means a scheduling domain name is generated and you configure CNAME at your DNS provider; domain means Cloud DNS directly resolves the business domain name to the target address
AlarmId string: Alarm rule ID associated with the GTM instance
Cname string: Scheduling domain name of the GTM instance
CreateTime string: Creation time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
Domain string: Domain name of the GTM instance, such as www.example.com
GtmId string: UUID of the GTM instance
Id string: Uniquely identifies the resource.
LastOperator string: Account that last operated the GTM instance
Owner string: Account that created the GTM instance
Policy Byteplus.GetGtmPolicy: Detailed configuration of the scheduling policy for the GTM instance.
PolicyType string: Routing policy type. geo indicates basic routing policy, perf indicates intelligent routing policy
Probe Byteplus.GetGtmProbe: Detailed configuration of the health check for the GTM instance.
ProjectName string: Project name to which the GTM instance belongs
Remark string: Remark information for the GTM instance
SpecName string: Feature version of the GTM instance. ultimate indicates flagship edition, standard indicates standard edition
State string: Current lifecycle status of the GTM instance, such as init: indicates the GTM instance has been successfully created but not yet configured. configuringAddress: indicates basic rule configuration is complete but target address configuration is not yet finished. editing: indicates both basic configuration and target address are completed but the instance is not yet enabled. running: indicates the instance is officially enabled
Ttl int: Expiration time of the DNS record, in seconds
UpdateTime string: Most recent modification time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
ZoneType string: This parameter has no practical significance and can be ignored

AccessMode string: Access method for the GTM instance. cname means a scheduling domain name is generated and you configure CNAME at your DNS provider; domain means Cloud DNS directly resolves the business domain name to the target address
AlarmId string: Alarm rule ID associated with the GTM instance
Cname string: Scheduling domain name of the GTM instance
CreateTime string: Creation time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
Domain string: Domain name of the GTM instance, such as www.example.com
GtmId string: UUID of the GTM instance
Id string: Uniquely identifies the resource.
LastOperator string: Account that last operated the GTM instance
Owner string: Account that created the GTM instance
Policy GetGtmPolicy: Detailed configuration of the scheduling policy for the GTM instance.
PolicyType string: Routing policy type. geo indicates basic routing policy, perf indicates intelligent routing policy
Probe GetGtmProbe: Detailed configuration of the health check for the GTM instance.
ProjectName string: Project name to which the GTM instance belongs
Remark string: Remark information for the GTM instance
SpecName string: Feature version of the GTM instance. ultimate indicates flagship edition, standard indicates standard edition
State string: Current lifecycle status of the GTM instance, such as init: indicates the GTM instance has been successfully created but not yet configured. configuringAddress: indicates basic rule configuration is complete but target address configuration is not yet finished. editing: indicates both basic configuration and target address are completed but the instance is not yet enabled. running: indicates the instance is officially enabled
Ttl int: Expiration time of the DNS record, in seconds
UpdateTime string: Most recent modification time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
ZoneType string: This parameter has no practical significance and can be ignored

access_mode string: Access method for the GTM instance. cname means a scheduling domain name is generated and you configure CNAME at your DNS provider; domain means Cloud DNS directly resolves the business domain name to the target address
alarm_id string: Alarm rule ID associated with the GTM instance
cname string: Scheduling domain name of the GTM instance
create_time string: Creation time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
domain string: Domain name of the GTM instance, such as www.example.com
gtm_id string: UUID of the GTM instance
id string: Uniquely identifies the resource.
last_operator string: Account that last operated the GTM instance
owner string: Account that created the GTM instance
policy object: Detailed configuration of the scheduling policy for the GTM instance.
policy_type string: Routing policy type. geo indicates basic routing policy, perf indicates intelligent routing policy
probe object: Detailed configuration of the health check for the GTM instance.
project_name string: Project name to which the GTM instance belongs
remark string: Remark information for the GTM instance
spec_name string: Feature version of the GTM instance. ultimate indicates flagship edition, standard indicates standard edition
state string: Current lifecycle status of the GTM instance, such as init: indicates the GTM instance has been successfully created but not yet configured. configuringAddress: indicates basic rule configuration is complete but target address configuration is not yet finished. editing: indicates both basic configuration and target address are completed but the instance is not yet enabled. running: indicates the instance is officially enabled
ttl number: Expiration time of the DNS record, in seconds
update_time string: Most recent modification time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
zone_type string: This parameter has no practical significance and can be ignored

accessMode String: Access method for the GTM instance. cname means a scheduling domain name is generated and you configure CNAME at your DNS provider; domain means Cloud DNS directly resolves the business domain name to the target address
alarmId String: Alarm rule ID associated with the GTM instance
cname String: Scheduling domain name of the GTM instance
createTime String: Creation time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
domain String: Domain name of the GTM instance, such as www.example.com
gtmId String: UUID of the GTM instance
id String: Uniquely identifies the resource.
lastOperator String: Account that last operated the GTM instance
owner String: Account that created the GTM instance
policy GetGtmPolicy: Detailed configuration of the scheduling policy for the GTM instance.
policyType String: Routing policy type. geo indicates basic routing policy, perf indicates intelligent routing policy
probe GetGtmProbe: Detailed configuration of the health check for the GTM instance.
projectName String: Project name to which the GTM instance belongs
remark String: Remark information for the GTM instance
specName String: Feature version of the GTM instance. ultimate indicates flagship edition, standard indicates standard edition
state String: Current lifecycle status of the GTM instance, such as init: indicates the GTM instance has been successfully created but not yet configured. configuringAddress: indicates basic rule configuration is complete but target address configuration is not yet finished. editing: indicates both basic configuration and target address are completed but the instance is not yet enabled. running: indicates the instance is officially enabled
ttl Integer: Expiration time of the DNS record, in seconds
updateTime String: Most recent modification time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
zoneType String: This parameter has no practical significance and can be ignored

accessMode string: Access method for the GTM instance. cname means a scheduling domain name is generated and you configure CNAME at your DNS provider; domain means Cloud DNS directly resolves the business domain name to the target address
alarmId string: Alarm rule ID associated with the GTM instance
cname string: Scheduling domain name of the GTM instance
createTime string: Creation time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
domain string: Domain name of the GTM instance, such as www.example.com
gtmId string: UUID of the GTM instance
id string: Uniquely identifies the resource.
lastOperator string: Account that last operated the GTM instance
owner string: Account that created the GTM instance
policy GetGtmPolicy: Detailed configuration of the scheduling policy for the GTM instance.
policyType string: Routing policy type. geo indicates basic routing policy, perf indicates intelligent routing policy
probe GetGtmProbe: Detailed configuration of the health check for the GTM instance.
projectName string: Project name to which the GTM instance belongs
remark string: Remark information for the GTM instance
specName string: Feature version of the GTM instance. ultimate indicates flagship edition, standard indicates standard edition
state string: Current lifecycle status of the GTM instance, such as init: indicates the GTM instance has been successfully created but not yet configured. configuringAddress: indicates basic rule configuration is complete but target address configuration is not yet finished. editing: indicates both basic configuration and target address are completed but the instance is not yet enabled. running: indicates the instance is officially enabled
ttl number: Expiration time of the DNS record, in seconds
updateTime string: Most recent modification time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
zoneType string: This parameter has no practical significance and can be ignored

access_mode str: Access method for the GTM instance. cname means a scheduling domain name is generated and you configure CNAME at your DNS provider; domain means Cloud DNS directly resolves the business domain name to the target address
alarm_id str: Alarm rule ID associated with the GTM instance
cname str: Scheduling domain name of the GTM instance
create_time str: Creation time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
domain str: Domain name of the GTM instance, such as www.example.com
gtm_id str: UUID of the GTM instance
id str: Uniquely identifies the resource.
last_operator str: Account that last operated the GTM instance
owner str: Account that created the GTM instance
policy GetGtmPolicy: Detailed configuration of the scheduling policy for the GTM instance.
policy_type str: Routing policy type. geo indicates basic routing policy, perf indicates intelligent routing policy
probe GetGtmProbe: Detailed configuration of the health check for the GTM instance.
project_name str: Project name to which the GTM instance belongs
remark str: Remark information for the GTM instance
spec_name str: Feature version of the GTM instance. ultimate indicates flagship edition, standard indicates standard edition
state str: Current lifecycle status of the GTM instance, such as init: indicates the GTM instance has been successfully created but not yet configured. configuringAddress: indicates basic rule configuration is complete but target address configuration is not yet finished. editing: indicates both basic configuration and target address are completed but the instance is not yet enabled. running: indicates the instance is officially enabled
ttl int: Expiration time of the DNS record, in seconds
update_time str: Most recent modification time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
zone_type str: This parameter has no practical significance and can be ignored

accessMode String: Access method for the GTM instance. cname means a scheduling domain name is generated and you configure CNAME at your DNS provider; domain means Cloud DNS directly resolves the business domain name to the target address
alarmId String: Alarm rule ID associated with the GTM instance
cname String: Scheduling domain name of the GTM instance
createTime String: Creation time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
domain String: Domain name of the GTM instance, such as www.example.com
gtmId String: UUID of the GTM instance
id String: Uniquely identifies the resource.
lastOperator String: Account that last operated the GTM instance
owner String: Account that created the GTM instance
policy Property Map: Detailed configuration of the scheduling policy for the GTM instance.
policyType String: Routing policy type. geo indicates basic routing policy, perf indicates intelligent routing policy
probe Property Map: Detailed configuration of the health check for the GTM instance.
projectName String: Project name to which the GTM instance belongs
remark String: Remark information for the GTM instance
specName String: Feature version of the GTM instance. ultimate indicates flagship edition, standard indicates standard edition
state String: Current lifecycle status of the GTM instance, such as init: indicates the GTM instance has been successfully created but not yet configured. configuringAddress: indicates basic rule configuration is complete but target address configuration is not yet finished. editing: indicates both basic configuration and target address are completed but the instance is not yet enabled. running: indicates the instance is officially enabled
ttl Number: Expiration time of the DNS record, in seconds
updateTime String: Most recent modification time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
zoneType String: This parameter has no practical significance and can be ignored

Supporting Types

GetGtmPolicy

AlarmOnly bool: If the current address pool set is unavailable, does Cloud Scheduling GTM only trigger an alert notification without automatically switching to an available address pool? true: Cloud Scheduling GTM only triggers an alert notification. false: Cloud Scheduling GTM automatically switches to an available address pool.
PerfMode string: Routing mode for intelligent routing policies. perf: Performance first. capacity: Capacity first. feedback: Load feedback.
RoutingMode string: Routing mode. The parameter values are: lb: Routes user traffic proportionally to different IDC data centers based on load balancing. geo: Routes user traffic to the nearest IDC data center on the same carrier line based on the user's geographic location and carrier. geo-lb (default): First routes user traffic to the nearest IDC data center access line on the same carrier based on the user's geographic location and carrier, then distributes user traffic proportionally to multiple IDC data centers based on load balancing.
Statistics Byteplus.GetGtmPolicyStatistics: Statistics for addresses associated with the scheduling policy.
Targets List<Byteplus.GetGtmPolicyTarget>: List of target address pools associated with the scheduling policy.

AlarmOnly bool: If the current address pool set is unavailable, does Cloud Scheduling GTM only trigger an alert notification without automatically switching to an available address pool? true: Cloud Scheduling GTM only triggers an alert notification. false: Cloud Scheduling GTM automatically switches to an available address pool.
PerfMode string: Routing mode for intelligent routing policies. perf: Performance first. capacity: Capacity first. feedback: Load feedback.
RoutingMode string: Routing mode. The parameter values are: lb: Routes user traffic proportionally to different IDC data centers based on load balancing. geo: Routes user traffic to the nearest IDC data center on the same carrier line based on the user's geographic location and carrier. geo-lb (default): First routes user traffic to the nearest IDC data center access line on the same carrier based on the user's geographic location and carrier, then distributes user traffic proportionally to multiple IDC data centers based on load balancing.
Statistics GetGtmPolicyStatistics: Statistics for addresses associated with the scheduling policy.
Targets []GetGtmPolicyTarget: List of target address pools associated with the scheduling policy.

alarm_only bool: If the current address pool set is unavailable, does Cloud Scheduling GTM only trigger an alert notification without automatically switching to an available address pool? true: Cloud Scheduling GTM only triggers an alert notification. false: Cloud Scheduling GTM automatically switches to an available address pool.
perf_mode string: Routing mode for intelligent routing policies. perf: Performance first. capacity: Capacity first. feedback: Load feedback.
routing_mode string: Routing mode. The parameter values are: lb: Routes user traffic proportionally to different IDC data centers based on load balancing. geo: Routes user traffic to the nearest IDC data center on the same carrier line based on the user's geographic location and carrier. geo-lb (default): First routes user traffic to the nearest IDC data center access line on the same carrier based on the user's geographic location and carrier, then distributes user traffic proportionally to multiple IDC data centers based on load balancing.
statistics object: Statistics for addresses associated with the scheduling policy.
targets list(object): List of target address pools associated with the scheduling policy.

alarmOnly Boolean: If the current address pool set is unavailable, does Cloud Scheduling GTM only trigger an alert notification without automatically switching to an available address pool? true: Cloud Scheduling GTM only triggers an alert notification. false: Cloud Scheduling GTM automatically switches to an available address pool.
perfMode String: Routing mode for intelligent routing policies. perf: Performance first. capacity: Capacity first. feedback: Load feedback.
routingMode String: Routing mode. The parameter values are: lb: Routes user traffic proportionally to different IDC data centers based on load balancing. geo: Routes user traffic to the nearest IDC data center on the same carrier line based on the user's geographic location and carrier. geo-lb (default): First routes user traffic to the nearest IDC data center access line on the same carrier based on the user's geographic location and carrier, then distributes user traffic proportionally to multiple IDC data centers based on load balancing.
statistics GetGtmPolicyStatistics: Statistics for addresses associated with the scheduling policy.
targets List<GetGtmPolicyTarget>: List of target address pools associated with the scheduling policy.

alarmOnly boolean: If the current address pool set is unavailable, does Cloud Scheduling GTM only trigger an alert notification without automatically switching to an available address pool? true: Cloud Scheduling GTM only triggers an alert notification. false: Cloud Scheduling GTM automatically switches to an available address pool.
perfMode string: Routing mode for intelligent routing policies. perf: Performance first. capacity: Capacity first. feedback: Load feedback.
routingMode string: Routing mode. The parameter values are: lb: Routes user traffic proportionally to different IDC data centers based on load balancing. geo: Routes user traffic to the nearest IDC data center on the same carrier line based on the user's geographic location and carrier. geo-lb (default): First routes user traffic to the nearest IDC data center access line on the same carrier based on the user's geographic location and carrier, then distributes user traffic proportionally to multiple IDC data centers based on load balancing.
statistics GetGtmPolicyStatistics: Statistics for addresses associated with the scheduling policy.
targets GetGtmPolicyTarget[]: List of target address pools associated with the scheduling policy.

alarm_only bool: If the current address pool set is unavailable, does Cloud Scheduling GTM only trigger an alert notification without automatically switching to an available address pool? true: Cloud Scheduling GTM only triggers an alert notification. false: Cloud Scheduling GTM automatically switches to an available address pool.
perf_mode str: Routing mode for intelligent routing policies. perf: Performance first. capacity: Capacity first. feedback: Load feedback.
routing_mode str: Routing mode. The parameter values are: lb: Routes user traffic proportionally to different IDC data centers based on load balancing. geo: Routes user traffic to the nearest IDC data center on the same carrier line based on the user's geographic location and carrier. geo-lb (default): First routes user traffic to the nearest IDC data center access line on the same carrier based on the user's geographic location and carrier, then distributes user traffic proportionally to multiple IDC data centers based on load balancing.
statistics GetGtmPolicyStatistics: Statistics for addresses associated with the scheduling policy.
targets Sequence[GetGtmPolicyTarget]: List of target address pools associated with the scheduling policy.

alarmOnly Boolean: If the current address pool set is unavailable, does Cloud Scheduling GTM only trigger an alert notification without automatically switching to an available address pool? true: Cloud Scheduling GTM only triggers an alert notification. false: Cloud Scheduling GTM automatically switches to an available address pool.
perfMode String: Routing mode for intelligent routing policies. perf: Performance first. capacity: Capacity first. feedback: Load feedback.
routingMode String: Routing mode. The parameter values are: lb: Routes user traffic proportionally to different IDC data centers based on load balancing. geo: Routes user traffic to the nearest IDC data center on the same carrier line based on the user's geographic location and carrier. geo-lb (default): First routes user traffic to the nearest IDC data center access line on the same carrier based on the user's geographic location and carrier, then distributes user traffic proportionally to multiple IDC data centers based on load balancing.
statistics Property Map: Statistics for addresses associated with the scheduling policy.
targets List<Property Map>: List of target address pools associated with the scheduling policy.

GetGtmPolicyStatistics

ActiveAddr int: Number of available addresses.
InactiveAddr int: Number of unavailable addresses.

ActiveAddr int: Number of available addresses.
InactiveAddr int: Number of unavailable addresses.

active_addr number: Number of available addresses.
inactive_addr number: Number of unavailable addresses.

activeAddr Integer: Number of available addresses.
inactiveAddr Integer: Number of unavailable addresses.

activeAddr number: Number of available addresses.
inactiveAddr number: Number of unavailable addresses.

active_addr int: Number of available addresses.
inactive_addr int: Number of unavailable addresses.

activeAddr Number: Number of available addresses.
inactiveAddr Number: Number of unavailable addresses.

GetGtmPolicyTarget

PoolId string: Target address pool ID.

PoolId string: Target address pool ID.

pool_id string: Target address pool ID.

poolId String: Target address pool ID.

poolId string: Target address pool ID.

pool_id str: Target address pool ID.

poolId String: Target address pool ID.

GetGtmProbe

AdvisedNodeCount int: Recommended number of health check probe points.
Disable bool: Whether health check is disabled. true: disabled. false: enabled.
DnsRecordType string: DNS record type for the health check.
FailedCount int: 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 will be marked as faulty after 3 consecutive health check failures. Default value: 3.
Host string: Full 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<Byteplus.GetGtmProbeHttpUsabilityCode>: Customize a range of HTTP status codes. After a probe initiates a health check, if the target address returns an HTTP status code outside the specified range, the health check at that probe is considered failed. If you do not set the HttpUsabilityCodes parameter for the policy, this parameter will not be returned.
Interval int: Interval between each health check, in seconds.
IsManualNodes bool: Whether to manually configure health check probe points. true: Manually configure health check probe points. false: Use recommended health check probe points.
Nodes List<string>: List of probe nodes used for health checks.
PingCount int: Number of packets sent. 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. Unit: percent. If the packet loss rate exceeds this parameter value, the result is considered abnormal. For example, if this parameter is set to 10 and the packet loss rate during a health check is greater than 10, 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.
TcpConnTimeout int: Timeout for establishing a single TCP connection. For example, if you set this parameter to 2 seconds, a TCP connection will be considered failed if it is not established within 2 seconds during a health check. This parameter is only valid when the health check protocol is set to tcp.
Timeout int: Timeout for the health check task. Unit: seconds.
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 check is disabled. true: disabled. false: enabled.
DnsRecordType string: DNS record type for the health check.
FailedCount int: 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 will be marked as faulty after 3 consecutive health check failures. Default value: 3.
Host string: Full 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 []GetGtmProbeHttpUsabilityCode: Customize a range of HTTP status codes. After a probe initiates a health check, if the target address returns an HTTP status code outside the specified range, the health check at that probe is considered failed. If you do not set the HttpUsabilityCodes parameter for the policy, this parameter will not be returned.
Interval int: Interval between each health check, in seconds.
IsManualNodes bool: Whether to manually configure health check probe points. true: Manually configure health check probe points. false: Use recommended health check probe points.
Nodes []string: List of probe nodes used for health checks.
PingCount int: Number of packets sent. 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. Unit: percent. If the packet loss rate exceeds this parameter value, the result is considered abnormal. For example, if this parameter is set to 10 and the packet loss rate during a health check is greater than 10, 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.
TcpConnTimeout int: Timeout for establishing a single TCP connection. For example, if you set this parameter to 2 seconds, a TCP connection will be considered failed if it is not established within 2 seconds during a health check. This parameter is only valid when the health check protocol is set to tcp.
Timeout int: Timeout for the health check task. Unit: seconds.
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 check is disabled. true: disabled. false: enabled.
dns_record_type string: DNS record type for the health check.
failed_count number: 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 will be marked as faulty after 3 consecutive health check failures. Default value: 3.
host string: Full 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): Customize a range of HTTP status codes. After a probe initiates a health check, if the target address returns an HTTP status code outside the specified range, the health check at that probe is considered failed. If you do not set the HttpUsabilityCodes parameter for the policy, this parameter will not be returned.
interval number: Interval between each health check, in seconds.
is_manual_nodes bool: Whether to manually configure health check probe points. true: Manually configure health check probe points. false: Use recommended health check probe points.
nodes list(string): List of probe nodes used for health checks.
ping_count number: Number of packets sent. 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. Unit: percent. If the packet loss rate exceeds this parameter value, the result is considered abnormal. For example, if this parameter is set to 10 and the packet loss rate during a health check is greater than 10, 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.
tcp_conn_timeout number: Timeout for establishing a single TCP connection. For example, if you set this parameter to 2 seconds, a TCP connection will be considered failed if it is not established within 2 seconds during a health check. This parameter is only valid when the health check protocol is set to tcp.
timeout number: Timeout for the health check task. Unit: seconds.
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 check is disabled. true: disabled. false: enabled.
dnsRecordType String: DNS record type for the health check.
failedCount Integer: 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 will be marked as faulty after 3 consecutive health check failures. Default value: 3.
host String: Full 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<GetGtmProbeHttpUsabilityCode>: Customize a range of HTTP status codes. After a probe initiates a health check, if the target address returns an HTTP status code outside the specified range, the health check at that probe is considered failed. If you do not set the HttpUsabilityCodes parameter for the policy, this parameter will not be returned.
interval Integer: Interval between each health check, in seconds.
isManualNodes Boolean: Whether to manually configure health check probe points. true: Manually configure health check probe points. false: Use recommended health check probe points.
nodes List<String>: List of probe nodes used for health checks.
pingCount Integer: Number of packets sent. 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. Unit: percent. If the packet loss rate exceeds this parameter value, the result is considered abnormal. For example, if this parameter is set to 10 and the packet loss rate during a health check is greater than 10, 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.
tcpConnTimeout Integer: Timeout for establishing a single TCP connection. For example, if you set this parameter to 2 seconds, a TCP connection will be considered failed if it is not established within 2 seconds during a health check. This parameter is only valid when the health check protocol is set to tcp.
timeout Integer: Timeout for the health check task. Unit: seconds.
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 check is disabled. true: disabled. false: enabled.
dnsRecordType string: DNS record type for the health check.
failedCount number: 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 will be marked as faulty after 3 consecutive health check failures. Default value: 3.
host string: Full 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 GetGtmProbeHttpUsabilityCode[]: Customize a range of HTTP status codes. After a probe initiates a health check, if the target address returns an HTTP status code outside the specified range, the health check at that probe is considered failed. If you do not set the HttpUsabilityCodes parameter for the policy, this parameter will not be returned.
interval number: Interval between each health check, in seconds.
isManualNodes boolean: Whether to manually configure health check probe points. true: Manually configure health check probe points. false: Use recommended health check probe points.
nodes string[]: List of probe nodes used for health checks.
pingCount number: Number of packets sent. 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. Unit: percent. If the packet loss rate exceeds this parameter value, the result is considered abnormal. For example, if this parameter is set to 10 and the packet loss rate during a health check is greater than 10, 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.
tcpConnTimeout number: Timeout for establishing a single TCP connection. For example, if you set this parameter to 2 seconds, a TCP connection will be considered failed if it is not established within 2 seconds during a health check. This parameter is only valid when the health check protocol is set to tcp.
timeout number: Timeout for the health check task. Unit: seconds.
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 check is disabled. true: disabled. false: enabled.
dns_record_type str: DNS record type for the health check.
failed_count int: 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 will be marked as faulty after 3 consecutive health check failures. Default value: 3.
host str: Full 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[GetGtmProbeHttpUsabilityCode]: Customize a range of HTTP status codes. After a probe initiates a health check, if the target address returns an HTTP status code outside the specified range, the health check at that probe is considered failed. If you do not set the HttpUsabilityCodes parameter for the policy, this parameter will not be returned.
interval int: Interval between each health check, in seconds.
is_manual_nodes bool: Whether to manually configure health check probe points. true: Manually configure health check probe points. false: Use recommended health check probe points.
nodes Sequence[str]: List of probe nodes used for health checks.
ping_count int: Number of packets sent. 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. Unit: percent. If the packet loss rate exceeds this parameter value, the result is considered abnormal. For example, if this parameter is set to 10 and the packet loss rate during a health check is greater than 10, 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.
tcp_conn_timeout int: Timeout for establishing a single TCP connection. For example, if you set this parameter to 2 seconds, a TCP connection will be considered failed if it is not established within 2 seconds during a health check. This parameter is only valid when the health check protocol is set to tcp.
timeout int: Timeout for the health check task. Unit: seconds.
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 check is disabled. true: disabled. false: enabled.
dnsRecordType String: DNS record type for the health check.
failedCount Number: 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 will be marked as faulty after 3 consecutive health check failures. Default value: 3.
host String: Full 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>: Customize a range of HTTP status codes. After a probe initiates a health check, if the target address returns an HTTP status code outside the specified range, the health check at that probe is considered failed. If you do not set the HttpUsabilityCodes parameter for the policy, this parameter will not be returned.
interval Number: Interval between each health check, in seconds.
isManualNodes Boolean: Whether to manually configure health check probe points. true: Manually configure health check probe points. false: Use recommended health check probe points.
nodes List<String>: List of probe nodes used for health checks.
pingCount Number: Number of packets sent. 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. Unit: percent. If the packet loss rate exceeds this parameter value, the result is considered abnormal. For example, if this parameter is set to 10 and the packet loss rate during a health check is greater than 10, 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.
tcpConnTimeout Number: Timeout for establishing a single TCP connection. For example, if you set this parameter to 2 seconds, a TCP connection will be considered failed if it is not established within 2 seconds during a health check. This parameter is only valid when the health check protocol is set to tcp.
timeout Number: Timeout for the health check task. Unit: seconds.
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.

GetGtmProbeHttpUsabilityCode

Codes List<int>: List of HTTP status codes.
Operator string: Operator. interval: matches values within the range. include: matches specified values. exclude: matches values other than the specified ones.

Codes []int: List of HTTP status codes.
Operator string: Operator. interval: matches values within the range. include: matches specified values. exclude: matches values other than the specified ones.

codes list(number): List of HTTP status codes.
operator string: Operator. interval: matches values within the range. include: matches specified values. exclude: matches values other than the specified ones.

codes List<Integer>: List of HTTP status codes.
operator String: Operator. interval: matches values within the range. include: matches specified values. exclude: matches values other than the specified ones.

codes number[]: List of HTTP status codes.
operator string: Operator. interval: matches values within the range. include: matches specified values. exclude: matches values other than the specified ones.

codes Sequence[int]: List of HTTP status codes.
operator str: Operator. interval: matches values within the range. include: matches specified values. exclude: matches values other than the specified ones.

codes List<Number>: List of HTTP status codes.
operator String: Operator. interval: matches values within the range. include: matches specified values. exclude: matches values other than the specified ones.

Package Details

Repository: bytepluscc byteplus-sdk/pulumi-bytepluscc
License: MPL-2.0
Notes: This Pulumi package is based on the bytepluscc Terraform Provider.

Viewing docs for bytepluscc v0.0.39
published on Thursday, Jul 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.gtm.getGtm

On this page

On this page

Using getGtm

getGtm Result

Supporting Types

GetGtmPolicy

GetGtmPolicyStatistics

GetGtmPolicyTarget

GetGtmProbe

GetGtmProbeHttpUsabilityCode

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

bytepluscc.gtm.getGtm

On this page

On this page

Using getGtm

getGtm Result

Supporting Types

GetGtmPolicy

GetGtmPolicyStatistics

GetGtmPolicyTarget

GetGtmProbe

GetGtmProbeHttpUsabilityCode

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.