Introduced1 Changed11 Deleted2
[{"label":"Latest (v5)","version":"latest"},{"version":"v4"}]
vmc-sizer

Get Sizing Recommendation

Description

Get a VMware Cloud sizing recommendation on total based calculations based on input workload characteristics.

Request

Request

URL

URL


post
https://vmc.vmware.com/api/vmc-sizer/v5/recommendation
Copy

Request Body

Request Body

VMCSizerRequest of mimetype application/json Required

The Total based sizing recommendation request with workload characteristics.

{
	"workloadProfiles": [
		{
			"vmList": [
				{
					"vmComputeInfo": {
						"vCpu": 4
					},
					"vmGroupId": "vm-gp-123",
					"vmId": "vm-123",
					"vmMemoryInfo": {
						"vRam": 4
					},
					"vmName": "oracleVM",
					"vmStorageInfo": {
						"vmdkUsed": 140
					}
				}
			]
		}
	]
}
array of WorkloadProfile
workloadProfiles Required

Workload profile comprises of the VM configurations and complete VM List.


configurations Optional

The VM Sizing configurations required for computation.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created returns VMCSizerResponse of type application/json
{
	"sddcList": [
		{
			"clusterList": {
				"mazClusters": {
					"applianceSize": "REGULAR",
					"clusterInfoList": [
						{
							"allottedMemory": 80,
							"allottedStorage": 80,
							"allottedvCpus": 90,
							"clusterName": "cluster-123",
							"clusterType": "SAZ",
							"fttFtmType": "AUTO_AUTO",
							"hostList": [
								{
									"allottedMemory": 90,
									"allottedvCpus": 90,
									"hostType": "i3",
									"numberOfVms": 1000,
									"totalCpuCapacity": 100,
									"totalMemoryCapacity": 100,
									"usedMemoryCapacity": 70,
									"vmList": [
										{
											"vmComputeInfo": {
												"utilizationRatio": 30,
												"vCpu": 4,
												"vCpuOverall": 4,
												"vCpuPerCore": 1
											},
											"vmGroupId": "vm-gp-123",
											"vmId": "vm-123",
											"vmMemoryInfo": {
												"ramOverhead": 70,
												"utilizationRatio": 100,
												"vRam": 4,
												"vRamConsumed": 3
											},
											"vmName": "oracleVM",
											"vmState": "RUNNING",
											"vmStorageInfo": {
												"readIOPS": 100,
												"vmdkTotal": 200,
												"vmdkUsed": 140,
												"writeIOPS": 30
											}
										}
									]
								}
							],
							"numberOfHosts": 10,
							"numberOfVMs": 100,
							"recommendationType": "CPU",
							"totalCpuCapacity": 100,
							"totalMemoryCapacity": 100,
							"totalStorageCapacity": 100,
							"usedMemory": 100
						}
					]
				},
				"sazClusters": {
					"applianceSize": "REGULAR",
					"clusterInfoList": [
						{
							"allottedMemory": 80,
							"allottedStorage": 80,
							"allottedvCpus": 90,
							"clusterName": "cluster-123",
							"clusterType": "SAZ",
							"fttFtmType": "AUTO_AUTO",
							"hostList": [
								{
									"allottedMemory": 90,
									"allottedvCpus": 90,
									"hostType": "i3",
									"numberOfVms": 1000,
									"totalCpuCapacity": 100,
									"totalMemoryCapacity": 100,
									"usedMemoryCapacity": 70,
									"vmList": [
										{
											"vmComputeInfo": {
												"utilizationRatio": 30,
												"vCpu": 4,
												"vCpuOverall": 4,
												"vCpuPerCore": 1
											},
											"vmGroupId": "vm-gp-123",
											"vmId": "vm-123",
											"vmMemoryInfo": {
												"ramOverhead": 70,
												"utilizationRatio": 100,
												"vRam": 4,
												"vRamConsumed": 3
											},
											"vmName": "oracleVM",
											"vmState": "RUNNING",
											"vmStorageInfo": {
												"readIOPS": 100,
												"vmdkTotal": 200,
												"vmdkUsed": 140,
												"writeIOPS": 30
											}
										}
									]
								}
							],
							"numberOfHosts": 10,
							"numberOfVMs": 100,
							"recommendationType": "CPU",
							"totalCpuCapacity": 100,
							"totalMemoryCapacity": 100,
							"totalStorageCapacity": 100,
							"usedMemory": 100
						}
					]
				}
			},
			"sddcName": "us-west-sddc",
			"sddcType": "ALL",
			"vmExceptions": {
				"vmExceptionAssumptions": [
					"The Virtual Machine would consume 75% or more CPU resources on a single host. | The Virtual Machine would consume 75% of more RAM resources on a single host. | The Virtual Machine would consume 50% of more available raw storage on a single host."
				],
				"vmExceptionInfo": [
					{
						"exceptionReason": "Memory insufficient",
						"totalDisk": 10020,
						"totalRAM": 1512,
						"totalVCPU": 1000,
						"usedDisk": 10010,
						"vmGroupId": "vm-gp-123",
						"vmId": "vm-123",
						"vmName": "oracleVM"
					}
				]
			}
		}
	],
	"sizingAssumtions": [
		"Default CPU Headroom: 15% | Default Memory utilization: 100"
	]
}
array of SDDCInfo
sddcList Optional

List of SDDC for SAZ and MAZ cluster details.


array of string
sizingAssumtions Optional

Assumptions for the SDDC done while doing total based calcultaion for the workloads.

Errors

Errors

400

Bad Request occured for the requested path.


401

Unauthorized to access the API.


403

Forbidden to access the API.


404

Requested API is Not Found.


500

Internal Server Error occured for the requested path.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"configurations":{"applianceSize":"REGULAR","cloudType":"VMC_ON_AWS","clusterType":"SAZ","computeOvercommitFactor":4,"fttFtmType":"AUTO_AUTO","includeManagementVMs":true,"instanceSettingsList":[{"hostType":"I3","name":"DEDUP_RATIO","value":"1.5"}],"memoryOvercommitFactor":1,"sddcHostType":"ALL","storageThresholdFactor":1,"vmOutlierLimits":{"cpuLimit":0,"memoryLimit":0,"storageLimit":0}},"workloadProfiles":[{"addonsList":[{"id":"HCX","isEnabled":false,"isGlobalAddOn":false,"name":"string"}],"configurations":{"applianceSize":"REGULAR","cloudType":"VMC_ON_AWS","clusterType":"SAZ","computeOvercommitFactor":4,"fttFtmType":"AUTO_AUTO","includeManagementVMs":true,"instanceSettingsList":[{"hostType":"I3","name":"DEDUP_RATIO","value":"1.5"}],"memoryOvercommitFactor":1,"sddcHostType":"ALL","storageThresholdFactor":1,"vmOutlierLimits":{"cpuLimit":0,"memoryLimit":0,"storageLimit":0}},"vmList":[{"vmComputeInfo":{"utilizationRatio":30,"vCpu":4,"vCpuOverall":4,"vCpuPerCore":1},"vmGroupId":"vm-gp-123","vmId":"vm-123","vmMemoryInfo":{"ramOverhead":70,"utilizationRatio":100,"vRam":4,"vRamConsumed":3},"vmName":"oracleVM","vmState":"RUNNING","vmStorageInfo":{"readIOPS":100,"vmdkTotal":200,"vmdkUsed":140,"writeIOPS":30}}]}]}' https://vmc.vmware.com/api/vmc-sizer/v5/recommendation


[{"label":"Latest (v5)","version":"latest"},{"version":"v4"}]
vmc-sizer
What's changed in v5?
CHANGED (11)
Parameter deleted
cloudProviderType
Parameter deleted
recommendationRequest
Service Name

Method Name

operationId

Extension Deleted
x-vmc-ui-servicename
Extension Deleted
x-vmw-vapi-methodname
Response Body Changes
type Changed from
RecommendationResponseList to VMCSizerResponse

INTRODUCED (1)
Added Parameters
vMCSizerRequest
DELETED (2)
Removed Parameters
cloudProviderType
recommendationRequest
Feedback

Was this page helpful?