NSX-T Data Center REST API

UpdateStatusWithFiltersParameter (type)

{
  "extends": {
    "$ref": "AlarmFilterParameter"
  },
  "id": "UpdateStatusWithFiltersParameter",
  "module_id": "Monitoring",
  "properties": {
    "after": {
      "$ref": "EpochMsTimestamp",
      "description": "Filter to fetch alarms after the specified time.",
      "required": false,
      "title": "Filter to fetch alarms after the specified time"
    },
    "before": {
      "$ref": "EpochMsTimestamp",
      "description": "Filter to fetch alarms before the specified time.",
      "required": false,
      "title": "Filter to fetch alarms before the specified time"
    },
    "cursor": {
      "description": "Opaque cursor to be used for getting next page of records (supplied by current result page).",
      "readonly": false,
      "required": false,
      "title": "Cursor for pagination",
      "type": "string"
    },
    "event_tag": {
      "description": "Comma delimited list of one or more tags, used to filter alarms, for example, INFRASTRUCTURE, TENANT_NETWORKING, TENANT_SECURITY.",
      "required": false,
      "title": "Event tag",
      "type": "string"
    },
    "event_type": {
      "description": "Comma delimited list of one or more event types, used to filter alarms. Refer to GET /api/v1/events to get valid event types.",
      "required": false,
      "title": "Event Type Filter",
      "type": "string"
    },
    "feature_name": {
      "description": "Comma delimited list of one or more feature names, used to filter alarms. Refer to GET /api/v1/events to get valid feature names.",
      "required": false,
      "title": "Feature Name",
      "type": "string"
    },
    "id": {
      "description": "Comma delimited list of one or more alarm IDs, used to filter alarms.",
      "required": false,
      "title": "Alarm ID",
      "type": "string"
    },
    "intent_path": {
      "description": "Comma delimited list of one or more intent paths, used to filter alarms.",
      "required": false,
      "title": "Intent Path for entity ID",
      "type": "string"
    },
    "new_status": {
      "$ref": "MonitoringStatus",
      "description": "Specify new alarm status for filtered alarms. Can be one of OPEN, ACKNOWLEDGED, SUPPRESSED, RESOLVED.",
      "required": true,
      "title": "Status"
    },
    "node_id": {
      "description": "Comma delimited list of one or more node IDs, used to filter alarms.",
      "required": false,
      "title": "Node ID",
      "type": "string"
    },
    "node_resource_type": {
      "description": "Comma delimited list of one or more node resource types, used to filter alarms.",
      "required": false,
      "title": "Node Resource Type",
      "type": "string"
    },
    "org": {
      "description": "Comma delimited list of one or more Org IDs, used to filter alarms.",
      "required": false,
      "title": "Org ID",
      "type": "string"
    },
    "page_size": {
      "description": "Maximum number of results to return in this page (server may return fewer).",
      "required": false,
      "title": "Page Size for pagination",
      "type": "integer"
    },
    "project": {
      "description": "Comma delimited list of one or more Project IDs, used to filter alarms.",
      "required": false,
      "title": "Project ID",
      "type": "string"
    },
    "severity": {
      "description": "Comma delimited list of one or more of the following severity levels: CRITICAL, HIGH, MEDIUM, LOW, used to filter alarms.",
      "required": false,
      "title": "Severity",
      "type": "string"
    },
    "sort_ascending": {
      "default": true,
      "description": "If true, the value of the column are sorted in ascending order. Otherwise, in descending order.",
      "required": false,
      "title": "Represents order of sorting the values",
      "type": "boolean"
    },
    "sort_by": {
      "description": "Sorting on column is based on the sort_by. sort_by represents the field in the output data on which sort is requested.",
      "required": false,
      "title": "Key for sorting on this column",
      "type": "string"
    },
    "status": {
      "description": "Comma delimited list of one or more of the following statuses: OPEN, ACKNOWLEDGED, SUPPRESSED, RESOLVED, used to filter alarms.",
      "required": false,
      "title": "Status",
      "type": "string"
    },
    "suppress_duration": {
      "description": "Specify duration in hours for which Alarm should be suppressed.This value must be specified if the new_status is SUPPRESSED.",
      "title": "Duration in hours for which Alarm should be suppressed",
      "type": "integer"
    },
    "vpc": {
      "description": "Comma delimited list of one or more VPC IDs, used to filter alarms.",
      "required": false,
      "title": "VPC ID",
      "type": "string"
    }
  },
  "title": "Parameters to update status of alarm",
  "type": "object"
}