3.1.5.7.8 Get Resource Configuration Settings

The Get Resource Configuration Settings method SHOULD<44> be used to retrieve resource scoped configuration settings in a big data cluster.

This method is invoked by sending a GET operation to the following URI.

 https://<clusterIp>:<controllerPort>/api/<uriVersion>/bdc/services/<serviceName>/resources/<resourceName>/config?filterOption=<filterOption>&recursive=<false>&includeDetails=<includeDetails>&settings=<settings>

serviceName: A parameter that specifies which service to retrieve settings for.

resourceName: A parameter that specifies which resource to retrieve settings for.

filterOption: A parameter that allows the user to specify a subset of settings to be returned. The following are the possible values:

  • 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 settings that have been configured by the user are returned.

  • Pending: All pending resource settings are returned.

recursive: A parameter that allows for the scopes of all settings to be returned. If set to true, the API returns resource-scoped settings.

settings: A parameter that can specify a list of pattern property strings that can be used to restrict the number of settings returned.

includeDetails: A parameter that specifies whether to return additional details for each setting.

The HTTP response message for the Get Resource Configuration Settings method can include the following status codes.

HTTP status code

Description

200

Configuration settings were successfully returned.

400

Unable to parse the configuration setting GET request.

400

The filterOption parameter value was invalid.

401

User is not authorized to make this request.

404

The big data cluster does not exist.

500

An internal error occurred while retrieving the resource configuration settings.