POST /redpanda.core.admin.v2.ShadowLinkService/GetShadowTopic

Returns information about a shadow topic on a shadow link. A shadow topic is a resource created automatically by a shadow link. The shadow topic 'shadows' a topic on a source cluster, mirroring the data and properties of that topic.

Headers

  • Connect-Protocol-Version number Required

    Define the version of the Connect protocol

    Value is 1.

  • Connect-Timeout-Ms number

    Define the timeout, in ms

application/json

Body Required

  • name string Required

    The name of the shadow topic to get

  • shadowLinkName string Required

    The name of the shadow link the topic is contained in

Responses

  • 200 application/json

    Success

    Hide response attribute Show response attribute object
    • shadowTopic object

      A ShadowTopic resource contained by the ShadowLink

      Additional properties are NOT allowed.

      Hide shadowTopic attributes Show shadowTopic attributes object
      • name string

        Name of the shadow topic

      • sourceTopicId string

        The topic ID of the source topic

      • sourceTopicName string

        The name of the source topic

      • status object

        The status of the shadow topic

        Additional properties are NOT allowed.

        Hide status attributes Show status attributes object
        • partitionInformation array[object]

          List of partition information for the shadow topic

          Hide partitionInformation attributes Show partitionInformation attributes object

          Topic partition information

          • highWatermark integer | string

            Shadowed partition's HWM

          • partitionId integer | string

            Partition ID

          • sourceHighWatermark integer | string

            Source partition's HWM

          • sourceLastStableOffset integer | string

            Source partition's LSO

          • sourceLastUpdatedTimestamp string(date-time)

            Timestamp of the last time the source partition information was updated

        • state string

          State of the shadow topic

          Values are SHADOW_TOPIC_STATE_UNSPECIFIED, SHADOW_TOPIC_STATE_ACTIVE, SHADOW_TOPIC_STATE_FAULTED, SHADOW_TOPIC_STATE_PAUSED, SHADOW_TOPIC_STATE_FAILING_OVER, SHADOW_TOPIC_STATE_FAILED_OVER, SHADOW_TOPIC_STATE_PROMOTING, or SHADOW_TOPIC_STATE_PROMOTED.

      • topicId string

        The topic ID of the shadow topic
  • default application/json

    Error

    Hide response attributes Show response attributes object
    • code string

      The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

      Values are canceled, unknown, invalid_argument, deadline_exceeded, not_found, already_exists, permission_denied, resource_exhausted, failed_precondition, aborted, out_of_range, unimplemented, internal, unavailable, data_loss, or unauthenticated.

    • details array[object]

      A list of messages that carry the error details. There is no limit on the number of messages.

      Hide details attributes Show details attributes object

      Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.

      • debug object

        Detailed error information.

        Additional properties are allowed.

      • type string

        A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.

      • value string(binary)

        The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.

    • message string

      A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
POST /redpanda.core.admin.v2.ShadowLinkService/GetShadowTopic 
curl \
 --request POST 'http://localhost:9644/redpanda.core.admin.v2.ShadowLinkService/GetShadowTopic' \
 --header "Content-Type: application/json" \
 --header "Connect-Protocol-Version: 1" \
 --header "Connect-Timeout-Ms: 42.0" \
 --data '{"name":"string","shadowLinkName":"string"}'
Request examples 
# Headers
Connect-Protocol-Version: 1
Connect-Timeout-Ms: 42.0

# Payload
{
  "name": "string",
  "shadowLinkName": "string"
}
Response examples (200) 
{
  "shadowTopic": {
    "name": "string",
    "sourceTopicId": "string",
    "sourceTopicName": "string",
    "status": {
      "partitionInformation": [
        {
          "highWatermark": 42,
          "partitionId": 42,
          "sourceHighWatermark": 42,
          "sourceLastStableOffset": 42,
          "sourceLastUpdatedTimestamp": "2023-01-15T01:30:15.01Z"
        }
      ],
      "state": "SHADOW_TOPIC_STATE_UNSPECIFIED"
    },
    "topicId": "string"
  }
}
Response examples (default) 
{
  "code": "not_found",
  "details": [
    {
      "debug": {},
      "type": "string",
      "value": "@file"
    }
  ],
  "message": "string"
}