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

Modify a storage backend

Contributors
PDFs

PUT /accounts/{account_id}/topology/v1/storageBackends/{storageBackend_id}

Replaces the entire stored resource with the supplied JSON request body while preserving key values that are not user-modifiable.

Side Effects

  • Specifying a configuration version results in storage backend type-specific configuration changes being applied, which can include the initial installation of a storage backend.

  • Specifying a configuration version might result in storageClass resources being added, modified, or removed.

Parameters

Name Type In Required Description

account_id

string

path

True

ID of the containing account resource

  • example: {{.Account}}

storageBackend_id

string

path

True

ID of the storageBackend collection to list

Request Body

Replaces the entire stored resource with the supplied JSON request body while preserving key values that are not user-modifiable.

Side Effects

  • Specifying a configuration version results in storage backend type-specific configuration changes being applied, which can include the initial installation of a storage backend.

  • Specifying a configuration version might result in storageClass resources being added, modified, or removed.

Name Type Required Description

type

string

True

Media type of the resource. Defined values are:

  • "application/astra-storageBackend"

version

string

True

Version of the resource. Defined values are:

  • "1.0"

  • "1.1"

  • "1.2"

id

string

False

Globally unique identifier of the resource. Defined values are:

  • Conforms to the UUIDv4 Schema

backendName

string

False

JSON string containing a user-specified name for the storage backend. Defined values are:

  • Minimum length: 1

  • Maximum length: 63

backendType

string

False

JSON string containing a value indicating the type of the storage backend being represented. Defined values are:

  • "ontap" - The storage backend represents a NetApp ONTAP system

  • enum: ["ontap"]

  • example: ontap

backendVersion

string

False

JSON string containing a value indicating the version of the storage backend being represented. Defined values are:

  • Minimum length: 1

  • Maximum length: 63

backendCredentialsName

string

False

JSON string containing a value indicating the name of one or more credential resources used for the storage backend. Allows for credential rotation where multiple credential objects have the same name. Defined values are:

  • Minimum length: 1

  • Maximum length: 63

configVersion

string

False

JSON string containing a value indicating the active configuration to be used by the storage backend. Defined values are:

  • Minimum length: 1

  • Maximum length: 63

state

string

False

JSON string containing a value indicating the operational state of the storage backend. Defined values are:

  • "discovered" - The storage backend has been discovered from a managed cluster

  • "running" - The storage backend is running normally

  • "unknown" - The state of the storage backend cannot be determined

  • "failed" - The storage backend is in an unavailable state

stateDesired

string

False

JSON string containing a value indicating the desired operational state of the storage backend. Defined values are:

  • "running" - The storage backend will be in a normal running state

stateUnready

array[string]

False

JSON array of JSON strings, each indicating a reason why a storage backend is unable to transition to "running", why it has transitioned to "failed" or "unknown", and/or why it is at risk of transitioning to "failed". Defined values are:

  • Minimum length: 1

  • Maximum length: 127

managedState

string

False

JSON string containing a value indicating the management state of the storage backend. Defined values are:

  • "pending" - The storage backend is scheduled to be discovered or added

  • "unmanaged" - The storage backend is in a "discovered" state, is not under management, and is eligible for management

  • "managed" - The storage backend is in a "running" or "unknown" state and is under management

managedStateUnready

array[string]

False

JSON array of JSON strings, each indicating a reason why the storage backend is ineligible to be managed. Defined values are:

  • Minimum length: 1

  • Maximum length: 127

healthState

string

False

JSON string containing a value indicating the health state of the storage backend. Defined values are:

  • "indeterminate" - The health of the resource cannot be determined (for example, due to lack of connectivity)

  • "normal" - The resource has no known issues and can provide services in accordance with the interface specification

  • "warning" - The resource has known issues that do not prevent it providing services in accordance with the interface specification

  • "critical" - The resource has known issues that prevent it from providing services in accordance with the interface specification

healthStateUnready

array[string]

False

JSON array of JSON strings, each indicating a reason why a storage backend is not in a normal health state. Defined values are:

  • Minimum length: 1

  • Maximum length: 127

protectionState

string

False

JSON string containing a value indicating the protection state of the storage backend. "unknown" for ONTAP. Defined values are:

  • "protected" - The storage backend has a protection policy defined and is in conformance with that policy

  • "partial" - The storage backend has a protection policy defined but is out of conformance with that policy

  • "none" - The storage backend is not protected

  • "unknown" - The storage backend protection policy conformance cannot be determined

  • enum: ["protected", "partial", "none", "unknown"]

  • example: protected

protectionStateUnready

array[string]

False

JSON array of JSON strings, each indicating a reason why a protection policy is out of conformance. Defined values are:

  • Minimum length: 1

  • Maximum length: 127

ontap

ontap

False

JSON object containing specific information related to ONTAP clusters.

  • additionalProperties: false

metadata

type_astra_metadata_update

False

Client and service-specified metadata associated with the resource. Defined values are:

  • Conforms to the Astra Metadata Schema If not specified on create, a metadata object will be created with no labels. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.
Example request 
{
  "type": "application/astra-storageBackend",
  "version": "1.2",
  "backendName": "st1-46"
}

Response

Status: 204, Indicates if the storageBackend resource was updated.

Response

Status: 401, Unauthorized
Name Type Required Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False
Example response 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Response

Status: 400, Bad request
Name Type Required Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False

invalidFields

array[invalidFields]

False

List of invalid request body fields
Example response 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Response

Status: 409, Conflict
Name Type Required Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False

invalidFields

array[invalidFields]

False

List of invalid request body fields
Example response 
{
  "type": "https://astra.netapp.io/problems/10",
  "title": "JSON resource conflict",
  "detail": "The request body JSON contains a field that conflicts with an idempotent value.",
  "status": "409"
}

Response

Status: 403, Forbidden
Name Type Required Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False
Example response 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Error

Status: 404, Not found
Name Type Required Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False
Example error response 
{
  "type": "https://astra.netapp.io/problems/1",
  "title": "Resource not found",
  "detail": "The resource specified in the request URI wasn't found.",
  "status": "404"
}

Definitions

See Definitions

ontap

JSON object containing specific information related to ONTAP clusters.

Name Type Required Description

backendManagementIP

string

False

JSON string containing the IP address used to connect to this ONTAP cluster.

managementIPs

array[string]

False

JSON array of JSON strings containing the list of all possible management IPs used to connect to this ONTAP cluster. This is used to correlate backends detected through Trident and storage backends in Astra.

  • uniqueItems: 1

type_astra_label

Name Type Required Description

name

string

True

value

string

True

type_astra_metadata_update

Client and service-specified metadata associated with the resource. Defined values are:

  • Conforms to the Astra Metadata Schema If not specified on create, a metadata object will be created with no labels. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.

Name Type Required Description

labels

array[type_astra_label]

False

creationTimestamp

string

False

modificationTimestamp

string

False

createdBy

string

False

modifiedBy

string

False

invalidParams

Name Type Required Description

name

string

True

Name of the invalid query parameter

reason

string

True

Reason why the query parameter is invalid

invalidFields

Name Type Required Description

name

string

True

Name of the invalid request body field

reason

string

True

Reason why the request body field is invalid