COconfluent
Switchover Pairs (switchover/v1)

List of Switchover Pairs

Changed on

Early Access Request Access To Switchover API (Kafka Disaster Recovery)

Retrieve a sorted, filtered, paginated list of all switchover pairs.

get/switchover/v1/switchover-pairs

Request

  • Base URL
    https://api.confluent.cloud
  • URL
    https://api.confluent.cloud/switchover/v1/switchover-pairs
  • Auth
    • HTTP basic
    • or HTTP basic

Query parameters

environmentstring required

Filter a collection by a string search

Scope the operation to the environment with this ID. The bare-ID form of environment_crn; it is the standard Confluent collection filter, passed as the ?environment= query parameter.

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Switchover Pair.

api_version'switchover/v1' required

APIVersion defines the schema version of this representation of a resource.

kind'SwitchoverPairList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "pagination": {
      "page_size": 10,
      "total_size": 23
    }
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/switchover/v1/switchover-pairs/sw-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/switchover-pair=sw-12345",
        "created_at": "2006-01-02T15:04:05-07:00",
        "updated_at": "2006-01-02T15:04:05-07:00",
        "deleted_at": "2006-01-02T15:04:05-07:00"
      },
      "spec": {
        "environment_crn": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000",
        "display_name": "prod-kafka-dr",
        "members": [
          {
            "name": "west",
            "member_crn": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000/cloud-cluster=lkc-00000",
            "location": {
              "cloud": "aws",
              "region": "us-west-2"
            }
          }
        ],
        "active_member": "west",
        "first_active": "west",
        "failover_type": "PLANNED"
      },
      "status": {
        "phase": "READY_TO_FAILOVER",
        "conditions": [
          {
            "member": "east",
            "type": "ResourceValidationComplete",
            "status": "True",
            "reason": "Reconciled",
            "message": "The resource is ready."
          }
        ]
      }
    }
  ]
}

Changes