/clusters/{clusterName}/services/{serviceName}/roles/{roleName}/config

Mount Point: /api/v10/clusters/{clusterName}/services/{serviceName}/roles/{roleName}/config

GET

Retrieves the configuration of a specific role. Note that the "full" view performs validation on the configuration, which could take a few seconds on a large cluster (around 500 nodes or more).

Parameters

name description type default
roleName The role to look up. path
view The view of the data to materialize, either "summary" or "full". query summary
serviceName (no documentation provided) path
clusterName (no documentation provided) path

Response Body

element: configList

List of role configuration parameters.

PUT

Updates the role configuration with the given values.

If a value is set in the given configuration, it will be added to the role's configuration, replacing any existing entries. If a value is unset (its value is null), the existing configuration for the attribute will be erased, if any.

Attributes that are not listed in the input will maintain their current values in the configuration.

Parameters

name description type default
roleName The role to modify. path
message Optional message describing the changes. query
serviceName (no documentation provided) path
clusterName (no documentation provided) path

Request Body

element: configList

Configuration changes.

Response Body

element: configList

The new service configuration.