服务请求

列出或修改 Redis Enterprise 服务的 REST API 请求。

Redis 企业软件
方法 路径 描述
获取 /v1/local/services 列出本地节点上的 Redis Enterprise 服务
发布 /v1/local/services 修改本地进程或对本地进程执行作
发布 /v1/services 将集群范围的更改应用于服务
警告：

此 API 很危险，只能在 Redis 支持的指导下运行。

仅停止、启动或重新启动可选服务。更改所需服务的状态可能会对集群行为产生负面影响，并导致集群及其数据完全丢失。

有关可选服务的列表，请参阅 services 配置对象参考或使用GET /v1/cluster/services_configuration请求。

获取本地服务

GET /v1/local/services

Lists all Redis Enterprise services currently running on the local node and relevant metadata.

Request

Example HTTP request

GET /v1/local/services

Headers

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type

Response

Returns a JSON object that describes all Redis Enterprise services currently running on the local node and relevant metadata.

Possible status values:

  • RESTARTING
  • RUNNING
  • STARTING
  • STOPPED

Example JSON response body

{
    "alert_mgr": {
        "start_time": "2024-05-13T18:38:00Z",
        "status": "RUNNING",
        "uptime": "3 days, 0:58:59"
    },
    "ccs": {
        "start_time": "2024-05-13T18:38:59Z",
        "status": "RUNNING",
        "uptime": "3 days, 0:58:00"
    },
    ...
}

Status codes

Code Description
200 OK No error

Modify local services

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:

  • stop
  • start
  • restart
Warning:

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.

Request

Example HTTP request

POST /v1/local/services

Headers

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type

Example JSON request body

{
  "operation_type": "restart",
  "services": [
    "alert_mgr"
  ]
}

Response

Returns a JSON object that shows whether the operation ran successfully or failed for each requested service.

Example JSON response body

{
    "alert_mgr": true,
    "metrics_exporter": true
}

Status codes

Code Description
200 OK No error.

Apply cluster-wide service changes

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:

  • stop
  • start
  • restart
Warning:

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.

Request

Example HTTP request

POST /v1/services

Headers

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type

Example JSON request body

{
  "operation_type": "restart",
  "services": [
    "alert_mgr"
  ]
}

Response

Returns a JSON object that shows whether the operation ran successfully or failed for each requested service.

Example JSON response body

{
    "alert_mgr": true,
    "metrics_exporter": true
}

Status codes

Code Description
200 OK No error.
RATE THIS PAGE
Back to top ↑