Search (SHIFT+S)
ECS Management API
ECS Object Service API
-
Amazon S3
- S3 Bucket
- S3 Bucket ACL
- S3 Bucket Cors
- S3 Bucket Empty Status Operations
- S3 Bucket Is Stale Allowed
- S3 Bucket Lifecycle
- S3 Bucket List Fanout (Cloud DVR)
- S3 Bucket List Uploads
- S3 Bucket Location
- S3 Bucket Lock Configuration Operations
- S3 Bucket Object Lock Operations
- S3 Bucket Policy
- S3 Bucket Versioning
- S3 Bucket Versions
- S3 Data Node
- S3 Metadata Key List
- S3 Metadata Key System List
- S3 Metadata Search
- S3 Multi Object Delete
- S3 Object
- S3 Object ACL
- S3 Object Detailed Replication Status Operations
- S3 Object Init Uploads
- S3 Object Legal Hold Operations
- S3 Object Replication Info Operations
- S3 Object Retention Operations
- S3 Object Tagging Operations
- S3 Object Uploads
- S3 Options
- S3 Ping
- S3 Retention Update Operation
- S3 Select Operations
- EMC Atmos
- OpenStack Swift
ECS API Changes
Activate
PUT /ekm/cluster/{id}/activate
Triggers EKMCluster activation. Activation of cluster implies that the cluster is ready to be used for key management for all the VDCs in the ECS federation. For the activate, the service will have to validate that all VDCs have been mapped to some EKMServer, otherwise it is an error. The service will also have to validate that all VDCs are able to see the primary EKMs that they are mapped to; this status can be found by looking at the latest EKM_SERVER_STATUS entry.
| id | - URI referencing the EKMCluster that should be activated |
Required Roles
SYSTEM_ADMIN
Request Payload
No Request Payload
Response Body
- The representation of the EKMCluster after activation is initiated
| Field | Description | Type | Notes |
| ekmcluster | |||
| cluster_type | String | ||
| last_modified | Long | ||
| status | String | ||
| ekm_mapping_set | |||
| ekm_mapping |
0-* Elements |
||
| vdc_id | String | ||
| ekm_servers_list | |||
| ekm_server | String |
0-* Elements |
|
| activation_initiated_on_vdc | String | ||
| activation_message | String | ||
| name | Name assigned to this resource in ECS. The resource name is set by a user and can be changed at any time. It is not a unique identifier. | String | |
| id | Identifier that is generated by ECS when the resource is created. The resource Id is guaranteed to be unique and immutable across all virtual data centers for all time. | URI |
Valid Values:
|
| link | Hyperlink to the details for this resource | ||
| creation_time | Timestamp that shows when this resource was created in ECS | DateTime |
Valid Values:
|
| tags | Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search. | ||
| tag | String |
0-* Elements |
|
| inactive | Indicates whether the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ECS database. | Boolean |
Valid Values:
|
| global | Indicates whether the resource is global. | Boolean |
Valid Values:
|
| remote | Indicates whether the resource is remote. | Boolean |
Valid Values:
|
| vdc | |||
| id | Id of the related object | URI | |
| link | Hyperlink to the related object | ||
| internal | Indicates whether the resource is an internal resource. | Boolean |
Valid Values:
|
Examples
Request
PUT https://localhost:4443/ekm/cluster/urn:EKMCluster:77a5b6f9-2828-48d6-91a5-738204fbb207/activate Content-Type: application/xml <?xml version="1.0" encoding="UTF-8" ?>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ekmcluster>
<id>77a5b6f9-2828-48d6-91a5-738204fbb207</id>
<name>testcluster</name>
<tags/>
<cluster_type>GEMALTO</cluster_type>
<last_modified>1539623094248</last_modified>
<ekm_mapping_set>
<ekm_mapping>
<ekm_servers_list>
<ekm_server>urn:storageos:EKMServer:ad164ea1-f7be-3476-9e69-a93e0bec8683</ekm_server>
</ekm_servers_list>
<vdc_id>urn:storageos:VirtualDataCenterData:e02b05ef-5ec3-4b06-ad55-a2a9a52e5f01</vdc_id>
</ekm_mapping>
</ekm_mapping_set>
<status>ACTIVATED</status>
</ekmcluster>