ECS 3.6.2 Data Access Guide

PDF

ECS Management REST API summary

The ECS Management REST API enables the ECS object store to be configured and managed.

Table 1. ECS Management REST API - methods summaryThe following table summarizes the ECS Management REST API.
API Area	Description
Configuration
Certificate	/object-cert API to manage certificates. /object-cert/keystore API to specify and rotate the certificate chain used by ECS.
Configuration Properties	/config/object/properties API to set the user scope as GLOBAL or NAMESPACE. This must be set before the first user is created. The default is GLOBAL. In GLOBAL scope, users are global and are can be shared across namespaces. In this case, the default namespace associated with a user determines the namespace for object operations and there is no need to supply a namespace for an operation. In NAMESPACE scope, a user is associated with a namespace. In this case, there might be more than one user with the same name, each associated with a different namespace, and a namespace must be provided for every operation.
Licensing	/license API to add a license and retrieve license details.
Feature	/feature/ServerSideEncryption API to retrieve the details of the ServerSideEncryption feature.
Syslog	/vdc/syslog/config API to manage Syslog configuration and send alerts to the Syslog server for troubleshooting and debugging purposes.
SNMP	/vdc/snmp/config API to manage SNMP configuration and send alerts to SNMP server for troubleshooting and debugging purposes.
CAS
CAS user profile	/object/user-cas/secret API to assign secret keys to CAS users and generate the Pool Entry Authorization (PEA) file. /object/user-cas/bucket API to retrieve or update the default bucket of a specified CAS user. /object/user-cas/applications/{namespace} API to retrieve the CAS registered applications for a specified namespace. /object/user-cas/metadata/{namespace}/{uid} API to retrieve or update the CAS user metadata for the specified namespace and CAS user.
File system access
NFS	/object/nfs API to create an NFS export based on an ECS bucket and enable access to the export by UNIX users and groups. /object/nfs/users API to manage mapping between ECS user/group and corresponding UNIX user ID. /object/nfs/exports API to create and manage NFS exports. For the best practices to apply when you mount ECS NFS exports, see KB 532228.
Metering
Billing	/object/billing API to meter object store usage at the namespace and bucket level.
Migration
Transformation	/object/transformation API to enable data transformation from a Centera cluster.
Monitoring
Capacity	/object/capacity API to retrieve the current managed capacity.
Dashboard	/dashboard/zones/localzone API to retrieve the local VDC details, including details on replication groups, storage pools, nodes, and disks. /dashboard/zones/hostedzone API to retrieve the hosted VDC details, including details on replication groups. /dashboard/replicationgroups/{id} API to retrieve the replication group instance details. /dashboard/storagepools/{id} API to retrieve the storage pool details, including details on the storage pool nodes. /dashboard/nodes/{id} API to retrieve the node instance details, including node instance disk and process details. /dashboard/disks/{id} API to retrieve the disk instance details. /dashboard/processes/{id} API to retrieve the process instance details. /dashboard/rglinks/{id} API to retrieve the replication group link instance details. /dashboard/datatables/{id} API to retrieve the replication group datatables instance details.
Events	/vdc/events API to retrieve audit events for a specified namespace.
Alerts	/vdc/alerts API to retrieve audit alerts.
Multi-tenancy
Namespace	/object/namespaces API to create and manage a namespace. This API also sets the retention period and quota for the namespace. For more information about retention periods and quotas, see the ECS Administration Guide which is available from the https://www.dell.com/support/.
Geo-replication
Replication Group	/data/data-service/vpools API to create and manage replication groups.
Temporary Failed Zone	/tempfailedzone/ API to retrieve all temporary failed zones, or the temporary failed zones for a specified replication group.
Provisioning
Base URL	/object/baseurl API to create a Base URL that allows existing applications to work with the ECS object store. For more information on Base URL, see the ECS Administration Guide which is available from the https://www.dell.com/support/.
Bucket	/object/bucket API to provision and manage buckets. /object/bucket/{bucketName}/lock API to lock bucket access. /object/bucket/{bucketName}/tags API to add tags to a specified bucket. /object/bucket/{bucketName}/retention API to set the retention period for a specified bucket. /object/bucket/{bucketName}/quota API to set the quota for a specified bucket. /object/bucket/{bucketName}/policy API to add a policy for a specified bucket. /object/bucket/{bucketName}/metadata API to add metadata for a specified bucket.
Data store	/vdc/data-stores API to create datastores on file systems (/vdc/data-stores/filesystems) or on commodity nodes (/vdc/data-stores/commodity).
Node	/vdc/nodes API to retrieve the nodes that are currently configured for the cluster. /vdc/nodes/{nodename}/lockdown API to set the locked or unlocked status for a specified node. /vdc/lockdown API to retrieve the locked or unlocked status for a VDC.
Storage pool	/vdc/data-services/varrays API to create and manage storage pools.
Virtual data center	/object/vdcs API to add a VDC and specify the inter-VDC endpoints and secret key for replication of data between ECS sites.
VDC keystore	/vdc/keystore API to manage certificates for a VDC.
Support
Call home	/vdc/callhome/ API for managing ESRS configuration and sending alerts to ConnectEMC for troubleshooting and debugging purposes.
User Management
Authentication provider	/vdc/admin/authnproviders API to add and manage authentication providers.
Password group (Swift)	/object/user-password API to generate a password for use with OpenStack Swift authentication.
Secret key	/object/user-secret-keys API to assign secret keys to object users and to manage secret keys.
Secret key self-service	/object/secret-keys API to enable S3 users to create a new secret key that enables them to access objects and buckets within their namespace in the object store.
User (Object)	/object/users API to create and manage object users. Object users are always associated with a namespace. The API returns a secret key that can be used for S3 access. An object user assigned an S3 secret key can change it using the REST API. /object/users/lock. API to lock user access. /object/users/{userName}/tags. API to associate tags with a user ID. Tags are in the form of name=value pairs.
User (management)	/vdc/users API to create and manage users. Management users can be assigned to the System Administrator role or to the Namespace Administrator role. You can use this API the change the local management user password.