集群管理器设置请求

集群管理器 UI 设置的 REST API 请求

Redis 企业软件
方法 路径 描述
获取 /v1/cm_settings 获取集群管理器 UI 设置
放 /v1/cm_settings 更新集群管理器 UI 设置

获取 CM 设置

GET /v1/cm_settings

Get Cluster Manager UI settings.

Permissions

Permission name Roles
view_cluster_info admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager

Request

Example HTTP request

GET /v1/cm_settings

Headers

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

Response

Returns a cm_settings object.

Example JSON body

{
    "timezone": "UTC"
}

Status codes

Code Description
200 OK No error

Update CM settings

PUT /v1/cm_settings

Update Cluster Manager UI settings.

Permissions

Permission name Roles
update_cluster admin

Request

Example HTTP request

PUT /v1/cm_settings

Example JSON body

{
    "timezone": "US/Pacific"
}

Headers

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

Body

Include a cm_settings object with updated fields in the request body.

Response

Returns a cm_settings object with the updated fields.

Example JSON body

{
    "timezone": "US/Pacific"
}

Status codes

Code Description
200 OK Success, time zone config has been set.
400 Bad Request Bad or missing configuration parameters.
RATE THIS PAGE
Back to top ↑