Edit

Share via

Mirroring - Get Tables Mirroring Status

Service:
MirroredDatabase
API Version:
v1

Get the mirroring status of the tables.
This API supports pagination.

Permissions

The caller must have read permissions for the mirrored database.

Required Delegated Scopes

MirroredDatabase.Read.All or MirroredDatabase.ReadWrite.All or Item.Read.All or Item.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mirroredDatabases/{mirroredDatabaseId}/getTablesMirroringStatus
With optional parameters: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mirroredDatabases/{mirroredDatabaseId}/getTablesMirroringStatus?continuationToken={continuationToken}

URI Parameters

Name In Required Type Description
mirroredDatabaseId
 path True

string (uuid)

The mirrored database ID.
workspaceId
 path True

string (uuid)

The workspace ID.
continuationToken
 query

string

A token for retrieving the next page of results.

Responses

Name Type Description
200 OK

TablesMirroringStatusResponse

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • UnknownError - An error occurred.

Examples

Get tables mirroring status example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/mirroredDatabases/b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2/getTablesMirroringStatus

Sample response

Status code:
200 
{
  "data": [
    {
      "sourceObjectType": "Table",
      "sourceSchemaName": "dbo",
      "sourceTableName": "test",
      "status": "Replicating",
      "metrics": {
        "processedBytes": 1247,
        "processedRows": 6,
        "lastSyncDateTime": "2024-10-08T05:07:11.0663362Z",
        "lastSyncLatencyInSeconds": 15
      }
    }
  ]
}

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
TableMirroringMetrics

Table mirroring metrics.
TableMirroringStatus

The table mirroring status type. Additional TableMirroringStatus types may be added over time.
TableMirroringStatusResponse

Table mirroring status response.
TablesMirroringStatusResponse

A paginated list of table mirroring statuses.
TableSourceObjectType

The table source object type. Additional TableSourceObjectType types may be added over time.

ErrorRelatedResource

Object

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string

ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
relatedResource

ErrorRelatedResource

The error related resource details.

TableMirroringMetrics

Object

Table mirroring metrics.

Name Type Description
lastSyncDateTime

string (date-time)

Last processed time of the table in in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
lastSyncLatencyInSeconds

integer (int32)

Latency in seconds between source commit time and target commit time of last processed change. For sources whose source commit time is not available, this value is not returned.
processedBytes

integer (int64)

Processed bytes for this table.
processedRows

integer (int64)

Processed row count for this table.

TableMirroringStatus

Enumeration

The table mirroring status type. Additional TableMirroringStatus types may be added over time.

Value Description
Initialized

Mirroing of the table is initialized.
Snapshotting

The table is snapshotting.
Replicating

The table is replicating.
Reseeding

The table is reseeding.
Stopped

Mirroring of the table is stopped.
Failed

Mirroing of the table failed with error.

TableMirroringStatusResponse

Object

Table mirroring status response.

Name Type Description
error

ErrorResponse

Table level error is set if error happens in mirroring for this table
metrics

TableMirroringMetrics

The mirroring metrics of table.
sourceObjectType

TableSourceObjectType

Source object type.
sourceSchemaName

string

Source table schema name.
sourceTableName

string

Source table name.
status

TableMirroringStatus

The mirroring status type of table.

TablesMirroringStatusResponse

Object

A paginated list of table mirroring statuses.

Name Type Description
continuationToken

string

The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri

string

The URI of the next result set batch. If there are no more records, it's removed from the response.
data

TableMirroringStatusResponse[]

A list of table mirroring statuses.

TableSourceObjectType

Enumeration

The table source object type. Additional TableSourceObjectType types may be added over time.

Value Description
Table

Table type
View

View type