Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




Create a Transformation Instance

POST /object/transformation/

Creates a transformation from a Centera cluster.


Required Roles

  • SYSTEM_ADMIN


Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
centera_transformation_object_param
type Defines type of transformation, for instance "centera". String
admin User provided Centera admin name String
password User provided Centera admin password String
management_ip User provided management IP address String
access_ip Optional. User provided data IP address String
port User provided management port address Integer
datagram_port Oprional. User provided data port address Integer
name User provided name (not verified or unique) String
description User provided description String
replication_group Replication group for transformation. If bucket not provided by user, this rg will be used by transformation during bucket creation. URI
namespace String
auto_mode Boolean
encryption_enabled Encryption for namespace Boolean

Response Body

Transformation info indicating success or failure of the transformation create operation.

Field Description Type Notes
transformation
transformation_id ID of this transformation URI
current_phase Optional. Current phase String
phases     0-* Elements
phase_id Optional. Phase id of transformation. Possible values: PreCheck, Enumeration, Indexing, Migration, Reconciliation, Deletion String
status Optional. Phase status. Possible values: Pending, InProgress, Succeeded, Failed, Canceled String
source_ids Optional. List of sources (profile and bucket mappings) for transformation String 0-* Elements
namespace Optional. Namespace for transformation. If namespace not provided by user, this namespace will be used by transformation during bucket creation. String
replication_group Optional. Replication group for transformation. If bucket not provided by user, this replication group will be used by transformation during bucket creation. String
name Optional. User provided name (not verified or unique) String
description Optional. User provided description. String
storageDeviceInfo Storage device info.
start_time Optional. Transformation start time. String
end_time Optional. Transformation end time. String
total_objects_for_migration Optional. Total objects discovered for migration. Long
total_objects_migrated Optional. Total objects migrated. Long
total_bytes_for_migration Optional. Total bytes discovered for migration. Long
total_bytes_migrated Optional. Total bytes migrated. Long
total_errors Optional. Total unrecovered errors occurred during migration. Long
total_mismatch_objects Optional. Total mismatches after reconciliation. Long
encryption_enabled Optional. Namespace encryption. Boolean

JSON Example

Request
Using curl:

curl -s -k -X POST -H Content-Type:application/json -H X-SDS-AUTH-TOKEN:$TOKEN -H ACCEPT:application/json -d @request_body1.tmp https://10.247.200.192:4443/object/transformation

where the request_body1.tmp file could be:
{
"type":              "centera",
"name":              "Centera Transformation",
"description":       "Centera transformation",
"replication_group": "urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76a:global",
"admin":             "admin",
"password":          "centera",
"management_ip":     "10.247.195.19",
"port":              3682,
"access_ip":         "10.247.195.19",
"datagram_port":     3218
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

{"transformation_id":"urn:Transformation:Centera:7b4985d2-1dd2-11b2-9ac4-9b1603e01545"}