當您需要頻繁查看某一查詢和分析結果時,可以將對應查詢和分析語句另存為快速查詢。本文通過代碼示例介紹如何創建、修改、查詢、刪除快速查詢等。
前提條件
已開通日志服務。更多信息,請參見開通日志服務。
已創建RAM用戶并完成授權。具體操作,請參見創建RAM用戶并完成授權。
已配置環境變量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET。具體操作,請參見在Linux、macOS和Windows系統配置環境變量。
重要阿里云賬號的AccessKey擁有所有API的訪問權限,建議您使用RAM用戶的AccessKey進行API訪問或日常運維。
強烈建議不要把AccessKey ID和AccessKey Secret保存到工程代碼里,否則可能導致AccessKey泄露,威脅您賬號下所有資源的安全。
已安裝日志服務Java SDK。具體操作,請參見安裝Java SDK。
Logstore已寫入日志并開啟索引。具體操作,請參見使用Java SDK管理日志庫Logstore和創建索引。
注意事項
本示例以華東1(杭州)的公網Endpoint為例,其公網Endpoint為https://cn-hangzhou.log.aliyuncs.com
。如果您通過與Project同地域的其他阿里云產品訪問日志服務,請使用內網Endpointhttps://cn-hangzhou-intranet.log.aliyuncs.com
。關于日志服務支持的地域與Endpoint的對應關系,請參見服務入口。
原始日志樣例
body_bytes_sent:1750
host:www.example.com
http_referer:www.example.com
http_user_agent:Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_6; it-it) AppleWebKit/533.20.25 (KHTML, like Gecko) Version/5.0.4 Safari/533.20.27
http_x_forwarded_for:203.0.XX.XX
remote_addr:203.0.XX.XX
remote_user:p288
request_length:13741
request_method:GET
request_time:71
request_uri:/request/path-1/file-1
http_code:200
time_local:11/Aug/2021:06:52:27
upstream_response_time:0.66
創建快速查詢示例代碼
以下代碼用于創建名為ali-test-savedsearch的快速查詢。
import com.aliyun.openservices.log.Client;
import com.aliyun.openservices.log.common.SavedSearch;
import com.aliyun.openservices.log.exception.LogException;
import com.aliyun.openservices.log.request.CreateSavedSearchRequest;
public class CreateSavedSearch {
public static void main(String[] args) throws LogException {
// 本示例從環境變量中獲取AccessKey ID和AccessKey Secret。
String accessId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
String accessKey = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
// 輸入Project名稱。
String projectName = "ali-test-project";
// 設置日志服務的服務接入點。此處以杭州為例,其它地域請根據實際情況填寫。
String host = "https://cn-hangzhou.log.aliyuncs.com";
// 創建日志服務Client。
Client client = new Client(host, accessId, accessKey);
try {
// 輸入Logstore名稱。
String logstoreName = "ali-test-logstore";
// 設置快速查詢名稱。
String savedSearchName = "ali-test-savedsearch";
// 查詢GET請求或POST請求失敗的日志。
String query = "(request_method:GET or request_method:POST) not status in [200 299]";
System.out.println("ready to create savedsearch");
SavedSearch savedSearch = new SavedSearch();
// 設置Logstore。
savedSearch.setLogstore(logstoreName);
// 設置快速查詢名稱。
savedSearch.setSavedSearchName(savedSearchName);
// 設置快速查詢的顯示名稱。
savedSearch.setDisplayName("savedsearch-displayname");
// 設置快速查詢的查詢語句。
savedSearch.setSearchQuery(query);
CreateSavedSearchRequest request = new CreateSavedSearchRequest(projectName, savedSearch);
// 創建快速查詢。
client.createSavedSearch(request);
System.out.println(String.format("create savedsearch %s success", savedSearchName));
} catch (LogException e) {
System.out.println("LogException e :" + e.toString());
System.out.println("error code :" + e.GetErrorCode());
System.out.println("error message :" + e.GetErrorMessage());
throw e;
}
}
}
預期結果如下:
ready to create savedsearch
create savedsearch ali-test-savedsearch success
修改快速查詢示例代碼
以下代碼用于修改名為ali-test-savedsearch的快速查詢。
import com.aliyun.openservices.log.Client;
import com.aliyun.openservices.log.common.SavedSearch;
import com.aliyun.openservices.log.exception.LogException;
import com.aliyun.openservices.log.request.UpdateSavedSearchRequest;
public class UpdateSavedSearch {
public static void main(String[] args) throws LogException {
// 本示例從環境變量中獲取AccessKey ID和AccessKey Secret。
String accessId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
String accessKey = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
// 輸入Project名稱。
String projectName = "ali-test-project";
// 設置日志服務的服務接入點。此處以杭州為例,其它地域請根據實際情況填寫。
String host = "https://cn-hangzhou.log.aliyuncs.com";
// 創建日志服務Client。
Client client = new Client(host, accessId, accessKey);
try {
// 輸入Logstore名稱。
String logstoreName = "ali-test-logstore";
// 輸入快速查詢名稱。
String savedSearchName = "ali-test-savedsearch";
// 查詢GET請求或POST請求失敗的日志。
String query = "(request_method:GET or request_method:POST) not status in [200 299]";
System.out.println("ready to update savedsearch");
SavedSearch savedSearch = new SavedSearch();
// 設置Logstore。
savedSearch.setLogstore(logstoreName);
// 設置快速查詢名稱。
savedSearch.setSavedSearchName(savedSearchName);
// 更新快速查詢的顯示名稱。
savedSearch.setDisplayName("new-savedsearch-displayname");
// 設置快速查詢的查詢語句。
savedSearch.setSearchQuery(query);
UpdateSavedSearchRequest request = new UpdateSavedSearchRequest(projectName, savedSearch);
// 更新快速查詢。
client.updateSavedSearch(request);
System.out.println(String.format("update savedsearch %s success", savedSearchName));
} catch (LogException e) {
System.out.println("LogException e :" + e.toString());
System.out.println("error code :" + e.GetErrorCode());
System.out.println("error message :" + e.GetErrorMessage());
throw e;
}
}
}
預期結果如下:
ready to update savedsearch
update savedsearch ali-test-savedsearch success
查詢所有快速查詢示例代碼
以下代碼用于查詢目標Project下的所有快速查詢。
import com.aliyun.openservices.log.Client;
import com.aliyun.openservices.log.common.SavedSearch;
import com.aliyun.openservices.log.exception.LogException;
import com.aliyun.openservices.log.request.ListSavedSearchRequest;
import com.aliyun.openservices.log.response.ListSavedSearchResponse;
public class ListSavedSearch {
public static void main(String[] args) throws LogException {
// 本示例從環境變量中獲取AccessKey ID和AccessKey Secret。
String accessId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
String accessKey = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
// 輸入Project名稱。
String projectName = "ali-test-project";
// 設置日志服務的服務接入點。此處以杭州為例,其它地域請根據實際情況填寫。
String host = "https://cn-hangzhou.log.aliyuncs.com";
// 創建日志服務Client。
Client client = new Client(host, accessId, accessKey);
try {
System.out.println("ready to list savedsearch");
// 查看所有快速查詢。
ListSavedSearchRequest request = new ListSavedSearchRequest(projectName, 0, 10);
ListSavedSearchResponse response = client.listSavedSearch(request);
for (SavedSearch savedSearch : response.getSavedSearches()){
// 輸出快速查詢。
System.out.println("the savedsearch is :" + savedSearch.getDisplayName());
}
System.out.println(String.format("list savedsearch from project %s success", projectName));
} catch (LogException e) {
System.out.println("LogException e :" + e.toString());
System.out.println("error code :" + e.GetErrorCode());
System.out.println("error message :" + e.GetErrorMessage());
throw e;
}
}
}
預期結果如下:
ready to list savedsearch
the savedsearch is :savedsearch-displayname
the savedsearch is :savedsearch-displayname2
list savedsearch from project ali-test-project success
查詢指定快速查詢示例代碼
以下代碼用于查詢指定快速查詢信息。
import com.aliyun.openservices.log.Client;
import com.aliyun.openservices.log.common.SavedSearch;
import com.aliyun.openservices.log.exception.LogException;
import com.aliyun.openservices.log.request.GetSavedSearchRequest;
import com.aliyun.openservices.log.response.GetSavedSearchResponse;
public class GetSavedSearch {
public static void main(String[] args) throws LogException {
// 本示例從環境變量中獲取AccessKey ID和AccessKey Secret。
String accessId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
String accessKey = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
// 輸入Project名稱。
String projectName = "ali-test-project";
// 設置日志服務的服務接入點。此處以杭州為例,其它地域請根據實際情況填寫。
String host = "https://cn-hangzhou.log.aliyuncs.com";
// 創建日志服務Client。
Client client = new Client(host, accessId, accessKey);
try {
// 輸入快速查詢名稱。
String savedSearchName = "ali-test-savedsearch";
System.out.println("ready to get savedsearch");
// 查看指定快速查詢。
GetSavedSearchRequest request = new GetSavedSearchRequest(projectName, savedSearchName);
GetSavedSearchResponse response = client.getSavedSearch(request);
SavedSearch savedSearch = response.getSavedSearch();
// 輸出快速查詢詳細配置。
System.out.println("the savedsearch name is :" + savedSearch.getSavedSearchName());
System.out.println("the savedsearch displayname is :" + savedSearch.getDisplayName());
System.out.println("the savedsearch query is :" + savedSearch.getSearchQuery());
System.out.println(String.format("get savedsearch from project %s success", projectName));
} catch (LogException e) {
System.out.println("LogException e :" + e.toString());
System.out.println("error code :" + e.GetErrorCode());
System.out.println("error message :" + e.GetErrorMessage());
throw e;
}
}
}
預期結果如下:
ready to get savedsearch
the savedsearch name is :ali-test-savedsearch
the savedsearch displayname is :savedsearch-displayname
the savedsearch query is :(request_method:GET or request_method:POST) not status in [200 299]
get savedsearch from project ali-test-project success
刪除快速查詢示例代碼
以下代碼用于刪除目標Project下的快速查詢。
import com.aliyun.openservices.log.Client;
import com.aliyun.openservices.log.exception.LogException;
import com.aliyun.openservices.log.request.DeleteSavedSearchRequest;
public class DeleteSavedSearch {
public static void main(String[] args) throws LogException {
// 本示例從環境變量中獲取AccessKey ID和AccessKey Secret。
String accessId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
String accessKey = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
// 輸入Project名稱。
String projectName = "ali-test-project";
// 設置日志服務的服務接入點。此處以杭州為例,其它地域請根據實際情況填寫。
String host = "https://cn-hangzhou.log.aliyuncs.com";
// 創建日志服務Client。
Client client = new Client(host, accessId, accessKey);
try {
// 輸入快速查詢名稱。
String savedSearchName = "ali-test-savedsearch";
System.out.println("ready to delete savedsearch");
// 刪除指定快速查詢。
DeleteSavedSearchRequest request = new DeleteSavedSearchRequest(projectName, savedSearchName);
client.deleteSavedSearch(request);
System.out.println(String.format("delete savedsearch from project %s success", projectName));
} catch (LogException e) {
System.out.println("LogException e :" + e.toString());
System.out.println("error code :" + e.GetErrorCode());
System.out.println("error message :" + e.GetErrorMessage());
throw e;
}
}
}
預期結果如下:
ready to delete savedsearch
delete savedsearch from project ali-test-project success
相關文檔
在調用API接口過程中,若服務端返回結果中包含錯誤信息,則表示調用API接口失敗。您可以參考API錯誤碼對照表查找對應的解決方法。更多信息,請參見API錯誤處理對照表。
阿里云OpenAPI開發者門戶提供調試、SDK、示例和配套文檔。通過OpenAPI,您無需手動封裝請求和簽名操作,就可以快速對日志服務API進行調試。更多信息,請參見OpenAPI開發者門戶。
為滿足越來越多的自動化日志服務配置需求,日志服務提供命令行工具CLI(Command Line Interface)。更多信息,請參見日志服務命令行工具CLI。
關于快速查詢API接口說明,請參見如下:
更多示例代碼,請參見Aliyun Log Java SDK on GitHub。