通过

通过 REST API 引入配置（预览版）

引入配置 REST API 允许以编程方式检索数据引入的配置设置，包括存储容器 URI、Microsoft Fabric 产品/服务的 Lake 文件夹路径和引入限制。 此终结点支持与用于引入的数据管理存储资源集成。

Permissions

若要使用 REST API 进行引入配置，需要：

  • 具有表范围将数据引入现有表的引入器角色。

有关详细信息，请参阅基于角色的访问控制。

HTTP 终结点

URL: /v1/rest/ingestion/configuration
Method: GET

此终结点不需要输入参数。

Authentication

身份验证方案：持有者令牌

GET /v1/rest/ingestion/configuration
Authorization: Bearer <access_token>

响应

响应是一个 JSON 对象，其中包含容器和引入参数的配置设置。

响应架构

顶级字段

领域 类型 Description
containerSettings object 包含与存储容器和上传方法相关的所有设置。
ingestionSettings object 包含与引入相关的配置属性。

容器设置对象

领域 类型 Description
containers array 容器说明的列表，每个说明都包含存储路径。
lakeFolders array OneLake 集成的 Lake 文件夹路径列表。
refreshInterval string 配置刷新调用之间的时间间隔（持续时间格式）。
preferredUploadMethod string 首选上传方法： Storage、 Lake或 Default。

Container 对象

领域 类型 Description
path string 嵌入了凭据的容器 URI（SAS 令牌）。

Lake 文件夹对象

领域 类型 Description
path string OneLake 存储的 Lake 文件夹路径。

引入设置对象

领域 类型 Description
maxBlobsPerBatch integer 每个引入批处理接受的最大 Blob 数。
maxDataSize long 允许的最大数据大小（以字节为单位）。
preferredIngestionMethod string 首选引入方法： V1 （队列）或 V2 （REST）。

Example

请求

GET /v1/rest/ingestion/configuration
Authorization: Bearer <access_token>

响应

{
  "containerSettings": {
    "containers": [
      {
        "path": "https://mystorageaccount.blob.core.chinacloudapi.cn/ingestdata?sv=2021-06-08&ss=b&srt=sco&sp=rwdlacx&se=2025-12-31T23:59:59Z&st=2025-01-01T00:00:00Z&spr=https&sig=..."
      }
    ],
    "lakeFolders": [
      {
        "path": "https://onelake.dfs.fabric.microsoft.com/workspace/artifact/Files"
      }
    ],
    "refreshInterval": "01:00:00",
    "preferredUploadMethod": "Storage"
  },
  "ingestionSettings": {
    "maxBlobsPerBatch": 20,
    "maxDataSize": 6442450944,
    "preferredIngestionMethod": "REST"
  }
}

使用提示

  • 在启动引入之前调用此终结点以获取正确的存储容器或 Lake 文件夹 URI。
  • 指示 refreshInterval 刷新配置以获取更新凭据的频率。
  • maxBlobsPerBatch使用该值来确保引入请求不超过允许的限制。
  • 容器 path 包含基于令牌有效期过期的嵌入式 SAS 凭据。
  • Last updated on