ChannelStatus

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oracle/json-schema/oracle-channel-status-schema.json",
  "title": "ChannelStatus",
  "description": "Runtime status summary of a Channel, aggregating information about health and operational indicators.\n",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-channels-api-openapi.yml#/components/schemas/ChannelStatus",
  "properties": {
    "channelStatusResult": {
      "$ref": "#/$defs/ChannelStatusResult"
    },
    "timeCreated": {
      "description": "The date and time that the Work Request to generate the Channel status was issued, \nas described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n",
      "format": "date-time",
      "type": "string"
    },
    "timeUpdated": {
      "description": "The date and time that the Channel status was generated, \nas described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "channelStatusResult",
    "timeCreated",
    "timeUpdated"
  ],
  "$defs": {
    "ChannelStatusResult": {
      "description": "Status information for the channel attached to the DB System.\n",
      "properties": {
        "channelId": {
          "description": "The OCID of the Channel for which the status is gathered.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "errors": {
          "description": "Channel errors identified, if there are any.",
          "items": {
            "type": "string"
          },
          "maxItems": 2,
          "minItems": 0,
          "type": "array",
          "uniqueItems": true
        },
        "isHealthy": {
          "description": "Specifies if the channel is healthy or not. If healthy, replication target DB System is connected to the \nsource and no replication errors are seen.\n",
          "type": "boolean"
        },
        "isReceivedGtidSetApplied": {
          "description": "Specifies if all transactions received by this channel are executed and their GTIDs are part of gtid_executed\nset.\n",
          "type": "boolean"
        },
        "lagDuration": {
          "description": "The channel lag, with respect to the immediate source of the channel. \nIf the channel is configured with replication delay, the channel lag includes the replication delay.\n",
          "format": "x-obmcs-duration",
          "type": "string"
        }
      },
      "required": [
        "channelId"
      ]
    }
  }
}