Sync Groups - List Hub Schemas

參考

服務:: SQL Database

API 版本:: 2023-08-01

取得中樞資料庫架構的集合。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/hubSchemas?api-version=2023-08-01

URI 參數

名稱	位於	必要	類型	Description
databaseName	path	True	string	同步群組裝載所在的資料庫名稱。
resourceGroupName	path	True	string	包含資源的資源群組名稱。您可以從 Azure Resource Manager API 或入口網站取得此值。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	識別 Azure 訂用帳戶的訂用帳戶標識碼。
syncGroupName	path	True	string	同步群組的名稱。
api-version	query	True	string	要用於要求的 API 版本。

回應

名稱	類型	Description
200 OK	SyncFullSchemaPropertiesListResult	成功取得同步群組中樞資料庫架構。
Other Status Codes	ErrorResponse	錯誤回應： *** 400 InvalidSyncGroupCreateOrUpdateRequest - 建立或更新同步群組要求本文是空的。 400 InvalidSyncMemberCreateOrUpdateRequest - 建立或更新同步成員要求本文是空的。 400 InvalidSyncAgentCreateOrUpdateRequest - 建立或更新同步代理程式要求本文是空的。 400 InvalidDatabaseResourceId - 資料庫資源標識符無效。 400 InvalidSyncGroupName - 同步組名無效。此欄位可以包含字母、數位、虛線和底線。 400 InvalidSyncMemberName - 同步成員名稱無效。此欄位可以包含字母、數位、虛線和底線。 400 MissingSyncMemberName - 遺漏同步成員名稱 400 InvalidSyncGroupInterval - 同步間隔應大於或等於 5 秒。 400 MismatchingSubscriptionWithUrl - 提供的訂用帳戶不符合 Url 中的訂用帳戶。 400 InvalidSyncAgentResourceId - 無效的同步代理程序資源標識符。 400 不符ResourceGroupNameWithUrl - 提供的資源組名不符合 Url 中的名稱。 400 不相符ServerNameWithUrl - 提供的伺服器名稱不符合 Url 中的名稱。 400 InvalidParameterValue - 為參數指定了無效的值。 400 MissingServerName - 遺漏伺服器名稱 400 MissingDatabaseName - 資料庫名稱遺失 400 MissingSyncGroupName - 遺失同步組名 400 MissingConflictResolutionPolicy - 遺漏衝突解決原則 400 MissingSyncAgentName - 遺漏同步代理程序名稱 400 SyncOperation_GenericFailure - 無法執行資料同步作業。 400 InvalidSyncGroup - 同步群組無效。 400 FeatureDisabledOnSelectedEdition - 用戶嘗試使用目前資料庫版本已停用的功能。 400 CannotCreateSyncGroupDueToQuotaExceeded - 因為超過配額而無法建立同步群組。 400 SyncOperation_DuplicateSyncGroupDrop - 同步群組已卸除。 400 SyncOperation_WrongSyncDatabase - 指定的同步資料庫不符合現有的資料庫。 400 SyncOperation_UpdateSyncGroupWhenDropping - 無法更新同步群組，因為它目前正在卸除。 400 SyncOperation_DwInSyncGroup - 無法在數據同步中使用 datawarehouse 版本。 400 SyncOperation_MasterDbInSyncGroup - 無法在資料同步處理中使用邏輯主機。 400 SyncOperation_UnsupportedDataTypeColumnInSchema - 無法將數據行新增至架構，因為不支援數據行的數據類型。 400 SyncOperation_InvalidCredential - 資料庫的認證無效。 400 InvalidSyncMetadataDatabase - 同步元數據資料庫無效。 400 SyncOperation_InvalidSyncInterval - 無法建立或更新同步群組，因為同步間隔無效。 404 ResourceNotFound - 找不到要求的資源。 404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器 404 DatabaseDoesNotExist - 使用者已指定此伺服器實例上不存在的資料庫名稱。 404 SyncOperation_HubServerNotFound - 中樞邏輯伺服器不存在。 404 SyncOperation_InvalidHubDatabase - 中樞資料庫無效。 409 SyncOperation_DuplicateSyncGroupName - 無法建立同步群組，因為具有相同名稱的同步群組已經存在。

名稱

類型

Description

200 OK

SyncFullSchemaPropertiesListResult

成功取得同步群組中樞資料庫架構。

Other Status Codes

ErrorResponse

錯誤回應： ***

400 InvalidSyncGroupCreateOrUpdateRequest - 建立或更新同步群組要求本文是空的。
400 InvalidSyncMemberCreateOrUpdateRequest - 建立或更新同步成員要求本文是空的。
400 InvalidSyncAgentCreateOrUpdateRequest - 建立或更新同步代理程式要求本文是空的。
400 InvalidDatabaseResourceId - 資料庫資源標識符無效。
400 InvalidSyncGroupName - 同步組名無效。此欄位可以包含字母、數位、虛線和底線。
400 InvalidSyncMemberName - 同步成員名稱無效。此欄位可以包含字母、數位、虛線和底線。
400 MissingSyncMemberName - 遺漏同步成員名稱
400 InvalidSyncGroupInterval - 同步間隔應大於或等於 5 秒。
400 MismatchingSubscriptionWithUrl - 提供的訂用帳戶不符合 Url 中的訂用帳戶。
400 InvalidSyncAgentResourceId - 無效的同步代理程序資源標識符。
400 不符ResourceGroupNameWithUrl - 提供的資源組名不符合 Url 中的名稱。
400 不相符ServerNameWithUrl - 提供的伺服器名稱不符合 Url 中的名稱。
400 InvalidParameterValue - 為參數指定了無效的值。
400 MissingServerName - 遺漏伺服器名稱
400 MissingDatabaseName - 資料庫名稱遺失
400 MissingSyncGroupName - 遺失同步組名
400 MissingConflictResolutionPolicy - 遺漏衝突解決原則
400 MissingSyncAgentName - 遺漏同步代理程序名稱
400 SyncOperation_GenericFailure - 無法執行資料同步作業。
400 InvalidSyncGroup - 同步群組無效。
400 FeatureDisabledOnSelectedEdition - 用戶嘗試使用目前資料庫版本已停用的功能。
400 CannotCreateSyncGroupDueToQuotaExceeded - 因為超過配額而無法建立同步群組。
400 SyncOperation_DuplicateSyncGroupDrop - 同步群組已卸除。
400 SyncOperation_WrongSyncDatabase - 指定的同步資料庫不符合現有的資料庫。
400 SyncOperation_UpdateSyncGroupWhenDropping - 無法更新同步群組，因為它目前正在卸除。
400 SyncOperation_DwInSyncGroup - 無法在數據同步中使用 datawarehouse 版本。
400 SyncOperation_MasterDbInSyncGroup - 無法在資料同步處理中使用邏輯主機。
400 SyncOperation_UnsupportedDataTypeColumnInSchema - 無法將數據行新增至架構，因為不支援數據行的數據類型。
400 SyncOperation_InvalidCredential - 資料庫的認證無效。
400 InvalidSyncMetadataDatabase - 同步元數據資料庫無效。
400 SyncOperation_InvalidSyncInterval - 無法建立或更新同步群組，因為同步間隔無效。
404 ResourceNotFound - 找不到要求的資源。
404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器
404 DatabaseDoesNotExist - 使用者已指定此伺服器實例上不存在的資料庫名稱。
404 SyncOperation_HubServerNotFound - 中樞邏輯伺服器不存在。
404 SyncOperation_InvalidHubDatabase - 中樞資料庫無效。
409 SyncOperation_DuplicateSyncGroupName - 無法建立同步群組，因為具有相同名稱的同步群組已經存在。

範例

Get a hub database schema.

範例要求

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/hubSchemas?api-version=2023-08-01

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "tables": [
        {
          "columns": [
            {
              "dataSize": "4",
              "dataType": "int",
              "hasError": false,
              "isPrimaryKey": false,
              "name": "intField",
              "quotedName": "[intField]"
            },
            {
              "dataSize": "100",
              "dataType": "nvarchar",
              "hasError": false,
              "isPrimaryKey": false,
              "name": "charField",
              "quotedName": "[charField]"
            }
          ],
          "errorId": "Schema_TableHasNoPrimaryKey",
          "hasError": true,
          "name": "dbo.myTable",
          "quotedName": "[dbo].[myTable]"
        }
      ],
      "lastUpdateTime": "2017-05-30T07:16:08.21Z"
    }
  ]
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
SyncFullSchemaProperties	資料庫完整架構的屬性。
SyncFullSchemaPropertiesListResult	同步架構屬性的清單。
SyncFullSchemaTable	資料庫完整架構中數據表的屬性。
SyncFullSchemaTableColumn	資料庫完整架構數據表中數據行的屬性。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

SyncFullSchemaProperties

Object

資料庫完整架構的屬性。

名稱	類型	Description
lastUpdateTime	string (date-time)	資料庫架構的上次更新時間。
tables	SyncFullSchemaTable[]	資料庫完整架構中的數據表清單。

SyncFullSchemaPropertiesListResult

Object

同步架構屬性的清單。

名稱	類型	Description
nextLink	string	連結以擷取下一頁的結果。
value	SyncFullSchemaProperties[]	結果的陣列。

SyncFullSchemaTable

Object

資料庫完整架構中數據表的屬性。

名稱	類型	Description
columns	SyncFullSchemaTableColumn[]	資料庫完整架構數據表中的數據列清單。
errorId	string	數據表的錯誤識別碼。
hasError	boolean	如果資料表中有錯誤，則為。
name	string	數據表的名稱。
quotedName	string	數據表的引號名稱。

SyncFullSchemaTableColumn

Object

資料庫完整架構數據表中數據行的屬性。

名稱	類型	Description
dataSize	string	數據行的數據大小。
dataType	string	數據行的數據類型。
errorId	string	數據行的錯誤識別碼。
hasError	boolean	如果資料表中有錯誤，則為。
isPrimaryKey	boolean	如果是數據表的主鍵。
name	string	數據行的名稱。
quotedName	string	數據行的引號名稱。

共用方式為

Sync Groups - List Hub Schemas

URI 參數

回應

範例

Get a hub database schema.

範例要求

範例回覆

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SyncFullSchemaProperties

SyncFullSchemaPropertiesListResult

SyncFullSchemaTable

SyncFullSchemaTableColumn

其他資源