VMware Cloud Sizer API 1.0.0

Getting Started with VMware Cloud Sizer REST APIs in 5 Minutes

VMware Sizer helps you with the sizing recommendations for VMware Cloud environments based on On-Premises workload characteristics.

About VMware Cloud Sizer API Programming

There are two core modules that are exposed currently:

Recommendation API

Recommendation API would recommend the number of hosts and resources required for a set of workloads.

A sample sizing recommendation request for a I3 host, running 200 General Purpose VMs, the request would be something like:

curl -X POST -d '{
	"globalSpecs": {
		"instanceType": "I3",
		"CPUHeadroom": 15,
		"fttAndftm": "AUTO_AUTO",
		"stretchedCluster": false,
		"sddcApplianceSize": "AUTO",
		"sizingType": "QUICK"
	},
	"workloads": [
		{
			"profileName": "Workload profile - 1",
			"workloadType": "GPW_GVM",
			"vmProfile": {
				"vCpusPerVM": 2,
				"vCpusPerCore": 4,
				"vmsNum": 200,
				"vRAMPerVM": {
					"value": 4
				},
				"vmdkSize": {
					"value": 200
				}
			}
		}
	]
}' -H "Content-Type: application/json" 
'https://vmc.vmware.com/api/sizer/v4/recommendation?cloudProviderType=VMC_ON_AWS'

Defaults and Limits API

The sizing recommendation API takes up a number of parameters that are required as inputs to compute a precise sizing recommendation.

Defaults and Limits API contain the default values for a configuration set, and the range of acceptable values for each of them with respect to a given workload profile.

This can be used as a reference point to the sizing recommendation requests.

For example, to request the default workload values, the range of acceptable values for a I3 host, and a General Purpose VM would be something like:

curl -X GET 'https://vmc.vmware.com/api/sizer/v4/workload-specs?cloudProviderType=VMC_ON_AWS&instanceType=I3&workloadType=GPW_GVM'

Likewise for default global (cluster) level values and the range of acceptable values for a I3 host:

curl -X GET 'https://vmc.vmware.com/api/sizer/v4/global-specs?cloudProviderType=VMC_ON_AWS&instanceType=i3'