Instances

{
  "backends": [
    "ibm_backend"
  ],
  "instance_limit": 60.7,
  "instance_limit_seconds": "61",
  "plan_id": "flex-plan-id-1",
  "usage_allocation_seconds": "200"
}

{
  "type": "object",
  "description": "Instance",
  "properties": {
    "backends": {
      "type": "array",
      "description": "List of backend systems or clusters associated with the service instance",
      "items": {
        "type": "string",
        "pattern": "^.*$",
        "minLength": 1,
        "maxLength": 128,
        "nullable": false
      },
      "minItems": 0,
      "maxItems": 100
    },
    "instance_limit": {
      "type": "number",
      "format": "double",
      "description": "Represents the instance limits in seconds; will be replaced by instance_limit_seconds",
      "deprecated": true
    },
    "instance_limit_seconds": {
      "type": "string",
      "description": "Specifies the maximum number of resources time that can run on this instance"
    },
    "plan_id": {
      "type": "string",
      "description": "Identifier for the service plan associated with the instance as defined in Global Catalog",
      "pattern": "^.*$",
      "minLength": 1,
      "maxLength": 128
    },
    "usage_allocation_seconds": {
      "type": "string",
      "description": "The maximum sum of allowable usage allocation on the instance."
    }
  }
}

{
  "instance_limit": 123456
}

{
  "type": "object",
  "description": "Instance configuration",
  "properties": {
    "instance_limit": {
      "type": "number",
      "format": "double",
      "description": "Instance usage limit in seconds"
    }
  }
}

{
  "instance_id": "example",
  "plan_id": "example",
  "usage_period": {
    "start_time": "example",
    "end_time": "example"
  },
  "usage_consumed_seconds": 12,
  "usage_limit_seconds": 60,
  "usage_allocation_seconds": 120,
  "usage_limit_reached": true,
  "time_available_at": "2024-01-01T00:00:00.000Z"
}

{
  "type": "object",
  "properties": {
    "instance_id": {
      "type": "string"
    },
    "plan_id": {
      "type": "string"
    },
    "usage_period": {
      "description": "Start and end time of the usage period",
      "allOf": [
        {
          "type": "object",
          "properties": {
            "start_time": {
              "format": "date-time",
              "type": "string",
              "description": "The start time of the usage"
            },
            "end_time": {
              "format": "date-time",
              "type": "string",
              "description": "The end time of the usage"
            }
          }
        }
      ]
    },
    "usage_consumed_seconds": {
      "type": "number",
      "example": 12,
      "description": "Usage consumed in the current usage period"
    },
    "usage_limit_seconds": {
      "type": "number",
      "example": 60,
      "description": "The usage limit in seconds during the usage period"
    },
    "usage_allocation_seconds": {
      "type": "number",
      "example": 120,
      "description": "The seconds that are allocated for the instance during the usage period"
    },
    "usage_limit_reached": {
      "type": "boolean",
      "example": false,
      "description": "true if the usage limit is reached. false if not reached. undefined if usage limits do not apply to this instance."
    },
    "time_available_at": {
      "format": "date-time",
      "type": "string",
      "description": "The earliest datetime at which usage will fall below the instance limit due to old usage rolling out of the 28-day window. Only present when the instance-level limit is reached on a rolling window plan.",
      "example": "2024-01-01T00:00:00.000Z",
      "minLength": 20,
      "maxLength": 29
    }
  },
  "required": [
    "instance_id",
    "plan_id",
    "usage_consumed_seconds"
  ]
}