/scalemgmt/v3/config/cluster: GET

Lists the current configuration data for the I/O daemon that is stored on a disk.

Availability

Available on all IBM Storage Scale editions.

Description

The GET config/cluster request lists the current configuration data for the administration daemon that is stored on a disk. To run this request, you must have the RBAC permission for the get action on the /scalemgmt/v3/config/cluster resource.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/config/cluster

Request headers

Accept: application/json

Parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of parameters
Parameter name Description and applicable keywords Required/optional
view Specifies the view for configuration values. The possible values are ALL, AFM, NSD_RAID, TRACE, and MMHEALTH. Optional.
page_size Specifies the number of items to list per API request. Optional.
page_token Specifies the page token that is received from previous config/cluster: GET request. You can provide this page token to retrieve the next page. Optional.
running Displays the configuration value that is running on the node. Optional.
X-StorageScaleDomain The domain to be authorized against for the request. The default value is StorageScaleDomain. Optional.

Request data

No request data.

Response data

  • 200: A successful response.c
    {
  "configs": [
    {
      "config": {
        "name": "string",
        "node_id": "string",
        "node_name": "string",
        "value": "string"
      },
      "diag": 0,
      "dynamic": 0,
      "tagName": "string"
    }
  ],
  "next_page_token": "string"
}
  • default: An unexpected error response.
    {
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example lists information about the current configuration data for the I/O daemon:

Request data: 
curl -k -X  'GET'   'https://localhost:8001/scalemgmt/v3/config/cluster/' -n
Response data: 
{
	"configs": [
		{
			"config": {
				"name": "cipherList",
				"value": "AUTHONLY"
			}
		},
		{
			"config": {
				"name": "sdrNotifyAuthEnabled",
				"value": "yes"
			}
		},
		{
			"config": {
				"name": "readReplicaRuleEnabled",
				"value": "yes",
				"node_id": "2",
				"node_name": "scale-22.openstacklocal"
			}
		},
		{
			"config": {
				"name": "adminMode",
				"value": "central"
			}
		}
	]
}