1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. gtm
  6. Gtm
Viewing docs for volcenginecc v0.0.49
published on Thursday, Jul 16, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.49
published on Thursday, Jul 16, 2026 by Volcengine

    The GTM instance is the core resource in Cloud Scheduling GTM for hosting scheduling domain names, routing policies, and health check configurations. After creating a GTM instance, you can use it to configure global traffic scheduling, failover, and health check capabilities for your business domain name

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
    
    const gTMGTMDemo = new volcenginecc.gtm.Gtm("GTMGTMDemo", {
        domain: "www.example4.com",
        accessMode: "cname",
        cname: "gtm-cname.example4.com.bdns-gtm-pressure.com",
        projectName: "default",
        remark: "gtm test",
        specName: "ultimate",
        ttl: 600,
        policyType: "perf",
        alarmId: "71xxxx26d79-2b08-4033-b025-71xxxx26d79",
    });
    
    import pulumi
    import pulumi_volcenginecc as volcenginecc
    
    g_tmgtm_demo = volcenginecc.gtm.Gtm("GTMGTMDemo",
        domain="www.example4.com",
        access_mode="cname",
        cname="gtm-cname.example4.com.bdns-gtm-pressure.com",
        project_name="default",
        remark="gtm test",
        spec_name="ultimate",
        ttl=600,
        policy_type="perf",
        alarm_id="71xxxx26d79-2b08-4033-b025-71xxxx26d79")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/gtm"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := gtm.NewGtm(ctx, "GTMGTMDemo", &gtm.GtmArgs{
    			Domain:      pulumi.String("www.example4.com"),
    			AccessMode:  pulumi.String("cname"),
    			Cname:       pulumi.String("gtm-cname.example4.com.bdns-gtm-pressure.com"),
    			ProjectName: pulumi.String("default"),
    			Remark:      pulumi.String("gtm test"),
    			SpecName:    pulumi.String("ultimate"),
    			Ttl:         pulumi.Int(600),
    			PolicyType:  pulumi.String("perf"),
    			AlarmId:     pulumi.String("71xxxx26d79-2b08-4033-b025-71xxxx26d79"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcenginecc = Volcengine.Pulumi.Volcenginecc;
    
    return await Deployment.RunAsync(() => 
    {
        var gTMGTMDemo = new Volcenginecc.Gtm.Gtm("GTMGTMDemo", new()
        {
            Domain = "www.example4.com",
            AccessMode = "cname",
            Cname = "gtm-cname.example4.com.bdns-gtm-pressure.com",
            ProjectName = "default",
            Remark = "gtm test",
            SpecName = "ultimate",
            Ttl = 600,
            PolicyType = "perf",
            AlarmId = "71xxxx26d79-2b08-4033-b025-71xxxx26d79",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.volcengine.volcenginecc.gtm.Gtm;
    import com.volcengine.volcenginecc.gtm.GtmArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var gTMGTMDemo = new Gtm("gTMGTMDemo", GtmArgs.builder()
                .domain("www.example4.com")
                .accessMode("cname")
                .cname("gtm-cname.example4.com.bdns-gtm-pressure.com")
                .projectName("default")
                .remark("gtm test")
                .specName("ultimate")
                .ttl(600)
                .policyType("perf")
                .alarmId("71xxxx26d79-2b08-4033-b025-71xxxx26d79")
                .build());
    
        }
    }
    
    resources:
      gTMGTMDemo:
        type: volcenginecc:gtm:Gtm
        name: GTMGTMDemo
        properties:
          domain: www.example4.com
          accessMode: cname
          cname: gtm-cname.example4.com.bdns-gtm-pressure.com
          projectName: default
          remark: gtm test
          specName: ultimate
          ttl: 600
          policyType: perf
          alarmId: 71xxxx26d79-2b08-4033-b025-71xxxx26d79
    
    pulumi {
      required_providers {
        volcenginecc = {
          source = "pulumi/volcenginecc"
        }
      }
    }
    
    resource "volcenginecc_gtm_gtm" "GTMGTMDemo" {
      domain       = "www.example4.com"
      access_mode  = "cname"
      cname        = "gtm-cname.example4.com.bdns-gtm-pressure.com"
      project_name = "default"
      remark       = "gtm test"
      spec_name    = "ultimate"
      ttl          = 600
      policy_type  = "perf"
      alarm_id     = "71xxxx26d79-2b08-4033-b025-71xxxx26d79"
    }
    

    Create Gtm Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Gtm(name: string, args: GtmArgs, opts?: CustomResourceOptions);
    @overload
    def Gtm(resource_name: str,
            args: GtmArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Gtm(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            access_mode: Optional[str] = None,
            domain: Optional[str] = None,
            alarm_id: Optional[str] = None,
            cname: Optional[str] = None,
            policy_type: Optional[str] = None,
            project_name: Optional[str] = None,
            remark: Optional[str] = None,
            spec_name: Optional[str] = None,
            ttl: Optional[int] = None)
    func NewGtm(ctx *Context, name string, args GtmArgs, opts ...ResourceOption) (*Gtm, error)
    public Gtm(string name, GtmArgs args, CustomResourceOptions? opts = null)
    public Gtm(String name, GtmArgs args)
    public Gtm(String name, GtmArgs args, CustomResourceOptions options)
    
    type: volcenginecc:gtm:Gtm
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "volcenginecc_gtm_gtm" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args GtmArgs
    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 GtmArgs
    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 GtmArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GtmArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GtmArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var gtmResource = new Volcenginecc.Gtm.Gtm("gtmResource", new()
    {
        AccessMode = "string",
        Domain = "string",
        AlarmId = "string",
        Cname = "string",
        PolicyType = "string",
        ProjectName = "string",
        Remark = "string",
        SpecName = "string",
        Ttl = 0,
    });
    
    example, err := gtm.NewGtm(ctx, "gtmResource", &gtm.GtmArgs{
    	AccessMode:  pulumi.String("string"),
    	Domain:      pulumi.String("string"),
    	AlarmId:     pulumi.String("string"),
    	Cname:       pulumi.String("string"),
    	PolicyType:  pulumi.String("string"),
    	ProjectName: pulumi.String("string"),
    	Remark:      pulumi.String("string"),
    	SpecName:    pulumi.String("string"),
    	Ttl:         pulumi.Int(0),
    })
    
    resource "volcenginecc_gtm_gtm" "gtmResource" {
      access_mode  = "string"
      domain       = "string"
      alarm_id     = "string"
      cname        = "string"
      policy_type  = "string"
      project_name = "string"
      remark       = "string"
      spec_name    = "string"
      ttl          = 0
    }
    
    var gtmResource = new Gtm("gtmResource", GtmArgs.builder()
        .accessMode("string")
        .domain("string")
        .alarmId("string")
        .cname("string")
        .policyType("string")
        .projectName("string")
        .remark("string")
        .specName("string")
        .ttl(0)
        .build());
    
    gtm_resource = volcenginecc.gtm.Gtm("gtmResource",
        access_mode="string",
        domain="string",
        alarm_id="string",
        cname="string",
        policy_type="string",
        project_name="string",
        remark="string",
        spec_name="string",
        ttl=0)
    
    const gtmResource = new volcenginecc.gtm.Gtm("gtmResource", {
        accessMode: "string",
        domain: "string",
        alarmId: "string",
        cname: "string",
        policyType: "string",
        projectName: "string",
        remark: "string",
        specName: "string",
        ttl: 0,
    });
    
    type: volcenginecc:gtm:Gtm
    properties:
        accessMode: string
        alarmId: string
        cname: string
        domain: string
        policyType: string
        projectName: string
        remark: string
        specName: string
        ttl: 0
    

    Gtm Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Gtm resource accepts the following input properties:

    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
    Domain string
    Domain name of the GTM instance, such as www.example.com
    AlarmId string
    Alarm rule ID associated with the GTM instance
    Cname string
    Scheduling domain name of the GTM instance
    PolicyType string
    Routing policy type. geo indicates basic routing policy, perf indicates intelligent routing policy
    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
    Ttl int
    Expiration time of the DNS record, in seconds
    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
    Domain string
    Domain name of the GTM instance, such as www.example.com
    AlarmId string
    Alarm rule ID associated with the GTM instance
    Cname string
    Scheduling domain name of the GTM instance
    PolicyType string
    Routing policy type. geo indicates basic routing policy, perf indicates intelligent routing policy
    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
    Ttl int
    Expiration time of the DNS record, in seconds
    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
    domain string
    Domain name of the GTM instance, such as www.example.com
    alarm_id string
    Alarm rule ID associated with the GTM instance
    cname string
    Scheduling domain name of the GTM instance
    policy_type string
    Routing policy type. geo indicates basic routing policy, perf indicates intelligent routing policy
    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
    ttl number
    Expiration time of the DNS record, in seconds
    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
    domain String
    Domain name of the GTM instance, such as www.example.com
    alarmId String
    Alarm rule ID associated with the GTM instance
    cname String
    Scheduling domain name of the GTM instance
    policyType String
    Routing policy type. geo indicates basic routing policy, perf indicates intelligent routing policy
    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
    ttl Integer
    Expiration time of the DNS record, in seconds
    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
    domain string
    Domain name of the GTM instance, such as www.example.com
    alarmId string
    Alarm rule ID associated with the GTM instance
    cname string
    Scheduling domain name of the GTM instance
    policyType string
    Routing policy type. geo indicates basic routing policy, perf indicates intelligent routing policy
    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
    ttl number
    Expiration time of the DNS record, in seconds
    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
    domain str
    Domain name of the GTM instance, such as www.example.com
    alarm_id str
    Alarm rule ID associated with the GTM instance
    cname str
    Scheduling domain name of the GTM instance
    policy_type str
    Routing policy type. geo indicates basic routing policy, perf indicates intelligent routing policy
    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
    ttl int
    Expiration time of the DNS record, in seconds
    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
    domain String
    Domain name of the GTM instance, such as www.example.com
    alarmId String
    Alarm rule ID associated with the GTM instance
    cname String
    Scheduling domain name of the GTM instance
    policyType String
    Routing policy type. geo indicates basic routing policy, perf indicates intelligent routing policy
    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
    ttl Number
    Expiration time of the DNS record, in seconds

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Gtm resource produces the following output properties:

    CreateTime string
    Creation time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
    GtmId string
    UUID of the GTM instance
    Id string
    The provider-assigned unique ID for this managed resource.
    LastOperator string
    Account that last operated the GTM instance
    Owner string
    Account that created the GTM instance
    Policy Volcengine.GtmPolicy
    Detailed configuration of the scheduling policy for the GTM instance.
    Probe Volcengine.GtmProbe
    Detailed configuration of the health check for the GTM instance.
    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
    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
    CreateTime string
    Creation time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
    GtmId string
    UUID of the GTM instance
    Id string
    The provider-assigned unique ID for this managed resource.
    LastOperator string
    Account that last operated the GTM instance
    Owner string
    Account that created the GTM instance
    Policy GtmPolicy
    Detailed configuration of the scheduling policy for the GTM instance.
    Probe GtmProbe
    Detailed configuration of the health check for the GTM instance.
    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
    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
    create_time string
    Creation time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
    gtm_id string
    UUID of the GTM instance
    id string
    The provider-assigned unique ID for this managed 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.
    probe object
    Detailed configuration of the health check for the GTM instance.
    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
    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
    createTime String
    Creation time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
    gtmId String
    UUID of the GTM instance
    id String
    The provider-assigned unique ID for this managed resource.
    lastOperator String
    Account that last operated the GTM instance
    owner String
    Account that created the GTM instance
    policy GtmPolicy
    Detailed configuration of the scheduling policy for the GTM instance.
    probe GtmProbe
    Detailed configuration of the health check for the GTM instance.
    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
    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
    createTime string
    Creation time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
    gtmId string
    UUID of the GTM instance
    id string
    The provider-assigned unique ID for this managed resource.
    lastOperator string
    Account that last operated the GTM instance
    owner string
    Account that created the GTM instance
    policy GtmPolicy
    Detailed configuration of the scheduling policy for the GTM instance.
    probe GtmProbe
    Detailed configuration of the health check for the GTM instance.
    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
    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
    create_time str
    Creation time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
    gtm_id str
    UUID of the GTM instance
    id str
    The provider-assigned unique ID for this managed resource.
    last_operator str
    Account that last operated the GTM instance
    owner str
    Account that created the GTM instance
    policy GtmPolicy
    Detailed configuration of the scheduling policy for the GTM instance.
    probe GtmProbe
    Detailed configuration of the health check for the GTM instance.
    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
    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
    createTime String
    Creation time of the GTM instance. Accurate to milliseconds, formatted according to ISO 8601 standard
    gtmId String
    UUID of the GTM instance
    id String
    The provider-assigned unique ID for this managed 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.
    probe Property Map
    Detailed configuration of the health check for the GTM instance.
    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
    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

    Look up Existing Gtm Resource

    Get an existing Gtm resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GtmState, opts?: CustomResourceOptions): Gtm
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_mode: Optional[str] = None,
            alarm_id: Optional[str] = None,
            cname: Optional[str] = None,
            create_time: Optional[str] = None,
            domain: Optional[str] = None,
            gtm_id: Optional[str] = None,
            last_operator: Optional[str] = None,
            owner: Optional[str] = None,
            policy: Optional[GtmPolicyArgs] = None,
            policy_type: Optional[str] = None,
            probe: Optional[GtmProbeArgs] = None,
            project_name: Optional[str] = None,
            remark: Optional[str] = None,
            spec_name: Optional[str] = None,
            state: Optional[str] = None,
            ttl: Optional[int] = None,
            update_time: Optional[str] = None,
            zone_type: Optional[str] = None) -> Gtm
    func GetGtm(ctx *Context, name string, id IDInput, state *GtmState, opts ...ResourceOption) (*Gtm, error)
    public static Gtm Get(string name, Input<string> id, GtmState? state, CustomResourceOptions? opts = null)
    public static Gtm get(String name, Output<String> id, GtmState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:gtm:Gtm    get:      id: ${id}
    import {
      to = volcenginecc_gtm_gtm.example
      id = "${id}"
    }
    
    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.
    The following state arguments are supported:
    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
    LastOperator string
    Account that last operated the GTM instance
    Owner string
    Account that created the GTM instance
    Policy Volcengine.GtmPolicy
    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 Volcengine.GtmProbe
    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
    LastOperator string
    Account that last operated the GTM instance
    Owner string
    Account that created the GTM instance
    Policy GtmPolicyArgs
    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 GtmProbeArgs
    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
    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
    lastOperator String
    Account that last operated the GTM instance
    owner String
    Account that created the GTM instance
    policy GtmPolicy
    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 GtmProbe
    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
    lastOperator string
    Account that last operated the GTM instance
    owner string
    Account that created the GTM instance
    policy GtmPolicy
    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 GtmProbe
    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
    last_operator str
    Account that last operated the GTM instance
    owner str
    Account that created the GTM instance
    policy GtmPolicyArgs
    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 GtmProbeArgs
    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
    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

    GtmPolicy, GtmPolicyArgs

    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 Volcengine.GtmPolicyStatistics
    Statistics for addresses associated with the scheduling policy.
    Targets List<Volcengine.GtmPolicyTarget>
    List of target address pools associated with the scheduling policy. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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 GtmPolicyStatistics
    Statistics for addresses associated with the scheduling policy.
    Targets []GtmPolicyTarget
    List of target address pools associated with the scheduling policy. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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 GtmPolicyStatistics
    Statistics for addresses associated with the scheduling policy.
    targets List<GtmPolicyTarget>
    List of target address pools associated with the scheduling policy. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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 GtmPolicyStatistics
    Statistics for addresses associated with the scheduling policy.
    targets GtmPolicyTarget[]
    List of target address pools associated with the scheduling policy. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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 GtmPolicyStatistics
    Statistics for addresses associated with the scheduling policy.
    targets Sequence[GtmPolicyTarget]
    List of target address pools associated with the scheduling policy. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.

    GtmPolicyStatistics, GtmPolicyStatisticsArgs

    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.

    GtmPolicyTarget, GtmPolicyTargetArgs

    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.

    GtmProbe, GtmProbeArgs

    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<Volcengine.GtmProbeHttpUsabilityCode>
    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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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 []GtmProbeHttpUsabilityCode
    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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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<GtmProbeHttpUsabilityCode>
    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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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 GtmProbeHttpUsabilityCode[]
    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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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[GtmProbeHttpUsabilityCode]
    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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    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.

    GtmProbeHttpUsabilityCode, GtmProbeHttpUsabilityCodeArgs

    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.

    Import

    $ pulumi import volcenginecc:gtm/gtm:Gtm example "gtm_id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.49
    published on Thursday, Jul 16, 2026 by Volcengine

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial