ResourceRecordSets

For a list of methods for this resource, see the end of this page.

Resource representations

A unit of data that is returned by the DNS servers.

{
  "kind": "dns#resourceRecordSet",
  "name": string,
  "type": string,
  "ttl": integer,
  "rrdatas": [
    string
  ],
  "signatureRrdatas": [
    string
  ],
  "routingPolicy": {
    "kind": "dns#rRSetRoutingPolicy",
    "geo": {
      "kind": "dns#rRSetRoutingPolicyGeoPolicy",
      "items": [
        {
          "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem",
          "location": string,
          "rrdatas": [
            string
          ],
          "signatureRrdatas": [
            string
          ],
          "healthCheckedTargets": {
            "internalLoadBalancers": [
              {
                "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
                "loadBalancerType": string,
                "ipAddress": string,
                "port": string,
                "ipProtocol": string,
                "networkUrl": string,
                "project": string,
                "region": string
              }
            ]
          }
        }
      ],
      "enableFencing": boolean
    },
    "wrr": {
      "kind": "dns#rRSetRoutingPolicyWrrPolicy",
      "items": [
        {
          "kind": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem",
          "weight": double,
          "rrdatas": [
            string
          ],
          "signatureRrdatas": [
            string
          ],
          "healthCheckedTargets": {
            "internalLoadBalancers": [
              {
                "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
                "loadBalancerType": string,
                "ipAddress": string,
                "port": string,
                "ipProtocol": string,
                "networkUrl": string,
                "project": string,
                "region": string
              }
            ]
          }
        }
      ]
    },
    "primaryBackup": {
      "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy",
      "primaryTargets": {
        "internalLoadBalancers": [
          {
            "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
            "loadBalancerType": string,
            "ipAddress": string,
            "port": string,
            "ipProtocol": string,
            "networkUrl": string,
            "project": string,
            "region": string
          }
        ]
      },
      "backupGeoTargets": {
        "kind": "dns#rRSetRoutingPolicyGeoPolicy",
        "items": [
          {
            "kind": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem",
            "location": string,
            "rrdatas": [
              string
            ],
            "signatureRrdatas": [
              string
            ],
            "healthCheckedTargets": {
              "internalLoadBalancers": [
                {
                  "kind": "dns#rRSetRoutingPolicyLoadBalancerTarget",
                  "loadBalancerType": string,
                  "ipAddress": string,
                  "port": string,
                  "ipProtocol": string,
                  "networkUrl": string,
                  "project": string,
                  "region": string
                }
              ]
            }
          }
        ],
        "enableFencing": boolean
      },
      "trickleTraffic": double
    }
  }
}

Property name	Value	Description
`kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dns#resourceRecordSet"`.
`name`	`string`	For example, www.example.com.
`routingPolicy`	`nested object`	Configures dynamic query responses based on geo location of querying user or a weighted round robin based routing policy. A ResourceRecordSet should only have either rrdata (static) or routing_policy (dynamic). An error is returned otherwise.
`routingPolicy.geo`	`nested object`
`routingPolicy.geo.enableFencing`	`boolean`	Without fencing, if health check fails for all configured items in the current geo bucket, we'll failover to the next nearest geo bucket. With fencing, if health check is enabled, as long as some targets in the current geo bucket are healthy, we'll return only the healthy targets. However, if they're all unhealthy, we won't failover to the next nearest bucket, we'll simply return all the items in the current bucket even though they're unhealthy.
`routingPolicy.geo.items[]`	`list`	The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
`routingPolicy.geo.items[].healthCheckedTargets`	`nested object`	For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item.
`routingPolicy.geo.items[].healthCheckedTargets.internalLoadBalancers[]`	`list`
`routingPolicy.geo.items[].healthCheckedTargets.internalLoadBalancers[].ipAddress`	`string`	The frontend IP address of the
`routingPolicy.geo.items[].healthCheckedTargets.internalLoadBalancers[].ipProtocol`	`string`	Acceptable values are: "`tcp`" "`udp`" "`undefined`"
`routingPolicy.geo.items[].healthCheckedTargets.internalLoadBalancers[].kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dns#rRSetRoutingPolicyLoadBalancerTarget"`.
`routingPolicy.geo.items[].healthCheckedTargets.internalLoadBalancers[].loadBalancerType`	`string`	Acceptable values are: "`none`" "`regionalL4ilb`"
`routingPolicy.geo.items[].healthCheckedTargets.internalLoadBalancers[].networkUrl`	`string`	The fully qualified url of the network on which the ILB is
`routingPolicy.geo.items[].healthCheckedTargets.internalLoadBalancers[].port`	`string`	Load Balancer to health check.
`routingPolicy.geo.items[].healthCheckedTargets.internalLoadBalancers[].project`	`string`	present. This should be formatted like https://!www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
`routingPolicy.geo.items[].healthCheckedTargets.internalLoadBalancers[].region`	`string`	The region for regional ILBs.
`routingPolicy.geo.items[].kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem"`.
`routingPolicy.geo.items[].location`	`string`	The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc.
`routingPolicy.geo.items[].rrdatas[]`	`list`
`routingPolicy.geo.items[].signatureRrdatas[]`	`list`	DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 ip per item. .
`routingPolicy.geo.kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dns#rRSetRoutingPolicyGeoPolicy"`.
`routingPolicy.kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dns#rRSetRoutingPolicy"`.
`routingPolicy.primaryBackup`	`nested object`
`routingPolicy.primaryBackup.backupGeoTargets`	`nested object`	Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to BACKUP, this policy essentially becomes a geo routing policy.
`routingPolicy.primaryBackup.backupGeoTargets.enableFencing`	`boolean`	Without fencing, if health check fails for all configured items in the current geo bucket, we'll failover to the next nearest geo bucket. With fencing, if health check is enabled, as long as some targets in the current geo bucket are healthy, we'll return only the healthy targets. However, if they're all unhealthy, we won't failover to the next nearest bucket, we'll simply return all the items in the current bucket even though they're unhealthy.
`routingPolicy.primaryBackup.backupGeoTargets.items[]`	`list`	The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.
`routingPolicy.primaryBackup.backupGeoTargets.items[].healthCheckedTargets`	`nested object`	For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with rrdata within this item.
`routingPolicy.primaryBackup.backupGeoTargets.items[].healthCheckedTargets.internalLoadBalancers[]`	`list`
`routingPolicy.primaryBackup.backupGeoTargets.items[].healthCheckedTargets.internalLoadBalancers[].ipAddress`	`string`	The frontend IP address of the
`routingPolicy.primaryBackup.backupGeoTargets.items[].healthCheckedTargets.internalLoadBalancers[].ipProtocol`	`string`	Acceptable values are: "`tcp`" "`udp`" "`undefined`"
`routingPolicy.primaryBackup.backupGeoTargets.items[].healthCheckedTargets.internalLoadBalancers[].kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dns#rRSetRoutingPolicyLoadBalancerTarget"`.
`routingPolicy.primaryBackup.backupGeoTargets.items[].healthCheckedTargets.internalLoadBalancers[].loadBalancerType`	`string`	Acceptable values are: "`none`" "`regionalL4ilb`"
`routingPolicy.primaryBackup.backupGeoTargets.items[].healthCheckedTargets.internalLoadBalancers[].networkUrl`	`string`	The fully qualified url of the network on which the ILB is
`routingPolicy.primaryBackup.backupGeoTargets.items[].healthCheckedTargets.internalLoadBalancers[].port`	`string`	Load Balancer to health check.
`routingPolicy.primaryBackup.backupGeoTargets.items[].healthCheckedTargets.internalLoadBalancers[].project`	`string`	present. This should be formatted like https://!www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
`routingPolicy.primaryBackup.backupGeoTargets.items[].healthCheckedTargets.internalLoadBalancers[].region`	`string`	The region for regional ILBs.
`routingPolicy.primaryBackup.backupGeoTargets.items[].kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem"`.
`routingPolicy.primaryBackup.backupGeoTargets.items[].location`	`string`	The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. "us-east1", "southamerica-east1", "asia-east1", etc.
`routingPolicy.primaryBackup.backupGeoTargets.items[].rrdatas[]`	`list`
`routingPolicy.primaryBackup.backupGeoTargets.items[].signatureRrdatas[]`	`list`	DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 ip per item. .
`routingPolicy.primaryBackup.backupGeoTargets.kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dns#rRSetRoutingPolicyGeoPolicy"`.
`routingPolicy.primaryBackup.kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dns#rRSetRoutingPolicyPrimaryBackupPolicy"`.
`routingPolicy.primaryBackup.primaryTargets`	`nested object`
`routingPolicy.primaryBackup.primaryTargets.internalLoadBalancers[]`	`list`
`routingPolicy.primaryBackup.primaryTargets.internalLoadBalancers[].ipAddress`	`string`	The frontend IP address of the
`routingPolicy.primaryBackup.primaryTargets.internalLoadBalancers[].ipProtocol`	`string`	Acceptable values are: "`tcp`" "`udp`" "`undefined`"
`routingPolicy.primaryBackup.primaryTargets.internalLoadBalancers[].kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dns#rRSetRoutingPolicyLoadBalancerTarget"`.
`routingPolicy.primaryBackup.primaryTargets.internalLoadBalancers[].loadBalancerType`	`string`	Acceptable values are: "`none`" "`regionalL4ilb`"
`routingPolicy.primaryBackup.primaryTargets.internalLoadBalancers[].networkUrl`	`string`	The fully qualified url of the network on which the ILB is
`routingPolicy.primaryBackup.primaryTargets.internalLoadBalancers[].port`	`string`	Load Balancer to health check.
`routingPolicy.primaryBackup.primaryTargets.internalLoadBalancers[].project`	`string`	present. This should be formatted like https://!www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
`routingPolicy.primaryBackup.primaryTargets.internalLoadBalancers[].region`	`string`	The region for regional ILBs.
`routingPolicy.primaryBackup.trickleTraffic`	`double`	When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets.
`routingPolicy.wrr`	`nested object`
`routingPolicy.wrr.items[]`	`list`
`routingPolicy.wrr.items[].healthCheckedTargets`	`nested object`	endpoints that need to be health checked before making the routing decision. The unhealthy endpoints will be omitted from the result. If all endpoints within a buckete are unhealthy, we'll choose a different bucket (sampled w.r.t. its weight) for responding. Note that if DNSSEC is enabled for this zone, only one of rrdata or health_checked_targets can be set.
`routingPolicy.wrr.items[].healthCheckedTargets.internalLoadBalancers[]`	`list`
`routingPolicy.wrr.items[].healthCheckedTargets.internalLoadBalancers[].ipAddress`	`string`	The frontend IP address of the
`routingPolicy.wrr.items[].healthCheckedTargets.internalLoadBalancers[].ipProtocol`	`string`	Acceptable values are: "`tcp`" "`udp`" "`undefined`"
`routingPolicy.wrr.items[].healthCheckedTargets.internalLoadBalancers[].kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dns#rRSetRoutingPolicyLoadBalancerTarget"`.
`routingPolicy.wrr.items[].healthCheckedTargets.internalLoadBalancers[].loadBalancerType`	`string`	Acceptable values are: "`none`" "`regionalL4ilb`"
`routingPolicy.wrr.items[].healthCheckedTargets.internalLoadBalancers[].networkUrl`	`string`	The fully qualified url of the network on which the ILB is
`routingPolicy.wrr.items[].healthCheckedTargets.internalLoadBalancers[].port`	`string`	Load Balancer to health check.
`routingPolicy.wrr.items[].healthCheckedTargets.internalLoadBalancers[].project`	`string`	present. This should be formatted like https://!www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
`routingPolicy.wrr.items[].healthCheckedTargets.internalLoadBalancers[].region`	`string`	The region for regional ILBs.
`routingPolicy.wrr.items[].kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem"`.
`routingPolicy.wrr.items[].rrdatas[]`	`list`
`routingPolicy.wrr.items[].signatureRrdatas[]`	`list`	DNSSEC generated signatures for all the rrdata within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 ip per item. .
`routingPolicy.wrr.items[].weight`	`double`	The weight corresponding to this subset of rrdata. When multiple WeightedRoundRobinPolicyItems are configured, the probability of returning an rrset is proportional to its weight relative to the sum of weights configured for all items. This weight should be non-negative.
`routingPolicy.wrr.kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dns#rRSetRoutingPolicyWrrPolicy"`.
`rrdatas[]`	`list`	As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
`signatureRrdatas[]`	`list`	As defined in RFC 4034 (section 3.2).
`ttl`	`integer`	Number of seconds that this ResourceRecordSet can be cached by resolvers.
`type`	`string`	The identifier of a supported record type. See the list of Supported DNS record types.

Methods

create: Creates a new ResourceRecordSet.
delete: Deletes a previously created ResourceRecordSet.
get: Fetches the representation of an existing ResourceRecordSet.
list: Enumerates ResourceRecordSets that you have created but not yet deleted.
patch: Applies a partial update to an existing ResourceRecordSet.