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

Retrieve capacity pool information

PDFs

GET /cluster/licensing/capacity-pools/{serial_number}

Introduced In: 9.8

Retrieves information about the capacity pool.

Learn more

  • system license show-status

  • system license show

Parameters

Name Type In Required Description

serial_number

string

path

True

Serial number of the capacity pool license.

nodes.node.name

string

query

False

Filter by nodes.node.name

nodes.node.uuid

string

query

False

Filter by nodes.node.uuid

nodes.used_size

integer

query

False

Filter by nodes.used_size

license_manager.uuid

string

query

False

Filter by license_manager.uuid

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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.
Example response 
{
  "_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

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

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.

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.