ThresholdCrossedNotification.schema.json 3.63 KB
Newer Older
{
    "description": "This type represents a notification that is sent when a threshold has been crossed. The notification shall be triggered by the VNFM when a threshold has been crossed.\n",
    "type": "object",
    "required": [
      "id",
      "notificationType",
      "subscriptionId",
      "timeStamp",
      "thresholdId",
      "crossingDirection",
      "objectInstanceId",
      "performanceMetric",
      "performanceValue",
      "_links"
    ],
    "properties": {
      "id": {
        "description": "An identifier with the intention of being globally unique.\n",
        "type": "string"
      },
      "notificationType": {
        "description": "Discriminator for the different notification types. Shall be set to \"ThresholdCrossedNotification\" for this notification type.\n",
        "type": "string",
        "enum": [
          "ThresholdCrossedNotification"
        ]
      },
      "subscriptionId": {
        "description": "An identifier with the intention of being globally unique.\n",
        "type": "string"
      },
      "timeStamp": {
        "description": "Date-time stamp.  Representation: String formatted according to IETF RFC 3339.\n",
        "type": "string",
        "format": "date-time"
      },
      "thresholdId": {
        "description": "An identifier with the intention of being globally unique.\n",
        "type": "string"
      },
      "crossingDirection": {
        "type": "string",
        "enum": [
          "UP",
          "DOWN"
        ]
      },
      "objectInstanceId": {
        "description": "An identifier with the intention of being globally unique.\n",
        "type": "string"
      },
      "performanceMetric": {
        "description": "Performance metric associated with the threshold.\n",
        "type": "string"
      },
      "performanceValue": {
        "description": "Value of the metric that resulted in threshold crossing. The type of the \"performanceValue\" attribute (i.e. scalar, structure (Object in JSON), or array (of scalars, arrays or structures / Objects)) is assumed to be defined in the external measurement specification (see ETSI GS NFV-IFA 027).\n",
        "type": "object"
      },
      "_links": {
        "description": "Links to resources related to this notification.\n",
        "type": "object",
        "required": [
          "subscription",
          "threshold"
        ],
        "properties": {
          "subscription": {
            "description": "This type represents a link to a resource.\n",
            "type": "object",
            "required": [
              "href"
            ],
            "properties": {
              "href": {
                "description": "URI of the referenced resource.\n",
                "type": "string",
                "format": "url"
              }
            }
          },
          "objectInstance": {
            "description": "This type represents a link to a resource.\n",
            "type": "object",
            "required": [
              "href"
            ],
            "properties": {
              "href": {
                "description": "URI of the referenced resource.\n",
                "type": "string",
                "format": "url"
              }
            }
          },
          "threshold": {
            "description": "This type represents a link to a resource.\n",
            "type": "object",
            "required": [
              "href"
            ],
            "properties": {
              "href": {
                "description": "URI of the referenced resource.\n",
                "type": "string",
                "format": "url"
              }
            }
          }
        }
      }
    }
  }