Skip to main content

Retrieve a host cache setting for an SVM

Contributors
PDFs

GET /name-services/cache/host/settings/{uuid}

Introduced In: 9.14

Retrieves a host cache setting for a given SVM.

  • vserver services name-service cache hosts settings show

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

UUID for the host record.

negative_ttl

string

query

False

Filter by negative_ttl

dns_ttl_enabled

boolean

query

False

Filter by dns_ttl_enabled

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

negative_cache_enabled

boolean

query

False

Filter by negative_cache_enabled

ttl

string

query

False

Filter by ttl

enabled

boolean

query

False

Filter by enabled

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

dns_ttl_enabled

boolean

Specifies whether TTL is based on the DNS or host settings. If enabled, TTL from DNS is used.

enabled

boolean

Indicates whether or not the cache is enabled.

negative_cache_enabled

boolean

Indicates whether or not the negative cache is enabled.

negative_ttl

string

Specifies negative Time to Live, in ISO 8601 format.

svm

svm

SVM, applies only to SVM-scoped objects.

ttl

string

Specifies Time to Live (TTL), in ISO 8601 format.

uuid

string

UUID for the host record.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "dns_ttl_enabled": 1,
  "negative_ttl": "PT5M",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "ttl": "PT24H",
  "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

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.