Get Db
Endpoint to get databases by id
Authorized Roles : PROVIDER or ORG_ADMIN or ORG_USER
Request
URI
GET
https://{api_host}/provider/databases/{id}
COPY
Path Parameters
string
id
Required
ID of the database
Responses
200
OK
Returns
ManagedDbDTO
of type(s)
application/vnd.vmware.dms-v1+json
{
"id": "string",
"instanceName": "string",
"version": "string",
"dbType": "string",
"role": "string",
"logicalBuildId": "string",
"environment": {
"environmentId": "string",
"tenantId": "string",
"vcInstanceUuid": "string",
"vcIpAddress": "string",
"pscFqdn": "string",
"vcThumbprint": "string",
"pscThumbprint": "string",
"vcDatacenter": {
"id": "string",
"moId": "string",
"name": "string",
"type": "string",
"isDefault": false
},
"vcVMFolder": {
"id": "string",
"moId": "string",
"name": "string",
"type": "string",
"isDefault": false
},
"vcCluster": {
"id": "string",
"moId": "string",
"name": "string",
"type": "string",
"isDefault": false
},
"vcResourcePool": {
"id": "string",
"moId": "string",
"name": "string",
"type": "string",
"isDefault": false
},
"vcResourcePoolPath": "string",
"vcVmDatastores": {
"list": [
{
"mor": "string",
"datastoreName": "string",
"isDefault": false
}
]
},
"vcAppNetworks": {
"list": [
{
"mor": "string",
"appNetworkName": "string",
"isDefault": false
}
]
},
"lcpNetwork": {
"id": "string",
"moId": "string",
"name": "string",
"type": "string",
"isDefault": false
},
"vcDmsUsername": "string",
"vcDmsUserPassword": "string",
"vcDmsROUsername": "string",
"vcDmsROUserPassword": "string",
"tenantNtp": "string",
"tenantIpAddress": "string",
"providerIpAddress": "string",
"state": "string",
"providerRabbitSettings": {
"rabbitEndpoints": [
{
"endpoint": "string",
"port": 0
}
],
"username": "string",
"password": "string"
},
"runtimeInfo": [
{
"environmentId": "string",
"alertType": "string",
"alertStatus": "string",
"alertTime": "string",
"environmentName": "string"
}
],
"status": "string",
"version": "string",
"vmRootPassword": "string",
"clusterType": "string",
"templateStorage": {
"id": "string",
"name": "string",
"endpoint": "string",
"bucket": "string",
"accessKey": "string",
"secretKey": [
"string"
],
"region": "string",
"thumbprint": "string",
"templateStorage": false
},
"agentVMName": "string",
"rootPasswordExpiryInfo": {
"expiryDate": "string",
"noOfDaysToWarn": 0,
"noOfDaysToExpire": 0,
"warning": false,
"expired": false,
"status": "string"
},
"links": [
{
"rel": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string"
}
]
},
"tenantId": "string",
"user": {
"id": 0,
"firstName": "string",
"lastName": "string",
"contactNumber": "string",
"email": "string",
"password": "string",
"tenantId": "string",
"companyName": "string",
"type": "string",
"roles": [
"string"
],
"forcePasswordChange": false,
"links": [
{
"rel": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string"
}
]
},
"status": "string",
"fqdn": "string",
"primaryFqdn": "string",
"ip": "string",
"dbMgmtIp": "string",
"vmId": "string",
"createdTimestamp": "string",
"datastoreId": "string",
"appNetworkId": "string",
"lcpNetworkId": "string",
"dbInstanceConfig": {
"id": "string",
"port": 0,
"rootUser": "string",
"rootPassword": "string",
"adminUser": "string",
"adminPassword": "string",
"replicationUser": "string",
"replicationPassword": "string",
"dbName": "string",
"monitoringType": "string",
"dbId": 0,
"edition": "string",
"dbVersion": "string"
},
"maintenanceConfig": {
"id": "string",
"maintenanceWindowStartDay": "string",
"maintenanceWindowStartTime": "string",
"maintenanceWindowDuration": 0,
"minorVersionUpgradeEnabled": false,
"maintenanceWindowSelected": false
},
"hwConfig": {
"id": "string",
"hdDiskSizeGB": 0,
"cpuCores": 0,
"memoryGB": 0,
"thinDisk": false
},
"backupConfig": {
"id": "string",
"numLocalBackupDays": 0,
"numRemoteBackupDays": 0,
"autoBackupsEnabled": false,
"automatedBackupStartTime": "string"
},
"runtimeInfo": [
{
"id": "string",
"alertTypeEnum": "string",
"alertLevel": "string",
"updatedTimestamp": "string"
}
],
"enableProtection": false,
"dbVmRootPassword": "string",
"dbVmProviderAdminUser": "string",
"dbVmProviderAdminPassword": "string",
"dbVmTenantAdminUser": "string",
"dbVmTenantAdminPassword": "string",
"requireClientSsl": false,
"dbOptions": [
{
"key": "string",
"value": "string",
"type": "string",
"url": "string"
}
],
"dbCluster": "DbClusterDTO Object",
"readReplicas": [
{
"dbUUID": "string",
"instanceName": "string",
"ip": "string",
"dbMgmtIp": "string",
"fqdn": "string",
"role": "string",
"status": "string",
"createdTimestamp": "string",
"replicationLag": "number",
"replicationStatus": "string",
"environment": {
"environmentId": "string",
"vcHost": "string",
"vcClusterName": "string",
"vcResourcePoolName": "string"
},
"dbVersion": "string",
"memberPriority": 0,
"syncReplicationEnabled": false,
"namespace": {
"id": "string",
"name": "string"
}
}
],
"shellOvaVersion": "string",
"dbAdapterRpmVersion": "string",
"dbEngineRpmVersion": "string",
"coreRpmVersion": "string",
"tags": [
{
"id": "string",
"orgId": "string",
"name": "string",
"createdTime": "string",
"modifiedTime": "string",
"lastModified": "string",
"assignedInstanceCount": 0
}
],
"namespace": {
"id": "string",
"name": "string",
"description": "string",
"environment": {
"id": "string",
"name": "string"
},
"localStorages": [
{
"id": "string",
"name": "string",
"isDefault": false
}
],
"cloudStorages": [
{
"id": "string",
"name": "string",
"isDefault": false
}
],
"datastores": [
{
"id": "string",
"name": "string",
"moId": "string",
"isDefault": false
}
],
"appNetworks": [
{
"id": "string",
"name": "string",
"moId": "string",
"isDefault": false
}
],
"organisations": [
{
"id": "string",
"name": "string",
"isPublished": false,
"databaseCount": 0
}
],
"status": "string",
"runtimeInfo": [
{
"id": "string",
"namespaceId": "string",
"alertType": "string",
"alertLevel": "string",
"alertTime": "string"
}
],
"databaseCount": 0,
"lastUpdatedTime": "string"
},
"edition": "string",
"rootPasswordExpiryInfo": {
"expiryDate": "string",
"noOfDaysToWarn": 0,
"noOfDaysToExpire": 0,
"warning": false,
"expired": false,
"status": "string"
},
"alertRuleSetDto": {
"alertRuleSetId": "string",
"alertRuleSetName": "string"
},
"links": [
{
"rel": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string"
}
]
}
string As uuid
As uuid
id
Optional
id
string
instanceName
Optional
instanceName
string
version
Optional
version
string
dbType
Optional
dbType
string
role
Optional
role
Possible values are :
STAND_ALONE,
PRIMARY,
READ_REPLICA,
PG_MONITOR,
string As uuid
As uuid
logicalBuildId
Optional
logicalBuildId
string As uuid
As uuid
tenantId
Optional
tenantId
string
status
Optional
status
Possible values are :
ONLINE,
ERROR,
LOST_CONNECTIVITY,
WARNING,
FATAL,
CRITICAL,
INIT,
DELETED,
POWEREDOFF,
POWEREDON,
CONTROL_PLANE_UPDATE_IN_PROGRESS,
CONTROL_PLANE_UPDATE_FAILED,
DB_ENGINE_UPDATE_IN_PROGRESS,
DB_ENGINE_UPDATE_FAILED,
OS_UPDATE_IN_PROGRESS,
OS_UPDATE_FAILED,
DELETING,
MODIFYING,
BACKUP_IN_PROGRESS,
string
fqdn
Optional
fqdn
string
primaryFqdn
Optional
primaryFqdn
string
ip
Optional
ip
string
dbMgmtIp
Optional
dbMgmtIp
string
vmId
Optional
vmId
string As date-time
As date-time
createdTimestamp
Optional
createdTimestamp
string
datastoreId
Optional
datastoreId
string
appNetworkId
Optional
appNetworkId
string
lcpNetworkId
Optional
lcpNetworkId
boolean
enableProtection
Optional
enableProtection
string
dbVmRootPassword
Optional
dbVmRootPassword
string
dbVmProviderAdminUser
Optional
dbVmProviderAdminUser
string
dbVmProviderAdminPassword
Optional
dbVmProviderAdminPassword
string
dbVmTenantAdminUser
Optional
dbVmTenantAdminUser
string
dbVmTenantAdminPassword
Optional
dbVmTenantAdminPassword
boolean
requireClientSsl
Optional
requireClientSsl
string
shellOvaVersion
Optional
shellOvaVersion
string
dbAdapterRpmVersion
Optional
dbAdapterRpmVersion
string
dbEngineRpmVersion
Optional
dbEngineRpmVersion
string
coreRpmVersion
Optional
coreRpmVersion
string
edition
Optional
edition
400
Bad Request
Operation doesn't return any data structure
Databases Operations
POST
Add Read Replica
PUT
Change Backup Storage
PUT
Change Db Options
PATCH
Change Db Owner
PUT
Change Edition
POST
Create 7
POST
Create 8
POST
Create Db Cluster
DELETE
Delete 1
DELETE
Delete Db Cluster
POST
Disable Require Client Ssl
POST
Enable Require Client Ssl
GET
Export Db Ca Certificate
GET
Export Db Server Certificate 1
GET
Export To CSV
GET
Export To XLS
PUT
Extend Db Disk
GET
Fetch Db Disk Freespace
GET
Fetch Supported Edition Upgrades
POST
Generate Db Logs
GET
Get Database Alerts History
GET
Get Database Notifications
GET
Get Database Search Filter Values
GET
Get Db
GET
Get DB Admin Password
GET
Get Db Updates
GET
Get Db Version
GET
Get DB Vm Root Password
GET
Get Flagged Db Alert Types
GET
Get Page 7
GET
Get PITR Allowed Range By DB
GET
Get Protection Details
GET
Get Replica Deployable Namespaces
PUT
Modify Backup Config
PUT
Modify Db Config
PUT
Modify Member Settings
PUT
Poweroff
PUT
Poweron
POST
Promote Read Replica
POST
Protect
PUT
Provider Disable Db Vm Ssh
PUT
Provider Enable Db Vm Ssh
PATCH
Refresh Db Certificate
PATCH
Resync Db Trusted Certificates
PUT
Scaledbconfig
POST
Submit Clone Task
POST
Submit PITR Task
POST
Submit Recover Task
POST
Submit Restore Task
PUT
Tenant Disable Db Vm Ssh
PUT
Tenant Enable Db Vm Ssh
PUT
Update Alert Rule Set 1
POST
Update Alert Type As Verified
PUT
Update Database Notifications
PATCH
Update Db Engine Rpm
PATCH
Update Db Os