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

Retrieve a collection of cloud stores used by an aggregate

PDFs

GET /storage/aggregates/{aggregate.uuid}/cloud-stores

Introduced In: 9.6

Retrieves the collection of cloud stores used by an aggregate.

  • storage aggregate object-store show

Parameters

Name Type In Required Description

aggregate.uuid

string

path

True

Aggregate UUID

unavailable_reason.message

string

query

False

Filter by unavailable_reason.message

  • Introduced in: 9.7

aggregate.name

string

query

False

Filter by aggregate.name

  • Introduced in: 9.9

availability

string

query

False

Filter by availability

resync-progress

integer

query

False

Filter by resync-progress

  • Introduced in: 9.14

primary

boolean

query

False

Filter by primary

unreclaimed_space_threshold

integer

query

False

Filter by unreclaimed_space_threshold

target.uuid

string

query

False

Filter by target.uuid

target.name

string

query

False

Filter by target.name

used

integer

query

False

Filter by used

mirror_degraded

boolean

query

False

Filter by mirror_degraded

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: 15

  • 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

num_records

integer

Number of records

records

array[cloud_store]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "aggregate": {
        "name": "aggr1"
      },
      "availability": "string",
      "resync-progress": 0,
      "target": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "target1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "unavailable_reason": {
        "message": "string"
      },
      "unreclaimed_space_threshold": 20,
      "used": 0
    }
  ]
}

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

next

href

self

href

_links

Name Type Description

self

href

aggregate

Aggregate

Name Type Description

name

string

target

Cloud target

Name Type Description

_links

_links

name

string

uuid

string

unavailable_reason

Name Type Description

message

string

Indicates why the object store is unavailable.

cloud_store

Name Type Description

_links

_links

aggregate

aggregate

Aggregate

availability

string

Availability of the object store.

mirror_degraded

boolean

This field identifies if the mirror cloud store is in sync with the primary cloud store of a FabricPool.

primary

boolean

This field indicates whether the cloud store is the primary cloud store of a mirrored FabricPool.

resync-progress

integer

Resync progress of the mirror object store in percentage.

target

target

Cloud target

unavailable_reason

unavailable_reason

unreclaimed_space_threshold

integer

Usage threshold for reclaiming unused space in the cloud store. Valid values are 0 to 99. The default value depends on the provider type. This can be specified in PATCH but not POST.

used

integer

The amount of object space used. Calculated every 5 minutes and cached.

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.