Mirroring - Get Mirroring Status

服務:
MirroredDatabase
API 版本:
v1

取得鏡像資料庫的狀態。

權限

呼叫端必須具有鏡像資料庫的 讀取 許可權。

必要的委派範圍

MirroredDatabase.Read.All 或 MirroredDatabase.ReadWrite.All 或 Item.Read.All 或 Item.ReadWrite.All

Microsoft Entra 支援的身份識別

此 API 支援本節中列出的Microsoft 身分識別。

身份 支援
使用者 是的
服務主體 和 受控識別 是的

介面

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mirroredDatabases/{mirroredDatabaseId}/getMirroringStatus

URI 參數

名稱 位於 必要 類型 Description
mirroredDatabaseId
 path True

string (uuid)

鏡像資料庫標識碼。
workspaceId
 path True

string (uuid)

工作區識別碼。

回覆

名稱 類型 Description
200 OK

MirroringStatusResponse

要求成功完成。
429 Too Many Requests

ErrorResponse

服務費率上限被超標。 伺服器會回傳一個 Retry-After 標頭，以秒數表示客戶端在發送額外請求前必須等待多久。

標題

Retry-After: integer
Other Status Codes

ErrorResponse

常見的錯誤碼：

  • UnknownError - 發生錯誤。

範例

Get mirroring status example

範例要求

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

範例回覆

狀態碼:
200 
{
  "status": "Running"
}

定義

名稱 Description
ErrorParameter

一個結構化參數，提供關於錯誤的額外機器可讀上下文。
ErrorRelatedResource

錯誤相關的資源詳細資料物件。
ErrorResponse

錯誤回應。
ErrorResponseDetails

錯誤回應詳細數據。
MirroringStatus

鏡像狀態類型。 可能會隨著時間新增其他 MirroringStatus 類型。
MirroringStatusResponse

取得鏡像狀態的回應。

ErrorParameter

Object

一個結構化參數，提供關於錯誤的額外機器可讀上下文。

名稱 類型 Description
message

string

一個人類可讀的參數意義描述。
name

string

參數識別碼。
value

string

這是參數值。

ErrorRelatedResource

Object

錯誤相關的資源詳細資料物件。

名稱 類型 Description
resourceId

string

發生錯誤的資源識別碼。
resourceType

string

發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
isRetriable

boolean

若屬實，請求可重新嘗試。 如果有延遲，請使用 Retry-After 回應標頭來判斷延遲。
message

string

錯誤的人類可讀取表示法。
moreDetails

ErrorResponseDetails[]

其他錯誤詳細數據的清單。
parameters

ErrorParameter[]

結構化參數提供更多機器可讀的錯誤上下文。
relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。
requestId

string (uuid)

與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message

string

錯誤的人類可讀取表示法。
parameters

ErrorParameter[]

結構化參數提供更多機器可讀的錯誤上下文。
relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。

MirroringStatus

列舉型別

鏡像狀態類型。 可能會隨著時間新增其他 MirroringStatus 類型。

值 Description
Initializing

相關聯的 SQL 端點布建正在進行中。
Initialized

相關聯的 SQL 端點布建成功，鏡像資料庫已準備好啟動。
Starting

鏡像資料庫的鏡像實例正在啟動。
Running

鏡像資料庫的鏡像實例正在執行。
Paused

鏡像資料庫的鏡像實例會暫停。
Stopping

鏡像資料庫的鏡像實例正在停止。
Stopped

鏡像資料庫的鏡像實例已停止。

MirroringStatusResponse

Object

取得鏡像狀態的回應。

名稱 類型 Description
error

ErrorResponse

如果鏡像發生錯誤，就會設定錯誤
status

MirroringStatus

鏡像的狀態