SQL Server

List SQLServer

GEThttps://api.cegedim.cloud/itcare/databases/sqlserver

Query parameters

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

totalElementsinteger (int64)

totalPagesinteger (int32)

firstboolean

sizeinteger (int32)

contentarray of SQLServerV1 (object)

numberinteger (int32)

sortarray of SortObject (object)

pageablePageableObject (object)

numberOfElementsinteger (int32)

lastboolean

emptyboolean

Request

JavaScriptCurlPython

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

Response

200

{
  "totalElements": 0,
  "totalPages": 0,
  "first": false,
  "size": 0,
  "content": [
    {
      "id": 0,
      "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": 0,
      "cloudName": "text",
      "serviceId": 0,
      "serviceName": "text",
      "serviceKey": "text",
      "environment": "text",
      "endOfSupportAt": "2025-01-02T14:41:07.337Z",
      "supportPhase": "text",
      "creationUser": "text",
      "creationTime": "text",
      "releasedAt": "2025-01-02T14:41:07.337Z",
      "endOfSalesAt": "2025-01-02T14:41:07.337Z",
      "extendedSupportAt": "2025-01-02T14:41:07.337Z",
      "monitoringEnabled": false,
      "monitoringAlerting": false,
      "monitoringOnCallEnabled": false,
      "monitoringRequested": false,
      "replicationStatus": false,
      "backupStatus": false,
      "patchParty": {
        "excluded": false,
        "exclusionReason": "text",
        "patchGroup": "text",
        "patchDate": "2025-01-02T14:41:07.337Z",
        "patchTag": "text",
        "name": "text",
        "id": 0,
        "excludedBy": "text",
        "exclusionDate": "2025-01-02T14:41:07.337Z"
      },
      "metrologyUrl": "text",
      "path": "text",
      "resourceType": "text",
      "internalResourceId": 0,
      "backupPolicyDetails": {
        "backups": [
          {
            "id": 0,
            "type": "text",
            "backupSize": 0,
            "backupLastDate": "2025-01-02T14:41:07.337Z"
          }
        ],
        "policies": [
          {
            "name": "text",
            "label": "text",
            "scope": "text",
            "type": "text",
            "replication": false,
            "durationInHours": 0,
            "startTime": "text",
            "timezone": "text",
            "policyId": "text",
            "backupLastDate": "2025-01-02T14:41:07.337Z",
            "backupSize": 0
          }
        ]
      },
      "nodeCount": 0,
      "topology": "text",
      "version": "text",
      "sizing": "text",
      "network": {
        "id": 0,
        "technicalId": "text",
        "cidr": "text",
        "description": "text",
        "scope": "text",
        "defaultNetwork": false,
        "usedPercent": 0,
        "ipFreeNumber": 0,
        "ipAddress": "text",
        "dns": [
          {
            "alias": "text",
            "domain": "text"
          }
        ],
        "mask": "text",
        "networkShortDescription": "text",
        "isIpRangePublic": false,
        "cloud": "text",
        "environment": "text",
        "shortDescription": "text",
        "gateway": "text",
        "region": "text",
        "area": "text"
      },
      "availabilityZone": {
        "id": "text",
        "location": "text",
        "routable": false,
        "defaultZone": false,
        "datacenterId": "text",
        "availabilityZoneGroup": "text"
      },
      "area": {
        "id": "text",
        "location": "text",
        "regulation": "text",
        "defaultArea": false,
        "availabilityZones": [
          {
            "id": "text",
            "location": "text",
            "routable": false,
            "defaultZone": false,
            "datacenterId": "text",
            "availabilityZoneGroup": "text"
          }
        ]
      },
      "region": {
        "id": "text",
        "location": "text",
        "areas": [
          {
            "id": "text",
            "location": "text",
            "regulation": "text",
            "defaultArea": false,
            "availabilityZones": [
              {
                "id": "text",
                "location": "text",
                "routable": false,
                "defaultZone": false,
                "datacenterId": "text",
                "availabilityZoneGroup": "text"
              }
            ]
          }
        ],
        "dataCenter": "text"
      },
      "allowMonitoringDisplay": false,
      "cpu": 0,
      "ram": 0,
      "agOptions": {
        "agListener": "text",
        "agListenerIp": "text",
        "agName": "text",
        "agWitness": "text"
      }
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "text",
      "nullHandling": "text",
      "ascending": false,
      "property": "text",
      "ignoreCase": false
    }
  ],
  "pageable": {
    "offset": 0,
    "sort": [
      {
        "direction": "text",
        "nullHandling": "text",
        "ascending": false,
        "property": "text",
        "ignoreCase": false
      }
    ],
    "pageSize": 0,
    "pageNumber": 0,
    "paged": false,
    "unpaged": false
  },
  "numberOfElements": 0,
  "last": false,
  "empty": false
}

Create a SQL server instance

This method allows to create a SQL Server 2022 platform.

You will have to know at the minimum :

• name of the SQL server (name attribute). The name can contain any lowercase characters or numbers (5-60). It must not be the keyword 'cluster'.
• storage needed on each disk of the SQL server (volumes attribute). Initially, 5 disks are allocated and you can create one more. The first disk with id disk0 represents the "C: System", its maximum possible value is 70 and minimum is 1 (representing GB). disk1 represents "D: Root Instance", disk2 represents "E: User Databases", disk 3 represents "F: User Log" and disk4 represents "G: TempDB". The maximum possible value for these disks is 4096 and the minimum is 10 (representing GB).
• password to connect to the server (customerPassword attribute). The password must be At least one lowercase, one uppercase, one digit, one special character, minimum length must be 8.
• On which service the SQL server belongs to (serviceId attribute).
• network ID of the cluster (networkId attribute).
• the area where you want to host your cluster (area attribute).
• the database collation you want to use (collation attribute).
• the SQL server edition (edition attribute) whether it's "STD" or "ENT"

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

optional fields:

• Availability zone of the SQL server (az attribute) default az of area will be used if not provided
• Authentication domain (authenticationDomainId attribute)
• Whether SQL server is cluster AlwaysOn or standalone (alwaysOn attribute) default is false
• Installing SQL Server Integration Services (SSIS) (ssis attribute) default is false
• Installing SQL Server Reporting Services (SSRS) (ssrs attribute) default is false
• Installing SQL Server Analysis Services (SSAS) (ssas attribute) default is false
• Modelisation type (asServerModeStd attribute) which will be considered only if ssas is true
• Collation for Analysis Services (asCollation attribute) which will be considered only if ssas is true
• Whether Full-Text search is enabled or not (fullText attribute) default is false
• Availability mode when sql server is cluster AlwaysOn (availabilityMode attribute)
• Failover mode when sql server is cluster AlwaysOn (failoverMode attribute)
• Readable secondary when sql server is cluster AlwaysOn (readableSecondary attribute)
• Witness when sql server is cluster AlwaysOn (witness attribute)
• Listener name when sql server is cluster AlwaysOn (listenerName attribute)

POST /sqlserver
{
   "name":"RSQL22",
   "nodeSizing":"2cpu8gb",
   "volumes":[
      {
         "id":"disk3",
         "sizeGb":10
      },
      {
         "id":"disk4",
         "sizeGb":10
      },
      {
         "id":"disk2",
         "sizeGb":30
      },
      {
         "id":"disk1",
         "sizeGb":30
      },
      {
         "id":"disk0",
         "sizeGb":70
      }
   ],
   "area":"EB-QA",
   "customerPassword":"P@ssw0rd",
   "collation":"French_BIN",
   "edition":"STD",
   "serviceId":2423,
   "networkId":5000802
}

POSThttps://api.cegedim.cloud/itcare/databases/sqlserver

Body

application/vnd.cegedim-it.v1+json

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.

area*string

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

nodeSizing*string

Node sizing for cluster

networkId*integer (int64)

The network Id of the ELS cluster

platform*string

Product platform of the cluster

name*string

Name of SQL Server

prefixstring

Prefix name of SQL Server

specificRequeststring

specific request to be done by an administrator. Can differ delivery of instance up to 24h., example: Could you please install .NET framework 4.5 on instance ? Thanks.

volumes*array of VolumeProfile (object)

Volumes to setup on instance. If absent, will be set to defaults.

az*string

Availability zone of SQL Server

edition*string

SQL Server edition, example: ENT

authenticationDomainIdstring

authentication domain id, example: CGDM-EMEA

nodeCountinteger (int32)

cluster nodes number, example: 3

alwaysOnboolean

Cluster/Basic Always On, example: true

listenerNamestring

Cluster listener name, example: rhusqllsnr01

customerPassword*string

Customer Password

collation*string

Database Collation, example: French_BIN

ssisboolean

SQL Server Integration Services (SSIS)

ssrsboolean

SQL Server Reporting Services (SSRS)

ssasboolean

SQL Server Analysis Services (SSAS)

asServerModeStdstring

Modelisation type, example: TABULAR

asCollactionstring

Collation for Analysis Services

asServerModeEntstring

Modelisation type

fullTextboolean

Whether Full-Text search is enabled or not

availabilityModestring

Cluster availability mode, example: Synchronous_commit

failoverModestring

Cluster failover mode, example: Read-intent_only

readableSecondarystring

Cluster readable secondary, example: YES, NO, READ_ONLY

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

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

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/databases/sqlserver', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.cegedim-it.v1+json"
    },
    body: JSON.stringify({
      "area": "text",
      "az": "text",
      "collation": "text",
      "customerPassword": "text",
      "edition": "text",
      "name": "text",
      "networkId": 0,
      "nodeSizing": "text",
      "platform": "text",
      "region": "text",
      "serviceId": 0,
      "volumes": [
        {
          "id": "data",
          "sizeGb": 0
        }
      ]
    }),
});
const data = await response.json();

Response

200

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 0,
  "internalId": 0,
  "resourceName": "text",
  "resourceType": "text",
  "family": "text",
  "lastUpdatedAt": "2025-01-02T14:41:07.337Z"
}

get SQLServer instance by its id

GEThttps://api.cegedim.cloud/itcare/databases/sqlserver/{id}

Path parameters

id*integer (int64)

id, example: 123

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

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

Storage Replication Enabled - The farm has replicated storage

backupStatusboolean

Indicates backup is active on the host

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

nodeCountinteger (int64)

Number of Nodes

topologystring

High availability mode status

versionstring

Version of the Farm

sizingstring

Size profile

networkNetworkV1 (object)

availabilityZoneAvailabilityZoneV1 (object)

areaAreaV1 (object)

regionRegionV1 (object)

allowMonitoringDisplayboolean

cpuinteger (int64)

raminteger (int64)

agOptionsSQLServerAgOptionsV1 (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "id": 0,
  "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": 0,
  "cloudName": "text",
  "serviceId": 0,
  "serviceName": "text",
  "serviceKey": "text",
  "environment": "text",
  "endOfSupportAt": "2025-01-02T14:41:07.337Z",
  "supportPhase": "text",
  "creationUser": "text",
  "creationTime": "text",
  "releasedAt": "2025-01-02T14:41:07.337Z",
  "endOfSalesAt": "2025-01-02T14:41:07.337Z",
  "extendedSupportAt": "2025-01-02T14:41:07.337Z",
  "monitoringEnabled": false,
  "monitoringAlerting": false,
  "monitoringOnCallEnabled": false,
  "monitoringRequested": false,
  "replicationStatus": false,
  "backupStatus": false,
  "patchParty": {
    "excluded": false,
    "exclusionReason": "text",
    "patchGroup": "text",
    "patchDate": "2025-01-02T14:41:07.337Z",
    "patchTag": "text",
    "name": "text",
    "id": 0,
    "excludedBy": "text",
    "exclusionDate": "2025-01-02T14:41:07.337Z"
  },
  "metrologyUrl": "text",
  "path": "text",
  "resourceType": "text",
  "internalResourceId": 0,
  "backupPolicyDetails": {
    "backups": [
      {
        "id": 0,
        "type": "text",
        "backupSize": 0,
        "backupLastDate": "2025-01-02T14:41:07.337Z"
      }
    ],
    "policies": [
      {
        "name": "text",
        "label": "text",
        "scope": "text",
        "type": "text",
        "replication": false,
        "durationInHours": 0,
        "startTime": "text",
        "timezone": "text",
        "policyId": "text",
        "backupLastDate": "2025-01-02T14:41:07.337Z",
        "backupSize": 0
      }
    ]
  },
  "nodeCount": 0,
  "topology": "text",
  "version": "text",
  "sizing": "text",
  "network": {
    "id": 0,
    "technicalId": "text",
    "cidr": "text",
    "description": "text",
    "scope": "text",
    "defaultNetwork": false,
    "usedPercent": 0,
    "ipFreeNumber": 0,
    "ipAddress": "text",
    "dns": [
      {
        "alias": "text",
        "domain": "text"
      }
    ],
    "mask": "text",
    "networkShortDescription": "text",
    "isIpRangePublic": false,
    "cloud": "text",
    "environment": "text",
    "shortDescription": "text",
    "gateway": "text",
    "region": "text",
    "area": "text"
  },
  "availabilityZone": {
    "id": "text",
    "location": "text",
    "routable": false,
    "defaultZone": false,
    "datacenterId": "text",
    "availabilityZoneGroup": "text"
  },
  "area": {
    "id": "text",
    "location": "text",
    "regulation": "text",
    "defaultArea": false,
    "availabilityZones": [
      {
        "id": "text",
        "location": "text",
        "routable": false,
        "defaultZone": false,
        "datacenterId": "text",
        "availabilityZoneGroup": "text"
      }
    ]
  },
  "region": {
    "id": "text",
    "location": "text",
    "areas": [
      {
        "id": "text",
        "location": "text",
        "regulation": "text",
        "defaultArea": false,
        "availabilityZones": [
          {
            "id": "text",
            "location": "text",
            "routable": false,
            "defaultZone": false,
            "datacenterId": "text",
            "availabilityZoneGroup": "text"
          }
        ]
      }
    ],
    "dataCenter": "text"
  },
  "allowMonitoringDisplay": false,
  "cpu": 0,
  "ram": 0,
  "agOptions": {
    "agListener": "text",
    "agListenerIp": "text",
    "agName": "text",
    "agWitness": "text"
  }
}

Delete an existing SQL Server instance

This method allows to delete a SQL Server instance.

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

• by id

DELETE /compute/databases/sqlserver/1234

• by id and changeReference (RFC)

DELETE /compute/databases/sqlserver/1234
{
	"changeReference": "56789"
}

DELETEhttps://api.cegedim.cloud/itcare/databases/sqlserver/{id}

Path parameters

id*integer (int64)

id, example: 123

Body

application/json

changeReferencestring

Optional reference for change

Response

202400

Accepted

Body

application/vnd.cegedim-it.v1+json

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

JavaScriptCurlPython

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

Response

202

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 0,
  "internalId": 0,
  "resourceName": "text",
  "resourceType": "text",
  "family": "text",
  "lastUpdatedAt": "2025-01-02T14:41:07.337Z"
}

Performs update actions to an existing SQLServer instance

This method allows to update a SQL Server Farm.

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 SQL Server Farm

Use the start operation to start the SQL Server Farm.

This method is synchronous (status code 202).

Example :

PATCH /compute/databases/sqlserver/1234
{
    "operation": "start"
}

Stop SQL Server Farm

Use the stop operation to stop the SQL Server Farm.

This operation cannot be undone afterwards.

This method is synchronous (status code 202).

• by SQL Server id

PATCH /compute/databases/sqlserver/1234
{
	"operation": "stop"
}

• by sql server id and changeReference number (RFC)

PATCH /compute/databases/sqlserver/1234
{
	"operation": "stop",
	"options": {
	    "changeReference": "56789"
	}
}

Reset SQLServer Farm

Use the reset operation to reset the SQL Server Farm.

This method is synchronous (status code 202).

Example :

PATCH /compute/databases/sqlserver/1234
{
    "operation": "reset"
}

Resize SQLServer instance

Use the resize operation to resize the nodes of the SQLServer instance and the instance itself.

This operation cannot be undone afterwards.

This method is asynchronous (status code 202).

PATCH /compute/databases/sqlserver/1234
{
	"operation":"resize",
	"options": {
        "sizing": "2cpu4gb"
    }
}

Update Monitoring

Use the update_monitoring operation to update the monitoring state of the SQL Server.

Use the state option to turn on/off monitoring. Use the on_call option to turn on/off 24/7 monitoring.

This method is synchronous (status code 202).

PATCH /compute/databases/sqlserver/1234
{
  "operation": "update_monitoring",
  "options": {
       "state": true,
       "on_call": true
 }
}

Update Patch Party

Use the update_patch_party operation to update the patch party scheduled plan of the SQLServer.

• Use the excluded option to turn on/off patch party.
• Use the patchGroup option to select the patching group, the patchGroup is optional, and is only allowed when the farm has one member.
• Use the exclusionReason option to explain the reason of excluding the resource from patch part.

This method is synchronous (status code 202).

• Include from patch party body:

PATCH /compute/databases/sqlserver/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": false,
        "patchGroup": "3"
    }
 }
}

• Exclude from patch party body:

PATCH /compute/databases/sqlserver/1234
{
  "operation": "update_patch_party",
  "options": {
    "patchParty": {
        "excluded": true,
        "exclusionReason": "I want to handle this by myself"
    }
 }
}

PATCHhttps://api.cegedim.cloud/itcare/databases/sqlserver/{id}

Path parameters

id*integer (int64)

id, example: 123

Body

application/vnd.cegedim-it.v1+json

operation*string

Operation to perform on target object, example: operation_name

optionsobject

Specific payload to pass to have the operation performed. Refer to documentation for each operation.

Response

202400

Accepted

Body

application/vnd.cegedim-it.v1+json

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

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/databases/sqlserver/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/vnd.cegedim-it.v1+json"
    },
    body: JSON.stringify({
      "operation": "text"
    }),
});
const data = await response.json();

Response

202

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 0,
  "internalId": 0,
  "resourceName": "text",
  "resourceType": "text",
  "family": "text",
  "lastUpdatedAt": "2025-01-02T14:41:07.337Z"
}

Verify the existence of a FARM_MSSQL by FARM_AG_LISTENER.

HEADhttps://api.cegedim.cloud/itcare/databases/sqlserver/{name}

Path parameters

name*string

Query parameters

Response

200400

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.cegedim.cloud/itcare/databases/sqlserver/{name}', {
    method: 'HEAD',
    headers: {},
});
const data = await response.json();

Get a SQLServer node informations

GEThttps://api.cegedim.cloud/itcare/databases/sqlserver/{id}/nodes

Path parameters

id*integer (int64)

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

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

patchPartyPatchPartyV1 (object)

Representation of a resource patch party

metrologyUrlstring

pathstring

resourceTypestring

internalResourceIdinteger (int64)

backupPolicyDetailsBackupPolicyDetailsV1 (object)

ipAddressstring

networkNetworkV1 (object)

storageInformationStorageInformationV1 (object)

Information about a Storage of an Instance

availabilityZoneAvailabilityZoneV1 (object)

areaAreaV1 (object)

regionRegionV1 (object)

backupBackupV1 (object)

Backup information on an instance

replicationReplicationV1 (object)

Replication information on an instance

snapshotSnapshotV1 (object)

Snapshot of an instance

labelRegionstring

Region pretty name

labelDataCenterstring

DataCenter pretty name

labelAreastring

Area pretty name

labelAvailabilityZonestring

Availability Zone pretty name

totalSizeDisksstring

Total Disk size of the resource

cpuinteger (int64)

CPU of the resource

raminteger (int64)

RAM of the resource

storagenumber

Storage after disks format in GB of the resource

isMemberOFLoadBalancerboolean

Instance is member of load balancer

loadbalancersarray of LoadbalancerInfoV1 (object)

imageCodestring

Internal Image linked to this instance

osNamestring

OS name of this instance

osTypestring

OS type of this instance

isExternalIngressNodeboolean

This instance is ingress external node

isInternalIngressNodeboolean

This instance is ingress internal node

storageMoveInProgressboolean

Information about storage replication in Progress

authenticationDomainstring

parentResourceTypestring

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "id": 0,
    "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": 0,
    "cloudName": "text",
    "serviceId": 0,
    "serviceName": "text",
    "serviceKey": "text",
    "environment": "text",
    "endOfSupportAt": "2025-01-02T14:41:07.337Z",
    "supportPhase": "text",
    "creationUser": "text",
    "creationTime": "text",
    "releasedAt": "2025-01-02T14:41:07.337Z",
    "endOfSalesAt": "2025-01-02T14:41:07.337Z",
    "extendedSupportAt": "2025-01-02T14:41:07.337Z",
    "monitoringEnabled": false,
    "monitoringAlerting": false,
    "monitoringOnCallEnabled": false,
    "monitoringRequested": false,
    "replicationStatus": false,
    "backupStatus": false,
    "patchParty": {
      "excluded": false,
      "exclusionReason": "text",
      "patchGroup": "text",
      "patchDate": "2025-01-02T14:41:07.337Z",
      "patchTag": "text",
      "name": "text",
      "id": 0,
      "excludedBy": "text",
      "exclusionDate": "2025-01-02T14:41:07.337Z"
    },
    "metrologyUrl": "text",
    "path": "text",
    "resourceType": "text",
    "internalResourceId": 0,
    "backupPolicyDetails": {
      "backups": [
        {
          "id": 0,
          "type": "text",
          "backupSize": 0,
          "backupLastDate": "2025-01-02T14:41:07.337Z"
        }
      ],
      "policies": [
        {
          "name": "text",
          "label": "text",
          "scope": "text",
          "type": "text",
          "replication": false,
          "durationInHours": 0,
          "startTime": "text",
          "timezone": "text",
          "policyId": "text",
          "backupLastDate": "2025-01-02T14:41:07.337Z",
          "backupSize": 0
        }
      ]
    },
    "ipAddress": "text",
    "network": {
      "id": 0,
      "technicalId": "text",
      "cidr": "text",
      "description": "text",
      "scope": "text",
      "defaultNetwork": false,
      "usedPercent": 0,
      "ipFreeNumber": 0,
      "ipAddress": "text",
      "dns": [
        {
          "alias": "text",
          "domain": "text"
        }
      ],
      "mask": "text",
      "networkShortDescription": "text",
      "isIpRangePublic": false,
      "cloud": "text",
      "environment": "text",
      "shortDescription": "text",
      "gateway": "text",
      "region": "text",
      "area": "text"
    },
    "storageInformation": {
      "totalSizeDisks": 0,
      "fileSystems": [
        {
          "mountingPoint": "text",
          "type": "text",
          "sizeOf": 0,
          "free": 0
        }
      ],
      "totalSizeFileSystems": 0
    },
    "availabilityZone": {
      "id": "text",
      "location": "text",
      "routable": false,
      "defaultZone": false,
      "datacenterId": "text",
      "availabilityZoneGroup": "text"
    },
    "area": {
      "id": "text",
      "location": "text",
      "regulation": "text",
      "defaultArea": false,
      "availabilityZones": [
        {
          "id": "text",
          "location": "text",
          "routable": false,
          "defaultZone": false,
          "datacenterId": "text",
          "availabilityZoneGroup": "text"
        }
      ]
    },
    "region": {
      "id": "text",
      "location": "text",
      "areas": [
        {
          "id": "text",
          "location": "text",
          "regulation": "text",
          "defaultArea": false,
          "availabilityZones": [
            {
              "id": "text",
              "location": "text",
              "routable": false,
              "defaultZone": false,
              "datacenterId": "text",
              "availabilityZoneGroup": "text"
            }
          ]
        }
      ],
      "dataCenter": "text"
    },
    "backup": {
      "backupSystem": "text",
      "size": 0,
      "type": "text",
      "filesNb": 0,
      "lastDate": "2025-01-02T14:41:07.337Z"
    },
    "replication": {
      "storageClass": "text",
      "storageReplicationClass": "text",
      "storageClassOverride": "text",
      "storageMoveInProgress": false,
      "storageMoveTicket": "text",
      "noStoRplExplanation": "text"
    },
    "snapshot": {
      "id": "text",
      "label": "text",
      "createdBy": "text",
      "createdAt": "2025-01-02T14:41:07.337Z",
      "recoveredAt": "2025-01-02T14:41:07.337Z",
      "expiresAt": "2025-01-02T14:41:07.337Z",
      "description": "text",
      "changeReference": "text",
      "snapshotSize": 0
    },
    "labelRegion": "text",
    "labelDataCenter": "text",
    "labelArea": "text",
    "labelAvailabilityZone": "text",
    "totalSizeDisks": "text",
    "cpu": 0,
    "ram": 0,
    "storage": 0,
    "isMemberOFLoadBalancer": false,
    "loadbalancers": [
      {
        "id": 0,
        "name": "text",
        "status": "text",
        "monitoringEnabled": false,
        "memberCount": 0,
        "serviceId": 0
      }
    ],
    "imageCode": "text",
    "osName": "text",
    "osType": "text",
    "isExternalIngressNode": false,
    "isInternalIngressNode": false,
    "storageMoveInProgress": false,
    "authenticationDomain": "text",
    "parentResourceType": "text"
  }
]

Get a SQLServer network informations

GEThttps://api.cegedim.cloud/itcare/databases/sqlserver/{id}/networks

Path parameters

id*integer (int64)

Response

200400

OK

Body

application/vnd.cegedim-it.v1+json

idinteger (int64)

technicalIdstring

cidrstring

descriptionstring

scopestring

defaultNetworkboolean

usedPercentinteger (int32)

ipFreeNumberinteger (int32)

ipAddressstring

dnsarray of DNSV1 (object)

maskstring

networkShortDescriptionstring

isIpRangePublicboolean

cloudstring

environmentstring

shortDescriptionstring

gatewaystring

regionstring

areastring

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "id": 0,
    "technicalId": "text",
    "cidr": "text",
    "description": "text",
    "scope": "text",
    "defaultNetwork": false,
    "usedPercent": 0,
    "ipFreeNumber": 0,
    "ipAddress": "text",
    "dns": [
      {
        "alias": "text",
        "domain": "text"
      }
    ],
    "mask": "text",
    "networkShortDescription": "text",
    "isIpRangePublic": false,
    "cloud": "text",
    "environment": "text",
    "shortDescription": "text",
    "gateway": "text",
    "region": "text",
    "area": "text"
  }
]