Get DBaaS

GET 
/projects/:projectId/providers/Aruba.Database/dbaas/:id

Get DBaaS

Request

Path Parameters

projectId stringrequired
id stringrequired

unique identifier of the dbaas

Query Parameters

ignoreDeletedStatus boolean

if the resource exists in status "Deleted", returns NotFound according to the value of this flag

api-version string
The requested API version
Default value: 1

Responses

200

OK

text/plain

Schema

Schema

metadata

object

idstringnullable

uristringnullable

namestringnullable

location

object

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

idstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

isDisabledboolean

reasonsstring[]

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

Dto properties response dbaas.

linkedResources

object[]

Array [

uristringnullable

strictCorrelationboolean

]

engine

object

Engine response class.

idstringnullable

typestringnullable

namestringnullable

versionstringnullable

dataCenterstringnullable

For more information, check the documentation.

privateIpAddressstringnullable

flavor

object

Engine response class.

namestringnullable

categorystringnullable

cpuint32nullable

ramint32nullable

networking

object

Network response class.

vpc

object

uristringnullable

subnet

object

uristringnullable

securityGroup

object

uristringnullable

elasticIp

object

uristringnullable

storage

object

Storage response class.

sizeGbint32nullable

billingPlan

object

BillingPlan response class.

billingPeriodstringnullable

autoscaling

object

Autoscaling

statusstringnullable

availableSpaceint32nullable

stepSizeint32nullable

ruleIdstringnullable

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "string",
    "location": {
      "code": "string",
      "country": "string",
      "city": "string",
      "name": "string",
      "value": "string"
    },
    "project": {
      "id": "string"
    },
    "tags": [
      "string"
    ],
    "category": {
      "name": "string",
      "provider": "string",
      "typology": {
        "id": "string",
        "name": "string"
      }
    },
    "creationDate": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "updateDate": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string",
    "version": "string",
    "createdUser": "string",
    "updatedUser": "string"
  },
  "status": {
    "state": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "disableStatusInfo": {
      "isDisabled": true,
      "reasons": [
        "string"
      ],
      "previousStatus": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z"
      }
    },
    "failureReason": "string"
  },
  "properties": {
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "engine": {
      "id": "string",
      "type": "string",
      "name": "string",
      "version": "string"
    },
    "dataCenter": "string",
    "privateIpAddress": "string",
    "flavor": {
      "name": "string",
      "category": "string",
      "cpu": 0,
      "ram": 0
    },
    "networking": {
      "vpc": {
        "uri": "string"
      },
      "subnet": {
        "uri": "string"
      },
      "securityGroup": {
        "uri": "string"
      },
      "elasticIp": {
        "uri": "string"
      }
    },
    "storage": {
      "sizeGb": 0
    },
    "billingPlan": {
      "billingPeriod": "string"
    },
    "autoscaling": {
      "status": "string",
      "availableSpace": 0,
      "stepSize": 0,
      "ruleId": "string"
    }
  }
}

application/json

Schema

Schema

metadata

object

idstringnullable

uristringnullable

namestringnullable

location

object

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

idstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

isDisabledboolean

reasonsstring[]

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

Dto properties response dbaas.

linkedResources

object[]

Array [

uristringnullable

strictCorrelationboolean

]

engine

object

Engine response class.

idstringnullable

typestringnullable

namestringnullable

versionstringnullable

dataCenterstringnullable

For more information, check the documentation.

privateIpAddressstringnullable

flavor

object

Engine response class.

namestringnullable

categorystringnullable

cpuint32nullable

ramint32nullable

networking

object

Network response class.

vpc

object

uristringnullable

subnet

object

uristringnullable

securityGroup

object

uristringnullable

elasticIp

object

uristringnullable

storage

object

Storage response class.

sizeGbint32nullable

billingPlan

object

BillingPlan response class.

billingPeriodstringnullable

autoscaling

object

Autoscaling

statusstringnullable

availableSpaceint32nullable

stepSizeint32nullable

ruleIdstringnullable

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "string",
    "location": {
      "code": "string",
      "country": "string",
      "city": "string",
      "name": "string",
      "value": "string"
    },
    "project": {
      "id": "string"
    },
    "tags": [
      "string"
    ],
    "category": {
      "name": "string",
      "provider": "string",
      "typology": {
        "id": "string",
        "name": "string"
      }
    },
    "creationDate": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "updateDate": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string",
    "version": "string",
    "createdUser": "string",
    "updatedUser": "string"
  },
  "status": {
    "state": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "disableStatusInfo": {
      "isDisabled": true,
      "reasons": [
        "string"
      ],
      "previousStatus": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z"
      }
    },
    "failureReason": "string"
  },
  "properties": {
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "engine": {
      "id": "string",
      "type": "string",
      "name": "string",
      "version": "string"
    },
    "dataCenter": "string",
    "privateIpAddress": "string",
    "flavor": {
      "name": "string",
      "category": "string",
      "cpu": 0,
      "ram": 0
    },
    "networking": {
      "vpc": {
        "uri": "string"
      },
      "subnet": {
        "uri": "string"
      },
      "securityGroup": {
        "uri": "string"
      },
      "elasticIp": {
        "uri": "string"
      }
    },
    "storage": {
      "sizeGb": 0
    },
    "billingPlan": {
      "billingPeriod": "string"
    },
    "autoscaling": {
      "status": "string",
      "availableSpace": 0,
      "stepSize": 0,
      "ruleId": "string"
    }
  }
}

text/json

Schema

Schema

metadata

object

idstringnullable

uristringnullable

namestringnullable

location

object

codestringnullable

countrystringnullable

citystringnullable

namestringnullable

valuestringnullable

project

object

idstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

status

object

statestringnullable

creationDatedate-timenullable

disableStatusInfo

object

isDisabledboolean

reasonsstring[]

previousStatus

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

properties

object

Dto properties response dbaas.

linkedResources

object[]

Array [

uristringnullable

strictCorrelationboolean

]

engine

object

Engine response class.

idstringnullable

typestringnullable

namestringnullable

versionstringnullable

dataCenterstringnullable

For more information, check the documentation.

privateIpAddressstringnullable

flavor

object

Engine response class.

namestringnullable

categorystringnullable

cpuint32nullable

ramint32nullable

networking

object

Network response class.

vpc

object

uristringnullable

subnet

object

uristringnullable

securityGroup

object

uristringnullable

elasticIp

object

uristringnullable

storage

object

Storage response class.

sizeGbint32nullable

billingPlan

object

BillingPlan response class.

billingPeriodstringnullable

autoscaling

object

Autoscaling

statusstringnullable

availableSpaceint32nullable

stepSizeint32nullable

ruleIdstringnullable

Example (from schema)

{
  "metadata": {
    "id": "string",
    "uri": "string",
    "name": "string",
    "location": {
      "code": "string",
      "country": "string",
      "city": "string",
      "name": "string",
      "value": "string"
    },
    "project": {
      "id": "string"
    },
    "tags": [
      "string"
    ],
    "category": {
      "name": "string",
      "provider": "string",
      "typology": {
        "id": "string",
        "name": "string"
      }
    },
    "creationDate": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "updateDate": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string",
    "version": "string",
    "createdUser": "string",
    "updatedUser": "string"
  },
  "status": {
    "state": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "disableStatusInfo": {
      "isDisabled": true,
      "reasons": [
        "string"
      ],
      "previousStatus": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z"
      }
    },
    "failureReason": "string"
  },
  "properties": {
    "linkedResources": [
      {
        "uri": "string",
        "strictCorrelation": true
      }
    ],
    "engine": {
      "id": "string",
      "type": "string",
      "name": "string",
      "version": "string"
    },
    "dataCenter": "string",
    "privateIpAddress": "string",
    "flavor": {
      "name": "string",
      "category": "string",
      "cpu": 0,
      "ram": 0
    },
    "networking": {
      "vpc": {
        "uri": "string"
      },
      "subnet": {
        "uri": "string"
      },
      "securityGroup": {
        "uri": "string"
      },
      "elasticIp": {
        "uri": "string"
      }
    },
    "storage": {
      "sizeGb": 0
    },
    "billingPlan": {
      "billingPeriod": "string"
    },
    "autoscaling": {
      "status": "string",
      "availableSpace": 0,
      "stepSize": 0,
      "ruleId": "string"
    }
  }
}

401

Unauthorized

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

Not Found

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

Internal Server Error