REST API requests to list or modify Redis Enterprise services.
| Redis Enterprise Software |
|---|
| Method | Path | Description |
|---|---|---|
| GET | /v1/local/services |
List Redis Enterprise services on the local node |
| POST | /v1/local/services |
Modify or perform operations on local processes |
| POST | /v1/services |
Apply cluster-wide changes to services |
This API is dangerous and should only be run with guidance from Redis support.
Stop, start, or restart optional services only. Changing the status of required services can negatively affect cluster behavior and cause a complete loss of the cluster and its data.
For a list of optional services, see the services configuration object reference or use a GET /v1/cluster/services_configuration request.
GET /v1/local/services
Lists all Redis Enterprise services currently running on the local node and relevant metadata.
GET /v1/local/services
| Key | Value | Description |
|---|---|---|
| Host | cnm.cluster.fqdn | Domain name |
| Accept | application/json | Accepted media type |
Returns a JSON object that describes all Redis Enterprise services currently running on the local node and relevant metadata.
Possible status values:
{
"alert_mgr": {
"start_time": "2024年05月13日T18:38:00Z",
"status": "RUNNING",
"uptime": "3 days, 0:58:59"
},
"ccs": {
"start_time": "2024年05月13日T18:38:59Z",
"status": "RUNNING",
"uptime": "3 days, 0:58:00"
},
...
}
| Code | Description |
|---|---|
| 200 OK | No error |
POST /v1/local/services
Modify Redis Enterprise services or perform operations that directly interact with processes. For cluster-wide changes that are not node-specific, use POST /v1/services instead.
Supported operation_type values:
This API is dangerous and should only be run with guidance from Redis support.
Stop, start, or restart optional services only. Changing the status of required services can negatively affect cluster behavior and cause a complete loss of the cluster and its data.
For a list of optional services, see the services configuration object reference or use a GET /v1/cluster/services_configuration request.
POST /v1/local/services
| Key | Value | Description |
|---|---|---|
| Host | cnm.cluster.fqdn | Domain name |
| Accept | application/json | Accepted media type |
{
"operation_type": "restart",
"services": [
"alert_mgr"
]
}
Returns a JSON object that shows whether the operation ran successfully or failed for each requested service.
{
"alert_mgr": true,
"metrics_exporter": true
}
| Code | Description |
|---|---|
| 200 OK | No error. |
POST /v1/services
Makes cluster-wide changes that are not node-specific on Redis Enterprise services. The master node handles these changes. For operations that directly interact with processes, use POST /v1/local/services instead.
Supported operation_type values:
This API is dangerous and should only be run with guidance from Redis support.
Stop, start, or restart optional services only. Changing the status of required services can negatively affect cluster behavior and cause a complete loss of the cluster and its data.
For a list of optional services, see the services configuration object reference or use a GET /v1/cluster/services_configuration request.
POST /v1/services
| Key | Value | Description |
|---|---|---|
| Host | cnm.cluster.fqdn | Domain name |
| Accept | application/json | Accepted media type |
{
"operation_type": "restart",
"services": [
"alert_mgr"
]
}
Returns a JSON object that shows whether the operation ran successfully or failed for each requested service.
{
"alert_mgr": true,
"metrics_exporter": true
}
| Code | Description |
|---|---|
| 200 OK | No error. |