Check Storage Policy Compliance

Check datastores for compliance against a given storage policy.

Request

URI

POST

https://{api_host}/pairings/{pairing_id}/vcenters/{vcenter_id}/storage-policies/{storage_policy_id}/actions/check-compliance

COPY

Path Parameters

string

pairing_id

Required

The ID of the pairing between this vSphere Replication server and the remote one.

string

vcenter_id

Required

The ID of the vCenter server

string

storage_policy_id

Required

The ID of a storage policy

Request Body

List of datastores to check their compliance

[
    {}
]

array of string

Optional

Authentication

This operation uses the following authentication methods.

SessionHeader

Responses

200

Compliance result of datastores.

Returns StoragePolicyComplianceCheckDataDrResponseList of type(s) application/json

{
    "list": [
        {
            "storage_policy_id": "string",
            "datastore": "string",
            "compliant": false,
            "not_compliant_detailed_message": "string"
        }
    ],
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ],
        "total": 0,
        "offset": 0,
        "limit": 0,
        "links": {
            "next": {
                "href": "string"
            },
            "self": {
                "href": "string"
            },
            "previous": {
                "href": "string"
            }
        }
    }
}

array of object

list

Optional

Datastore compliance status against a storage policy.

object

_meta

Optional

List metadata

400

Bad request - the server cannot understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json

"ResponseError Object"

string

error_code

Optional

The code of the error.

string

message

Optional

The message of the error.

string As uuid As uuid

op_id

Optional

The ID of the operation.

401

Unauthorized - the client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json

"ResponseError Object"

string

error_code

Optional

The code of the error.

string

message

Optional

The message of the error.

string As uuid As uuid

op_id

Optional

The ID of the operation.

404

Not Found - server cannot find the requested in URL resource

Operation doesn't return any data structure

500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json

"ResponseError Object"

string

error_code

Optional

The code of the error.

string

message

Optional

The message of the error.

string As uuid As uuid

op_id

Optional

The ID of the operation.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/pairings/{pairing_id}/vcenters/{vcenter_id}/storage-policies/{storage_policy_id}/actions/check-compliance

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Replication Operations

GET

Get All Replications