BlockchainPlatform

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-blockchain-platform-schema.json",
  "title": "BlockchainPlatform",
  "description": "Blockchain Platform Instance Description.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-blockchainplatform-api-openapi.yml#/components/schemas/BlockchainPlatform",
  "properties": {
    "compartmentId": {
      "description": "Compartment Identifier",
      "type": "string"
    },
    "componentDetails": {
      "$ref": "#/$defs/BlockchainPlatformComponentDetails"
    },
    "computeShape": {
      "description": "Compute shape - STANDARD or ENTERPRISE_SMALL or ENTERPRISE_MEDIUM or ENTERPRISE_LARGE or ENTERPRISE_EXTRA_LARGE or ENTERPRISE_CUSTOM",
      "enum": [
        "STANDARD",
        "ENTERPRISE_SMALL",
        "ENTERPRISE_MEDIUM",
        "ENTERPRISE_LARGE",
        "ENTERPRISE_EXTRA_LARGE",
        "ENTERPRISE_CUSTOM"
      ],
      "type": "string"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string, integer and boolean types are supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
      "type": "object"
    },
    "description": {
      "description": "Platform Instance Description",
      "type": "string"
    },
    "displayName": {
      "description": "Platform Instance Display name, can be renamed",
      "type": "string"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
      "type": "object"
    },
    "hostOcpuUtilizationInfo": {
      "description": "List of OcpuUtilization for all hosts",
      "items": {
        "$ref": "#/$defs/OcpuUtilizationInfo"
      },
      "type": "array"
    },
    "id": {
      "description": "unique identifier that is immutable on creation",
      "type": "string"
    },
    "isByol": {
      "description": "Bring your own license",
      "type": "boolean"
    },
    "isChaincodeClusterEnabled": {
      "description": "Multiple Chaincode hosts enabled in the platform cluster",
      "type": "boolean"
    },
    "isMultiAD": {
      "description": "True for multi-AD blockchain plaforms, false for single-AD",
      "type": "boolean"
    },
    "lifecycleDetails": {
      "description": "An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.",
      "type": "string"
    },
    "lifecycleState": {
      "description": "The current state of the Platform Instance.",
      "enum": [
        "CREATING",
        "UPDATING",
        "ACTIVE",
        "DELETING",
        "DELETED",
        "SCALING",
        "INACTIVE",
        "FAILED"
      ],
      "type": "string"
    },
    "platformRole": {
      "description": "Role of platform - FOUNDER or PARTICIPANT",
      "enum": [
        "FOUNDER",
        "PARTICIPANT"
      ],
      "type": "string"
    },
    "replicas": {
      "$ref": "#/$defs/ReplicaDetails"
    },
    "serviceEndpoint": {
      "description": "Service endpoint URL, valid post-provisioning",
      "type": "string"
    },
    "serviceVersion": {
      "description": "The version of the Platform Instance.",
      "type": "string"
    },
    "storageSizeInTBs": {
      "description": "Storage size in TBs",
      "format": "double",
      "type": "number"
    },
    "storageUsedInTBs": {
      "description": "Storage used in TBs",
      "format": "double",
      "type": "number"
    },
    "timeCreated": {
      "description": "The time the the Platform Instance was created. An RFC3339 formatted datetime string",
      "format": "date-time",
      "type": "string"
    },
    "timeUpdated": {
      "description": "The time the Platform Instance was updated. An RFC3339 formatted datetime string",
      "format": "date-time",
      "type": "string"
    },
    "totalOcpuCapacity": {
      "description": "Number of total OCPUs allocated to the platform cluster",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "compartmentId",
    "displayName",
    "platformRole",
    "computeShape"
  ],
  "type": "object",
  "$defs": {
    "BlockchainPlatformComponentDetails": {
      "description": "Blockchain Platform component details.",
      "properties": {
        "osns": {
          "description": "List of OSNs",
          "items": {
            "$ref": "#/$defs/Osn"
          },
          "type": "array"
        },
        "peers": {
          "description": "List of Peers",
          "items": {
            "$ref": "#/$defs/Peer"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "OcpuAllocationNumberParam": {
      "description": "OCPU allocation parameter",
      "properties": {
        "ocpuAllocationNumber": {
          "description": "Number of OCPU allocation",
          "format": "float",
          "maximum": 64,
          "minimum": 0,
          "type": "number"
        }
      },
      "required": [
        "ocpuAllocationNumber"
      ],
      "type": "object"
    },
    "OcpuUtilizationInfo": {
      "description": "Ocpu utilization for a VM host",
      "properties": {
        "host": {
          "description": "Host name of VM",
          "type": "string"
        },
        "ocpuCapacityNumber": {
          "description": "Number of total OCPU capacity on the host",
          "format": "float",
          "type": "number"
        },
        "ocpuUtilizationNumber": {
          "description": "Number of OCPU utilized",
          "format": "float",
          "type": "number"
        }
      },
      "type": "object"
    },
    "Osn": {
      "description": "An Ordering Service Node details",
      "properties": {
        "ad": {
          "description": "Availability Domain of OSN",
          "type": "string",
          "x-obmcs-enumref": "#/definitions/AvailabilityDomain/ads"
        },
        "lifecycleState": {
          "description": "The current state of the OSN.",
          "enum": [
            "ACTIVE",
            "INACTIVE",
            "FAILED"
          ],
          "type": "string"
        },
        "ocpuAllocationParam": {
          "$ref": "#/$defs/OcpuAllocationNumberParam"
        },
        "osnKey": {
          "description": "OSN identifier",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "osnKey",
        "ad"
      ],
      "type": "object"
    },
    "Peer": {
      "description": "A Peer details",
      "properties": {
        "ad": {
          "description": "Availability Domain of peer",
          "type": "string",
          "x-obmcs-enumref": "#/definitions/AvailabilityDomain/ads"
        },
        "alias": {
          "description": "peer alias",
          "type": "string"
        },
        "host": {
          "description": "Host on which the Peer exists",
          "type": "string"
        },
        "lifecycleState": {
          "description": "The current state of the peer.",
          "enum": [
            "ACTIVE",
            "INACTIVE",
            "FAILED"
          ],
          "type": "string"
        },
        "ocpuAllocationParam": {
          "$ref": "#/$defs/OcpuAllocationNumberParam"
        },
        "peerKey": {
          "description": "peer identifier",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "role": {
          "description": "Peer role",
          "type": "string",
          "x-obmcs-enumref": "#/definitions/PeerRole/role"
        }
      },
      "required": [
        "peerKey",
        "role",
        "host",
        "ad"
      ],
      "type": "object"
    },
    "ReplicaDetails": {
      "description": "Number of replicas of service components like Rest Proxy, CA and Console",
      "properties": {
        "caCount": {
          "description": "Number of CA replicas",
          "maximum": 10,
          "minimum": 1,
          "type": "integer"
        },
        "consoleCount": {
          "description": "Number of console replicas",
          "maximum": 10,
          "minimum": 1,
          "type": "integer"
        },
        "proxyCount": {
          "description": "Number of REST proxy replicas",
          "maximum": 10,
          "minimum": 1,
          "type": "integer"
        }
      },
      "type": "object"
    }
  }
}