Skip to main content
REST API reference

Update a cloud store

PDFs

PATCH /storage/aggregates/{aggregate.uuid}/cloud-stores/{target.uuid}

Introduced In: 9.6

Updates the cloud store specified by the UUID with the fields in the body. This request starts a job and returns a link to that job.

  • storage aggregate object-store modify

Parameters

Name Type In Required Description

aggregate.uuid

string

path

True

Aggregate UUID

target.uuid

string

path

True

Cloud target UUID

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

Request Body

Name Type Description

availability

string

Availability of the object store.

availability_at_partner

string

Availability of the object store at the HA partner.

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.

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.
Example request 
{
  "availability": "string",
  "availability_at_partner": "string",
  "resync-progress": 0,
  "unavailable_reason": {
    "message": "string"
  },
  "unreclaimed_space_threshold": 20,
  "used": 0
}

Response

Status: 200, Ok
Name Type Description

job

job_link
Example response 
{
  "job": {
    "uuid": "string"
  }
}

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

787154

The Object stores are currently not synchronized. Check the mirror resync status.

787156

Modifying the attributes of a mirror object store is not allowed.

Also see the table of common errors in the Response body overview section of this documentation.

Definitions

See Definitions

href

Name Type Description

href

string

_links

aggregate

Aggregate

Name Type Description

name

string

target

Cloud target

Name Type Description

name

string

uuid

string

unavailable_reason

Name Type Description

message

string

Indicates why the object store is unavailable.

cloud_store

Name Type Description

availability

string

Availability of the object store.

availability_at_partner

string

Availability of the object store at the HA partner.

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.

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

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

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.