Get started
Get permutations
Suggest changes
You can use the permutations endpoint to retrieve the Cloud Volumes ONTAP configuration information.
Choose the workflow to use based on the type of Cloud Volumes ONTAP deployment:
Get permutations for single node
You can use this workflow to retrieve the configuration information for a single node working environment.
This REST API call uses the following method and endpoint.
| HTTP method | Path |
|---|---|
GET |
/occm/api/vsa/metadata/permutations |
curl --request GET \
--location "https://cloudmanager.cloud.netapp.com/occm/api/vsa/metadata/permutations" \
--header "x-agent-id: <AGENT_ID>" \
--header "Authorization: Bearer <ACCESS_TOKEN>" \
--header "Content-Type: application/json"In addition to the parameters common with all REST API calls, the following parameters are also used in the curl examples for this step.
| Parameter | Type | Required | Description |
|---|---|---|---|
|
Query |
No |
Identifies the region of the working environment. |
|
Query |
No |
Identifies the AMazon resource name for the connection's role. |
|
Query |
No |
Identifies the license associated with your working environment. |
|
Query |
No |
Identifies the Cloud Volumes ONTAP instance type. |
|
Query |
No |
Identifies the default Cloud Volumes ONTAP instance type. |
|
Query |
No |
Identifies the feature. |
|
Query |
No |
Identifies whether the latest instance is associated. |
|
Query |
No |
Identifies the Amazon machine image. |
The JSON output example includes the list of Cloud Volumes ONTAP configurations.
Example output
[
{
"ontapVersion": "ONTAP-9.9.0X4.T1",
"license": {
"type": "cot-explore-paygo",
"name": "Cloud Volumes ONTAP Explore",
"description": "Suitable for smaller capacity applications. Supports up to 2 TB of underlying AWS storage.",
"subName": "",
"subDescription":"Support of tiering to object storage is not included.",
"capacity_limit": "2TB",
"platformLicenseRequired": false,
"default":false,
"capacityLimit": {"size":2.0, "unit": "TB"}
},
"instanceType": "m5.xlarge",
"region": {
"name": "EU",
"code": "eu-central-1",
"location": "Frankfurt",
"s3Region": "eu-central-1"
},
"defaultInstance":true,
"features": ["ena","kvm","network-utilization"],
"upgradeableFrom": ["9.8","9.9.0"]
}
]
Get permutations for high availability pair
You can use this workflow to retrieve the configuration information for an HA working environment.
This REST API call uses the following method and endpoint.
| HTTP method | Path |
|---|---|
GET |
/occm/api/aws/ha/metadata/permutations |
curl --request GET \
--location "https://cloudmanager.cloud.netapp.com/occm/api/aws/ha/metadata/permutations?latest_only=true" \
--header "x-agent-id: <AGENT_ID>" \
--header "Authorization: Bearer <ACCESS_TOKEN>" \
--header "Content-Type: application/json"In addition to the parameters common with all REST API calls, the following parameters are also used in the curl examples for this step.
| Parameter | Type | Required | Description |
|---|---|---|---|
|
Query |
No |
Identifies the region of the working environment. |
|
Query |
No |
Identifies the AMazon resource name for the connection's role. |
|
Query |
No |
Identifies the license associated with your working environment. |
|
Query |
No |
Identifies the Cloud Volumes ONTAP instance type. |
|
Query |
No |
Identifies the default Cloud Volumes ONTAP instance type. |
|
Query |
No |
Identifies the feature. |
|
Query |
No |
Identifies whether the latest instance is associated. |
|
Query |
No |
Identifies the Amazon machine image. |
The JSON output example includes the list of Cloud Volumes ONTAP configurations.
Example output
[
{
"ontapVersion": "ONTAP-9.9.0X6.T1.ha",
"license": {
"type": "ha-cot-explore-paygo",
"name": "Cloud Volumes ONTAP Explore",
"description": "Suitable for smaller capacity applications. Supports up to 2 TB of underlying AWS storage.",
"subName": "",
"subDescription": "Support of tiering to object storage is not included.",
"capacity_limit": "2TB",
"platformLicenseRequired": false,
"default": false,
"capacityLimit": {
"size": 2.0,
"unit": "TB"
}
},
"instanceType": "m5.xlarge",
"region": {
"name": "EU",
"code": "eu-central-1",
"location": "Frankfurt",
"s3Region": "eu-central-1"
},
"defaultInstance": true,
"features": [
"ena",
"kvm",
"network-utilization"
],
"upgradeableFrom": [
"9.8",
"9.9.0"
]
},
{
"ontapVersion": "ONTAP-9.9.0X6.T1.ha",
"license": {
"type": "ha-cot-explore-paygo",
"name": "Cloud Volumes ONTAP Explore",
"description": "Suitable for smaller capacity applications. Supports up to 2 TB of underlying AWS storage.",
"subName": "",
"subDescription": "Support of tiering to object storage is not included.",
"capacity_limit": "2TB",
"platformLicenseRequired": false,
"default": false,
"capacityLimit": {
"size": 2.0,
"unit": "TB"
}
},
"instanceType": "m5.xlarge",
"region": {
"name": "EU",
"code": "eu-west-1",
"location": "Ireland",
"s3Region": "eu-west-1"
},
"defaultInstance": true,
"features": [
"ena",
"kvm",
"network-utilization"
],
"upgradeableFrom": [
"9.8",
"9.9.0"
]
}
]