vcenter storage policies: check compatibility
Returns datastore compatibility summary about a specific storage policy. This operation was added in vSphere API 6.7.
Request:
HTTP request
POST https://{server}/rest/vcenter/storage/policies/{policy}?action=check-compatibility
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| policy | string | The storage policy identifier. |
Request Body Structure:
{
"datastores" : [
"obj-103",
"obj-103"
]
}
"datastores" : [
"obj-103",
"obj-103"
]
}
Request Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| datastores | string[] | Datastores used to check compatibility against a storage policy. The number of datastores is limited to 1024. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : {
"compatible_datastores" : [
{
"datastore" : "obj-103"
},
{
"datastore" : "obj-103"
}
]
}
}
"value" : {
"compatible_datastores" : [
{
"datastore" : "obj-103"
},
{
"datastore" : "obj-103"
}
]
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | compatibility_info | datastore compatibility summary about a specific storage policy. |
| value.compatible_datastores | compatible_datastore_info[] | Info about a list of datastores compatible with a specific storage policy. This attribute was added in vSphere API 6.7. |
| value.compatible_datastores[].datastore | string | Identifier of the datastore. This attribute was added in vSphere API 6.7. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Datastore. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Datastore. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | if the system reports an error while responding to the request. |
| 404 | not_found | if the storage policy specified does not exist. |
| 503 | service_unavailable | if the system is unable to communicate with a service to complete the request. |
| 401 | unauthenticated | if the user can not be authenticated. |
| 403 | unauthorized | if the user doesn't have the required privileges. |
| 500 | unable_to_allocate_resource | if input more than 1024 datastores. |