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

Retrieve a collection of cloud stores used by an aggregate

Contributors
PDFs

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

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

unreclaimed_space_threshold

integer

query

False

Filter by unreclaimed_space_threshold

mirror_degraded

boolean

query

False

Filter by mirror_degraded

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

primary

boolean

query

False

Filter by primary

availability

string

query

False

Filter by availability

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.

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.

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"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "availability": "string",
      "target": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "target1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "unreclaimed_space_threshold": 20,
      "used": 0
    }
  ]
}

Error

Status: Default, n/a
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

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

target

Cloud target

Name Type Description

_links

_links

name

string

uuid

string

cloud_store

Name Type Description

_links

_links

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 cloud mirrored composite aggregate.

target

target

Cloud target

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

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.