Items - Refresh Sql Endpoint Metadata

บริการ:
SQLEndpoint
เวอร์ชัน API:
v1

รีเฟรชตารางภายในจุดสิ้นสุดการวิเคราะห์ SQL
API นี้สนับสนุน การดําเนินการที่ใช้เวลานาน (LRO)

เมื่อมีการ tables ระบุในเนื้อความคําขอ เฉพาะตารางที่ระบุเท่านั้นที่จะถูกรีเฟรช เมื่อเว้นไว้หรือว่างเปล่า ตารางทั้งหมดจะถูกรีเฟรช

Permissions

ผู้โทรต้องมีบทบาท ผู้สนับสนุน หรือสูงกว่า

จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์

Item.ReadWrite.All

ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra

API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้

Identity Support
User Yes
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ Yes

Interface

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

พารามิเตอร์ URI

ชื่อ ใน จำเป็น พิมพ์ คำอธิบาย
sqlEndpointId
 path True

string (uuid)

รหัสจุดสิ้นสุดการวิเคราะห์ SQL
workspaceId
 path True

string (uuid)

ID พื้นที่ทํางาน

เนื้อความของคำขอ

ชื่อ พิมพ์ คำอธิบาย
recreateTables

boolean

เมื่อตั้งค่าเป็น true คุณสมบัตินี้จะแนะนําระบบให้วางและสร้างตารางทั้งหมดบนจุดสิ้นสุดการวิเคราะห์ SQL ใหม่ในระหว่างกระบวนการรีเฟรช ใช้ตัวเลือกนี้ถ้าคุณต้องการสร้างตารางใหม่ทั้งหมดจากข้อกําหนดแหล่งข้อมูล ตัวอย่างเช่น เพื่อแก้ไขความไม่สอดคล้องกัน หรือตรวจสอบให้แน่ใจว่ามีการรีเฟรชที่สะอาด เมื่อรวมกับ tablesแล้ว การรีเซ็ตสถานะการซิงค์จะถูกกําหนดขอบเขตเป็นตารางที่ระบุเท่านั้น ค่าเริ่มต้นคือ เท็จ
tables

TableDefinition[]

เมื่อระบุแล้ว กําหนดขอบเขตการรีเฟรชไปยังตารางที่อยู่ในรายการเท่านั้น เมื่อเว้นไว้หรือว่างเปล่า ตารางทั้งหมดจะถูกรีเฟรช แต่ละรายการระบุสคีมาและชื่อตารางอย่างน้อยหนึ่งรายการเพื่อรีเฟรชภายใต้สคีมานั้น จํานวนสูงสุดของตารางที่สามารถซิงโครไนซ์ได้ในคําขอเดียวคือ 25 การแก้ปัญหาตารางขึ้นอยู่กับว่ารายการหลักของจุดสิ้นสุด SQL เปิดใช้งาน Schema หรือไม่ สําหรับรายการที่เปิดใช้งาน schema ตารางได้รับการแก้ไขโดยใช้ schema ที่ผู้เรียกให้มา สําหรับรายการที่ไม่ได้เปิดใช้งาน schema ตารางทั้งหมดจะแก้ไขภายใต้สคีมาเริ่มต้นโดยไม่คํานึงถึงค่า Schema ที่ผู้เรียกให้มา ไม่สามารถแก้ไขตารางภายใต้ Schema ที่ไม่ใช่ค่าเริ่มต้นและจะถูกรายงานที่มีข้อผิดพลาดDeltaTableNotFound
timeout

Duration

ระยะเวลาคําขอก่อนหมดเวลา ค่าเริ่มต้นคือ 15 นาที

การตอบสนอง

ชื่อ พิมพ์ คำอธิบาย
200 OK

TableSyncStatuses

คําขอเสร็จสมบูรณ์
202 Accepted

คําขอที่ยอมรับ การรีเฟรชตารางการวิเคราะห์ SQL กําลังดําเนินการ

ส่วนหัว

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ Retry-After ส่วนหัวที่ระบุ ภายในไม่กี่วินาที ระยะเวลาที่ไคลเอ็นต์ต้องรอก่อนที่จะส่งคําขอเพิ่มเติม

ส่วนหัว

Retry-After: integer
Other Status Codes

ErrorResponse

รหัสข้อผิดพลาดทั่วไป:

  • ItemNotFound - ไม่พบรายการที่ร้องขอ

ตัวอย่าง

Refresh all tables for a specified SQL analytics endpoint in a workspace
Refresh selective tables for a specified SQL analytics endpoint in a workspace
Refresh selective tables with recreate tables for a specified SQL analytics endpoint in a workspace
Refresh selective tables with user defined schemas for a specified SQL analytics endpoint in a workspace

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

คำตอบตัวอย่าง

รหัสสถานะ:
200 
{
  "value": [
    {
      "tableName": "Table 1",
      "startDateTime": "2025-08-08T10:31:22.2708973Z",
      "endDateTime": "2025-08-08T10:36:54.9651741Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2025-08-08T10:36:54.9651741Z"
    },
    {
      "tableName": "Table 2",
      "startDateTime": "2025-08-08T10:31:22.2708973Z",
      "endDateTime": "2025-08-08T10:43:02.5329616Z",
      "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": "2025-08-07T10:44:27.2632648Z"
    },
    {
      "tableName": "Table 3",
      "startDateTime": "2025-08-08T10:31:22.2708973Z",
      "endDateTime": "2025-08-08T10:36:59.9183509Z",
      "status": "NotRun",
      "lastSuccessfulSyncDateTime": "2025-08-06T08:32:53.3890146Z"
    }
  ]
}

Refresh selective 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

{
  "tables": [
    {
      "schema": "dbo",
      "tableNames": [
        "Orders",
        "OrderDetails"
      ]
    },
    {
      "schema": "dbo",
      "tableNames": [
        "DailySummary"
      ]
    }
  ]
}

คำตอบตัวอย่าง

รหัสสถานะ:
200 
{
  "value": [
    {
      "tableName": "Orders",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:25.9651741Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:25.9651741Z"
    },
    {
      "tableName": "OrderDetails",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:26.5329616Z",
      "status": "Failure",
      "error": {
        "errorCode": "DeltaTableNotFound",
        "message": "Delta table 'Tables\\OrderDetails\\_delta_log' not found."
      },
      "lastSuccessfulSyncDateTime": "2026-06-08T10:31:26.5329616Z"
    },
    {
      "tableName": "DailySummary",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:24.9183509Z",
      "status": "NotRun",
      "lastSuccessfulSyncDateTime": "2026-06-08T08:32:53.3890146Z"
    }
  ]
}

Refresh selective tables with recreate 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

{
  "recreateTables": true,
  "tables": [
    {
      "schema": "dbo",
      "tableNames": [
        "Orders",
        "OrderDetails"
      ]
    }
  ]
}

คำตอบตัวอย่าง

รหัสสถานะ:
200 
{
  "value": [
    {
      "tableName": "Orders",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:25.9651741Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:25.9651741Z"
    },
    {
      "tableName": "OrderDetails",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:26.5329616Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:26.5329616Z"
    }
  ]
}

Refresh selective tables with user defined schemas 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

{
  "tables": [
    {
      "schema": "sales",
      "tableNames": [
        "Orders",
        "OrderDetails"
      ]
    },
    {
      "schema": "analytics",
      "tableNames": [
        "DailySummary"
      ]
    }
  ]
}

คำตอบตัวอย่าง

รหัสสถานะ:
200 
{
  "value": [
    {
      "tableName": "sales.Orders",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:25.9651741Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:25.9651741Z"
    },
    {
      "tableName": "sales.OrderDetails",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:26.5329616Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:26.5329616Z"
    },
    {
      "tableName": "analytics.DailySummary",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:24.9183509Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:24.9183509Z"
    }
  ]
}

คำจำกัดความ

ชื่อ คำอธิบาย
Duration

ระยะเวลา
ErrorRelatedResource

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse

การตอบสนองข้อผิดพลาด
ErrorResponseDetails

รายละเอียดการตอบสนองข้อผิดพลาด
SqlEndpointRefreshMetadataRequest

ส่วนข้อมูลคําขอสําหรับการรีเฟรชจุดสิ้นสุดการวิเคราะห์ SQL
SyncStatus

สถานะของการดําเนินการซิงโครไนส์ ประเภท SyncStatus เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
TableDefinition

คู่ของ Schema และชื่อตารางสําหรับการกําหนดขอบเขตการรีเฟรชที่เลือก
TableSyncStatus

ออบเจ็กต์สถานะการซิงโครไนซ์ตาราง
TableSyncStatuses

รายการของสถานะการซิงโครไนซ์ตาราง
TimeUnit

หน่วยเวลาสําหรับระยะเวลา ประเภทระยะเวลาเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

Duration

วัตถุ

ระยะเวลา

ชื่อ พิมพ์ คำอธิบาย
timeUnit

TimeUnit

หน่วยเวลาสําหรับระยะเวลา ประเภทระยะเวลาเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
value

number

จํานวนเวลาหน่วยในระยะเวลา

ErrorRelatedResource

วัตถุ

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
resourceId

string

ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType

string

ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

วัตถุ

การตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
isRetriable

boolean

เมื่อเป็นจริง สามารถลองคําขอใหม่ได้ ใช้ส่วนหัวการตอบสนอง Retry-After เพื่อกําหนดความล่าช้า ถ้ามี
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails

ErrorResponseDetails[]

รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId

string (uuid)

รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

วัตถุ

รายละเอียดการตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

SqlEndpointRefreshMetadataRequest

วัตถุ

ส่วนข้อมูลคําขอสําหรับการรีเฟรชจุดสิ้นสุดการวิเคราะห์ SQL

ชื่อ พิมพ์ คำอธิบาย
recreateTables

boolean

เมื่อตั้งค่าเป็น true คุณสมบัตินี้จะแนะนําระบบให้วางและสร้างตารางทั้งหมดบนจุดสิ้นสุดการวิเคราะห์ SQL ใหม่ในระหว่างกระบวนการรีเฟรช ใช้ตัวเลือกนี้ถ้าคุณต้องการสร้างตารางใหม่ทั้งหมดจากข้อกําหนดแหล่งข้อมูล ตัวอย่างเช่น เพื่อแก้ไขความไม่สอดคล้องกัน หรือตรวจสอบให้แน่ใจว่ามีการรีเฟรชที่สะอาด เมื่อรวมกับ tablesแล้ว การรีเซ็ตสถานะการซิงค์จะถูกกําหนดขอบเขตเป็นตารางที่ระบุเท่านั้น ค่าเริ่มต้นคือ เท็จ
tables

TableDefinition[]

เมื่อระบุแล้ว กําหนดขอบเขตการรีเฟรชไปยังตารางที่อยู่ในรายการเท่านั้น เมื่อเว้นไว้หรือว่างเปล่า ตารางทั้งหมดจะถูกรีเฟรช แต่ละรายการระบุสคีมาและชื่อตารางอย่างน้อยหนึ่งรายการเพื่อรีเฟรชภายใต้สคีมานั้น จํานวนสูงสุดของตารางที่สามารถซิงโครไนซ์ได้ในคําขอเดียวคือ 25 การแก้ปัญหาตารางขึ้นอยู่กับว่ารายการหลักของจุดสิ้นสุด SQL เปิดใช้งาน Schema หรือไม่ สําหรับรายการที่เปิดใช้งาน schema ตารางได้รับการแก้ไขโดยใช้ schema ที่ผู้เรียกให้มา สําหรับรายการที่ไม่ได้เปิดใช้งาน schema ตารางทั้งหมดจะแก้ไขภายใต้สคีมาเริ่มต้นโดยไม่คํานึงถึงค่า Schema ที่ผู้เรียกให้มา ไม่สามารถแก้ไขตารางภายใต้ Schema ที่ไม่ใช่ค่าเริ่มต้นและจะถูกรายงานที่มีข้อผิดพลาดDeltaTableNotFound
timeout

Duration

ระยะเวลาคําขอก่อนหมดเวลา ค่าเริ่มต้นคือ 15 นาที

SyncStatus

การแจงนับ

สถานะของการดําเนินการซิงโครไนส์ ประเภท SyncStatus เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

ค่า คำอธิบาย
Success

ระบุความสําเร็จ
Failure

ระบุความล้มเหลว
NotRun

ระบุว่าการดําเนินการไม่ได้ทํางาน

TableDefinition

วัตถุ

คู่ของ Schema และชื่อตารางสําหรับการกําหนดขอบเขตการรีเฟรชที่เลือก

ชื่อ พิมพ์ คำอธิบาย
schema

string

minLength: 1
maxLength: 128

ชื่อเค้าร่างสําหรับการแก้ไขตาราง ต้องไม่ใช่เค้าร่างระบบที่สงวนไว้
tableNames

string[]

minLength: 1
maxLength: 128

ชื่อตารางอย่างน้อยหนึ่งรายการที่จะรีเฟรชภายใต้เค้าร่างที่ระบุ

TableSyncStatus

วัตถุ

ออบเจ็กต์สถานะการซิงโครไนซ์ตาราง

ชื่อ พิมพ์ คำอธิบาย
endDateTime

string (date-time)

วันที่และเวลาเมื่อการซิงโครไนซ์ตารางเสร็จสมบูรณ์ในรูปแบบ UTC โดยใช้รูปแบบ YYYY-MM-DDTHH:mm:ssZ
error

ErrorResponseDetails

รายละเอียดการตอบกลับข้อผิดพลาด
lastSuccessfulSyncDateTime

string (date-time)

วันที่และเวลาเมื่อการซิงโครไนซ์ตารางสําเร็จในรูปแบบ UTC โดยใช้รูปแบบ YYYY-MM-DDTHH:mm:ssZ
startDateTime

string (date-time)

วันที่และเวลาเมื่อการซิงโครไนซ์ตารางเริ่มต้นในรูปแบบ UTC โดยใช้รูปแบบ YYYY-MM-DDTHH:mm:ssZ
status

SyncStatus

ไม่ว่าตารางจะซิงโครไนซ์โดยไม่มีข้อผิดพลาดหรือไม่
tableName

string

ชื่อของตารางที่ซิงโครไนซ์ สําหรับรายการที่เปิดใช้งาน schema ชื่อตารางจะถูกขึ้นต้นด้วยชื่อ schema (เช่น "schema.tableName")

TableSyncStatuses

วัตถุ

รายการของสถานะการซิงโครไนซ์ตาราง

ชื่อ พิมพ์ คำอธิบาย
value

TableSyncStatus[]

รายการของสถานะการซิงโครไนซ์ตาราง

TimeUnit

การแจงนับ

หน่วยเวลาสําหรับระยะเวลา ประเภทระยะเวลาเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

ค่า คำอธิบาย
Seconds

ระยะเวลาเป็นวินาที
Minutes

ระยะเวลาเป็นนาที
Hours

ระยะเวลาเป็นชั่วโมง
Days

ระยะเวลาเป็นวัน