Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. gtm
  6. getPool
Viewing docs for bytepluscc v0.0.31
published on Monday, Jun 1, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.gtm.getPool

bytepluscc logo
Viewing docs for bytepluscc v0.0.31
published on Monday, Jun 1, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::GTM::Pool

    Using getPool

    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 getPool(args: GetPoolArgs, opts?: InvokeOptions): Promise<GetPoolResult>
function getPoolOutput(args: GetPoolOutputArgs, opts?: InvokeOptions): Output<GetPoolResult>
    def get_pool(id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetPoolResult
def get_pool_output(id: pulumi.Input[Optional[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetPoolResult]
    func LookupPool(ctx *Context, args *LookupPoolArgs, opts ...InvokeOption) (*LookupPoolResult, error)
func LookupPoolOutput(ctx *Context, args *LookupPoolOutputArgs, opts ...InvokeOption) LookupPoolResultOutput

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

    public static class GetPool 
{
    public static Task<GetPoolResult> InvokeAsync(GetPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetPoolResult> Invoke(GetPoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)
public static Output<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)

    fn::invoke:
  function: bytepluscc:gtm/getPool:getPool
  arguments:
    # arguments dictionary
    data "bytepluscc_gtm_getpool" "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.

    getPool Result

    The following output properties are available:

    AddrType string
    Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
    Addresses List<Byteplus.GetPoolAddress>
    List of target addresses in the address pool
    Capacity int
    Address pool capacity
    CapacityMode string
    Capacity mode, indicates whether to configure address pool capacity or address capacity
    CreateTime string
    Creation time
    Deletable bool
    Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
    GtmId string
    UUID of the associated GTM instance
    Id string
    Uniquely identifies the resource.
    Name string
    Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
    PoolId string
    Address pool ID
    Remark string
    Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters
    UpdateTime string
    Update time
    AddrType string
    Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
    Addresses []GetPoolAddress
    List of target addresses in the address pool
    Capacity int
    Address pool capacity
    CapacityMode string
    Capacity mode, indicates whether to configure address pool capacity or address capacity
    CreateTime string
    Creation time
    Deletable bool
    Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
    GtmId string
    UUID of the associated GTM instance
    Id string
    Uniquely identifies the resource.
    Name string
    Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
    PoolId string
    Address pool ID
    Remark string
    Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters
    UpdateTime string
    Update time
    addr_type string
    Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
    addresses list(object)
    List of target addresses in the address pool
    capacity number
    Address pool capacity
    capacity_mode string
    Capacity mode, indicates whether to configure address pool capacity or address capacity
    create_time string
    Creation time
    deletable bool
    Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
    gtm_id string
    UUID of the associated GTM instance
    id string
    Uniquely identifies the resource.
    name string
    Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
    pool_id string
    Address pool ID
    remark string
    Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters
    update_time string
    Update time
    addrType String
    Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
    addresses List<GetPoolAddress>
    List of target addresses in the address pool
    capacity Integer
    Address pool capacity
    capacityMode String
    Capacity mode, indicates whether to configure address pool capacity or address capacity
    createTime String
    Creation time
    deletable Boolean
    Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
    gtmId String
    UUID of the associated GTM instance
    id String
    Uniquely identifies the resource.
    name String
    Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
    poolId String
    Address pool ID
    remark String
    Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters
    updateTime String
    Update time
    addrType string
    Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
    addresses GetPoolAddress[]
    List of target addresses in the address pool
    capacity number
    Address pool capacity
    capacityMode string
    Capacity mode, indicates whether to configure address pool capacity or address capacity
    createTime string
    Creation time
    deletable boolean
    Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
    gtmId string
    UUID of the associated GTM instance
    id string
    Uniquely identifies the resource.
    name string
    Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
    poolId string
    Address pool ID
    remark string
    Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters
    updateTime string
    Update time
    addr_type str
    Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
    addresses Sequence[GetPoolAddress]
    List of target addresses in the address pool
    capacity int
    Address pool capacity
    capacity_mode str
    Capacity mode, indicates whether to configure address pool capacity or address capacity
    create_time str
    Creation time
    deletable bool
    Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
    gtm_id str
    UUID of the associated GTM instance
    id str
    Uniquely identifies the resource.
    name str
    Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
    pool_id str
    Address pool ID
    remark str
    Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters
    update_time str
    Update time
    addrType String
    Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
    addresses List<Property Map>
    List of target addresses in the address pool
    capacity Number
    Address pool capacity
    capacityMode String
    Capacity mode, indicates whether to configure address pool capacity or address capacity
    createTime String
    Creation time
    deletable Boolean
    Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
    gtmId String
    UUID of the associated GTM instance
    id String
    Uniquely identifies the resource.
    name String
    Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
    poolId String
    Address pool ID
    remark String
    Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters
    updateTime String
    Update time

    Supporting Types

    GetPoolAddress

    Capacity int
    Address capacity
    Geo string
    Geographic location of the address, returned only in queries
    Mode string
    Address availability mode
    RectifiedGeos List<string>
    List of geographic route codes to be corrected
    Value string
    Target address value
    Weight int
    Address weight
    Capacity int
    Address capacity
    Geo string
    Geographic location of the address, returned only in queries
    Mode string
    Address availability mode
    RectifiedGeos []string
    List of geographic route codes to be corrected
    Value string
    Target address value
    Weight int
    Address weight
    capacity number
    Address capacity
    geo string
    Geographic location of the address, returned only in queries
    mode string
    Address availability mode
    rectified_geos list(string)
    List of geographic route codes to be corrected
    value string
    Target address value
    weight number
    Address weight
    capacity Integer
    Address capacity
    geo String
    Geographic location of the address, returned only in queries
    mode String
    Address availability mode
    rectifiedGeos List<String>
    List of geographic route codes to be corrected
    value String
    Target address value
    weight Integer
    Address weight
    capacity number
    Address capacity
    geo string
    Geographic location of the address, returned only in queries
    mode string
    Address availability mode
    rectifiedGeos string[]
    List of geographic route codes to be corrected
    value string
    Target address value
    weight number
    Address weight
    capacity int
    Address capacity
    geo str
    Geographic location of the address, returned only in queries
    mode str
    Address availability mode
    rectified_geos Sequence[str]
    List of geographic route codes to be corrected
    value str
    Target address value
    weight int
    Address weight
    capacity Number
    Address capacity
    geo String
    Geographic location of the address, returned only in queries
    mode String
    Address availability mode
    rectifiedGeos List<String>
    List of geographic route codes to be corrected
    value String
    Target address value
    weight Number
    Address weight

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.31
    published on Monday, Jun 1, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial