通过

Items - Refresh Sql Endpoint Metadata

服务:
SQLEndpoint
API 版本:
v1

注释

此预览版 API 是实验性的，可以不通知更改。 它仅用于评估和开发;不建议使用生产。

刷新 SQL 分析终结点中的所有表。
此 API 支持 长时间运行的作（LRO）。

权限

调用方必须具有 参与者 或更高版本的工作区角色。

所需的委派范围

Item.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份 支持
用户 是的
服务主体和托管标识 是的

接口

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/refreshMetadata?preview={preview}

URI 参数

名称 在 必需 类型 说明
sqlEndpointId
 path True

string (uuid)

SQL 分析终结点 ID。
workspaceId
 path True

string (uuid)

工作区 ID。
preview
 query True

boolean

必须将此必需参数设置为 true 访问当前处于预览状态的此 API。 它表示调用方确认 API 的实验性，并接受中断性变更的可能性。 目前不支持任何其他值或遗漏。

请求正文

名称 类型 说明
timeout

Duration

超时前的请求持续时间。默认值为 15 分钟。

响应

名称 类型 说明
200 OK

TableSyncStatus[]

请求成功完成。
202 Accepted

请求已接受，SQL 分析表正在进行刷新。

标头

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

常见错误代码：

  • ItemNotFound - 找不到请求的项目。

示例

Refresh all tables for a specified SQL analytics endpoint in a workspace

示例请求

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/sqlEndpoints/5b218778-e7a5-4d73-8187-f10824047715/refreshMetadata?preview=true

示例响应

状态代码:
200 
[
  {
    "tableName": "Table 1",
    "startDateTime": "2025-02-04T22:29:12.4400865Z",
    "endDateTime": "2025-02-04T22:29:12.4869641Z",
    "status": "Success",
    "lastSuccessfulSyncDateTime": "2024-07-23T14:28:23.1864319Z"
  },
  {
    "tableName": "Table 2",
    "startDateTime": "2025-02-04T22:29:13.4400865Z",
    "endDateTime": "2025-02-04T22:29:13.4869641Z",
    "status": "Failure",
    "error": {
      "errorCode": "AdalRetryException",
      "message": "Couldn't run query. There is a problem with the Microsoft Entra ID token. Have the warehouse owner log in again. If they're unavailable, use the takeover feature."
    },
    "lastSuccessfulSyncDateTime": "2024-07-23T14:28:23.1864319Z"
  },
  {
    "tableName": "Table 3",
    "startDateTime": "2025-02-04T22:29:14.4400865Z",
    "endDateTime": "2025-02-04T22:29:14.4869641Z",
    "status": "NotRun",
    "lastSuccessfulSyncDateTime": "2024-07-23T14:28:23.1864319Z"
  }
]

定义

名称 说明
Duration

持续时间。
ErrorRelatedResource

与错误相关的资源详细信息对象。
ErrorResponse

错误响应。
ErrorResponseDetails

错误响应详细信息。
SqlEndpointRefreshMetadataRequest

刷新 SQL analaytics 终结点请求有效负载。
SyncStatus

同步作的状态。 可能会随着时间的推移添加其他 SyncStatus 类型。
TableSyncStatus

表同步状态对象。
TimeUnit

持续时间的时间单位。 可能会随着时间的推移添加其他持续时间类型。

Duration

Object

持续时间。

名称 类型 说明
timeUnit

TimeUnit

持续时间的时间单位。 可能会随着时间的推移添加其他持续时间类型。
value

number

持续时间中的 timeUnits 数。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称 类型 说明
resourceId

string

错误中涉及的资源 ID。
resourceType

string

错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
moreDetails

ErrorResponseDetails[]

其他错误详细信息的列表。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。
requestId

string

与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。

SqlEndpointRefreshMetadataRequest

Object

刷新 SQL analaytics 终结点请求有效负载。

名称 类型 说明
timeout

Duration

超时前的请求持续时间。默认值为 15 分钟。

SyncStatus

枚举

同步作的状态。 可能会随着时间的推移添加其他 SyncStatus 类型。

值 说明
Failure

指示失败。
NotRun

指示作未运行。
Success

指示成功。

TableSyncStatus

Object

表同步状态对象。

名称 类型 说明
endDateTime

string (date-time)

使用 YYYY-MM-DDTHH：mm：ssZ 格式完成表同步的日期和时间。
error

ErrorResponseDetails

错误响应详细信息
lastSuccessfulSyncDateTime

string (date-time)

使用 YYYY-MM-DDTHH：mm：ssZ 格式的表同步成功时的日期和时间。
startDateTime

string (date-time)

使用 YYYY-MM-DDTHH：mm：ssZ 格式启动表同步的日期和时间。
status

SyncStatus

表是否同步而不出错。
tableName

string

同步的表的名称。

TimeUnit

枚举

持续时间的时间单位。 可能会随着时间的推移添加其他持续时间类型。

值 说明
Days

持续时间（以天为单位）。
Hours

持续时间（以小时为单位）。
Minutes

持续时间（以分钟为单位）。
Seconds

持续时间（以秒为单位）。