This section includes the following topics:
- Input Parameters
- Output Parameters
Input Parameters
The following table provides the parameters and descriptions.
Parameter | Description |
sessionId | String containing a GUID, obtained via a prior API call to Hyper-V Create Browsing Session. |
hostId | Numeric id of the host, obtained either while registering or while getting list of hosts. |
cores | Number of CPU cores. |
hostProperties memory | Memory size in MB. |
Example
{
"sessionId": "5d05495f-39e5-4e4e-ad0c-e351cc2c78f3",
"hostId": 2,
"hostProperties": {
"cores": 4,
"memory": 1024
}
}
Output Parameters
None when successful, validation errors otherwise:
If the provided hostId integer from Input section does not point to a valid Hyper-V server (the correct ids can be obtained via get list of hosts), error message: ErrorCode.HostNotInCatalog
If chosen hostProperties.memory > memoryAllocation.maximum, error message: "The source machine's original Memory configuration exceeds the available RAM resources on the target machine. Maximum value is {MAX_ALLOWED}, provided value was {USER_INPUT}"
If chosen hostProperties.cores > processorAllocation.maximum, error message: "The source machine's original CPU Cores configuration exceeds the available CPU resources on the target machine. Maximum value is {MAX_ALLOWED}, provided value was {USER_INPUT}"
Example POST
POST /v2/accounts/test_acc/computers/0000/restore/diskimage/standard/vm/validate/host/server
Input Parameters
{
"sessionId": "5d05495f-39e5-4e4e-ad0c-e351cc2c78f3",
"hostId": 2,
"hostProperties": {
"cores": 4,
"memory": 1024
}
}
Output Parameters
Response status: 204 No content (for online operation).