Endpoint Resolution - Resolve

服务:

Workload Development

API 版本:

v1

解析由 Microsoft Fabric 调用的给定服务的终结点
根据租户的区域和工作区区域解析由 Microsoft Fabric 调用的给定服务的终结点。 Fabric 提供一组上下文属性，并返回相应的服务终结点 URL 及其生存时间（TTL）。

终结点解析 API 对于需要基于作上下文进行动态终结点确定的服务至关重要。 这允许优化的路由和区域合规性。

若要解析终结点，Fabric 将使用请求正文中所需的上下文属性发送 POST 请求。 响应将包含解析的 URL 及其 TTL，该 URL 指示 URL 的有效期。

有关示例实现和用法示例，请参阅 终结点解析示例代码。

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

请求头

名称	必需	类型	说明
ActivityId	True	string	当用户与工作负荷交互时，用于将请求与系统相关联的唯一 ID。
RequestId	True	string	一个全局唯一 ID，可帮助 Fabric 将请求与我们的日志相关联。 报告问题时提供此 ID。
Authorization	True	string	一个双令牌授权标头，允许工作负荷验证请求源、提供用户上下文和调用其他服务。 此标头的格式如下：SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"。

请求正文

名称	必需	类型	说明
context	True	EndpointResolutionContextProperty[]	终结点解析的上下文属性数组。

响应

名称	类型	说明
200 OK	EndpointResolutionResponse	终结点解析响应
Other Status Codes	ErrorResponse	对于错误条件，工作负荷应返回相应的 HTTP 错误状态代码（4xx，5xx），并在响应正文中返回详细的错误信息。

定义

名称	说明
EndpointResolutionContextProperty	定义终结点解析中使用的上下文属性。 必须在工作负荷清单中指定此属性，以确保 Fabric 正确确定终结点。
EndpointResolutionContextPropertyName	终结点解析上下文的属性的名称。
EndpointResolutionRequest
EndpointResolutionResponse
ErrorExtendedInformation	扩展的错误信息。
ErrorResponse	错误响应。
ErrorSource	错误的源。
NameValuePair	名称值对。

EndpointResolutionContextProperty

Object

定义终结点解析中使用的上下文属性。 必须在工作负荷清单中指定此属性，以确保 Fabric 正确确定终结点。

名称	类型	说明
name	EndpointResolutionContextPropertyName	上下文属性的名称。
value	string	上下文属性的值。

EndpointResolutionContextPropertyName

Enumeration

终结点解析上下文的属性的名称。

值	说明
EndpointName
TenantId
TenantRegion
WorkspaceRegion

EndpointResolutionRequest

Object

名称	类型	说明
context	EndpointResolutionContextProperty[]	终结点解析的上下文属性数组。

EndpointResolutionResponse

Object

名称	类型	说明
ttlInMinutes	integer int32	解析的 URL 生存时间（以分钟为单位）。
url	string	服务的已解析 URL。

ErrorExtendedInformation

Object

扩展的错误信息。

名称	类型	说明
additionalParameters	NameValuePair[]	特定于错误的其他参数的列表。
errorCode	string	错误代码。
message	string	错误消息。
messageParameters	string[]	用于设置本地化消息格式的参数列表。

ErrorResponse

Object

错误响应。

名称	类型	说明
errorCode	string	错误代码。
isPermanent	boolean	指示错误是永久性的，还是可以重试作。
message	string	错误消息。
messageParameters	string[]	用于设置本地化消息格式的参数列表。
moreDetails	ErrorExtendedInformation[]	其他错误详细信息的列表。
source	ErrorSource	错误源。

ErrorSource

Enumeration

错误的源。

值	说明
External
System
User

NameValuePair

Object

名称值对。

名称	类型	说明
name	string	名称。
value	string	值。