Get buckets

10/02/2023 Contributors

You can perform this workflow to retrieve the S3 buckets. The S3 buckets are the Google Cloud storage buckets (data containers in Google Cloud) required for data tiering and backups.

Choose the workflow to use based on the type of Cloud Volumes ONTAP deployment:

Single Node
HA pair

Get buckets for single node

You can use this workflow to retrieve the S3 buckets for a single node working environment.

1. Get the buckets

HTTP method	Path
GET	/occm/api/vsa/metadata/buckets

curl example

curl --location --request GET 'https://cloudmanager.cloud.netapp.com/occm/api/vsa/metadata/buckets' --header 'x-agent-id: <AGENT_ID>' --header 'Authorization: Bearer <ACCESS_TOKEN>' --header 'Content-Type: application/json'

Input: None
Output: The JSON output example includes the list of S3 buckets.
JSON output example

[
    {
        "bucketName": "3.9.0.bins.08112xxx",
        "region": "us-east-1",
        "tags": {}
    },
    {
        "bucketName": "000000xxx-awsmacietrail-dataevent",
        "region": "us-east-1",
        "tags": {}
    }
]

Get buckets for high availability pair

You can use this workflow to retrieve the S3 buckets for an HA working environment.

1. Get the buckets

HTTP method	Path
GET	/occm/api/ha/metadata/buckets

curl example

curl --location --request GET 'https://cloudmanager.cloud.netapp.com/occm/api/ha/metadata/buckets' --header 'x-agent-id: <AGENT_ID>' --header 'Authorization: Bearer <ACCESS_TOKEN>' --header 'Content-Type: application/json'

Input: None
Output: The JSON output example includes the list of S3 buckets.
JSON output example

[
    {
        "bucketName": "3.9.0.bins.08112xxx",
        "region": "us-east-1",
        "tags": {}
    },
    {
        "bucketName": "7330xxxxxxx-awsmacietrail-dataevent",
        "region": "us-east-1",
        "tags": {}
    }
]