Check Compatibility Policies
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Returns datastore compatibility summary about a specific storage policy.
Request
URLURL
https://{api_host}/rest/vcenter/storage/policies/{policy}?action=check-compatibility
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | The storage policy identifier The parameter must be an identifier for the resource type: com.vmware.vcenter.StoragePolicy. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains StoragePoliciesCheckCompatibilityRequestBody
of type application/json
(required)
{
"datastores": [
"string"
]
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | datastores | array of string |
Datastores used to check compatibility against a storage policy. The number of datastores is limited to 1024. The parameter must contain identifiers for the resource type: Datastore. |
Response
Response
Response BodyResponse Body
200 OK returns
StoragePoliciesCheckCompatibilityResponseBody
of type application/json
datastore compatibility summary about a specific storage policy.
{
"value": {
"compatible_datastores": [
{
"datastore": "string"
}
]
}
}| Property Name | Type | Description |
|---|---|---|
| value | StoragePoliciesCompatibilityInfo |
datastore compatibility summary about a specific storage policy. |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"datastores":["string"]}' https://{api_host}/rest/vcenter/storage/policies/{policy}?action=check-compatibility
Errors
| Code | Returns | Description |
|---|---|---|
| 507 | ErrorRest | com.vmware.vapi.std.errors.unable_to_allocate_resource : if input more than 1024 datastores. |
| default | ErrorRest | Not available |
| 401 | ErrorRest | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges. |
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.not_found : if the storage policy specified does not exist. |
| 503 | ErrorRest | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
