InfluxDB Anti-Entropy API

Note: The Anti-Entropy API is only available when the Anti-Entropy service is enabled in the data node configuration settings. For information on the configuration settings, see Anti-Entropy settings.

The Anti-Entropy service is used by InfluxDB Enterprise clusters to monitor and repair entropy in data nodes and their shards.

The base URL is:

http://localhost:8086/shard-repair`

GET /status

Description

Lists shards that are in an inconsistent state and in need of repair.

Parameters

Name Located in Description Required Type
local query Limits status check to local shards on the data node handling this request No boolean

Responses

Headers

Header name Value
Accept application/json

Status codes

Code Description Type
200 Successful operation object

Examples

cURL request

curl -X GET "http://localhost:8086/shard-repair/status?local=true" -H "accept: application/json"

Request URL

http://localhost:8086/shard-repair/status?local=true

Responses

Example of server response value:

{
  "shards": [
    {
      "id": "1",
      "database": "ae",
      "retention_policy": "autogen",
      "start_time": "-259200000000000",
      "end_time": "345600000000000",
      "expires": "0",
      "status": "diff"
    },
    {
      "id": "3",
      "database": "ae",
      "retention_policy": "autogen",
      "start_time": "62640000000000000",
      "end_time": "63244800000000000",
      "expires": "0",
      "status": "diff"
    }
  ],
  "queued_shards": [
    "3",
    "5",
    "9"
  ],
  "processing_shards": [
    "3",
    "9"
  ]
}

POST /repair

Description

Queues the specified shard for repair of the inconsistent state.

Parameters

Name Located in Description Required Type
id query ID of shard to queue for repair Yes integer

Responses

Headers

Header name Value
Accept application/json

Status codes

Code Description
204 Successful operation
400 Bad request
500 Internal server error

Examples

cURL request

curl -X POST "http://localhost:8086/shard-repair/repair?id=1" -H "accept: application/json"

Request URL

http://localhost:8086/shard-repair/repair?id=1

POST /cancel-repair

Description

Removes the specified shard from the repair queue on nodes.

Parameters

Name Located in Description Required Type
id query ID of shard to remove from repair queue Yes integer
local query Only remove shard from repair queue on node receiving the request No boolean

Responses

Headers

Header name Value
Accept application/json

Status codes

Code Description
204 Successful operation
400 Bad request
500 Internal server error

Examples

cURL request

curl -X POST "http://localhost:8086/shard-repair/cancel-repair?id=1&local=false" -H "accept: application/json"

Request URL

http://localhost:8086/shard-repair/cancel-repair?id=1&local=false

Models

ShardStatus

Name Type Required
id string No
database string No
retention_policy string No
start_time string No
end_time string No
expires string No
status string No

Examples

{
  "shards": [
    {
      "id": "1",
      "database": "ae",
      "retention_policy": "autogen",
      "start_time": "-259200000000000",
      "end_time": "345600000000000",
      "expires": "0",
      "status": "diff"
    },
    {
      "id": "3",
      "database": "ae",
      "retention_policy": "autogen",
      "start_time": "62640000000000000",
      "end_time": "63244800000000000",
      "expires": "0",
      "status": "diff"
    }
  ],
  "queued_shards": [
    "3",
    "5",
    "9"
  ],
  "processing_shards": [
    "3",
    "9"
  ]
}

This documentation is open source. See a typo? Please, open an issue.


Need help getting up and running? Get Support