Skip to main content

Update a host cache setting

Contributors
PDFs

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

Introduced In: 9.14

Updates a host cache setting.

Important notes

  • UUID field cannot be empty.

  • Returns success in case no values are provided for update.

  • vserver services name-service cache hosts settings modify

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

UUID for the host record.

Request Body

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 request 
{
  "_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"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

23724055

Internal error. Configuration for Vserver failed. Verify that the cluster is healthy, then try the command again. For further assistance, contact technical support.

Also see the table of common errors in the Response body overview section of this documentation.

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.

hosts_settings

Hosts cache setting.

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.

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.