Retrieve the cloud store for an aggregate
Suggest changes
PDFs
GET /storage/aggregates/{aggregate.uuid}/cloud-stores/{target.uuid}
Introduced In: 9.6
Retrieves the cloud store for the aggregate using the specified cloud target UUID.
Related ONTAP commands
-
storage aggregate object-store show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
aggregate.uuid |
string |
path |
True |
Aggregate UUID |
target.uuid |
string |
path |
True |
Cloud target UUID |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok| Name | Type | Description |
|---|---|---|
_links |
||
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. |
target |
Cloud target |
|
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. |
Example response
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"aggregate": {
"name": "aggr1"
},
"availability": "string",
"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 |
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 |
|---|---|---|
self |
aggregate
Aggregate
| Name | Type | Description |
|---|---|---|
name |
string |
target
Cloud target
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
| Name | Type | Description |
|---|---|---|
message |
string |
Indicates why the object store is unavailable. |
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. |