Endpoint Resolution - Resolve

服務:

Workload Development

API 版本:

v1

解析由 Microsoft Fabric 所呼叫之指定服務的端點
根據租用戶的區域和工作區區域，解析由 Microsoft Fabric 所呼叫之指定服務的端點。 Fabric 提供一組內容屬性，並傳回適當的服務端點 URL 及其存留時間（TTL）。

端點解析 API 對於需要根據作內容進行動態端點判斷的服務而言非常重要。 這允許優化的路由和區域合規性。

為了解析端點，Fabric 會在要求本文中傳送具有必要內容屬性的 POST 要求。 回應會包含已解析的 URL 及其 TTL，指出 URL 視為有效的時間長度。

如需範例實作和使用範例，請參閱 端點解析範例程式代碼。

POST https://workload.contoso.com/workload-api-path-placeholder/resolve-api-path-placeholder

要求標頭

名稱	必要	類型	Description
ActivityId	True	string	當使用者與工作負載互動時，用來將要求與您的系統相互關聯的唯一標識符。
RequestId	True	string	全域唯一標識碼，可協助網狀架構將您的要求與我們的記錄相互關聯。 回報問題時，請提供此標識符。
Authorization	True	string	雙重令牌授權標頭，可讓工作負載驗證要求來源、提供用戶內容，以及呼叫其他服務。 此標頭格式如下：SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"。

要求本文

名稱	必要	類型	Description
context	True	EndpointResolutionContextProperty[]	端點解析的內容屬性陣列。

回應

名稱	類型	Description
200 OK	EndpointResolutionResponse	端點解析回應
Other Status Codes	ErrorResponse	針對錯誤狀況，工作負載應該傳回適當的 HTTP 錯誤狀態代碼 （4xx， 5xx），並在回應本文中提供詳細的錯誤資訊。

定義

名稱	Description
EndpointResolutionContextProperty	定義端點解析中使用的內容屬性。 您必須在工作負載指令清單中指定此屬性，以確保 Fabric 能夠正確判斷端點。
EndpointResolutionContextPropertyName	端點解析內容的屬性名稱。
EndpointResolutionRequest
EndpointResolutionResponse
ErrorExtendedInformation	擴充的錯誤資訊。
ErrorResponse	錯誤回應。
ErrorSource	錯誤的來源。
NameValuePair	名稱/值組。

EndpointResolutionContextProperty

Object

定義端點解析中使用的內容屬性。 您必須在工作負載指令清單中指定此屬性，以確保 Fabric 能夠正確判斷端點。

名稱	類型	Description
name	EndpointResolutionContextPropertyName	內容屬性的名稱。
value	string	內容屬性的值。

EndpointResolutionContextPropertyName

列舉型別

端點解析內容的屬性名稱。

值	Description
EndpointName
TenantRegion
WorkspaceRegion
TenantId

EndpointResolutionRequest

Object

名稱	類型	Description
context	EndpointResolutionContextProperty[]	端點解析的內容屬性陣列。

EndpointResolutionResponse

Object

名稱	類型	Description
ttlInMinutes	integer (int32)	已解析 URL 的存留時間分鐘數。
url	string	服務的已解析 URL。

ErrorExtendedInformation

Object

擴充的錯誤資訊。

名稱	類型	Description
additionalParameters	NameValuePair[]	錯誤特有的其他參數清單。
errorCode	string	錯誤碼。
message	string	錯誤訊息。
messageParameters	string[]	格式化當地語系化訊息的參數清單。

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
errorCode	string	錯誤碼。
isPermanent	boolean	指出錯誤是永久性的，還是可以重試作業。
message	string	錯誤訊息。
messageParameters	string[]	格式化當地語系化訊息的參數清單。
moreDetails	ErrorExtendedInformation[]	其他錯誤詳細數據的清單。
source	ErrorSource	錯誤來源。

ErrorSource

列舉型別

錯誤的來源。

值	Description
System
User
External

NameValuePair

Object

名稱/值組。

名稱	類型	Description
name	string	名稱。
value	string	值。