{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-analytics-instance-schema.json",
  "title": "AnalyticsInstance",
  "description": "Analytics Instance metadata.\n",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-analytics-api-openapi.yml#/components/schemas/AnalyticsInstance",
  "properties": {
    "capacity": {
      "$ref": "#/$defs/Capacity"
    },
    "compartmentId": {
      "description": "The OCID of the compartment.\n",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only the String type is supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a\nnamespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
      "type": "object"
    },
    "description": {
      "description": "Optional description.\n",
      "maxLength": 512,
      "minLength": 0,
      "type": "string"
    },
    "domainId": {
      "description": "Identity domain OCID.\n",
      "type": "string"
    },
    "emailNotification": {
      "description": "Email address receiving notifications.\n",
      "maxLength": 512,
      "minLength": 0,
      "type": "string"
    },
    "featureBundle": {
      "description": "The feature set of an Analytics instance.\n",
      "enum": [
        "FAW_PAID",
        "FAW_FREE",
        "EE_EMBEDDED",
        "SE_EMBEDDED"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/FeatureBundle"
    },
    "featureSet": {
      "description": "Analytics feature set.\n",
      "enum": [
        "SELF_SERVICE_ANALYTICS",
        "ENTERPRISE_ANALYTICS"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/FeatureSet"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no\npredefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
      "type": "object"
    },
    "id": {
      "description": "The resource OCID.\n",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "kmsKeyId": {
      "description": "OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption.\n",
      "maxLength": 255,
      "minLength": 0,
      "type": "string"
    },
    "licenseType": {
      "description": "The license used for the service.\n",
      "enum": [
        "LICENSE_INCLUDED",
        "BRING_YOUR_OWN_LICENSE"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/LicenseType"
    },
    "lifecycleState": {
      "description": "The current state of an instance.\n",
      "enum": [
        "ACTIVE",
        "CREATING",
        "DELETED",
        "DELETING",
        "FAILED",
        "INACTIVE",
        "UPDATING"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/AnalyticsInstanceLifecycleState"
    },
    "name": {
      "description": "The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.\n",
      "maxLength": 32,
      "minLength": 1,
      "pattern": "^[a-zA-Z](-?[a-zA-Z0-9])*$",
      "type": "string"
    },
    "networkEndpointDetails": {
      "$ref": "#/$defs/NetworkEndpointDetails"
    },
    "privateAccessChannels": {
      "additionalProperties": {
        "$ref": "#/$defs/PrivateAccessChannel"
      },
      "description": "Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object as VALUE.\n",
      "type": "object"
    },
    "serviceUrl": {
      "description": "URL of the Analytics service.\n",
      "maxLength": 1024,
      "minLength": 0,
      "type": "string"
    },
    "systemTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string, integer and boolean types are supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing system tags' keys and values scoped to a namespace.\nExample: `{\"key\": \"value\"}`\n",
        "type": "object"
      },
      "description": "System tags for this resource. These predefined keys are scoped to namespaces.\nExample: `{\"orcl-cloud\": {\"key\": \"value\"}}`\n",
      "type": "object"
    },
    "timeCreated": {
      "description": "The date and time the instance was created, in the format defined by RFC3339.\n\nExample: `2016-08-25T21:10:29.600Z`\n",
      "format": "date-time",
      "type": "string"
    },
    "timeUpdated": {
      "description": "The date and time the instance was last updated (in the format defined by RFC3339).\nThis timestamp represents updates made through this API. External events do not\ninfluence it.\n",
      "format": "date-time",
      "type": "string"
    },
    "updateChannel": {
      "description": "Analytics instance update channel.\n",
      "enum": [
        "REGULAR",
        "EARLY",
        "PHASE_2",
        "PHASE_1"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/UpdateChannel"
    },
    "vanityUrlDetails": {
      "additionalProperties": {
        "$ref": "#/$defs/VanityUrlDetails"
      },
      "description": "Map of VanityUrl unique identifier key as KEY and VanityUrl Object as VALUE.\n",
      "type": "object"
    }
  },
  "required": [
    "id",
    "name",
    "compartmentId",
    "lifecycleState",
    "capacity",
    "networkEndpointDetails",
    "featureSet",
    "timeCreated"
  ],
  "$defs": {
    "Capacity": {
      "description": "Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).\n",
      "properties": {
        "capacityType": {
          "description": "The capacity model to use.\nAccepted values are:\nOLPU_COUNT, USER_COUNT\n",
          "enum": [
            "OLPU_COUNT",
            "USER_COUNT"
          ],
          "type": "string",
          "x-obmcs-top-level-enum": "#/definitions/CapacityType"
        },
        "capacityValue": {
          "description": "The capacity value selected, either the number of OCPUs (OLPU_COUNT) or the number of users (USER_COUNT).\nThis parameter affects the number of OCPUs, amount of memory, and other resources allocated to the instance.\n",
          "minimum": 1,
          "type": "integer"
        }
      },
      "required": [
        "capacityType",
        "capacityValue"
      ],
      "type": "object"
    },
    "NetworkEndpointDetails": {
      "description": "Base representation of a network endpoint.\n",
      "properties": {
        "networkEndpointType": {
          "description": "The type of network endpoint.\n",
          "enum": [
            "PUBLIC",
            "PRIVATE"
          ],
          "type": "string",
          "x-obmcs-top-level-enum": "#/definitions/NetworkEndpointType"
        }
      },
      "required": [
        "networkEndpointType"
      ],
      "type": "object"
    },
    "PrivateAccessChannel": {
      "description": "Analytics Instance Private Access Channel model.\n",
      "properties": {
        "displayName": {
          "description": "Display Name of the Private Access Channel.\n",
          "maxLength": 32,
          "minLength": 1,
          "pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$",
          "type": "string"
        },
        "egressSourceIpAddresses": {
          "description": "The list of IP addresses from the customer subnet connected to private access channel, used as a source Ip by Private Access Channel\nfor network traffic from the AnalyticsInstance to Private Sources.\n",
          "items": {
            "maxLength": 46,
            "minLength": 8,
            "type": "string"
          },
          "type": "array"
        },
        "ipAddress": {
          "description": "IP Address of the Private Access channel.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "key": {
          "description": "Private Access Channel unique identifier key.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "networkSecurityGroupIds": {
          "description": "Network Security Group OCIDs for an Analytics instance.\n",
          "items": {
            "maxLength": 255,
            "minLength": 1,
            "type": "string"
          },
          "maxLength": 5,
          "type": "array"
        },
        "privateSourceDnsZones": {
          "description": "List of Private Source DNS zones registered with Private Access Channel,\nwhere datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance.\nMin of 1 is required and Max of 30 Private Source DNS zones can be registered.\n",
          "items": {
            "$ref": "#/$defs/PrivateSourceDnsZone"
          },
          "maxLength": 30,
          "minLength": 1,
          "type": "array"
        },
        "privateSourceScanHosts": {
          "description": "List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.\n",
          "items": {
            "$ref": "#/$defs/PrivateSourceScanHost"
          },
          "maxLength": 15,
          "type": "array"
        },
        "subnetId": {
          "description": "OCID of the customer subnet connected to private access channel.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "vcnId": {
          "description": "OCID of the customer VCN peered with private access channel.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "key",
        "displayName",
        "vcnId",
        "subnetId",
        "ipAddress",
        "egressSourceIpAddresses"
      ]
    },
    "PrivateSourceDnsZone": {
      "description": "Private source DNS Zone model.\n",
      "properties": {
        "description": {
          "description": "Description of private source dns zone.\n",
          "maxLength": 255,
          "minLength": 0,
          "type": "string"
        },
        "dnsZone": {
          "description": "Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.\n",
          "maxLength": 253,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "dnsZone"
      ]
    },
    "PrivateSourceScanHost": {
      "description": "Private source Scan Hostname model.\n",
      "properties": {
        "description": {
          "description": "Description of private source scan host zone.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "scanHostname": {
          "description": "Private Source Scan hostname. Ex: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "scanPort": {
          "description": "Private Source Scan host port. This is the source port where SCAN protocol will get connected (e.g. 1521).\n",
          "minimum": 1,
          "type": "integer"
        }
      },
      "required": [
        "scanHostname",
        "scanPort"
      ]
    },
    "VanityUrlDetails": {
      "description": "Vanity url configuration details.\n",
      "properties": {
        "description": {
          "description": "Description of the vanity url.\n",
          "maxLength": 512,
          "minLength": 1,
          "type": "string"
        },
        "hosts": {
          "description": "List of fully qualified hostnames supported by this vanity URL definition (max of 3).\n",
          "items": {
            "maxLength": 255,
            "minLength": 1,
            "type": "string"
          },
          "maxItems": 3,
          "minItems": 1,
          "type": "array"
        },
        "key": {
          "description": "The vanity url unique identifier key.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "publicCertificate": {
          "description": "PEM certificate for HTTPS connections.\n",
          "minLength": 1,
          "type": "string"
        },
        "urls": {
          "description": "List of urls supported by this vanity URL definition (max of 3).\n",
          "items": {
            "maxLength": 255,
            "minLength": 1,
            "type": "string"
          },
          "maxItems": 3,
          "minItems": 1,
          "type": "array"
        }
      },
      "type": "object"
    }
  }
}