如何使用JavaSDK管理日誌庫Logstore - Simple Log Service

日誌庫（Logstore）是Log Service中資料的採集、儲存和查詢單元。每個Logstore隸屬於一個Project，每個Project中可建立多個Logstore。本文通過程式碼範例介紹如何建立、修改、查詢、刪除Logstore等。

前提條件

已建立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泄露，威脅您帳號下所有資源的安全。
已安裝Log ServiceJava SDK。具體操作，請參見安裝Java SDK。

注意事項

本樣本以華東1（杭州）的公網Endpoint為例，其公網Endpoint為https://cn-hangzhou.log.aliyuncs.com。如果您通過與Project同地區的其他阿里雲產品訪問Log Service，請使用內網Endpointhttps://cn-hangzhou-intranet.log.aliyuncs.com。關於Log Service支援的地區與Endpoint的對應關係，請參見服務入口。

建立Logstore

以下代碼用於建立名為ali-test-logstore的Logstore。

import com.aliyun.openservices.log.Client;
import com.aliyun.openservices.log.common.LogStore;
import com.aliyun.openservices.log.exception.LogException;
import com.aliyun.openservices.log.request.CreateLogStoreRequest;

public class CreateLogstore {
    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";
        // 設定Log Service的服務存取點。此處以杭州為例，其它地區請根據實際情況填寫。
        String host = "https://cn-hangzhou.log.aliyuncs.com";

        // 建立Log ServiceClient。
        Client client = new Client(host, accessId, accessKey);

        try {
            // 輸入Logstore名稱。
            String logstoreName = "ali-test-logstore";
            System.out.println("ready to create logstore");

            // 建立Logstore，資料儲存時間為60天，2個Shard，開啟WebTracking功能。
            LogStore logStore = new LogStore(logstoreName, 60, 2, true);
            // 開啟Shard自動分裂。
            logStore.setmAutoSplit(true);
            // 設定Shard自動分裂最大數為64。
            logStore.setmMaxSplitShard(64);
            // 開啟記錄外網IP地址功能。
            logStore.setAppendMeta(true);
            // 設定資料在Logstore熱儲存層中的儲存時間為30天。
            logStore.setHotTTL(30);
            // 設定Logstore類型為standard。
            logStore.setMode("standard");

            CreateLogStoreRequest request = new CreateLogStoreRequest(projectName, logStore);
            // 建立Logstore。
            client.CreateLogStore(request);

            System.out.println(String.format("create logstore %s success", logstoreName));

        } 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 logstore
create logstore ali-test-logstore success

修改Logstore

以下代碼用於修改名為ali-test-logstore的Logstore配置資訊。

import com.aliyun.openservices.log.Client;
import com.aliyun.openservices.log.common.LogStore;
import com.aliyun.openservices.log.exception.LogException;
import com.aliyun.openservices.log.request.UpdateLogStoreRequest;

public class UpdateLogstore {
    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";
        // 設定Log Service的服務存取點。此處以杭州為例，其它地區請根據實際情況填寫。
        String host = "https://cn-hangzhou.log.aliyuncs.com";

        // 建立Log ServiceClient。
        Client client = new Client(host, accessId, accessKey);

        try {
            // 輸入Logstore名稱。
            String logstoreName = "ali-test-logstore";
            System.out.println("ready to update logstore");

            // 更新資料在Logstore熱儲存層中的儲存時間為45天。
            LogStore logStore = new LogStore(logstoreName, 60, 2, true);
            logStore.setHotTTL(45);

            UpdateLogStoreRequest request = new UpdateLogStoreRequest(projectName, logStore);
            // 更新Logstore。
            client.UpdateLogStore(request);

            System.out.println(String.format("update logstore %s success", logstoreName));

        } 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 logstore
update logstore ali-test-logstore success

查詢所有Logstore

以下代碼用於查詢目標Project下的所有Logstore。

import com.aliyun.openservices.log.Client;
import com.aliyun.openservices.log.exception.LogException;
import com.aliyun.openservices.log.request.ListLogStoresRequest;
import com.aliyun.openservices.log.response.ListLogStoresResponse;

public class ListLogstore {

    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";
        // 設定Log Service的服務存取點。此處以杭州為例，其它地區請根據實際情況填寫。
        String host = "https://cn-hangzhou.log.aliyuncs.com";

        // 建立Log ServiceClient。
        Client client = new Client(host, accessId, accessKey);

        try {
            System.out.println("ready to list logstore");

            // 查詢10個Logstore。
            ListLogStoresRequest request = new ListLogStoresRequest(projectName, 0, 10, "", "None");

            ListLogStoresResponse response = client.ListLogStores(request);

            for (String logStore : response.GetLogStores()) {
                System.out.println(logStore.toString());
            }
        } 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 logstore
ali-test-logstore

查詢指定Logstore

以下代碼用於查詢指定Logstore資訊。

import com.aliyun.openservices.log.Client;
import com.aliyun.openservices.log.exception.LogException;
import com.aliyun.openservices.log.request.GetLogStoreRequest;
import com.aliyun.openservices.log.response.GetLogStoreResponse;

public class GetLogstore {

    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";
        // 設定Log Service的服務存取點。此處以杭州為例，其它地區請根據實際情況填寫。
        String host = "https://cn-hangzhou.log.aliyuncs.com";

        // 建立Log ServiceClient。
        Client client = new Client(host, accessId, accessKey);

        try {
            // 輸入Logstore名稱。
            String logStoreName = "ali-test-logstore";
            System.out.println("ready to get logstore");

            // 查詢指定Logstore。
            GetLogStoreRequest request = new GetLogStoreRequest(projectName, logStoreName);

            GetLogStoreResponse response = client.GetLogStore(request);

            System.out.println("The Logstore name is : " + response.GetLogStore().GetLogStoreName());

        } 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 logstore
The Logstore name is : ali-test-logstore

刪除Logstore

以下代碼用於刪除名為ali-test-logstore的Logstore。

重要

Logstore一旦刪除，其儲存的資料將會被永久刪除，不可恢複，請謹慎操作。
刪除Logstore前需先刪除其對應的所有Logtail配置。
如果該Logstore上還啟用了日誌投遞，建議刪除前停止向該Logstore寫入新資料，並確認Logstore中已有的資料已經全部投遞成功。
如果您使用阿里雲帳號刪除Logstore時，控制台提示許可權不足，請提交工單進行刪除。

import com.aliyun.openservices.log.Client;
import com.aliyun.openservices.log.exception.LogException;

public class DeleteLogstore {

    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";
        // 設定Log Service的服務存取點。此處以杭州為例，其它地區請根據實際情況填寫。
        String host = "https://cn-hangzhou.log.aliyuncs.com";

        //建立Log ServiceClient。
        Client client = new Client(host, accessId, accessKey);

        try {
            // 輸入Logstore名稱。
            String logStoreName = "ali-test-logstore";
            System.out.println("ready to delete logstore");

            // 刪除指定Logstore。
            client.DeleteLogStore(projectName,logStoreName);
            System.out.println(String.format("delete logstore %s success", logStoreName));

        } 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 logstore
delete logstore ali-test-logstore success

Simple Log Service：使用Java SDK管理日誌庫Logstore

前提條件

注意事項

建立Logstore

修改Logstore

查詢所有Logstore

查詢指定Logstore

刪除Logstore

相關文檔