Remotemount/owningclusters/{owningCluster}: GET

Gets the details of the cluster that owns file systems that can be mounted remotely. This API must be run on a cluster that mounts file systems remotely.

Availability

Available on all IBM Storage Scale editions.

Description

The GET /remotemount/owningclusters/{owningCluster} gets the details of the cluster that owns the file systems that can be mounted remotely. For more information about the fields in the data structures that are returned, see mmremotecluster command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/remotemount/owningclusters/{owningCluster}
where
remotemount/owningclusters/{owningCluster}
Specifies the target of the GET request.

Request headers

Accept: application/json

Request parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of request parameters
Parameter name Description and applicable keywords Required/optional
owningCluster Name of the owning cluster. Required.

Request data

No request data.

Response data

{  
  "status": {
      "code":ReturnCode,
      "message":"ReturnMessage"
   }
   "owningClusters": 
    {
      "owningCluster": "Name of the cluster",
      "contactNodes": "Contact nodes of owning cluster", 
      "keyDigest": "SHA digest of the public key",
      "filesystemPairs": "File system mapping",
    }
   "filesystemPair"
     {
      "owningClusterFilesystem ": "File system on the owning cluster",
      "owningClusterFilesystem ": "File system on the remote cluster",  
     }
  }
For more information about the fields in the following data structures, see the links at the end of this topic.
"owningClusters":
Owning cluster details.
"owningCluster": "Name of the cluster"
The owning cluster of the remote file system.
"contactNodes": "Contact nodes of owning cluster"
The contact nodes of the owning cluster used for remote mounting.
"keyDigest": "SHA digest of the public key"
The SHA digest of the public key of the owning cluster.
"filesystemPairs": "File system mapping"
The mapping of file systems of owning cluster and remote cluster.
"filesystemPair":
File system pair details.
"owningClusterFilesystem": "File system on the owning cluster"
The file system on the owning cluster.
"owningClusterFilesystem": "File system on the remote cluster"
The file system on the remote cluster.
"status":
Return status.
"message": "ReturnMessage",
The return message.
"code": ReturnCode
The return code.

Examples

The following example shows how to get the details of the cluster Cluster1 that owns file systems that can be mounted remotely.

Request data: 
curl -k -u admin:admin001 -X GET --header 'accept:application/json'
'https://198.51.100.1:443/scalemgmt/v2/remotemount/owningclusters/Cluster1'
Response data:
Note: In the JSON data that is returned, the return code indicates whether the command is successful. The response code 200 indicates that the command successfully retrieved the information. Error code 400 represents an invalid request and 500 represents internal server error. 
{
  "status": {
    "code": 200,
    "message": "..."
  },
   "owningClusters": [
    {
      "owningCluster": "Cluster1",
      "contactNodes": [
        "string"
      ],
      "keyDigest": "string",
      "filesystemPairs": "{ {'owningClusterFilesystem':'fs1', 'remoteClusterFilesystem':'fs1_remote'}, {'owningClusterFilesystem':'fs2', 'remoteClusterFilesystem':'fs2_remote'} }"
    }
  ]
}