Skip to main content

Retrieve the DNS domain and server configuration for an SVM

Contributors
PDFs

GET /name-services/dns/{uuid}

Introduced In: 9.13

Retrieves DNS domain and server configuration of an SVM. By default, both DNS domains and servers are displayed.

Advanced properties

  • 'tld_query_enabled'

  • 'source_address_match'

  • 'packet_query_match'

  • 'status' property retrieves the status of each name server of the DNS configuration for an SVM.

  • 'service_ips' property is displayed only when both service.name and SVM are set.

  • vserver services name-service dns show

  • vserver services name-service dns check

  • vserver services name-service dns dynamic-update show

  • vserver services access-check dns srv-lookup

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

UUID of the DNS object.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

attempts

integer

Number of attempts allowed when querying the DNS name servers.

domains

array[string]

A list of DNS domains. Domain names have the following requirements:

  • The name must contain only the following characters: A through Z, a through z, 0 through 9, ".", "-" or "_".

  • The first character of each label, delimited by ".", must be one of the following characters: A through Z or a through z or 0 through 9.

  • The last character of each label, delimited by ".", must be one of the following characters: A through Z, a through z, or 0 through 9.

  • The top level domain must contain only the following characters: A through Z, a through z.

  • The system reserves the following names:"all", "local", and "localhost".

dynamic_dns

dynamic_dns

packet_query_match

boolean

Indicates whether or not the query section of the reply packet is equal to that of the query packet.

scope

string

Set to "svm" for DNS owned by an SVM, otherwise set to "cluster".

servers

array[string]

The list of IP addresses of the DNS servers. Addresses can be either IPv4 or IPv6 addresses.

service_ips

array[string]

List of IP addresses for a DNS service. Addresses can be IPv4, IPv6 or both.

skip_config_validation

boolean

Indicates whether or not the validation for the specified DNS configuration is disabled.

source_address_match

boolean

Indicates whether or not the DNS responses are from a different IP address to the IP address the request was sent to.

status

array[status]

Status of all the DNS name servers configured for the specified SVM.

svm

svm

SVM, applies only to SVM-scoped objects.

timeout

integer

Timeout values for queries to the name servers, in seconds.

tld_query_enabled

boolean

Enable or disable top-level domain (TLD) queries.

uuid

string

UUID of the DNS object.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "attempts": 1,
  "domains": [
    "example.com",
    "example2.example3.com"
  ],
  "dynamic_dns": {
    "fqdn": "example.com",
    "time_to_live": "P2D"
  },
  "scope": "string",
  "servers": [
    "10.224.65.20",
    "2001:db08:a0b:12f0::1"
  ],
  "service_ips": [
    "10.224.65.20",
    "2001:db08:a0b:12f0::1"
  ],
  "status": [
    {
      "code": 6684732,
      "message": "string",
      "name_server": "10.10.10.10",
      "state": "up"
    }
  ],
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "timeout": 2,
  "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

dynamic_dns

Name Type Description

enabled

boolean

Enable or disable Dynamic DNS (DDNS) updates for the specified SVM.

fqdn

string

Fully Qualified Domain Name (FQDN) to be used for dynamic DNS updates.

skip_fqdn_validation

boolean

Enable or disable FQDN validation.

time_to_live

string

Time to live value for the dynamic DNS updates, in an ISO-8601 duration formatted string. Maximum Time To Live is 720 hours(P30D in ISO-8601 format) and the default is 24 hours(P1D in ISO-8601 format).

use_secure

boolean

Enable or disable secure dynamic DNS updates for the specified SVM.

status

Status of each of the DNS name server configured for the specified SVM.

Name Type Description

code

integer

Code corresponding to the status message. Code is 0 when the state is 'up'.

message

string

Detailed description of the validation state if the state is 'down' or the response time of the DNS server if the state is 'up'.

name_server

string

The IP address of the DNS server. The address can be either an IPv4 or an IPv6 address.

state

string

The validation status of the DNS server.

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.