Skip to main content
A newer release of this product is available.

Retrieve an IP address of a hostname

Contributors
PDFs

GET /name-services/host-record/{svm.uuid}/{host}

Introduced In: 9.10

Retrieves the IP address of the specified hostname and vice-versa.

  • vserver services name-service getxxbyyy getnameinfo

  • vserver services name-service getxxbyyy getaddrinfo

Parameters

Name Type In Required Description

host

string

path

True

Hostname or IP address.

use_cache

boolean

query

False

Enables or disables the cache.

  • Introduced in: 9.11

  • Default value:

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

canonical_name

string

Canonical name of the host.

host

string

IP address or hostname.

hostname

string

Hostname.

ipv4_addresses

array[string]

List of IPv4 addresses.

ipv6_addresses

array[string]

List of IPv6 addresses.

source

string

Source used for lookup.

svm

svm

SVM, applies only to SVM-scoped objects.
Example response 
{
  "canonical_name": "localhost",
  "host": "localhost",
  "hostname": "localhost",
  "ipv4_addresses": [
    "127.0.0.1"
  ],
  "ipv6_addresses": [
    ":1"
  ],
  "source": "Files",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

8912900

Invalid IP address.

23724050

Failed to resolve the specified hostname or IP address.
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

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.