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

URL

post

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

Copy

Request Body

VMCSizerRequest of mimetype application/json Required

The Total based sizing recommendation request with workload characteristics.

Show optional properties

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

{
	"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
					}
				}
			]
		}
	]
}

array of WorkloadProfile

workloadProfiles Required

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

VMCConfigurations

configurations Optional

The VM Sizing configurations required for computation.

Authentication

This operation uses the following authentication methods.

cspAuthToken

Response

Response Body

200 OK

Returns VMCSizerResponse of type application/json

{
    "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.

201 Created

Recommendation executed succefully for the requested API.

Operation doesn't return any data structure.

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

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

VMware Cloud Sizing Operations