/scalemgmt/v3/clusters/remote/{name}/refresh: POST

Refreshes the information of an owning cluster on the accessing cluster.

Availability

Available on all IBM Storage Scale editions.

Description

The POST clusters/remote/{name}/refresh request refreshes the information of an owning cluster on the accessing cluster. This command initiates a new cluster key exchange protocol from the accessing cluster for an existing owning cluster definition.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/clusters/remote/{name}/refresh

Where

name: Specifies the remote cluster name.

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
name	The name of the remote cluster.	Required.
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.
```
{}
```

default: An unexpected error response.

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

Examples

The following example refreshes the information of an owning cluster on the accessing cluster:

Request data:

curl -X 'POST' 'https://localhost:46443/scalemgmt/v3/clusters/remote/owningCluster1/refresh'  -H 'accept: application/json'  -n -k -d ''

Response data:

{}