Documentation

InfluxDB Anti-Entropy API

Note: The Anti-Entropy API is available from the meta nodes and 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.

Use the Anti-Entropy service in InfluxDB Enterprise to monitor and repair entropy in data nodes and their shards. To access the Anti-Entropy API and work with this service, use influxd-ctl entropy (also available on meta nodes).

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"
  ]
}

Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

Learn more
Contact InfluxData Sales

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: