Datasets - Execute Dax Queries

针对提供的数据集执行数据分析表达式 （DAX） 查询。 数据集必须驻留在 “我的工作区”中。 响应以 Apache Arrow 格式返回。

权限或查询错误将导致：

• 响应错误，例如 XMLA endpoint feature is disabled. Turn on the tenant setting 'Allow XMLA endpoints and Analyze in Excel with on-premises semantic models' to enable this feature.。
• 成功的 HTTP 状态代码（200），其中包含错误详细信息的记录批处理。

Permissions

必须在 集成设置下找到 数据集执行查询 REST API的租户设置。

用户必须具有数据集读取和生成权限。 有关详细信息，请参阅 管理数据集访问权限。

所需范围

Dataset.ReadWrite.All 或 Dataset.Read.All

Limitations

• 此 API 仅适用于容量上托管的数据集。
• 不支持托管在 Azure Analysis Services 中或与本地 Azure Analysis Services 模型建立实时连接的数据集。
• 每个 API 调用一个查询，但查询可以有多个评估语句。
• 无论查询的数据集如何，每个用户的查询请求数限制为每分钟 120 个。
• 若要使用服务主体，请确保管理员租户设置 允许服务主体在启用 开发人员设置 下使用 Power BI API。 有关使用 RLS 的语义模型的详细信息，请参阅 RLS 限制。
• 目前仅支持 DAX 查询和 INFO 函数。 不支持 MDX 和 DMV 查询。

响应格式

响应正文包含一个或多个串联 的 Apache Arrow IPC 流。 每个流自包含其自己的架构和记录批处理。 若要处理响应，请使用 Apache Arrow 客户端库。

响应可能包括以下行集类型，这些类型由架构级别元数据标识（箭头架构上的键值对）：

• 数据行集：包含查询结果。 没有特殊的元数据键。 列名和类型由 DAX 查询确定。
• 错误行集：在 IsError = true 架构元数据中标识。 包含列： ErrorCode、 ErrorMessage、 ErrorDescription和源位置字段。 架构元数据还包括 FaultCode （十六进制错误代码）和 FaultString （错误消息）。

在响应中记录批处理使用LZ4_FRAME压缩。 pyarrow 库会自动处理此问题。 对于 .NET，请安装 Apache.Arrow.Compression NuGet 包。

以下Python示例演示如何使用 pyarrow0 读取数据和检查错误：

import io
import pyarrow as pa

# response = requests.post(url, headers=headers, json=request_body)
stream = io.BytesIO(response.content)
results = []

while stream.tell() < len(response.content):
    try:
        reader = pa.ipc.open_stream(stream)
        table = reader.read_all()
        metadata = {
            k.decode(): v.decode()
            for k, v in (reader.schema.metadata or {}).items()
        }
        if metadata.get("IsError") == "true":
            raise RuntimeError(
                f"Query error [{metadata.get('FaultCode')}]: "
                f"{metadata.get('FaultString')}"
            )
        else:
            results.append(table)
    except pa.ArrowInvalid:
        break

print(results[0].to_pandas())

对于.NET，请使用此 SDK 中的 DaxQueryArrowResponseReader 类，该类处理流分析、错误检测和 LZ4 解压缩。

POST https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/executeDaxQueries

URI 参数

请求正文

响应

示例

Execute query with culture

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/executeDaxQueries

{
  "query": "EVALUATE ROW(\"Formatted Date\", FORMAT(DATE(2024, 12, 31), \"Long Date\"))",
  "culture": "en-US"
}

Execute query with custom data

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/executeDaxQueries

{
  "query": "EVALUATE FILTER('Sales', 'Sales'[Region] = CUSTOMDATA())",
  "customData": "North America"
}

Execute query with effective username

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/executeDaxQueries

{
  "query": "EVALUATE SUMMARIZECOLUMNS('Sales'[Region], \"Total\", SUM('Sales'[Amount]))",
  "effectiveUsername": "user@contoso.com",
  "roles": [
    "SalesRole"
  ],
  "queryTimeout": 300
}

Execute simple DAX query

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/executeDaxQueries

{
  "query": "EVALUATE VALUES('Product'[Category])",
  "queryTimeout": 600,
  "schemaOnly": false,
  "resultSetRowCountLimit": 100000
}

定义

DatasetExecuteDaxQueriesRequest

针对数据集执行查询的请求