/scalemgmt/v3/xcp/config: GET

Retrieves the current values of the maximum configuration parameters for parallel copy operations that are allowed in the cluster.

Availability

Available on all IBM Storage Scale editions.

Description

The GET xcp/config request retrieves the current values of the maximum configuration parameters for parallel copy operations that are allowed in the IBM Storage Scale cluster.

Request URL

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

where

config: Specifies the XCP configuration as the target of the GET call.

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
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.
```
"string"
```

default: An unexpected error response.

{
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example retrieves the XCP configuration:

Request data:

curl -k -n -X GET "https://10.0.100.25:46443/scalemgmt/v3/xcp/config" -H "accept: application/json"

Response data:

{
  "max_parallel": "10",
  "max_files": "0",
  "max_threads": "0"
}