List Alarms
Paginated list of all alarms.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/alarms
Query Parameters
Query Parameters
string
cursor
Optional
Opaque cursor to be used for getting next page of records (supplied by current result page)
string
included_fields
Optional
Comma separated list of fields that should be included in query result
integer
page_size
Optional
Maximum number of results to return in this page (server may return fewer)
boolean
sort_ascending
Optional
No description available
string
sort_by
Optional
Field by which records are sorted
Response
Response
Response BodyResponse Body
200 OK returns
PolicyAlarmResourceListResult
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"cursor": "string",
"result_count": 0,
"results": [
{
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_protection": "string",
"_revision": 0,
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_system_owned": false,
"description": "string",
"display_name": "string",
"error_details": {
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
},
"id": "string",
"message": "string",
"parent_path": "string",
"path": "string",
"relative_path": "string",
"resource_type": "string",
"source_reference": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
]
}
],
"sort_ascending": false,
"sort_by": "string"
}
array of
ResourceLink
_links
Optional
The server will populate this field when returing the resource. Ignored on PUT and POST.
string
_schema
Optional
Schema for this resource
string
cursor
Optional
Opaque cursor to be used for getting next page of records (supplied by current result page)
integer
result_count
Optional
Count of results found (across all pages), set only on first page
boolean
sort_ascending
Optional
If true, results are sorted in ascending order
string
sort_by
Optional
Field by which records are sorted
cURL Command
curl https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/alarms
Errors
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
503
The server is currently unavailable (because it is overloaded or down for maintenance).