Google Cloud DNS Client Library

0.36.1 · active · verified Tue Apr 14

The Google Cloud DNS API client library provides a Pythonic interface for managing DNS records and managed zones within Google Cloud DNS. It is part of the broader `google-cloud-python` monorepo, benefiting from its active development and frequent updates across Google Cloud services.

Warnings

breaking Python 2.7 support was dropped in `google-cloud-python` 2.0.0. Current versions require Python 3.9 or newer.
Fix: Upgrade your Python environment to 3.9+ and ensure your `google-cloud-dns` library is updated accordingly. Review the official migration guides for any specific API changes if coming from very old versions.
gotcha Ensure the Cloud DNS API is enabled in your Google Cloud project. Attempting operations without enabling the API will result in 'attempted action failed' or similar permission errors.
Fix: Navigate to the Google Cloud Console, search for 'Cloud DNS API' in the API Library, and enable it for your project.
gotcha When creating DNS records, be aware of DNS specifications and Cloud DNS limitations, particularly regarding CNAME records. A CNAME record cannot exist at the zone apex (root domain) and cannot coexist with other record types for the same DNS name.
Fix: Use A/AAAA records for the zone apex. For subdomains, ensure CNAMEs do not conflict with other record types. Always include a trailing dot for fully qualified domain names (e.g., 'example.com.') in record data.
gotcha Authentication for Google Cloud client libraries, including `google-cloud-dns`, typically relies on Application Default Credentials (ADC). For local development, `gcloud auth application-default login` generates user credentials for client libraries, distinct from `gcloud auth login` which authenticates the CLI itself.
Fix: For client library authentication in local development, use `gcloud auth application-default login`. In production, configure service accounts or other appropriate ADC mechanisms.

Install

pip install google-cloud-dns Install latest version

Imports

Client
```
from google.cloud import dns
```
The direct import `from google.cloud.dns.client import Client` was used in older versions of the `google-cloud` meta-package (e.g., prior to 1.0) but is deprecated in favor of `from google.cloud import dns` where `dns.Client` is the recommended instantiation.

Quickstart

This quickstart initializes the Google Cloud DNS client and lists all managed zones within a specified Google Cloud project. It leverages Application Default Credentials (ADC) for authentication, automatically inferring credentials from the environment. For local execution, ensure the `GOOGLE_CLOUD_PROJECT` environment variable is set or replace the placeholder. You'll also need to authenticate with `gcloud auth application-default login`.

import os
from google.cloud import dns

# Your Google Cloud project ID
project_id = os.environ.get('GOOGLE_CLOUD_PROJECT', 'your-project-id')

if not project_id or project_id == 'your-project-id':
    print("Please set the 'GOOGLE_CLOUD_PROJECT' environment variable or replace 'your-project-id' in the code.")
    exit(1)

# Initialize the DNS client
# The client automatically handles authentication using Application Default Credentials (ADC)
# For local development, ensure you've run 'gcloud auth application-default login'
client = dns.Client(project=project_id)

try:
    # List managed zones
    print(f"Listing managed zones for project: {project_id}")
    zones = client.list_zones()

    if not zones:
        print("No managed zones found.")
    else:
        for zone in zones:
            print(f"  Zone Name: {zone.name}, DNS Name: {zone.dns_name}")
except Exception as e:
    print(f"An error occurred: {e}")

view raw JSON →