- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Examples
- Try it!
Fetches the representation of an existing DnsKey.
HTTP request
GET https://dns.googleapis.com/dns/v1/projects/{project}/managedZones/{managedZone}/dnsKeys/{dnsKeyId}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Identifies the project addressed by this request. |
managed |
Identifies the managed zone addressed by this request. Can be the managed zone name or ID. |
dns |
The identifier of the requested DnsKey. |
Query parameters
Parameters | |
---|---|
client |
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. |
digest |
An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type is computed and displayed. |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of DnsKey
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/cloud-platform.read-only
https://www.googleapis.com/auth/ndev.clouddns.readonly
https://www.googleapis.com/auth/ndev.clouddns.readwrite
For more information, see the Authentication Overview.
Uses the .NET client library. Uses the Java client library. Uses the Node.js client library. Uses the Python client library.Examples
// BEFORE RUNNING:
// ---------------
// 1. If not already done, enable the Google Cloud DNS API
// and check the quota for your project at
// https://console.developers.google.com/apis/api/dns
// 2. This sample uses Application Default Credentials for authentication.
// If not already done, install the gcloud CLI from
// https://cloud.google.com/sdk and run
// `gcloud beta auth application-default login`.
// For more information, see
// https://developers.google.com/identity/protocols/application-default-credentials
// 3. Install the C# client library by adding a dependency on the relevant NuGet
// package. Libraries published by Google are owned by google-apis-packages:
// https://www.nuget.org/profiles/google-apis-packages
using Google.Apis.Auth.OAuth2;
using Google.Apis.Dns.v1;
using Google.Apis.Services;
using Newtonsoft.Json;
using System;
using System.Threading.Tasks;
using Data = Google.Apis.Dns.v1.Data;
namespace DnsSample
{
public class DnsExample
{
public static void Main(string[] args)
{
DnsService dnsService = new DnsService(new BaseClientService.Initializer
{
HttpClientInitializer = GetCredential(),
ApplicationName = "Google-DnsSample/0.1",
});
// Identifies the project addressed by this request.
string project = "my-project"; // TODO: Update placeholder value.
// Identifies the managed zone addressed by this request. Can be the managed zone name or id.
string managedZone = "my-managed-zone"; // TODO: Update placeholder value.
// The identifier of the requested DnsKey.
string dnsKeyId = "my-dns-key-id"; // TODO: Update placeholder value.
DnsKeysResource.GetRequest request = dnsService.DnsKeys.Get(project, managedZone, dnsKeyId);
// To execute asynchronously in an async method, replace `request.Execute()` as shown:
Data.DnsKey response = request.Execute();
// Data.DnsKey response = await request.ExecuteAsync();
// TODO: Change code below to process the `response` object:
Console.WriteLine(JsonConvert.SerializeObject(response));
}
public static GoogleCredential GetCredential()
{
GoogleCredential credential = Task.Run(() => GoogleCredential.GetApplicationDefaultAsync()).Result;
if (credential.IsCreateScopedRequired)
{
credential = credential.CreateScoped("https://www.googleapis.com/auth/cloud-platform");
}
return credential;
}
}
}/*
* BEFORE RUNNING:
* ---------------
* 1. If not already done, enable the Google Cloud DNS API
* and check the quota for your project at
* https://console.developers.google.com/apis/api/dns
* 2. This sample uses Application Default Credentials for authentication.
* If not already done, install the gcloud CLI from
* https://cloud.google.com/sdk and run
* `gcloud beta auth application-default login`.
* For more information, see
* https://developers.google.com/identity/protocols/application-default-credentials
* 3. Install the Java client library on Maven or Gradle. Check installation
* instructions at https://github.com/google/google-api-java-client.
* On other build systems, you can add the jar files to your project from
* https://developers.google.com/resources/api-libraries/download/dns/v1/java
*/
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.dns.Dns;
import com.google.api.services.dns.model.DnsKey;
import java.io.IOException;
import java.security.GeneralSecurityException;
import java.util.Arrays;
public class DnsExample {
public static void main(String args[]) throws IOException, GeneralSecurityException {
// Identifies the project addressed by this request.
String project = "my-project"; // TODO: Update placeholder value.
// Identifies the managed zone addressed by this request. Can be the managed zone name or id.
String managedZone = "my-managed-zone"; // TODO: Update placeholder value.
// The identifier of the requested DnsKey.
String dnsKeyId = "my-dns-key-id"; // TODO: Update placeholder value.
Dns dnsService = createDnsService();
Dns.DnsKeys.Get request = dnsService.dnsKeys().get(project, managedZone, dnsKeyId);
DnsKey response = request.execute();
// TODO: Change code below to process the `response` object:
System.out.println(response);
}
public static Dns createDnsService() throws IOException, GeneralSecurityException {
HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
JsonFactory jsonFactory = JacksonFactory.getDefaultInstance();
GoogleCredential credential = GoogleCredential.getApplicationDefault();
if (credential.createScopedRequired()) {
credential =
credential.createScoped(Arrays.asList("https://www.googleapis.com/auth/cloud-platform"));
}
return new Dns.Builder(httpTransport, jsonFactory, credential)
.setApplicationName("Google-DnsSample/0.1")
.build();
}
}// BEFORE RUNNING:
// ---------------
// 1. If not already done, enable the Google Cloud DNS API
// and check the quota for your project at
// https://console.developers.google.com/apis/api/dns
// 2. This sample uses Application Default Credentials for authentication.
// If not already done, install the gcloud CLI from
// https://cloud.google.com/sdk and run
// `gcloud beta auth application-default login`.
// For more information, see
// https://developers.google.com/identity/protocols/application-default-credentials
// 3. Install the Node.js client library by running
// `npm install googleapis --save`
const {google} = require('googleapis');
const dns = google.dns('v1');
async function main () {
const authClient = await authorize();
const request = {
// Identifies the project addressed by this request.
project: 'my-project', // TODO: Update placeholder value.
// Identifies the managed zone addressed by this request. Can be the managed zone name or id.
managedZone: 'my-managed-zone', // TODO: Update placeholder value.
// The identifier of the requested DnsKey.
dnsKeyId: 'my-dns-key-id', // TODO: Update placeholder value.
auth: authClient,
};
try {
const response = (await dns.dnsKeys.get(request)).data;
// TODO: Change code below to process the `response` object:
console.log(JSON.stringify(response, null, 2));
} catch (err) {
console.error(err);
}
}
main();
async function authorize() {
const auth = new google.auth.GoogleAuth({
scopes: ['https://www.googleapis.com/auth/cloud-platform']
});
return await auth.getClient();
}"""
BEFORE RUNNING:
---------------
1. If not already done, enable the Google Cloud DNS API
and check the quota for your project at
https://console.developers.google.com/apis/api/dns
2. This sample uses Application Default Credentials for authentication.
If not already done, install the gcloud CLI from
https://cloud.google.com/sdk and run
`gcloud beta auth application-default login`.
For more information, see
https://developers.google.com/identity/protocols/application-default-credentials
3. Install the Python client library for Google APIs by running
`pip install --upgrade google-api-python-client`
"""
from pprint import pprint
from googleapiclient import discovery
from oauth2client.client import GoogleCredentials
credentials = GoogleCredentials.get_application_default()
service = discovery.build('dns', 'v1', credentials=credentials)
# Identifies the project addressed by this request.
project = 'my-project' # TODO: Update placeholder value.
# Identifies the managed zone addressed by this request. Can be the managed zone name or id.
managed_zone = 'my-managed-zone' # TODO: Update placeholder value.
# The identifier of the requested DnsKey.
dns_key_id = 'my-dns-key-id' # TODO: Update placeholder value.
request = service.dnsKeys().get(project=project, managedZone=managed_zone, dnsKeyId=dns_key_id)
response = request.execute()
# TODO: Change code below to process the `response` dict:
pprint(response)