日志查询 API Prefer 选项

日志查询 API 支持使用 Prefer 标头设置一些请求和响应选项。 本部分介绍如何设置每个首选项及其值。

Prefer:include-render - 可视化信息

在查询语言中，可以指定不同的呈现选项。 默认情况下，API 不返回有关可视化效果类型的信息。 若要包含特定的可视化效果，请包含以下标头：

    Prefer: include-render=true

该标头在响应中包含一个 render 属性，该属性指定查询选择的可视化效果类型以及该可视化效果的任何属性。

例如，以下请求指定了一幅标题为“24H Perf 事件”的条形图可视化：

    POST https://api.loganalytics.azure.cn/v1/workspaces/{workspace-id}/query
    Authorization: Bearer <access token>
    Prefer: include-render=true
    Content-Type: application/json
    
    {
        "query": "Perf | summarize count() by bin(TimeGenerated, 4h) | render barchart title='24H Perf events'",
        "timespan": "P1D"
    }

响应包含一个 render 属性，该属性描述所选可视化效果的元数据。

    HTTP/1.1 200 OK
    Content-Type: application/json; charset=utf-8
    
    {
        "tables": [ ...query results... ],
        "render": {
            "visualization": "barchart",
            "title": "24H Perf events",
            "accumulate": false,
            "isQuerySorted": false,
            "kind": "default",
            "annotation": "",
            "by": null
        }
    }

Prefer:include-statistics - 查询统计信息

若要获取有关查询统计数据的信息，请包含以下标头：

    Prefer: include-statistics=true

该标头在响应中包含一个 statistics 属性，该属性描述各种性能统计信息，例如查询执行时间和资源使用量。

Prefer:wait - 查询超时

默认查询超时为 3 分钟（180 秒）。 要调整查询超时，请设置wait标头请求值（以秒为单位）。

    Prefer: wait=300

有关详细信息，请参阅 日志查询 API 服务器超时。

Prefer:include-dataSources - 查询数据源

若要获取有关查询数据源（如区域、工作区、群集和表）的信息，请包括以下标头：

    Prefer: include-dataSources=true

Prefer:include-permissions - 列出权限

若要查询 Azure 资源的日志，用户必须具有相应的权限才能访问包含日志的资源和 Log Analytics 工作区。 如果用户缺少必要的权限，可能会返回不同的错误响应，具体取决于缺少的特定权限。 良好的权限故障排除步骤是在请求中包含以下标头：

    Prefer: include-permissions=true

有关详细信息，请参阅 日志查询 API 资源查询访问故障排除。