EKM Cluster:List Clusters

Search (SHIFT+S)

ECS Management API

ECS Object Service API

ECS API Changes

List Clusters

GET /ekm/cluster

Required Roles

Requires one of the following roles:

SYSTEM_ADMIN
SYSTEM_MONITOR

Response Body

Field	Description	Type	Notes
ekmclusters
ekmcluster			0-* Elements
name	Name of the resource	String
id	Id of the related object	URI
link	Hyperlink to the related object

Examples

Request

GET https://localhost:4443/ekm/cluster HTTP/1.1
Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

Response

HTTP/1.1 200 OK
Content-Type: application/xml



<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ekmcluster>
     <id>urn:EKMCluster:77a5b6f9-2828-48d6-91a5-738204fbb207</id>
     <name>test_cluster</name>
     <tags/>
     <cluster_type>GEMALTO</cluster_type>
</ekmcluster>

Request

GET https://localhost:4443/ekm/cluster HTTP/1.1

Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

Response

HTTP/1.1 200 OK
Content-Type: application/json
   [
       {
             "id":"urn:EKMCluster:77a5b6f9-2828-48d6-91a5-738204fbb207",
             "tags":[],
             "name":"testcluster",
             "cluster_type":"GEMALTO"
       }
   ]

Request

curl -H $token -H "Content-Type: application/xml" -X GET https://$nodeIp:4443/ekm/cluster

Response

HTTP/1.1 200 OK
Content-Type: application/xml



<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ekmcluster>
     <id>urn:EKMCluster:77a5b6f9-2828-48d6-91a5-738204fbb207</id>
     <name>test_cluster</name>
     <tags/>
     <cluster_type>GEMALTO</cluster_type>
</ekmcluster>