Get packages

05/01/2024 Contributors

You can use the packages endpoint to retrieve the Cloud Volumes ONTAP packages configuration information.

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

Single Node
HA pair

Get packages for single node

You can use this workflow to retrieve the packages information for a single node system.

HTTP method and endpoint

This REST API call uses the following method and endpoint.

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

Curl example

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

JSON output example

The JSON output example includes the list of Cloud Volumes ONTAP packages.

[
    {
        "name": "aws_ha_poc",
        "displayName": "POC and small workloads",
        "description": "No description yet",
        "licenseType": "ha-cot-explore-paygo",
        "instanceTypeMapping": [
            {
                "region": "default",
                "instanceType": "m5.xlarge"
            }
        ],
        "diskType": "gp2",
        "diskSize": {
            "size": 100.0,
            "unit": "GB"
        },
        "capacityTier": null,
        "instanceTenancy": "default",
        "writingSpeedState": "NORMAL"
    },
    {
        "name": "aws_ha_standard",
        "displayName": "Database and application data production workloads",
        "description": "No description yet",
        "licenseType": "ha-cot-standard-paygo",
        "instanceTypeMapping": [
            {
                "region": "default",
                "instanceType": "m5.2xlarge"
            }
        ],
        "diskType": "gp2",
        "diskSize": {
            "size": 100.0,
            "unit": "GB"
        },
        "capacityTier": null,
        "instanceTenancy": "default",
        "writingSpeedState": "NORMAL"
    }
]

Get packages for high availability pair

You can use this workflow to retrieve the packages information for an HA working environment.

HTTP method and endpoint

This REST API call uses the following method and endpoint.

HTTP method	Path
GET	/occm/api/aws/ha/metadata/packages

Curl example

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

JSON output example

The JSON output example includes the list of Cloud Volumes ONTAP packages.

[
    {
        "name": "aws_ha_poc",
        "displayName": "POC and small workloads",
        "description": "No description yet",
        "licenseType": "ha-cot-explore-paygo",
        "instanceTypeMapping": [
            {
                "region": "default",
                "instanceType": "m5.xlarge"
            }
        ],
        "diskType": "gp2",
        "diskSize": {
            "size": 100.0,
            "unit": "GB"
        },
        "capacityTier": null,
        "instanceTenancy": "default",
        "writingSpeedState": "NORMAL"
    },
    {
        "name": "aws_ha_standard",
        "displayName": "Database and application data production workloads",
        "description": "No description yet",
        "licenseType": "ha-cot-standard-paygo",
        "instanceTypeMapping": [
            {
                "region": "default",
                "instanceType": "m5.2xlarge"
            }
        ],
        "diskType": "gp2",
        "diskSize": {
            "size": 100.0,
            "unit": "GB"
        },
        "capacityTier": null,
        "instanceTenancy": "default",
        "writingSpeedState": "NORMAL"
    }
]