Documentation

InfluxDB Anti-Entropy API

This page documents an earlier version of InfluxDB Enterprise. InfluxDB Enterprise v1.8 is the latest stable version. View this page in the v1.8 documentation.

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 influx-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

NameLocated inDescriptionRequiredType
localqueryLimits status check to local shards on the data node handling this requestNoboolean

Responses

Headers

Header nameValue
Acceptapplication/json

Status codes

CodeDescriptionType
200Successful operationobject

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

NameLocated inDescriptionRequiredType
idqueryID of shard to queue for repairYesinteger

Responses

Headers

Header nameValue
Acceptapplication/json

Status codes

CodeDescription
204Successful operation
400Bad request
500Internal 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

NameLocated inDescriptionRequiredType
idqueryID of shard to remove from repair queueYesinteger
localqueryOnly remove shard from repair queue on node receiving the requestNoboolean

Responses

Headers

Header nameValue
Acceptapplication/json

Status codes

CodeDescription
204Successful operation
400Bad request
500Internal 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

NameTypeRequired
idstringNo
databasestringNo
retention_policystringNo
start_timestringNo
end_timestringNo
expiresstringNo
statusstringNo

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

New! Cloud or OSS?

InfluxDB OSS 2.0 now generally available!

InfluxDB OSS 2.0 is now generally available and ready for production use. See the InfluxDB OSS 2.0 release notes.

For information about upgrading to InfluxDB OSS 2.0, see: