Overview

Contributors

Amazon FSx for ONTAP is a Cloud Manager service that enables you to create, operate, and delete Amazon FSx storage facilities for ONTAP systems.
For more information about FSx for ONTAP, see Cloud Manager FSx ONTAP.

There are four categories of API endpoints defined within the FSx for ONTAP service:

  • AWS operations

  • AWS credentials

  • Working environments

  • FSx ONTAP discovery

References


REST implementation

HTTP methods

Method Description

POST

Create an object instance

GET

Retrieve an object instance or collection

PUT

Update specified properties of existing objects

DELETE

Remove an existing object

Request headers

Request Header Description

Authorization

Required. Contains a JWT access token

X-Service-Request-Id

Request ID to use in logs

x-simulator

Indicates whether this API call is simulated or real

Query parameters

You can use query parameters with endpoints in the following components:

Component Query Parameter

isGov

- Used to decide whether FSx storage is located in the governed location

region

- The API will be executed in the specified region

workspace-id

- The Cloud Manager workspace

Path parameters

You can use path parameters with endpoints.

Component Query Parameter

account-id

Tenancy account ID for this API

workingEnvironmentId

FSx working environment ID used to execute this API

Response headers

This API uses the standard HTTP response headers common with all Cloud Manager APIs. See REST implementation for more information.

HTTP status codes

HTTP Status Code Description

200

OK: Returned for successful operation completion

400

Bad Request: Returned if the input is malformed and could not be parsed

401

Unauthorized: Returned if user authentication failed or the token has expired

403

Forbidden: Returned for authorization errors depending on the resource and token

404

Not Found: Returned if the requested resource could not be found

500

Processing Error: Returned if an error occurs on the server while processing the API call


Error handling

There are three processes involved with error handling and processing:

  • The error is logged for supportability

  • The error is returned to the caller for specific handling

  • The database connection is rolled back


cURL examples

Retrieve FSx working environments for a specified account ID

This cURL example retrieves FSx working environments for a specified account ID.

  curl -X GET "https://staging.cloudmanager.cloud.netapp.com/fsx-ontap/working-environments/<accountId>"
 -H  "accept: application/json" -H  "authorization: <user token>"