你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Query - Resource Execute Xms

参考

Service:: Log Analytics

API Version:: 2022-10-27_Preview

使用资源 ID 执行 Analytics 查询
对资源上下文中的数据执行 Analytics 查询。下面是将 POST 与分析查询配合使用的示例。

POST https://api.loganalytics.io/v1/{resourceId}/query

URI 参数

名称	在	必需	类型	说明
resourceId	path	True	string	资源的标识符。

请求头

名称	必需	类型	说明
Prefer		string	可选。首选标头，用于设置服务器超时、查询统计信息和可视化信息。

请求正文

名称	必需	类型	说明
query	True	string	要执行的查询。
timespan		string	可选。查询数据的时间跨度。这是一个ISO8601时间段值。除了查询表达式中指定的任何时间跨度外，还会应用此时间跨度。
workspaces		string[]	查询中包含的工作区列表。

响应

名称	类型	说明
200 OK	queryResults	没问题。 API 调用成功，分析查询结果位于响应有效负载中
Other Status Codes	errorResponse	错误响应对象。

安全性

oauth2

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

simple-query

Sample Request

HTTP

POST https://api.loganalytics.io/v1//subscriptions/fffa080af-c2d8-40ad-9cce-e1a450bawb57/resourceGroups/test-resourcegroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/query

{
  "query": "StorageBlobLogs | summarize count() by OperationName | top 10 by count_ desc",
  "timespan": "PT24H"
}

Sample Response

Status code:: 200

{
  "tables": [
    {
      "name": "PrimaryResult",
      "columns": [
        {
          "name": "OperationName",
          "type": "string"
        },
        {
          "name": "count_",
          "type": "long"
        }
      ],
      "rows": [
        [
          "operation1",
          "10"
        ]
      ]
    }
  ]
}

定义

名称	说明
column	表列。
errorDetail	错误详细信息。
errorInfo	错误的代码和消息。
errorResponse	错误详细信息。
logsColumnType	此列的数据类型。
queryBody	分析查询。详细了解 Analytics 查询语法
queryResults	查询响应。
Render	JSON 格式的可视化数据。
Statistics	以 JSON 格式表示的统计信息。
table	查询响应表。

column

表列。

名称	类型	说明
name	string	此列的名称。
type	logsColumnType	此列的数据类型。

errorDetail

错误详细信息。

名称	类型	说明
additionalProperties	object	可在错误详细信息对象上提供的其他属性
code	string	错误的代码。
message	string	人工可读的错误消息。
resources	string[]	指示导致错误的资源。
target	string	指示请求中的哪个属性是导致错误的。
value	string	指示“target”中的哪个值导致错误。

errorInfo

错误的代码和消息。

名称	类型	说明
additionalProperties	object	可在错误信息对象上提供的其他属性
code	string	计算机可读错误代码。
details	errorDetail[]	错误详细信息。
innererror	errorInfo	错误的代码和消息。内部错误详细信息（如果存在）。
message	string	人工可读的错误消息。

errorResponse

错误详细信息。

名称	类型	说明
error	errorInfo	错误的代码和消息。错误详细信息。

logsColumnType

此列的数据类型。

名称	类型	说明
bool	string
datetime	string
decimal	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string
timespan	string

queryBody

分析查询。详细了解 Analytics 查询语法

名称	类型	说明
query	string	要执行的查询。
timespan	string	可选。查询数据的时间跨度。这是一个ISO8601时间段值。除了查询表达式中指定的任何时间跨度外，还会应用此时间跨度。
workspaces	string[]	查询中包含的工作区列表。

queryResults

查询响应。

名称	类型	说明
error	errorInfo	错误的代码和消息。
render	Render	JSON 格式的可视化数据。
statistics	Statistics	以 JSON 格式表示的统计信息。
tables	table[]	表、列和行的列表。

Render

JSON 格式的可视化数据。

Statistics

以 JSON 格式表示的统计信息。

table

查询响应表。

名称	类型	说明
columns	column[]	此表中的列列表。
name	string	表的名称。
rows	object[]	此查询生成的行。

Share via