Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The Get Cluster Configuration Settings method SHOULD<40> be used to retrieve cluster-level settings.
This method is invoked by sending a GET operation to the following URI.
-
https://<clusterIp>:<controllerPort>/api/<uriVersion>/bdc/config?filterOption=<filterOption>&recursive=<false>&includeDetails=<includeDetails>&settings=<settings>
filterOption: A parameter that allows the user to specify a subset of settings to be returned. The possible values are as follows:
All: All user-configurable and system-managed settings are returned. If no option is specified, the system defaults to "All".
Configurable: All settings that can be configured by the user are returned.
UserConfigured: All user-configured settings are returned.
Pending: All pending cluster settings are returned.
settings: An optional parameter that can specify a list of pattern property strings that are used to restrict the number of settings to be returned.
recursive: A parameter that allows for the scope of all settings to be returned. When set to true, the API returns cluster-, service-, and resource-scoped settings.
includeDetails: A parameter that specifies whether to return additional details for each setting.
The HTTP response message for the Get Cluster Configuration Settings method can include the following status codes.
|
HTTP status code |
Description |
|---|---|
|
200 |
The retrieval of the configuration settings was initiated. |
|
400 |
Unable to parse the configuration settings GET request. |
|
400 |
The filterOption parameter value that was provided was invalid. |
|
401 |
User is not authorized to make this request. |
|
500 |
An internal error occurred while retrieving the configuration settings. |