operations

List replication queue items

Changed on

Returns raw replication queue evidence from system.replication_queue, per node.

get/operations/replication-queue

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/operations/replication-queue
  • Auth: none declared

Query parameters

nodeIdstring
Example:shard1-replica1

Filter by movoor configured node id.

databasestring
Example:movoor_dev

Filter by ClickHouse database name.

tablestring
Example:test_generic_network_month_local

Filter by ClickHouse table name.

typestring
Example:GET_PART

Filter by open ClickHouse replication queue type. Known values include GET_PART, MERGE_PARTS, MUTATE_PART, and DROP_RANGE.

currentlyExecutingboolean

Filter replication queue items by execution state.

hasExceptionboolean

Filter replication queue items by whether lastException is set.

Response

Replication queue details.

Example response

{
  "collection": {
    "warnings": [
      {
        "code": "node_unreachable",
        "message": "clickhouse-shard2-replica2 did not respond before timeout",
        "nodeId": "shard2-replica2"
      }
    ]
  },
  "items": [
    {
      "nodeId": "shard1-replica1",
      "shard": "shard1",
      "replica": "replica1",
      "position": "104",
      "type": "GET_PART",
      "requiredQuorum": "104",
      "numTries": "104",
      "numPostponed": "104",
      "conditions": [
        {
          "code": "replica_disk_mismatch"
        }
      ]
    }
  ]
}

Changes

  • ae109adee954Revision changes
    • breaking

      response property items/items/allOf[subschema #2]/lastException list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/items/allOf[subschema #2]/newPartName list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/items/allOf[subschema #2]/postponeReason list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/items/allOf[subschema #2]/sourceReplica list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the /// response's property type changed from no type to string for status

  • ddfd7d1ddb93Revision changes
    • info

      endpoint added