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

Retrieve capacity pools

Contributors
PDFs

GET /cluster/licensing/capacity-pools

Introduced In: 9.8

Retrieves a collection of capacity pools.

Learn more

  • system license show-status

  • system license show

Parameters

Name Type In Required Description

nodes.used_size

integer

query

False

Filter by nodes.used_size

nodes.node.uuid

string

query

False

Filter by nodes.node.uuid

nodes.node.name

string

query

False

Filter by nodes.node.name

serial_number

string

query

False

Filter by serial_number

license_manager.uuid

string

query

False

Filter by license_manager.uuid

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

collection_links

num_records

integer

Number of records

records

array[records]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "license_manager": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "uuid": "4ea7a442-86d1-11e0-ae1c-112233445566"
      },
      "nodes": [
        {
          "node": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "node1",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          },
          "used_size": 0
        }
      ],
      "serial_number": "390000100"
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

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
Name Type Description

self

href

license_manager

License manager instance where this capacity pool license in installed.

Name Type Description

_links

self_link

uuid

string

_links

Name Type Description

self

href

node_reference

Name Type Description

_links

_links

name

string

uuid

string

nodes

Information on a node from the capacity licensing perspective.

Name Type Description

node

node_reference

used_size

integer

Capacity, in bytes, that is currently used by the node.

records

Information on a capacity pool license and how it is associated with the cluster.

Name Type Description

_links

self_link

license_manager

license_manager

License manager instance where this capacity pool license in installed.

nodes

array[nodes]

Nodes in the cluster associated with this capacity pool.

serial_number

string

Serial number of the capacity pool license.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.