REST Resource: organizations.dnsZones

Resource: DnsZone

A DNS zone is a resource under an Apigee organization that is used to create a DNS peering with Apigee's network. DNS peering will let Apigee instances resolve the hostnames created in a peered network.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "description": string,
  "domain": string,
  "peeringConfig": {
    object (PeeringConfig)
  },
  "state": enum (State)
}
Fields
name

string

Identifier. Unique name for the resource. Defined by the server Format: "organizations/{organization}/dnsZones/{dnsZone}".
createTime

string (Timestamp format)

Output only. The time that this resource was created on the server.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The time that this resource was updated on the server.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
description

string

Required. Description of the resource. String of at most 1024 characters associated with this resource for the user's convenience.
domain

string

Required. The domain name for hosts in this private zone, for instance "example.com.".
peeringConfig

object (PeeringConfig)

DNS PEERING zone configuration.
state

enum (State)

Output only. State of the DNS Peering. Values other than ACTIVE mean the resource is not ready to use.

PeeringConfig

Fields for DNS PEERING zone.

JSON representation 
{
  "targetProjectId": string,
  "targetNetworkId": string
}
Fields
targetProjectId

string

Required. The ID of the project that contains the producer VPC network.
targetNetworkId

string

Required. The VPC network where the records for that private DNS zone's namespace are available. Apigee will be performing DNS peering with this VPC network.

Methods

create

 Creates a new DNS zone.

delete

 Deletes a previously created DNS zone.

get

 Fetches the representation of an existing DNS zone.

list

 Enumerates DNS zones that have been created but not yet deleted.