Returns a list of managed SQL Server instances in the tenant's Data Bridge cluster.
The number of provisioned server instances depends on your Data Bridge license agreement.
For each server instance, the response returns information about that server instance including its URI, available disk space and other details.
[
{
"name": "mySQLServer",
"uid": "5e6dbff5-5a99-441b-a999-f28265b6c640",
"endpoint": "467d5f3e13599b70a8f60bcb2808f105.company.com,1433",
"internalEndpoint": "string",
"status": "Ready",
"totalDiskSpaceInMb": 0,
"availableDiskSpaceInMb": 0,
"usedDiskSpaceInMb": 0,
"databaseLimit": 0,
"pinnedDatabaseLimit": 0,
"archivedDatabaseStorageUsedInMb": 16316,
"archivedDatabaseCount": 28,
"owner": "[email protected]",
"secured": true,
"groups": [
{
"groupId": "ad422c53-d970-4e90-b50e-c14aa18bb2bd",
"groupName": "Admin"
},
{
"groupId": "a5d11079-4c73-4863-9de1-0790d316b630",
"groupName": "Engineering Support"
}
]
}
]
If tenant security is enabled for this server instance, principals that are members of associated groups can view server-level security details.
| Property | Description |
|---|---|
name | Name of this SQL Server instance. |
uuid | Unique ID of this SQL Server instance. |
endpoint | URI of this SQL Server instance. |
internalEndpoint | "URI of Data Bridge page in the Integration Center?" |
status | Status of this SQL Server instance in cluster. One of Pending, Ready, Creating, Updating, Deleting, Deleted, FailedCreate, FailedUpdate, FailedDelete. |
totalDiskSpaceInMb | Disk space on this server instance in MB. Defined by licensing agreement. |
availableSpaceInMb | Disk space available on this server instance in MB. |
usedDiskSpaceInMb | Disk space used on this server instance in MB. |
databaseLimit | Maximum number of active databases this server instance will support as defined in the tenant's license agreement. |
pinnedDatabaseLimit | Maximum number of pinned databases this server instance will support as defined in tenant's license agreement. |
archivedDatabaseStorageUsedInMb | "total usage of Database Storage in MB." |
archivedDatabaseCount | Number of databases archived. |
owner | Name of the login that owns this server instance. Owner can grant access to one or more groups. |
secured | If true, the server is secured and access is restricted based on group membership. |
groups | The groupId and groupName of the group that can access to this server. |
Role-based Permissions
To perform this operation, a principal must belong to a group that has been assigned the appropriate role-based permissions. The table identifies the roles with permission to perform this operation.
Consumer Contributor Data Bridge Admin YES YES NO To learn more about role-based permissions in Data Bridge, see Access Controls.