Policy Status
This request returns the compliance status of the specified policy.
Request
URI
GET
https://{api_host}//policies/{policyId}/status
COPY
Path Parameters
string
policyId
Required
The unique policy id.
policyId example
107102e0-e03b-404e-8e17-0688c657a74b
Header Parameters
string
operationID
Optional
Operation ID for correlating logs across multiple services
Authentication
This operation uses the following authentication methods.
Responses
200
OK
[
{
"configuredReplications": 2,
"migrationViolation": 0,
"nonInstancesCompliant": [
"C4-ec991bd5-af9d-446a-8599-5b693842c4a3"
],
"nonRpoCompliant": [
"C4-ec991bd5-af9d-446a-8599-5b693842c4a3"
],
"org": "org1",
"protectionViolation": 0,
"quotaViolation": 0
}
]
401
The returned error codes include (but are not limited to):
- NotAuthenticated
Returns ApiError of type(s) application/json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}array of string
args
Optional
Positional arguments.
string
code
Optional
Specific error code.
string
msg
Optional
Detailed error message.
string
stacktrace
Optional
Exception stacktrace.
500
The returned error codes include (but are not limited to):
- GeneralServerFailure
Returns ApiError of type(s) application/json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}array of string
args
Optional
Positional arguments.
string
code
Optional
Specific error code.
string
msg
Optional
Detailed error message.
string
stacktrace
Optional
Exception stacktrace.