Overdrive

PreviousGlusterfs NextTopology

Last updated 1 month ago

List OverDrive Instances

GEThttps://api.cegedim.cloud/itcare/storage/overdrive

Authorization

Query parameters

Response

Body

totalElementsinteger (int64)

totalPagesinteger (int32)

firstboolean

sizeinteger (int32)

contentarray of object

numberinteger (int32)

sortarray of object

pageableobject

numberOfElementsinteger (int32)

lastboolean

emptyboolean

Request

const response = await fetch('https://api.cegedim.cloud/itcare/storage/overdrive', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "totalElements": 1,
  "totalPages": 1,
  "first": true,
  "size": 1,
  "content": [
    {
      "id": 1,
      "name": "text",
      "type": "text",
      "internalType": "text",
      "status": "text",
      "category": "text",
      "technology": "text",
      "family": "text",
      "label": "text",
      "comment": "text",
      "productCode": "text",
      "productName": "text",
      "productVersion": "text",
      "cloudId": 1,
      "cloudName": "text",
      "serviceId": 1,
      "serviceName": "text",
      "serviceKey": "text",
      "environment": "text",
      "endOfSupportAt": "2025-02-05T04:05:34.902Z",
      "supportPhase": "text",
      "creationUser": "text",
      "creationTime": "text",
      "releasedAt": "2025-02-05T04:05:34.902Z",
      "endOfSalesAt": "2025-02-05T04:05:34.902Z",
      "extendedSupportAt": "2025-02-05T04:05:34.902Z",
      "monitoringEnabled": true,
      "monitoringAlerting": true,
      "monitoringOnCallEnabled": true,
      "monitoringRequested": true,
      "replicationStatus": true,
      "backupStatus": true,
      "patchParty": {
        "excluded": true,
        "exclusionReason": "text",
        "patchGroup": "text",
        "patchDate": "2025-02-05T04:05:34.902Z",
        "patchTag": "text",
        "name": "text",
        "id": 1,
        "excludedBy": "text",
        "exclusionDate": "2025-02-05T04:05:34.902Z"
      },
      "metrologyUrl": "text",
      "path": "text",
      "resourceType": "text",
      "internalResourceId": 1,
      "backupPolicyDetails": {
        "backups": [
          {
            "id": 1,
            "type": "text",
            "backupSize": 1,
            "backupLastDate": "2025-02-05T04:05:34.902Z"
          }
        ],
        "policies": [
          {
            "name": "text",
            "label": "text",
            "scope": "text",
            "type": "text",
            "replication": true,
            "frequencies": {},
            "durationInHours": 1,
            "startTime": "text",
            "timezone": "text",
            "policyId": "text",
            "backupLastDate": "2025-02-05T04:05:34.902Z",
            "backupSize": 1
          }
        ]
      },
      "version": "text",
      "url": "text",
      "sizing": "text",
      "availableActions": [
        {
          "operation": "text",
          "available": true,
          "unavailabilityCauses": [
            "text"
          ]
        }
      ],
      "actionsInProgress": [
        {
          "process": "text",
          "status": "SUCCESS,IN_PROGRESS,ERROR",
          "message": "text",
          "id": 1,
          "internalId": 1,
          "resourceName": "text",
          "resourceType": "text",
          "family": "text",
          "lastUpdatedAt": "2025-02-05T04:05:34.902Z"
        }
      ]
    }
  ],
  "number": 1,
  "sort": [
    {
      "direction": "text",
      "nullHandling": "text",
      "ascending": true,
      "property": "text",
      "ignoreCase": true
    }
  ],
  "pageable": {
    "offset": 1,
    "sort": [
      {
        "direction": "text",
        "nullHandling": "text",
        "ascending": true,
        "property": "text",
        "ignoreCase": true
      }
    ],
    "pageSize": 1,
    "pageNumber": 1,
    "paged": true,
    "unpaged": true
  },
  "numberOfElements": 1,
  "last": true,
  "empty": true
}

Create an OverDrive instance

This method allows to create an OverDrive instance.

You will have to know at the minimum :

where you want to host your instance (region attribute)
name of instance (name attribute)
sizing of the instance (sizing attribute). The possible values are : XS (Up to 50 users total), S(Up to 1M ppm), M(Up to 10M ppm), L(Up to 100M ppm), XL(More than 100M ppm)
how to connect to the instance (password attribute). The password must be At least one lowercase, one uppercase, one digit, one special character, minimum length must be 12.
On which service the OverDrive instance belongs to (serviceId attribute).
Define the Drive URL to be configured in your service (driveSiteUri).

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

POST /storage/overdrive
{
	"name": "poverdrive01",
	"region": "EB",
	"sizing":"XS",
	"serviceId":"123",
	"password": "Password!!??",
	"driveSiteUri": "demo.mydrive.cegedim.cloud"
	
}

POSThttps://api.cegedim.cloud/itcare/storage/overdrive

Authorization

Body

serviceId*integer (int64)

id of service to put instance in.

regulationstring

Regulation. Refer to the regulation of the Area (HDS|STANDARD). If absent, default 'STANDARD' will be used.

region*string

Region. that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.

cloudIdinteger (int64)

monitoringEnabledboolean

Indicates if monitoring will be setup. If absent, it will be automatically be setup if this is an production environment, or if backup is enabled.

noMonitoringProdReasonstring

Indicates why a production resource is not under monitoring.

onCallSupervisionboolean

Indicates if on call teams will be called on non business hours if an incident occurs on instance. If absent, set to false.

monitoringAlertingboolean

Indicates if alerting should be activated. If absent, set to false.

backupEnabledboolean

Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.

noBackupProdReasonstring

Indicates why a production resource is not under backup.

replicationEnabledboolean

Indicates if replication will be setup. If absent, it will be automatically be setup if this is an production environment

noReplicationProdReasonstring

Indicates why a production resource is not replicated.

serverBackupPolicyIdstring

BackupPolicy id. Refers to desired backup policy to be applied for the virtual machine, must be set when backup is enabled.

dbBackupPolicyIdstring

BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.

sizing*string

Sizing. L, XL , XS, S, M. Sizing for OverDrive instances

password*string

Password to connect to the OverDrive instance.

name*string

Name of OverDrive Instance

Pattern: [a-z0-9\-]{4,60}$

driveSiteUri*string

Define the Drive URL to be configured in OverDrive

Response

Body

processstring

Code of action performed

statusenum

Status label of action

SUCCESS,IN_PROGRESS,ERROR

messagestring

Human readable message of status

idinteger (int32)

internalIdinteger (int64)

resourceNamestring

resourceTypestring

familystring

lastUpdatedAtstring (date-time)

Request

const response = await fetch('https://api.cegedim.cloud/itcare/storage/overdrive', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.cegedim-it.v1+json"
    },
    body: JSON.stringify({
      "serviceId": 1,
      "region": "text",
      "sizing": "text",
      "password": "text",
      "name": "text",
      "driveSiteUri": "text"
    }),
});
const data = await response.json();

Response

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 1,
  "internalId": 1,
  "resourceName": "text",
  "resourceType": "text",
  "family": "text",
  "lastUpdatedAt": "2025-02-05T04:05:34.902Z"
}

Get an OverDrive Instance

GEThttps://api.cegedim.cloud/itcare/storage/overdrive/{id}

Authorization

Path parameters

id*integer (int64)

id, example: 123

Response

Body

idinteger (int64)

namestring

typestring

internalTypestring

statusstring

categorystring

technologystring

familystring

labelstring

commentstring

productCodestring

productNamestring

productVersionstring

cloudIdinteger (int64)

cloudNamestring

serviceIdinteger (int64)

serviceNamestring

serviceKeystring

environmentstring

endOfSupportAtstring (date-time)

supportPhasestring

creationUserstring

creationTimestring

releasedAtstring (date-time)

endOfSalesAtstring (date-time)

extendedSupportAtstring (date-time)

monitoringEnabledboolean

monitoringAlertingboolean

monitoringOnCallEnabledboolean

monitoringRequestedboolean

replicationStatusboolean

backupStatusboolean

patchPartyobject

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsobject

versionstring

urlstring

sizingstring

availableActionsarray of object

actionsInProgressarray of object

Request

const response = await fetch('https://api.cegedim.cloud/itcare/storage/overdrive/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": 1,
  "name": "text",
  "type": "text",
  "internalType": "text",
  "status": "text",
  "category": "text",
  "technology": "text",
  "family": "text",
  "label": "text",
  "comment": "text",
  "productCode": "text",
  "productName": "text",
  "productVersion": "text",
  "cloudId": 1,
  "cloudName": "text",
  "serviceId": 1,
  "serviceName": "text",
  "serviceKey": "text",
  "environment": "text",
  "endOfSupportAt": "2025-02-05T04:05:34.902Z",
  "supportPhase": "text",
  "creationUser": "text",
  "creationTime": "text",
  "releasedAt": "2025-02-05T04:05:34.902Z",
  "endOfSalesAt": "2025-02-05T04:05:34.902Z",
  "extendedSupportAt": "2025-02-05T04:05:34.902Z",
  "monitoringEnabled": true,
  "monitoringAlerting": true,
  "monitoringOnCallEnabled": true,
  "monitoringRequested": true,
  "replicationStatus": true,
  "backupStatus": true,
  "patchParty": {
    "excluded": true,
    "exclusionReason": "text",
    "patchGroup": "text",
    "patchDate": "2025-02-05T04:05:34.902Z",
    "patchTag": "text",
    "name": "text",
    "id": 1,
    "excludedBy": "text",
    "exclusionDate": "2025-02-05T04:05:34.902Z"
  },
  "metrologyUrl": "text",
  "path": "text",
  "resourceType": "text",
  "internalResourceId": 1,
  "backupPolicyDetails": {
    "backups": [
      {
        "id": 1,
        "type": "text",
        "backupSize": 1,
        "backupLastDate": "2025-02-05T04:05:34.902Z"
      }
    ],
    "policies": [
      {
        "name": "text",
        "label": "text",
        "scope": "text",
        "type": "text",
        "replication": true,
        "frequencies": {},
        "durationInHours": 1,
        "startTime": "text",
        "timezone": "text",
        "policyId": "text",
        "backupLastDate": "2025-02-05T04:05:34.902Z",
        "backupSize": 1
      }
    ]
  },
  "version": "text",
  "url": "text",
  "sizing": "text",
  "availableActions": [
    {
      "operation": "text",
      "available": true,
      "unavailabilityCauses": [
        "text"
      ]
    }
  ],
  "actionsInProgress": [
    {
      "process": "text",
      "status": "SUCCESS,IN_PROGRESS,ERROR",
      "message": "text",
      "id": 1,
      "internalId": 1,
      "resourceName": "text",
      "resourceType": "text",
      "family": "text",
      "lastUpdatedAt": "2025-02-05T04:05:34.902Z"
    }
  ]
}

Delete an OverDrive instance

This method allows to delete an Overdrive instance.

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

DELETE /storage/overdrive/123

DELETEhttps://api.cegedim.cloud/itcare/storage/overdrive/{id}

Authorization

Path parameters

id*integer (int64)

id, example: 123

Response

Body

processstring

Code of action performed

statusenum

Status label of action

SUCCESS,IN_PROGRESS,ERROR

messagestring

Human readable message of status

idinteger (int32)

internalIdinteger (int64)

resourceNamestring

resourceTypestring

familystring

lastUpdatedAtstring (date-time)

Request

const response = await fetch('https://api.cegedim.cloud/itcare/storage/overdrive/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 1,
  "internalId": 1,
  "resourceName": "text",
  "resourceType": "text",
  "family": "text",
  "lastUpdatedAt": "2025-02-05T04:05:34.902Z"
}

Update an OverDrive instance

This method allows to update an Overdrive instance.

Structure of payload is generic and describes :

operation you want to be performed
options data relative to the operation performed - see details - optional.

Below are different operations currently implemented.

Start Overdrive instance

Use the start operation to start an Overdrive instance.

Starts overdrive instance.

This method is synchronous (status code 202).

Example :

PATCH /storage/overdrive/1234
{
    "operation": "start"
}

Stop Overdrive instance

Use the stop operation to stop the nodes of the Overdrive instance and the instance itself.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

PATCH /storage/overdrive/1234
{
	"operation":"stop"
}

PATCHhttps://api.cegedim.cloud/itcare/storage/overdrive/{id}

Authorization

Path parameters

id*integer (int64)

id, example: 123

Body

operationstring

optionsobject

Response

Body

processstring

Code of action performed

statusenum

Status label of action

SUCCESS,IN_PROGRESS,ERROR

messagestring

Human readable message of status

idinteger (int32)

internalIdinteger (int64)

resourceNamestring

resourceTypestring

familystring

lastUpdatedAtstring (date-time)

Request

const response = await fetch('https://api.cegedim.cloud/itcare/storage/overdrive/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "options": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }),
});
const data = await response.json();

Response

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 1,
  "internalId": 1,
  "resourceName": "text",
  "resourceType": "text",
  "family": "text",
  "lastUpdatedAt": "2025-02-05T04:05:34.902Z"
}