Get a DB Service by Id

get https://{server}/services/{id}

Responses

Response body

object

uuid

Tessell generated UUID for the DB Service. This is the unique identifier for the DB Service.

availabilityMachineId

uuid

Unique ID of the associated Availability Machine

name

string

length between 1 and 128

Name of the DB Service

description

string

length between 0 and 512

User specified description for the DB Service

engineType

string

Database Engine Type

ORACLE POSTGRESQL SQLSERVER MYSQL APACHE_KAFKA MONGODB MILVUS

topology

string

DB Service topology. This would specify whether the DB Service is single-node, or multi-node.

single_instance high_availability

numOfInstances

int32

≥ 0

This specifies the number of instances (nodes) that are created for the DB Service

status

string

The current status of the DB Service

CREATING FAILED READY STOPPING STOPPED DEGRADED HEALING DOWN STARTING DELETING SWITCHOVER REBUILDING PATCHING PATCH_FAILED UPDATING UNDER_MAINTENANCE REFRESHING RESTORING RESTORE_FAILED

contextInfo

object

Provide more context of DB Service state

subStatus

string

DB Service could have a sub status associated along with status

START_FAILED SWITCHOVER_FAILED BACKING_UP PATCH_FAILED REBUILDING STOP_FAILED REBUILD_FAILED RESIZING_STORAGE RESIZING_STORAGE_FAILED UPDATING_PARAMETER_PROFILE PARAMETER_PROFILE_UPDATE_FAILED REFRESH_FAILED

description

string

licenseType

string

DB Service License Type

byol oss gpl

autoMinorVersionUpdate

boolean

Defaults to true

This field specifies whether to automatically update minor version for the DB Service

enableDeletionProtection

boolean

Defaults to true

This field specifies whether to enable deletion protection for the DB Service. If this is enabled, the deletion for the DB Service would be disallowed until this setting is disabled.

enableStopProtection

boolean

Defaults to false

This field specifies whether to enable stop protection for the DB Service. If this is enabled, the stop for the DB Service would be disallowed until this setting is disabled.

edition

string

length between 1 and 128

Edition of the software image that has been used to create the DB Service (e.g. COMMUNITY/ENTERPRISE etc)

softwareImage

string

length between 1 and 128

The software image that has been used to create the DB Service

softwareImageVersion

string

length between 1 and 128

The software image version that is used to create the DB Service

softwareImageVersionFamily

string

length between 1 and 128

The software image version family that is used to create the DB Service

tenantId

string

length between 1 and 128

The tenant identifier under which the DB Service is created

subscription

string

length between 1 and 128

The Tessell Subscription under which this DB Service is created

owner

string

length between 0 and 512

This field specifies who is the owner for the DB Service

loggedInUserRole

string

length between 1 and 128

This field specifies access role on the DB Service for the currently logged in user

dateCreated

date-time

This field specifies the timestamp when the DB Service was created at

startedAt

date-time

This field specifies the timestamp when the DB Service was last started at

stoppedAt

date-time

This field specifies the timestamp when the DB Service was last stopped at

clonedFromInfo

object

If the DB Service is created as a clone from some other DB Service, this section describes the parent DB Service and cloning details

cloneType

string

clone restore sanitization native_backup

contentType

string

Backup Content Type

AS_IS SANITIZED

tessellServiceId

uuid

The DB Service ID using which this DB Service clone is created

availabilityMachineId

uuid

The Availability Machine ID using which this DB Service clone is created

tessellService

string

length between 1 and 128

The DB Service name using which this DB Service clone is created

availabilityMachine

string

length between 1 and 128

The Availability Machine name using which this DB Service clone is created

snapshotName

string

length between 1 and 128

The snapshot using which this DB Service clone is created

snapshotId

uuid

The snapshot ID using which this DB Service clone is created

snapshotTime

date-time

DB Service snapshot capture time

pitrTime

string

If the database was created using a Point-In-Time mechanism, it specifies the timestamp in UTC

maximumRecoverability

boolean

Defaults to false

If the service was created using a maximum recoverability from the parent service

refreshInfo

object

Service refresh details

contentType

string

Backup Content Type

AS_IS SANITIZED

snapshotName

string

snapshotTime

date-time

Time at which snapshot is created.

pitr

string

scriptInfo

object

scheduleId

uuid

If refreshed using schedule then schedule id, else null

lastSuccessfulRefreshTime

date-time

Time at which refresh would be successfully completed.

serviceConnectivity

object

DB Service's connectivity information

enableSSL

boolean

Defaults to false

Specify whether to enable SSL to the DB Service, default false

caCertId

string

Defaults to uuid

The CA certificate ID associated with the DB Service

dnsPrefix

string

DNS Prefix associated with the DB Service

servicePort

int32

≥ 0

The connection port for the DB Service

enablePublicAccess

boolean

Specify whether to enable public access to the DB Service, default false

allowedIpAddresses

array of strings

The list of allowed ipv4 addresses that can connect to the DB Service

allowedIpAddresses

connectStrings

array of objects

The list of connect strings for the DB Service

connectStrings

object

type

string

Connect string type

write_read read_only

usageType

string

Usage type of connection string.

default connection_pool

connectDescriptor

string

The connection description for the DB Service

endpoint

string

The connection end point for the DB Service

masterUser

string

The master user name for the DB Service

servicePort

int32

≥ 0

The connection port for the DB Service

privateLink

object

The interface endpoint or Gateway Load Balancer endpoint to connect to your DB service.

computesConnectivity

array of objects

The Genie endpoint to connect to your DB service.

computesConnectivity

object

computeResourceId

uuid

portAccessConfig

array of objects

portAccessConfig

object

port

int32

≥ 0

The connection port for the DB Service

enablePublicAccess

boolean

Enable public access to database (true/false)

allowedIpAddresses

array of strings

Set allowed IP address if enablePublicAccess is true.

allowedIpAddresses

updateInProgressInfo

object

DB Service connectivity update-in-progress details

tessellGenieStatus

string

DB Service's Genie status

requested enabled disabled enabling disabling failed_enable failed_disable

infrastructure

object

This field contains DB Service's infrastructure related information, like, where the service is hosted - cloud, region; what compute shape, or network is is configured with.

cloud

string

The cloud-type in which the DB Service is provisioned (ex. aws, azure)

region

string

The region in which the DB Service provisioned

availabilityZone

string

The availability-zone in which the DB Service is provisioned

cloudAvailability

array of objects

cloudAvailability

object

cloud

string

required

The cloud type

AWS AZURE GCP OCI

regions

array of objects

The regions details

regions

object

region

string

required

The cloud region name

availabilityZones

array of strings

availabilityZones

vpc

string

The VPC to be used for provisioning the DB Service

enableEncryption

boolean

Defaults to false

encryptionKey

string

The encryption key name which is used to encrypt the data at rest

computeType

string

The compute-type to be used for provisioning the DB Service

awsInfraConfig

object

enableComputeSharing

boolean

Specify if the computes should be shared across DB Services

iops

int32

IOPS requested for the DB Service

throughput

int32

throughput requested for the DB Service

storage

int64

≥ 0

Defaults to 0

The storage (in bytes) that has been provisioned for the DB Service

additionalStorage

int64

≥ 0

Defaults to 0

Storage in bytes that is over and above the storage included with compute. This is maintained for backward compatibility and would be deprecated soon.

timezone

string

length ≤ 256

The timezone detail

multiDisk

boolean

Specify whether the DB service uses multiple data disks

storageProvider

Storage Type in the cloud

storageConfig

object

computeProvider

string

AWS_EC2 AZURE_VM OCI_EXADATA

maintenanceWindow

object

This field details the DB Service maintenance related details.

day

string

required

Week Days

Sunday Monday Tuesday Wednesday Thursday Friday Saturday

time

string

required

Time value in (hh:mm) format. ex. "02:00"

duration

int32

required

≥ 30

The duration during which the maintenance window will be allowed to trigger

engineConfiguration

object | null

This field details the DB Service engine configuration details like - parameter profile, or options profile (if applicable) are used to configure the DB Service.

oracleConfig

object | null

postgresqlConfig

object | null

mysqlConfig

object | null

sqlServerConfig

object | null

apacheKafkaConfig

object | null

mongodbConfig

object | null

milvusConfig

object | null

preScriptInfo

object | null

postScriptInfo

object | null

collationConfig

object

integrationsConfig

object

Tessell provides support to integrate third party softwares with DB Services. This fields details the information about what third-party integrations are configured with the DB Service.

integrations

array of uuids

integrations

deletionConfig

object

If the DB Service is to be deleted, this config would be honoured if no preference is provided during deleting the service

retainAvailabilityMachine

boolean

Defaults to false

If specified as true, the associated Availability Machine (snapshots, sanitized-snapshots, logs) would be retained

tags

object | null

name

string

length between 1 and 128

Case sensitive, tag name

value

string

length between 0 and 256

Case sensitive, tag value

updatesInProgress

array of objects

The updates that are in progress for this resource

updatesInProgress

object

updateType

string

Type of the update

referenceId

uuid

The reference-id of the update request

submittedAt

date-time

Timestamp when the resource update was requested

updateInfo

object

The specific details for a Tessell resource that are being updated

Has additional fields

instances

array of objects

The instances (nodes) associated with this DB Service

instances

object

uuid

Tessell generated UUID for the DB Service Instance

name

string

required

Name of the DB Service Instance

instanceGroupName

string

Name of the instance group

type

string

DB Service instance type

DC DR

role

string

DB Service Topology

primary read_only_replica failover_replica dr

status

string

DB Service instance status

CREATING DELETING UP DOWN STOPPED REBUILDING REBUILD_FAILED PATCHING PATCH_FAILED UPDATING_PARAMETER_PROFILE PARAMETER_PROFILE_UPDATE_FAILED REFRESHING

tessellServiceId

uuid

DB Service Instance's associated DB Service id

cloud

string

DB Service Instance's cloud type

region

string

DB Service Instance's cloud region

availabilityZone

string

DB Service Instance's cloud availability zone

instanceGroupId

uuid

The instance groupd Id

computeType

string

The compute used for creation of the Tessell Service Instance

awsInfraConfig

object

computeId

uuid

The associated compute identifier

computeName

string

The associated compute name

storage

int64

≥ 0

The storage (in bytes) that has been provisioned for the DB Service instance.

dataVolumeIops

int32

throughput

int32

Throughput requested for this DB Service instance

enablePerfInsights

boolean

parameterProfile

object

monitoringConfig

object

vpc

string

The VPC used for creation of the DB Service Instance

publicSubnet

string

The public subnet used for creation of the DB Service Instance

privateSubnet

string

The private subnet used for creation of the DB Service Instance

encryptionKey

string

The encryption key name which is used to encrypt the data at rest

softwareImage

string

Software Image to be used to create the instance

softwareImageVersion

string

Software Image Version to be used to create the instance

dateCreated

date-time

Timestamp when the entity was created

connectString

object

updatesInProgress

array of objects

The updates that are in progress for this resource

updatesInProgress

object

updateType

string

Type of the update

referenceId

uuid

The reference-id of the update request

submittedAt

date-time

Timestamp when the resource update was requested

updateInfo

object

The specific details for a Tessell resource that are being updated

Has additional fields

lastStartedAt

date-time

Timestamp when the service instance was last started at

lastStoppedAt

date-time

Timestamp when the Service Instance was last stopped at

syncMode

string

Service instance sync mode

SYNC ASYNC

engineConfiguration

object | null

This field details the DB Service Instance engine configuration details like - access mode

computeConfig

object

storageConfig

object

databases

array of objects

This field details about the databases that are created under this DB Service

databases

object

uuid

Tessell generated UUID for the database

databaseName

string

length between 1 and 128

Database name

description

string

length between 0 and 512

Database description

tessellServiceId

uuid

Associated DB Service ID

engineType

string

Database engine type

ORACLE POSTGRESQL SQLSERVER MYSQL APACHE_KAFKA MONGODB MILVUS

status

string

Database status

CREATING FAILED DELETING READY DOWN STOPPED STOPPING STARTING

dateCreated

date-time

Timestamp when the entity was created

tessellCreated

boolean

Defaults to true

Database created from Tessell platform

clonedFromInfo

object

If a database is created as a clone from some other DB Service's database, this section describes the original database details

databaseConfiguration

object | null

connectString

object

sharedWith

object

Tessell Entity ACL Sharing Info

users

array of objects

users

object

emailId

string

role

string

deletionSchedule

object

Details of the deletion schedule on a DB Service

uuid

deleteAt

date-time

required

Time at which the DB Service should be deleted at

deletionConfig

object

If the DB Service is to be deleted, this config would be honoured if no preference is provided during deleting the service

upcomingScheduledActions

object

startStop

object

patch

object

delete

object

xxxxxxxxxx
}
{
  "id": "5a6f8b48-3b20-4e11-bdb0-870864cc8e34",
  "availabilityMachineId": "432bc899-b4b9-48db-a580-517f015188da",
  "name": "finance-db",
  "description": "Database for finance department",
  "engineType": "ORACLE",
  "topology": "single_instance",
  "numOfInstances": 1,
  "status": "READY",
  "licenseType": "byol",
  "autoMinorVersionUpdate": true,
  "enableDeletionProtection": false,
  "enableStopProtection": false,
  "softwareImage": "Oracle 12c",
  "softwareImageVersion": "12.1.0.2.0",
  "tenantId": "admin@my-org.com",
  "subscription": "default",
  "owner": "myself@my-org.com",
  "loggedInUserRole": "OWNER",
  "dateCreated": "2022-08-12T09:43:26.359+00:00",
  "startedAt": "2022-08-12T09:43:26.359+00:00",
  "stoppedAt": null,
  "clonedFromInfo": null,
  "serviceConnectivity": {
    "dnsPrefix": null,

200OK

defaultAPI error response