Pure Storage · Schema

Metric

A type of measurement recorded on a resource.

StorageData StorageFlash StorageEnterprise StorageCloud StorageObject StorageFile StorageBlock StorageKubernetes StorageInfrastructure
View JSON Schema on GitHub

JSON Schema

pure1-cloud-api-metric-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Metric",
  "description": "A type of measurement recorded on a resource.\n",
  "$id": "https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-metric-schema.json",
  "allOf": [
    {
      "description": "A built-in resource. Many are singletons predefined by Purity (e.g., support\nsettings). Some correspond to a piece of software, like an app, or hardware,\nlike a controller. Others are created by the system in response to some event\n(e.g., alerts, audit records).\n\nTypically, a user can't create, delete or rename a built-in resource. A few\ncan be created or deleted, but not renamed because the names are meaningful\nto Purity (e.g., VIFs).\n\n",
      "allOf": [
        {
          "$ref": "#/components/schemas/_timeAware"
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "description": "A non-modifiable, globally unique ID chosen by the system.",
              "type": "string",
              "readOnly": true,
              "example": "01c2889a-4124-49ff-8cbd-c33405ede123"
            },
            "name": {
              "description": "A non-modifiable, locally unique name chosen by the system.",
              "type": "string",
              "readOnly": true,
              "example": "example_name"
            }
          }
        }
      ]
    },
    {
      "type": "object",
      "properties": {
        "availabilities": {
          "description": "The available resolutions, aggregations and retentions of this metric.\n",
          "type": "array",
          "readOnly": true,
          "items": {
            "$ref": "#/components/schemas/_metricAvailability"
          }
        },
        "description": {
          "description": "The additional description for the the metric.",
          "type": "string",
          "readOnly": true
        },
        "resource_types": {
          "description": "The type of resource (as described by their endpoints) that this metric\nis available at. NOTE that a metric could be available for a combination\nof resource types, e.g. mirrored writes from \"arrays\" to \"pods\".\n",
          "type": "array",
          "readOnly": true,
          "items": {
            "type": "string",
            "description": "Valid values are `arrays`, `pods`, and `volumes`.\n",
            "example": "example_resource_type"
          }
        },
        "unit": {
          "description": "The unit of the metric.",
          "type": "string",
          "readOnly": true,
          "example": "B/s"
        }
      },
      "x-readOnly": true
    }
  ]
}