Migrations requests
REST API request to get the migration status of a database in the cluster when using Replica Of.
| Redis Enterprise Software |
|---|
| Method | Path | Description |
|---|---|---|
| GET | /v1/migrations/<uid> |
Get database migration status |
Get migration status
GET /v1/migrations/<uid>
Gets the migration status of a database in the cluster when using Replica Of.
Required permissions
| Permission name | Roles |
|---|---|
| view_bdb_info | admin cluster_member cluster_viewer db_member db_viewer user_manager |
Request
Example HTTP request
GET /v1/migrations/1
Headers
| Key | Value | Description |
|---|---|---|
| Host | cnm.cluster.fqdn | Domain name |
| Accept | application/json | Accepted media type |
URL parameters
| Field | Type | Description |
|---|---|---|
| uid | integer | The database's unique ID |
Response
Returns a JSON array with all data required by the migration orchestrator.
Example response body
"migration": {
"status": "foo",
"lag": 123,
"run_id": "5",
"flush_counter": 2,
"source_shards": [{"replication_id": "1", "replication_offset": 2}]
}
Status codes
| Code | Description |
|---|---|
| 200 OK | No error |
| 404 Not Found | Database does not exist |