Skip to main content
REST API reference

Retrieve the tags currently used for resources

Retrieves the tags that are currently in use for resources, helping you manage and categorize your data effectively.

HTTP method and endpoint

GET /resource-tags

Introduced in

ONTAP 9.13

Usage notes

Retrieves the tags currently being used for resources in the API.

Parameters

Name Type In Required Description

value

string

query

False

Filter by value

  • maxLength: 200

num_resources

integer

query

False

Filter by num_resources

  • Min value: 1

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.

  • Min value: 0

  • Default value: 15

  • Max value: 120

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[resource_tag]

Example response
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "value": "team:accounting"
    }
  ]
}

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

Name Type Description

next

href

self

href

resource_tag

A resource tag is a way to group resources in the API together for identification or tracking purposes.

Name Type Description

num_resources

integer

The number of resources that are currently using this tag.

value

string

A key:value formatted string representing the tag's name.

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.