GuideReference
Guide

Domain

Suggest Edits

Get details for a given Global Traffic Management domain.

data "akamai_gtm_domain" "my_domain" {
  name = "my_gtm_domain.net"
}

my_domain = {
      as_maps                         = [
          {
              assignments        = [
          {
              as_numbers    = [
                  12345,
                ]
              datacenter_id = 2345
              nickname      = "Test AS maps"
            },
        ]
      default_datacenter = {
          datacenter_id = 6789
          nickname      = "Default (all others)"
        }
      domain             = "my_gtm_asmap.com.akadns.net"
      id                 = "gtm_asmap"
      links              = [
          {
              href = "https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net/config-gtm/v1/domains/my_gtm_domain.com.akadns.net/as-maps/my%20gtm%20as%20map"
              rel  = "self"
            },
        ]
      name           = "my gtm as map"
    },
        ]
      cidr_maps                       = [
          {
              assignments        = [
          {
              blocks        = [
                  "1.1.1.1/1",
                ]
              datacenter_id = 1234
              nickname      = "Sample CIDR"
            },
        ]
      default_datacenter = {
          datacenter_id = 2345
          nickname      = "All Other CIDR Blocks"
        }
      domain             = "my_gtm_cidrmap.com.akadns.net"
      id                 = "gtm_cidrmap"
      links              = [
          {
              href = "https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net/config-gtm/v1/domains/my_gtm_domain.akadns.net/cidr-maps/my%20gtm%20cidrmap"
              rel  = "self"
            },
        ]
      name           = "my gtm cidrmap"
    },
        ]
      cname_coalescing_enabled        = false
      datacenters                     = [
          {
              city                              = ""
              clone_of                          = 0
              cloud_server_host_header_override = false
              cloud_server_targeting            = false
              continent                         = ""
              country                           = ""
              datacenter_id                     = 2345
              default_load_object               = []
              latitude                          = 0
              links                             = [
                  {
                      href = "https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net/config-gtm/v1/domains/my_gtm_domain.com/datacenters/5400"
                      rel  = "self"
                    },
                ]
              longitude                         = 0
              nickname                          = "Default Datacenter"
              score_penalty                     = 0
              server_monitor_pool               = ""
              state_or_province                 = ""
              virtual                           = true
            },
          {
              city                              = "Glasgow"
              clone_of                          = 0
              cloud_server_host_header_override = false
              cloud_server_targeting            = false
              continent                         = ""
              country                           = "GB"
              datacenter_id                     = 2
              default_load_object               = []
              latitude                          = 55.86568
              links                             = [
                  {
                      href = "https://akab-v4hvufz7ff5bykfd-qvagnv3t23f2aurc.luna.akamaiapis.net/config-gtm/v1/domains/my_gtm_domain.com/datacenters/2"
                      rel  = "self"
                    },
                ]
              longitude                         = -4.25714
              nickname                          = "dc2"
              score_penalty                     = 0
              server_monitor_pool               = ""
              state_or_province                 = ""
              virtual                           = true
            },
          {
              city                              = "San Diego"
              clone_of                          = 0
              cloud_server_host_header_override = false
              cloud_server_targeting            = false
              continent                         = ""
              country                           = "US"
              datacenter_id                     = 1
              default_load_object               = []
              latitude                          = 32.71576
              links                             = [
                  {
                      href = "https://akab-v4hvufz7ff5bykfd-qvagnv3t23f2aurc.luna.akamaiapis.net/config-gtm/v1/domains/my_gtm_domain.akadns.net/datacenters/1"
                      rel  = "self"
                    },
                ]
              longitude                         = -117.16382
              nickname                          = "dc1"
              score_penalty                     = 0
              server_monitor_pool               = ""
              state_or_province                 = "CA"
              virtual                           = true
            },
        ]
      default_error_penalty           = 75
      default_health_max              = 0
      default_health_multiplier       = 0
      default_health_threshold        = 0
      default_max_unreachable_penalty = 0
      default_ssl_client_certificate  = ""
      default_ssl_client_private_key  = ""
      default_timeout_penalty         = 25
      default_unreachable_threshold   = 0
      email_notification_list         = [
          "jsmith@email.com",
        ]
      end_user_mapping_enabled        = false
      geographic_maps                 = [
          {
              assignments        = [
                  {
                      countries     = [
                          "GB/SC",
                        ]
                      datacenter_id = 1
                      nickname      = "geozone1"
                    },
                ]
              default_datacenter = {
                  datacenter_id = 2345
                  nickname      = "Default Mapping"
                }
              links              = [
                  {
                      href = "https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net/config-gtm/v1/domains/my_gtm_domain.akadns.net/geographic-maps/geomap1"
                      rel  = "self"
                    },
                ]
              name               = "geomap1"
            },
        ]
      id                              = "my_gtm_domain.akadns.net"
      last_modified                   = "2023-11-16T18:12:01.000+00:00"
      last_modified_by                = "jsmith"
      links                           = [
          {
              href = "https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net/config-gtm/v1/domains/my_gtm_domain.akadns.net"
              rel  = "self"
            },
          {
              href = "https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net/config-gtm/v1/domains/my_gtm_domain.akadns.net/as-maps"
              rel  = "as-maps"
            },
          {
              href = "https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net/config-gtm/v1/domains/my_gtm_domain.akadns.net/cidr-maps"
              rel  = "cidr-maps"
            },
          {
              href = "https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net/config-gtm/v1/domains/my_gtm_domain.akadns.net/datacenters"
              rel  = "datacenters"
            },
          {
              href = "https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net/config-gtm/v1/domains/my_gtm_domain.akadns.net/geographic-maps"
              rel  = "geographic-maps"
            },
          {
              href = "https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net/config-gtm/v1/domains/my_gtm_domain.akadns.net/properties"
              rel  = "properties"
            },
          {
              href = "https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net/config-gtm/v1/domains/my_gtm_domain.akadns.net/resources"
              rel  = "resources"
            },
        ]
      load_feedback                   = true
      load_imbalance_percentage       = 10
      map_update_interval             = 600
      max_properties                  = 100
      max_resources                   = 512
      max_test_timeout                = 60
      max_ttl                         = 172800
      min_pingable_region_fraction    = 0
      min_test_interval               = 10
      min_ttl                         = 30
      modification_comments           = "Delete Resource"
      name                            = "my_gtm_domain.akadns.net"
      properties                      = [
          {
              backup_cname                = ""
              backup_ip                   = ""
              balance_by_download_score   = false
              cname                       = ""
              comments                    = ""
              dynamic_ttl                 = 60
              failback_delay              = 0
              failover_delay              = 0
              ghost_demand_reporting      = false
              handout_limit               = 0
              handout_mode                = "normal"
              health_max                  = 0
              health_multiplier           = 0
              health_threshold            = 0
              ipv6                        = false
              last_modified               = "2023-11-16T18:11:38.000+00:00"
              links                       = [
                  {
                      href = "https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net/config-gtm/v1/domains/my_gtm_domain.akadns.net/properties/mirror"
                      rel  = "self"
                    },
                ]
              liveness_tests              = []
              load_imbalance_percentage   = 0
              map_name                    = ""
              max_unreachable_penalty     = 0
              min_live_fraction           = 0
              name                        = "mirror"
              score_aggregation_type      = "worst"
              static_rr_sets              = []
              static_ttl                  = 0
              stickness_bonus_constant    = 0
              stickness_bonus_percentage  = 0
              traffic_targets             = [
                  {
                      datacenter_id = 1
                      enabled       = true
                      handout_cname = "dc1.my_gtm_domain.net"
                      name          = ""
                      servers       = []
                      weight        = 1
                      precedence    = 10
                    },
                  {
                      datacenter_id = 2
                      enabled       = true
                      handout_cname = "dc2.my_gtm_domain.net"
                      name          = ""
                      servers       = []
                      weight        = 0
                    },
                ]
              type                        = "failover"
              unreachable_threshold       = 0
              use_computed_targets        = false
              weighted_hash_bits_for_ipv4 = 0
              weighted_hash_bits_for_ipv6 = 0
            },
          {
              backup_cname                = ""
              backup_ip                   = ""
              balance_by_download_score   = false
              cname                       = ""
              comments                    = ""
              dynamic_ttl                 = 60
              failback_delay              = 0
              failover_delay              = 0
              ghost_demand_reporting      = false
              handout_limit               = 0
              handout_mode                = "normal"
              health_max                  = 0
              health_multiplier           = 0
              health_threshold            = 0
              ipv6                        = false
              last_modified               = "2023-11-16T18:11:57.000+00:00"
              links                       = [
                  {
                      href = "https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net/config-gtm/v1/domains/my_gtm_domain.akadns.net/properties/wrlb"
                      rel  = "self"
                    },
                ]
              liveness_tests              = []
              load_imbalance_percentage   = 0
              map_name                    = ""
              max_unreachable_penalty     = 0
              min_live_fraction           = 0
              name                        = "wrlb"
              score_aggregation_type      = "worst"
              static_rr_sets              = []
              static_ttl                  = 0
              stickness_bonus_constant    = 0
              stickness_bonus_percentage  = 0
              traffic_targets             = [
                  {
                      datacenter_id = 1
                      enabled       = true
                      handout_cname = "dc1.my_gtm_domain.net"
                      name          = ""
                      servers       = []
                      weight        = 90
                      precedence    = 5
                    },
                  {
                      datacenter_id = 2
                      enabled       = true
                      handout_cname = "dc2.my_gtm_domain.net"
                      name          = ""
                      servers       = []
                      weight        = 10
                    },
                ]
              type                        = "weighted-round-robin"
              unreachable_threshold       = 0
              use_computed_targets        = false
              weighted_hash_bits_for_ipv4 = 0
              weighted_hash_bits_for_ipv6 = 0
            },
        ]
      resources                       = [
          {
              aggregation_type               = "sum"
              constrained_property           = ""
              decay_rate                     = 0
              description                    = "Testing"
              host_header                    = "my_gtm_domain.net"
              leader_string                  = "leader"
              least_squares_decay            = 0
              links                          = [
                  {
                      href = "https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net/config-gtm/v1/domains/my_gtm_domain.akadns.net/resources/resource1"
                      rel  = "self"
                    },
                ]
              load_imbalance_percentage      = 0
              max_u_multiplicative_increment = 0
              name                           = "resource1"
              resource_instances             = [
                  {
                      datacenter_id           = 1
                      load_object             = ""
                      load_object_port        = 9999
                      load_servers            = [
                          "0.0.0.1",
                        ]
                      use_default_load_object = false
                    },
                  {
                      datacenter_id           = 2
                      load_object             = ""
                      load_object_port        = 9999
                      load_servers            = [
                          "0.0.0.2",
                        ]
                      use_default_load_object = false
                    },
                ]
              type                           = "Non-XML load object via HTTP"
              upper_bound                    = 0
            },
        ]
      round_robin_prefix              = ""
      server_monitor_pool             = ""
      status                          = {
          change_id               = "012a3b45-678c-90d1-ef2g-3h4567890123"
          links                   = [
              {
                  href = "https://akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net/config-gtm/v1/domains/my_gtm_domain.akadns.net/status/current"
                  rel  = "self"
                },
            ]
          message                 = "Current configuration has been propagated to all GTM nameservers"
          passing_validation      = true
          propagation_status      = "COMPLETE"
          propagation_status_date = "2023-11-16T18:13:00.000+00:00"
        }
      type                            = "basic"
    }

Argument

Pass a domain's name to get its details.

Attributes

Returned are comprehensive details about the given domain.

Attribute Description
as_maps The given domain's AS maps. Contains:
  • assignments. Details about the given domain's AS zones. Contains:
    • as_numbers. A set of AS numbers.
    • datacenter_id. An ID for an existing data center in the given domain.
    • nickname. A human-readable name for the group of AS zones.
  • default_datacenter. The ID for the default data center in the given domain. Contains:
    • datacenter_id. An ID for an existing data center in the given domain.
    • nickname. A human-readable name for the group of AS zones.
  • links. The direct URL to the given domain. Contains:
    • rel. The link relationship of the object.
    • href. The fully-qualified URL that defines the resource.
  • name. Your GTM domain's map name.
cidr_maps The given domain's CIDR maps. Contains:
  • assignments. Details about the given domain's CIDR maps. Contains:
    • blocks. A set of CIDR blocks.
    • datacenter_id. An ID for an existing data center in the given domain.
    • nickname. A human-readable name for the group of CIDR blocks.
  • default_datacenter. The ID for the default data center in the given domain. Contains:
    • datacenter_id. An ID for an existing data center in the given domain.
    • nickname. A human-readable name for the group of CIDR blocks.
  • links. The direct URL to the given domain. Contains:
    • rel. The link relationship of the object.
    • href. The fully-qualified URL that defines the resource.
  • name. Your GTM domain's map name.
cname_coalescing_enabled Whether GTM collapses CNAME redirections in DNS answers when it knows the target of the CNAME.
  • true collapses the CNAME chain to return the IP address of the A record.
  • false returns the record directly from the CNAME.
datacenters List of data centers associated with the domain. Each data center set contains:
  • city. The city where the data center is located.
  • clone_of. The cloned data center's ID.
  • cloud_server_host_header_override. Whether the cloud server host header has been overridden.
    • true uses the override.
    • false doesn't.
  • cloud_server_targeting. Whether the load has been balanced between two or more servers in a cloud environment.
    • true balances the load across multiple servers.
    • false does not.
  • continent. The continent code.
  • country. The country code for the country in which the data center is located.
  • datacenter_id. An ID for an existing data center in the given domain.
  • default_load_object. The default load object file used to report real-time information about the current load, maximum allowable load, and target load on each resource.
  • latitude. The latitude for the data center. Value can be up to six decimal places.
  • links. The direct URL to the given domain. Contains:
    • rel. The link relationship of the object.
    • href. The fully-qualified URL that defines the resource.
  • longitude. The longitude for the data center. Value can be up to six decimal places.
  • nickname. A human-readable name for the domain.
  • score_penalty. The score in milliseconds of ping time that determines the amount of traffic a particular data center gets. A positive penalty increases the score and drives traffic away from the data center. A negative penalty reduces the score and draws in more traffic that would have gone elsewhere.
  • server_monitor_pool. The name of the pool from which server monitors are drawn for the data center's liveness tests.
  • sign_and_serve. Whether we signed the domain's resource record for validation by a validating resolver.
    • true means we did.
    • false means we didn't.
  • sign_and_serve_algorithm. The signing algorithm used for sign_and_serve. Value is one of:
    • RSA_SHA1
    • RSA_SHA256
    • RSA_SHA512
    • ECDSA_P256_SHA256
    • ECDSA_P384_SHA384
    • ED25519
    • ED448
  • state_or_province. The state, province, or region where the data center is located.
  • virtual. Whether the data center is virtual or physical.
    • true represents a virtual data center.
    • false represents a physical data center.
default_error_penalty The liveness penalty score for request errors.
default_health_max The absolute limit beyond which IPs are declared unhealthy.
default_health_multiplier The value used as a factor in the health cutoff score product. The default value is 1.5.
default_health_threshold A value used as a factor in the health cutoff score product when its value is greater than the minimum liveness score. The default value is 4.
default_max_unreachable_penalty The penalty value added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value.
default_ssl_client_certificate An optional Base64-encoded certificate that corresponds with the private key for TLS-based liveness tests.
default_ssl_client_private_key An optional Base64-encoded private key that corresponds with the TLS certificate for TLS-based liveness tests.
default_timeout_penalty The liveness penalty score for request timeouts.
default_unreachable_threshold The penalty value added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value.
email_notification_list A list of email addresses that receive notifications.
end_user_mapping_enabled Whether the domain uses end-user client subnet mapping.
  • true represents the use of subnet mapping.
  • false represents it isn't used.
geographic_maps A list of geographic maps associated with the domain. Contains:
  • assignments. Details about the geographic zone groupings of countries. Contains:
    • countries. An array of country codes for data center locations.
    • datacenter_id. An ID for an existing data center in the given domain.
    • nickname. A human-readable name for the group of geographic countries.
  • default_datacenter. A placeholder for all other geographic zones, countries not found in these geographic zones. Contains:
    • datacenter_id. An ID for an existing data center in the given domain.
    • nickname. A human-readable name for the group of countries.
  • links. The direct URL to the given domain. Contains:
    • rel. The link relationship of the object.
    • href. The fully-qualified URL that defines the resource.
  • name. A descriptive label for the geographic map.
id The domain's ID.
last_modified The date the domain was last modified.
last_modified_by The user who last modified the domain.
links The direct URL to the given domain. Contains:
  • rel. The link relationship of the object.
  • href. The fully-qualified URL that defines the resource.
load_feedback Whether you're using resources to control load balancing.
  • true represents a use of data center constraints.
  • false represents they aren't used.
map_update_interval How often new maps are generated for performance domains.
max_properties Maximum number of associated properties with a domain.
max_resources Maximum amount of associated resources with a domain.
max_test_timeout Maximum liveness test duration before the test fails. The range is 0.001 to 60seconds.
max_ttl The greatest TTL allowed before failure.
min_pingable_region_fraction The minimum ping fraction score for data centers. If set, any core point that cannot ping more than this fraction of data centers is rejected and not mapped by ping scores.
min_test_interval The minimum allowed liveness test interval. Configurations specifying liveness test intervals smaller than this fail validation.
min_ttl The lowest TTL allowed before failure.
modification_comments A descriptive note about changes made to the domain.
name The domain's name.
properties A list of properties associated with the domain. Contains:
  • backup_cname. The CNAME returned if all servers for your property are down.
  • backup_ip. The IP returned when all targets are down.
  • balance_by_download_score. Whether download liveness score-based load balancing is enabled.
    • true uses score-based balancing.
    • false doesn't use it.
  • cname. The alias for the property.
  • comments. Human-readable details about the property.
  • dynamic_ttl. The TTL in seconds for records that might change dynamically based on liveness and load balancing.
  • failback_delay. The time in seconds to wait before a data center is back in rotation after an outage and subsequent passing liveness tests.
  • failover_delay. The time in seconds to wait before moving traffic from an unresponsive data center.
  • ghost_demand_reporting. Whether ghost load is enabled.
    • true allows the use of a ghost-load domain in load estimates.
    • false uses name server demand estimations for load.
  • handout_limit. The limit of live IPs handed out to a DNS request.
  • handout_mode. How IPs are returned when more than one IP is alive and available.
  • health_max. The absolute limit beyond which IPs are declared unhealthy.
  • health_multiplier. A cutoff computed from liveness scores across all data centers.
  • health_threshold. A cutoff computed from liveness scores across all data centers.
  • ipv6. The type of IP address handed out by a property.
  • last_modified. The date the domain was last modified.
  • links. The direct URL to the given domain. Contains:
    • rel. The link relationship of the object.
    • href. The fully-qualified URL that defines the resource.
  • liveness_tests. Details about liveness tests.
    • answers_required. If test_object_protocol is set to DNS, DOH, or DOT, liveness tests require an answer to the DNS query to be considered a success.
    • disabled. Disables the liveness test.
    • disable_nonstandard_port_warning. Disables warnings when non-standard ports are used.
    • error_penalty. The score that's reported if the liveness test encounters an error other than timeout, such as connection refused or not found.
    • http_error3xx. Treats a 3xx HTTP response as a failure if the test_object_protocol is set to http, https, or ftp.
    • http_error4xx. Treats a 4xx HTTP response as a failure if the test_object_protocol is set to http, https, or ftp.
    • http_error5xx. Treats a 5xx HTTP response as a failure if the test_object_protocol is set to http, https, or ftp.
    • http_method. When the test_object_protocol is http or https, the HTTP method sent. Value is one of:
      • TRACE
      • HEAD
      • OPTIONS
      • GET
      • PUT
      • POST
      • PATCH
      • DELETE
      The default is GET.
    • http_request_body. The Base64-encoded HTTP request body sent if the test_object_protocol is http or https.
    • name.The liveness test's name.
    • peer_certificate_verification. Validates the origin certificate. Applies to tests with test_object_protocol set to https.
    • request_string. A request string.
    • response_string. A response string.
    • resource_type. The query type, if test_object_protocol is DNS.
    • recursion_requested. Whether the DNS query is recursive.
      • true used when the setting of test_object_protocol is one of DNS, DOH, or DOT.
      • false for all other protocol types.
    • test_interval. The interval at which the liveness test is run in seconds.
    • test_object. The static text that acts as a stand-in for the data that you're sending on the network.
    • test_object_port. The port number for the test_object.
    • test_object_protocol. The test protocol.
    • test_object_username. The test object's name.
    • test_object_password. The test object's password.
    • test_timeout. The liveness test duration allowed before it fails.
    • timeout_penalty. The timeout penalty score.
    • ssl_client_certificate. A Base64-encoded certificate.
    • ssl_client_private_key. A Base64-encoded private key.
    • alternate_ca_certificates. A list of alternate CA certificates.
    • pre_2023_security_postureWhether to enable backwards compatibility for liveness endpoints that use older TLS protocols.
      • true allows the operation of pre-2023 security postures.
      • false sets failure for older and less secure protocol features rejected by OpenSSL 3.x.
    • http_headers. A list of HTTP headers for the liveness test.
      • name. The name of the HTTP header.
      • value. The value of the HTTP header.
  • load_imbalance_percentage. The percent of load imbalance factor for the domain.
  • map_name. The name of the geographic or CIDR map required when the property is either geographic or cidrmapping.
  • max_unreachable_penalty. The penalty value added to liveness test scores when data centers show an aggregated loss fraction higher than the penalty value.
  • min_live_fraction. The fraction of servers that need to respond to consider the data center up and able to receive traffic.
  • name. The property's name.
  • score_aggregation_type. The method used to aggregate liveness test scores across different tests when multiple tests are configured.
  • static_rr_sets. Details about the static record sets. Contains:
    • type. The record type.
    • ttl. The number of seconds the record should live in a resolver's cache before being refetched.
    • rdata. A list of the records within a set.
  • static_ttl. The TTL in seconds for static resource records unchanged by the requesting IP.
  • stickness_bonus_constant. The affinity setting in milliseconds that when reached reassigns users to a different data center.
  • stickness_bonus_percentage. The affinity percentage that when reached reassigns users to a different data center.
  • traffic_targets. The traffic targets for the property. Contains:
    • datacenter_id. An ID for an existing data center in the given domain.
    • enabled. Whether the traffic target is used.
      • true uses the target.
      • false does not use the target.
    • handout_cname. An optional data center for the property.
    • name. The traffic target's name.
    • servers. The server's IP address or hostnames.
    • weight. The total number of bytes for a target.
    • precedence. A non-negative integer that represents the failover rank in the event that the primary traffic target is down. Value is 0-255. The default is 0.
  • type. The load balancing behavior for the property.
  • unreachable_threshold. The point at which the aggregated loss fraction triggers an added penalty value to the penalty score.
  • use_computed_targets. Whether to automatically compute the target load.
    • true autocomputes the load for load-feedback domains.
    • false does not autocompute load for the domain.
  • weighted_hash_bits_for_ipv4. The number of leading bits of the client name server IP address to include when computing the hash used for picking a datacenter IPv4 clients.
  • weighted_hash_bits_for_ipv6. The number of leading bits of the client name server IP address to include when computing the hash used for picking a datacenter IPv6 clients.
resources A list of resources associated with the domain. Contains:
  • aggregation_type. The method used to handle different load numbers when multiple load servers are used for a data center or property.
  • constrained_property. The name of the property the resource constrains.
  • description. A human-readable note to help you track what properties the resource constrains.
  • host_header. The host header used when fetching the load object.
  • leader_string. The text that comes before the load_object.
  • links. The direct URL to the given domain. Contains:
    • rel. The link relationship of the object.
    • href. The fully-qualified URL that defines the resource.
  • load_imbalance_percentage. The percent of load imbalance factor for the domain.
  • name. The resource's name.
  • resource_instances. A list of resource instances. Each resource returned contains:
    • datacenter_id. An ID for an existing data center in the given domain.
    • load_object. The load object file used to report real-time information about the current, maximum allowable, and target load on each resource.
    • load_object_port. The TCP port of the load object.
    • load_serversA list of servers from which the load object is available.
    • use_default_load_object. Whether to use default load_object.
      • true uses the default.
      • false doesn't use it.
  • type. The load object format used to determine the load on the resource.
  • upper_bound. The maximum allowed value for any component of the load object.
round_robin_prefix A string that when configured automatically creates a shadow property for each normal property.
server_monitor_pool The name of the pool from which server monitors are drawn for liveness tests for a datacenter.
status Status information details. Contains:
  • change_id. The ID for a change to the domain.
  • links. The direct URL to the given domain. Contains:
    • rel. The link relationship of the object.
    • href. The fully-qualified URL that defines the resource.
  • message. The notification generated when a change occurs to the domain.
  • passing_validation. Whether the domain passes validation.
    • true represents a passing validation.
    • false represents a failure.
  • propagation_status. The status of the domain's propagation state.
  • propagation_status_date. An ISO 8601 timestamp for a change to the domain.
type The load balancing behavior for the property.

Updated 16 days ago