PrivateAccessChannel

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-private-access-channel-schema.json",
  "title": "PrivateAccessChannel",
  "description": "Analytics Instance Private Access Channel model.\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/PrivateAccessChannel",
  "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"
  ],
  "$defs": {
    "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"
      ]
    }
  }
}