API endpoints

IBM Storage Scale Data Access Services (DAS) REST APIs include several API services for managing an IBM Storage Scale S3 object access cluster. It uses the HTTP protocol for sending and retrieving data and JSON formatted responses.

IBM Storage Scale DAS provides the following REST APIs:
  • API for managing services
  • API for managing accounts
  • API for managing exports
The endpoints of each API have a characteristic basic syntax. In the following code blocks, <ibm-spectrumscale_host> is the host name or the IP address of the API server.
https://<ibm-spectrumscale_host>/scalemgmt/v2/das/<endpoint_ID>
Note: The variable <ibm-spectrumscale_host> in the request URL must be replaced with the route host. Obtain the route host by using the following command from a node that is configured to work with the Red Hat OpenShift Container Platform (OCP) cluster:
oc get route ibm-spectrum-scale-gui -n <IBM Storage Scale namespace> -o json | jq .spec.host
For example,
oc get route ibm-spectrum-scale-gui -n ibm-spectrum-scale -o json | jq .spec.host
A sample output is as follows:

"ibm-spectrum-scale-gui-ibm-spectrum-scale.example.com"
The supported endpoint IDs are:
  • services
  • accounts
  • exports

To access a specific service, account, or export, use the name of the resource in the URL as follows:

https://<ibm-spectrumscale_host>/scalemgmt/v2/das/<endpoint_ID>/<resource_name>

For example:

curl -k -u "s3-admin:Passw0rd" https://<ibm-spectrumscale_host>/scalemgmt/v2/das/services/s3
or 
curl -k -u "s3-admin:Passw0rd" https://<ibm-spectrumscale_host>/scalemgmt/v2/das/accounts/user1