Data Transfer API Resources

This topic provides reference information for the API resources associated with the Data Transfer service:

DataTransferJob

DataTransferAppliance

DataTransferDevice

DataTransferPackage

DataTransferJob

The DataTransferJob resource describes the operations of the data transfer import job.

Attributes

availabilityDomain

  • Required: no
  • Type: string

compartmentId

  • Required: yes
  • Type: string

displayName

  • Required: yes
  • Type: string

id

  • Required: yes
  • Type: string

lifecycleDetails

  • Required: no
  • Type: string

lifecycleState

  • Required: yes
  • Type: string

Allowed values are:

  • INITIATED
  • PREPARING
  • ACTIVE
  • DELETED
  • CLOSED

timeCreated

  • Required: yes
  • Type: string

label

  • Required: yes
  • Type: string

deviceType

  • Required: yes
  • Type: string

Allowed values are:

  • DISK
  • APPLIANCE

Example

{
  "availabilityDomain": "PHX-AD-2",
  "compartmentId": "ocid1.compartment.oc1..exampleuniqueID",
  "displayName": "data-transfer-job-1",
  "id": "ocid1.datatransferjob.oc1.phx.exampleuniqueID",
  "lifecycleDetails": "",
  "lifecycleState": "ACTIVE",
  "timeCreated": "2017-12-01T22:13:22.534Z",
  "label": "JOBLABEL",
  "deviceType": "APPLIANCE",
}

DataTransferAppliance

The DataTransferAppliance resource describes the operation of an Oracle-provided data transfer appliance.

Attributes

availabilityDomain

  • Required: no
  • Type: string

compartmentId

  • Required: yes
  • Type: string

displayName

  • Required: yes
  • Type: string

id

  • Required: yes
  • Type: string

lifecycleDetails

  • Required: no
  • Type: string

lifecycleState

  • Required: yes
  • Type: string

Allowed values are:

  • REQUESTED
  • ORACLE_PREPARING
  • SHIPPING
  • DELIVERED
  • PREPARING
  • FINALIZED
  • RETURN_DELAYED
  • RETURN_SHIPPED
  • RETURN_SHIPPED_CANCELLED
  • ORACLE_RECEIVED
  • ORACLE_RECEIVED_CANCELLED
  • PROCESSING
  • COMPLETE
  • CUSTOMER_NEVER_RECEIVED
  • ORACLE_NEVER_RECEIVED
  • CUSTOMER_LOST
  • CANCELLED
  • DELETED
  • REJECTED
  • ERROR

timeCreated

  • Required: yes
  • Type: string

label

  • Required: yes
  • Type: string

serialNumber

  • Required: no
  • Type: string

transferJobId

  • Required: yes
  • Type: string

Example

{
  "availabilityDomain": "PHX-AD-2",
  "compartmentId": "ocid1.compartment.oc1..exampleuniqueID",
  "displayName": "data-transfer-job-1",
  "id": "APPLIANCELABEL",
  "lifecycleDetails": "",
  "lifecycleState": "REQUESTED",
  "timeCreated": "2017-12-01T22:13:22.534Z",
  "label": "APPLIANCELABEL",
  "serialNumber": "serialnumber",
  "transferJobId": "ocid1.datatransferjob.oc1.phx.exampleuniqueID"
}

DataTransferDevice

The DataTransferDevice resource describes the operation of a user-provided data transfer hard disk.

Attributes

availabilityDomain

  • Required: no
  • Type: string

compartmentId

  • Required: yes
  • Type: string

displayName

  • Required: yes
  • Type: string

id

  • Required: yes
  • Type: string

lifecycleDetails

  • Required: no
  • Type: string

lifecycleState

  • Required: yes
  • Type: string

Allowed values are:

  • PREPARING
  • READY
  • PACKAGED
  • ACTIVE
  • PROCESSING
  • COMPLETE
  • MISSING
  • ERROR
  • DELETED
  • CANCELLED

timeCreated

  • Required: yes
  • Type: string

label

  • Required: yes
  • Type: string

serialNumber

  • Required: no
  • Type: string

transferJobId

  • Required: yes
  • Type: string

Example

{
  "availabilityDomain": "PHX-AD-2",
  "compartmentId": "ocid1.compartment.oc1..exampleuniqueID",
  "displayName": "data-transfer-job-1",
  "id": "DISKLABEL",
  "lifecycleDetails": "",
  "lifecycleState": "PROCESSING",
  "timeCreated": "2017-12-01T22:13:22.534Z",
  "label": "DISKLABEL",
  "serialNumber": "serialnumber",
  "transferJobId": "ocid1.datatransferjob.oc1.phx.exampleuniqueID",
}

DataTransferPackage

The DataTransferPackage resource describes the operation of a data transfer package associated with a disk-based data transfer.

Attributes

availabilityDomain

  • Required: no
  • Type: string

compartmentId

  • Required: yes
  • Type: string

displayName

  • Required: yes
  • Type: string

id

  • Required: yes
  • Type: string

lifecycleDetails

  • Required: no
  • Type: string

lifecycleState

  • Required: yes
  • Type: string

Allowed values are:

  • PREPARING
  • SHIPPING
  • RECEIVED
  • PROCESSING
  • PROCESSED
  • RETURNED
  • DELETED
  • CANCELLED
  • CANCELLED_RETURNED

timeCreated

  • Required: yes
  • Type: string

label

  • Required: yes
  • Type: string

transferJobId

  • Required: yes
  • Type: string

Example

{
  "availabilityDomain": "PHX-AD-2",
  "compartmentId": "ocid1.compartment.oc1..exampleuniqueID",
  "displayName": "data-transfer-job-1",
  "id": "PACKAGELABEL",
  "lifecycleDetails": "",
  "lifecycleState": "PROCESSING",
  "timeCreated": "2017-12-01T22:13:22.534Z",
  "label": "PACKAGELABEL",
  "transferJobId": "ocid1.datatransferjob.oc1.phx.exampleuniqueID",
}