查詢目標Project下的日志,該接口是Project級別的SQL查詢接口。
接口說明
- 請求語法中 Host 由 Project 名稱和日志服務 Endpoint 構成,您需要在 Host 中指定 Project。
- 已創建并獲取 AccessKey。更多信息,請參見訪問密鑰。
阿里云賬號 AccessKey 擁有所有 API 的訪問權限,風險很高。強烈建議您創建并使用 RAM 用戶進行 API 訪問或日常運維。RAM 用戶需具備操作日志服務資源的權限。具體操作,請參見創建 RAM 用戶及授權。
- 已明確您查詢日志所屬的 Project 名稱、所屬地域等。如何查詢,請參見管理 Project。
- 查詢日志前,已配置索引。具體操作,請參見創建索引。
- 日志服務查詢日志時存在使用限制。請設計合理查詢與分析語句、設置合理查詢區間等。更多信息,請參見查詢日志使用限制和分析日志使用限制。
- 參數 query 是一個標準的 SQL 查詢語句。
- 查詢的 Logstore 在查詢語句的 from 條件中指定。可以將 Logstore 看做是 SQL 中的表。
- 在查詢的 SQL 條件中必須指定要查詢的時間范圍,時間范圍由__date__(Timestamp 類型)或__time__(Integer 類型,單位是秒)來指定。
鑒權資源
下表列出了 API 對應的授權信息。您可以在 RAM 權限策略語句的 Action 元素中添加該信息,用于為 RAM 用戶或 RAM 角色授予調用此 API 的權限。
動作(Action) | 授權策略中的資源描述方式(Resource) |
---|---|
log:GetProjectLogs | acs:log:{#regionId}:{#accountId}:project/{#ProjectName} |
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求語法
GET /logs HTTP/1.1
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
project | string | 是 | Project 名稱。 | ali-test-project |
query | string | 是 | 標準 SQL 語句。例如日志庫名稱為 nginx-moni,查詢時間區間在 2022-03-01 10:41:40 到 2022-03-01 10:56:40 之間的訪問數量。 | SELECT COUNT(*) as pv FROM nginx-moni where __time__ > 1646102500 and __time__ < 1646103400 |
powerSql | boolean | 否 | 是否使用 SQL 獨享版。更多信息,請參見開啟 SQL 獨享版。
除通過 powerSql 參數配置 SQL 獨享版外,您還可以使用 query 參數。 | false |
請求示例:
GET /logs?query=SELECT COUNT(*) as pv FROM nginx-moni where __time__ > 1646102500 and __time__ < 1646103400&powerSql=false HTTP/1.1
Host:ali-test-project.ch-hangzhou.log.aliyuncs.com
Content-Type:application/json
返回參數
示例
正常返回示例
JSON
格式
[
{
"key": "[ { \"__time__\" : 1409529660, \"__source__\" : \"192.168.1.100\", \"Key1\" : \"error\", \"Key2\" : \"Value2\" }, { \"__time__\" : 1409529680, \"__source__\" : \"192.168.1.100\", \"Key3\" : \"error\", \"Key4\" : \"Value4\" } ]"
}
]
錯誤碼
訪問錯誤中心查看更多錯誤碼。
HttpStatusCode | ErrorCode | ErrorMessage | 錯誤碼描述 |
---|---|---|---|
400 | ParameterInvalid | Parameter is invalid. | 請求的參數錯誤。 |
更多信息,請參見通用錯誤碼。