load-balancing_resource_reference

A reference to a load balancer resource.

APIs.ioEngineeringPlatform

Properties

Name Type Description
reference_type string When listed as a reference, the type (direction) of the reference.
references array A list of references to (referrer) or from (referral) this resource.
resource_id object
resource_name string The human-identifiable name of the resource.
resource_type string The type of the resource.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-load-balancing-resource-reference-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/load-balancing_resource_reference",
  "title": "load-balancing_resource_reference",
  "description": "A reference to a load balancer resource.",
  "properties": {
    "reference_type": {
      "description": "When listed as a reference, the type (direction) of the reference.",
      "enum": [
        "referral",
        "referrer"
      ],
      "type": "string"
    },
    "references": {
      "description": "A list of references to (referrer) or from (referral) this resource.",
      "example": [
        {
          "reference_type": "referrer",
          "resource_id": "699d98642c564d2e855e9661899b7252",
          "resource_name": "www.example.com",
          "resource_type": "load_balancer"
        },
        {
          "reference_type": "referral",
          "resource_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
          "resource_name": "Login page monitor",
          "resource_type": "monitor"
        }
      ],
      "items": {
        "description": "A reference to a load balancer resource.",
        "type": "object"
      },
      "type": "array"
    },
    "resource_id": {
      "example": "17b5962d775c646f3f9725cbc7a53df4"
    },
    "resource_name": {
      "description": "The human-identifiable name of the resource.",
      "example": "primary-dc-1",
      "type": "string"
    },
    "resource_type": {
      "description": "The type of the resource.",
      "enum": [
        "load_balancer",
        "monitor",
        "pool"
      ],
      "example": "pool",
      "type": "string"
    }
  },
  "type": "object"
}