全部產品
Search

搜尋本產品

    Simple Log Service：UpdateLogtailPipelineConfig

    文件中心

    Simple Log Service：UpdateLogtailPipelineConfig

    更新時間：Sep 18, 2026

    更新 Logtail 流水線配置。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    log:UpdateLogtailPipelineConfig

    update

    *全部資源。

    *
    • log:TLSVersion
    		 無

    請求文法

    PUT /pipelineconfigs/{configName} HTTP/1.1

    路徑參數

    名稱

    類型

    必填

    描述

    樣本值
    configName

    string

    是

    Logtail 流水線配置名稱。

    test-config

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    project

    string

    是

    Project 名稱。

    test-project
    body

    object

    否

    Logtail 流水線配置內容。

    aggregators

    array<object>

    否

    聚合外掛程式清單。

    重要 僅當使用了擴充處理外掛程式時有效，且最多允許使用 1 個聚合外掛程式。

    object

    否

    聚合外掛程式。

    configName

    string

    是

    配置名稱。

    重要 需要與外層的 configName 參數保持一致。

    test-config
    flushers

    array<object>

    是

    輸出外掛程式清單。

    重要 目前，只允許存在 1 個 SLS 輸出外掛程式。

    object

    否

    輸出外掛程式。

    { "Type": "flusher_sls", "Logstore": "test" }
    global

    object

    否

    全域配置。

    inputs

    array<object>

    是

    輸入外掛程式清單。

    重要 目前，只允許配置 1 個輸入外掛程式。

    object

    否

    輸入外掛程式。

    說明

    檔案輸入外掛程式參數請參見檔案外掛程式，其餘輸入外掛程式參數請參見處理外掛程式。

    { "Type": "input_file", "FilePaths": ["/var/log/*.log"] }
    logSample

    string

    否

    日誌範例。支援多條日誌。

    2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world
    processors

    array<object>

    否

    處理外掛程式清單。

    說明

    可分為原生處理外掛程式和擴充處理外掛程式，詳情請參見處理外掛程式。

    重要
    說明

    • 原生外掛程式僅可用於採集文字日誌。

    • 不支援同時新增原生外掛程式和擴充外掛程式。

    • 使用原生外掛程式時，須符合如下要求：

      • 第一個處理外掛程式必須為正規解析外掛程式、分隔符號模式解析外掛程式、JSON 解析外掛程式、NGINX 模式解析外掛程式、Apache 模式解析外掛程式或 IIS 模式解析外掛程式。

      • 第一個處理外掛程式之後僅允許存在 1 個時間解析處理外掛程式，1 個過濾外掛程式和多個脫敏外掛程式。

    object

    否

    處理外掛程式。

    說明

    詳情請參見處理外掛程式。

    { "Type": "processor_parse_json_native", "SourceKey": "content" }
    task

    object

    否

    全域配置

    參數類型是否必填預設值範例說明
    TopicTypestring否空filepathTopic 類型。可選值包括：

    • filepath：從日誌檔案路徑中提取資訊作為 Topic。僅當輸入外掛程式為 input_file 時有效。

    • machine_group_topic：將套用該配置的機器群組 Topic 作為 Topic。

    • custom：自訂 Topic 更多資訊，請參見日誌主題。

    TopicFormatstring否，當 TopicType 取值為 filepath 或 custom 時必填//var/log/(.*).logTopic 格式。
    EnableTimestampNanosecondbool否falsefalse是否啟用時間奈秒精度。
    PipelineMetaTagKeyobject否空{"HOST_NAME":"__hostname__"}
    重要 僅 LoongCollector 3.0.10 之後支援。
    控制 LoongCollector 自身資訊相關 Tag。key 為 Tag 參數名，value 為 Tag 在日誌中的欄位名。當 value 為__default__時，取預設值。當 value 為空字串時，表示刪除 Tag。 可配置 Tag 如下：

    • HOST_NAME：主機名稱。預設新增，預設值為"__hostname__"。

    • AGENT_TAG：使用者自訂標識。預設新增，預設值為"__user_defined_id__"。

    • HOST_ID：主機 ID。預設不新增，預設值為"__host_id__"。

    • CLOUD_PROVIDER：預設不新增，預設值為"__cloud_provider__"。

    輸入外掛程式。

    檔案輸入外掛程式

    參數類型是否必填預設值範例說明
    Typestring是/input_file外掛程式類型。固定為 input_file。
    FilePaths[string]是/["/var/log/*.log"]待採集的日誌檔案路徑清單（目前僅限 1 個路徑）。路徑中支援使用*和**萬用字元，其中**萬用字元僅能出現一次且僅限用於檔案名稱前。
    MaxDirSearchDepthuint否00檔案路徑中**萬用字元符合的最大目錄深度。僅當日誌路徑中存在**萬用字元時有效，取值範圍為 0～1000。
    ExcludeFilePaths[string]否空["/home/admin/*.log"]檔案路徑黑名單。路徑必須為絕對路徑，支援使用*萬用字元
    ExcludeFiles[string]否空["app*.log", "password"]檔案名稱黑名單。支援使用*萬用字元
    ExcludeDirs[string]否空["/home/admin/dir1", "/home/admin/dir2*"]目錄黑名單。路徑必須為絕對路徑，支援使用*萬用字元
    FileEncodingstring否utf8utf8檔案編碼格式。可選值包括 utf8 和 gbk。
    TailSizeKBuint否10241024配置首次生效時，符合檔案的起始採集位置距離檔案結尾的大小。如果檔案大小小於該值，則從頭開始採集，取值範圍為 0～10485760KB。
    Multilineobject否空/多行聚合選項。
    Multiline.Modestring否customcustom多行聚合模式。可選值包括 custom 和 JSON。
    Multiline.StartPatternstring當 Multiline.Mode 取值為 custom 時必填空\d+-\d+-\d+.*行首正規表示式。
    EnableContainerDiscoverybool否falsetrue是否啟用容器探索功能。僅當 Logtail 以 Daemonset 模式執行，且採集檔案路徑為容器內路徑時有效。
    ContainerFiltersobject否空/容器過濾選項。多個選項之間為「且」的關係，僅當 EnableContainerDiscovery 取值為 true 時有效。
    ContainerFilters.K8sNamespaceRegexstring否空default對於部署於 K8s 環境的容器，指定待採集容器所在 Pod 所屬的命名空間條件。如果未新增該參數，則表示採集所有容器。支援正規匹配。
    ContainerFilters.K8sPodRegexstring否空test-pod對於部署於 K8s 環境的容器，指定待採集容器所在 Pod 的名稱條件。如果未新增該參數，則表示採集所有容器。支援正規匹配。
    ContainerFilters.IncludeK8sLabelmap否空/對於部署於 K8s 環境的容器，指定待採集容器所在 pod 的標籤條件。多個條件之間為「或」的關係，如果未新增該參數，則表示採集所有容器。支援正規匹配。 map 中的 key 為 Pod 標籤名，value 為 Pod 標籤的值，說明如下：

    • 如果 map 中的 value 為空，則 pod 標籤中包含以 key 為鍵的 pod 都會被符合；

    • 如果 map 中的 value 不為空，則：

      • 若 value 以^開頭並且以$結尾，則當 pod 標籤中存在以 key 為標籤名且對應標籤值能正規匹配 value 的情況時，相應的 pod 會被符合；

      • 其他情況下，當 pod 標籤中存在以 key 為標籤名且以 value 為標籤值的情況時，相應的 pod 會被符合。

    ContainerFilters.ExcludeK8sLabelmap否空/對於部署於 K8s 環境的容器，指定需要排除採集容器所在 pod 的標籤條件。多個條件之間為「或」的關係，如果未新增該參數，則表示採集所有容器。支援正規匹配。 map 中的 key 為 pod 標籤名，value 為 pod 標籤的值，說明如下：

    • 如果 map 中的 value 為空，則 pod 標籤中包含以 key 為鍵的 pod 都會被符合；

    • 如果 map 中的 value 不為空，則：

      • 若 value 以^開頭並且以$結尾，則當 pod 標籤中存在以 key 為標籤名且對應標籤值能正規匹配 value 的情況時，相應的 pod 會被符合；

      • 其他情況下，當 pod 標籤中存在以 key 為標籤名且以 value 為標籤值的情況時，相應的 pod 會被符合。

    ContainerFilters.K8sContainerRegexstring否空test-container對於部署於 K8s 環境的容器，指定待採集容器的名稱條件。如果未新增該參數，則表示採集所有容器。支援正規匹配。
    ContainerFilters.IncludeEnvmap否空/指定待採集容器的環境變數條件。多個條件之間為「或」的關係，如果未新增該參數，則表示採集所有容器。支援正規匹配。 map 中的 key 為環境變數名，value 為環境變數的值，說明如下：

    • 如果 map 中的 value 為空，則容器環境變數中包含以 key 為鍵的容器都會被符合；

    • 如果 map 中的 value 不為空，則：

      • 若 value 以^開頭並且以$結尾，則當容器環境變數中存在以 key 為環境變數名且對應環境變數值能正規匹配 value 的情況時，相應的容器會被符合；

      • 其他情況下，當容器環境變數中存在以 key 為環境變數名且以 value 為環境變數值的情況時，相應的容器會被符合。

    ContainerFilters.ExcludeEnvmap否空/指定需要排除採集容器的環境變數條件。多個條件之間為「或」的關係，如果未新增該參數，則表示採集所有容器。支援正規匹配。 map 中的 key 為環境變數名，value 為環境變數的值，說明如下：

    • 如果 map 中的 value 為空，則容器環境變數中包含以 key 為鍵的容器都會被符合；

    • 如果 map 中的 value 不為空，則：

      • 若 value 以^開頭並且以$結尾，則當容器環境變數中存在以 key 為環境變數名且對應環境變數值能正規匹配 value 的情況時，相應的容器會被符合；

      • 其他情況下，當容器環境變數中存在以 key 為環境變數名且以 value 為環境變數值的情況時，相應的容器會被符合。

    ContainerFilters.IncludeContainerLabelmap否空/指定待採集容器的標籤條件。多個條件之間為「或」的關係，如果未新增該參數，則預設為空，表示採集所有容器。支援正規匹配。 map 中的 key 為容器標籤名，value 為容器標籤的值，說明如下：

    • 如果 map 中的 value 為空，則容器標籤中包含以 key 為鍵的容器都會被符合；

    • 如果 map 中的 value 不為空，則：

      • 若 value 以^開頭並且以$結尾，則當容器標籤中存在以 key 為標籤名且對應標籤值能正規匹配 value 的情況時，相應的容器會被符合；

      • 其他情況下，當容器標籤中存在以 key 為標籤名且以 value 為標籤值的情況時，相應的容器會被符合。

    ContainerFilters.ExcludeContainerLabelmap否空/指定需要排除採集容器的標籤條件。多個條件之間為「或」的關係，如果未新增該參數，則預設為空，表示採集所有容器。支援正規匹配。 map 中的 key 為容器標籤名，value 為容器標籤的值，說明如下：

    • 如果 map 中的 value 為空，則容器標籤中包含以 key 為鍵的容器都會被符合；

    • 如果 map 中的 value 不為空，則：

      • 若 value 以^開頭並且以$結尾，則當容器標籤中存在以 key 為標籤名且對應標籤值能正規匹配 value 的情況時，相應的容器會被符合；

      • 其他情況下，當容器標籤中存在以 key 為標籤名且以 value 為標籤值的情況時，相應的容器會被符合。

    ExternalK8sLabelTagmap否空/對於部署於 K8s 環境的容器，需要在日誌中額外新增的與 Pod 標籤相關的 tag。map 中的 key 為 Pod 標籤名，value 為對應的 tag 名。 例如：在 map 中新增app: k8s\_label\_app，則若 pod 中包含app=serviceA的標籤時，會將該資訊以 tag 的形式新增到日誌中，即新增欄位__tag__:k8s_label_app: serviceA；若不包含app標籤，則會新增空欄位__tag__:k8s_label_app: 。
    ExternalEnvTagmap否空/對於部署於 K8s 環境的容器，需要在日誌中額外新增的與容器環境變數相關的 tag。map 中的 key 為環境變數名，value 為對應的 tag 名。 例如：在 map 中新增VERSION: env\_version，則當容器中包含環境變數VERSION=v1.0.0時，會將該資訊以 tag 的形式新增到日誌中，即新增欄位__tag__:env_version: v1.0.0；若不包含VERSION環境變數，則會新增空欄位__tag__:env_version: 。
    CollectingContainersMetabool否falsetrue是否啟用容器中繼資料預覽。
    AppendingLogPositionMetabool否falsefalse是否在日誌中新增該條日誌所屬檔案的中繼資料，包括__tag__:__inode__欄位和__file_offset__欄位。
    AllowingIncludedByMultiConfigsbool否falsefalse是否允許目前配置採集其它配置已符合的檔案。
    Tagsobject否空{"FileInodeTagKey":"__inode__"}
    重要 僅 LoongCollector 3.0.10 之後支援。
    控制檔案採集相關 Tag。key 為 Tag 參數名，value 為 Tag 在日誌中的欄位名。當 value 為__default__時，取預設值。當 value 為空字串時，表示刪除 Tag。 可配置 Tag 如下：

    • FileInodeTagKey：檔案 inode。 預設不新增，預設值為"__inode__"。

    • FilePathTagKey：檔案路徑。預設新增，預設值為"__path__"。

    以下參數僅當 EnableContainerDiscovery 參數取值為 true 時有效。

    • K8sNamespaceTagKey：檔案所在容器命名空間。預設新增，預設值為"_namespace_"。

    • K8sPodNameTagKey：檔案所在 Pod 名。預設新增，預設值為"_pod_name_"。

    • K8sPodUidTagKey：檔案所在 Pod UID。預設新增，預設值為"_pod_uid_"。

    • ContainerNameTagKey：檔案所在容器名。預設新增，預設值為"_container_name_"。

    • ContainerIpTagKey：檔案所在容器 IP。預設新增，預設值為"_container_ip_"。

    • ContainerImageNameTagKey：檔案所在容器映像。預設新增，預設值為"_image_name_"。

    FileOffsetKeystring否空__file_offset__
    重要 僅 LoongCollector 3.0.10 之後支援。
    日誌在檔案中的位置 Tag。預設不新增，預設值為__file_offset__。當 value 為__default__時，取預設值。當 value 為空字串時，表示刪除 Tag。當 EnableLogPositionMeta 參數與 Tags.FileInodeTagKey 或 FileOffsetKey 參數同時存在時，EnableLogPositionMeta 參數會被忽略。

    容器標準輸出（舊版）

    參數類型是否必填預設值範例說明
    Typestring是/service_docker_stdout外掛程式類型。固定為 service_docker_stdout。
    StdoutBoolean否truetrue是否採集標準輸出 stdout。
    StderrBoolean否truetrue是否採集標準出錯資訊 stderr。
    StartLogMaxOffsetInteger否128×1024131072首次採集時回溯歷史資料長度，單位：位元組。建議取值在[131072,1048576]之間。
    IncludeLabelMap，其中 LabelKey 和 LabelValue 為 String 類型否空

    容器 Label 白名單，用於指定待採集的容器。預設為空，表示採集所有容器的標準輸出。如果您要設定容器 Label 白名單，那麼 LabelKey 必填，LabelValue 可選填。

    • 如果 LabelValue 為空，則容器 Label 中包含 LabelKey 的容器都符合。

    • 如果 LabelValue 不為空，則容器 Label 中包含 LabelKey=LabelValue 的容器才符合。

      LabelValue 預設為字串符合，即只有 LabelValue 和容器 Label 的值完全相同才會符合。如果該值以^開頭並且以$結尾，則為正規匹配。例如設定 LabelKey 為io.kubernetes.container.name，設定 LabelValue 為^(nginx|cube)$，表示可符合名為 nginx、cube 的容器。

    多個白名單之間為或關係，即只要容器 Label 滿足任一白名單即可符合。

    ExcludeLabelMap，其中 LabelKey 和 LabelValue 為 String 類型否空

    容器 Label 黑名單，用於排除不採集的容器。預設為空，表示不排除任何容器。如果您要設定容器 Label 黑名單，那麼 LabelKey 必填，LabelValue 可選填。

    • 如果 LabelValue 為空，則容器 Label 中包含 LabelKey 的容器都將被排除。

    • 如果 LabelValue 不為空，則容器 Label 中包含 LabelKey=LabelValue 的容器才會被排除。

      LabelValue 預設為字串符合，即只有 LabelValue 和容器 Label 的值完全相同才會符合。如果該值以^開頭並且以$結尾，則為正規匹配。例如設定 LabelKey 為io.kubernetes.container.name，設定 LabelValue 為^(nginx|cube)$，表示可符合名為 nginx、cube 的容器。

    多個黑名單之間為或關係，即只要容器 Label 滿足任一黑名單對即可被排除。

    IncludeEnvMap，其中 EnvKey 和 EnvValue 為 String 類型否空

    設定環境變數白名單，用於指定待採集的容器。預設為空，表示採集所有容器的標準輸出。如果您要設定環境變數白名單，那麼 EnvKey 必填，EnvValue 可選填。

    • 如果 EnvValue 為空，則容器環境變數中包含 EnvKey 的容器都符合。

    • 如果 EnvValue 不為空，則容器環境變數中包含 EnvKey=EnvValue 的容器才符合。

      EnvValue 預設為字串符合，即只有 EnvValue 和環境變數的值完全相同才會符合。如果該值以^開頭並且以$結尾，則為正規匹配，例如設定 EnvKey 為NGINX_SERVICE_PORT，設定 EnvValue 為`^(80

    ExcludeEnvMap，其中 EnvKey 和 EnvValue 為 String 類型否空

    環境變數黑名單，用於排除不採集的容器。預設為空，表示不排除任何容器。如果您要設定環境變數黑名單，那麼 EnvKey 必填，EnvValue 可選填。

    • 如果 EnvValue 為空，則容器環境變數中包含 EnvKey 的容器的日誌都將被排除。

    • 如果 EnvValue 不為空，則容器環境變數中包含 EnvKey=EnvValue 的容器才會被排除。

      EnvValue 預設為字串符合，即只有 EnvValue 和環境變數的值完全相同才會符合。如果該值以^開頭並且以$結尾，則為正規匹配，例如設定 EnvKey 為NGINX_SERVICE_PORT，設定 EnvValue 為^(80|6379)$，表示可符合服務連接埠為 80、6379 的容器。

    多個黑名單之間為或關係，即只要容器的環境變數滿足任一鍵值對即可被排除。

    IncludeK8sLabelMap，其中 LabelKey 和 LabelValue 為 String 類型否空

    透過 Kubernetes Label（定義在 template.metadata 中）白名單指定待採集的容器。如果您要設定 Kubernetes Label 白名單，那麼 LabelKey 必填，LabelValue 可選填。

    • 如果 LabelValue 為空，則 Kubernetes Label 中包含 LabelKey 的容器都符合。

    • 如果 LabelValue 不為空，則 Kubernetes Label 中包含 LabelKey=LabelValue 的容器才符合。

      LabelValue 預設為字串符合，即只有 LabelValue 和 Kubernetes Label 的值完全相同才會符合。如果該值以^開頭並且以$結尾，則為正規匹配。例如設定 LabelKey 為app，設定 LabelValue 為^(test1|test2)$，表示符合 Kubernetes Label 中包含 app:test1、app:test2 的容器。

    多個白名單之間為或關係，即只要 Kubernetes Label 滿足任一白名單即可符合。

    ExcludeK8sLabelMap，其中 LabelKey 和 LabelValue 為 String 類型否空

    透過 Kubernetes Label（定義在 template.metadata 中）黑名單排除不採集的容器。如果您要設定 Kubernetes Label 黑名單，那麼 LabelKey 必填，LabelValue 可選填。

    • 如果 LabelValue 為空，則 Kubernetes Label 中包含 LabelKey 的容器都被排除。

    • 如果 LabelValue 不為空，則 Kubernetes Label 中包含 LabelKey=LabelValue 的容器才會被排除。

      LabelValue 預設為字串符合，即只有 LabelValue 和 Kubernetes Label 的值完全相同才會符合。如果該值以^開頭並且以$結尾，則為正規匹配。例如設定 LabelKey 為app，設定 LabelValue 為^(test1|test2)$，表示符合 Kubernetes Label 中包含 app:test1、app:test2 的容器。

    多個黑名單之間為或關係，即只要 Kubernetes Label 滿足任一黑名單對即可被排除。

    K8sNamespaceRegexString否空^(default|nginx)$透過 Namespace 名稱指定採集的容器，支援正規匹配。例如設定為^(default|nginx)$，表示符合 nginx 命名空間、default 命名空間下的所有容器。
    K8sPodRegexString否空^(nginx-log-demo.*)$透過 Pod 名稱指定待採集的容器，支援正規匹配。例如設定為^(nginx-log-demo.*)$，表示符合以 nginx-log-demo 開頭的 Pod 下的所有容器。
    K8sContainerRegexString否空^(container-test)$透過容器名稱指定待採集的容器（Kubernetes 容器名稱是定義在 spec.containers 中），支援正規匹配。例如設定為^(container-test)$，表示符合所有名為 container-test 的容器。

    資料處理參數

    參數類型是否必填預設值範例說明
    BeginLineRegexString否空

    行首符合的正規表示式。

    該配置項為空，表示單行模式。

    如果該表示式符合某行的開頭，則將該行作為一條新的日誌，否則將此行拼接到上一條日誌。

    BeginLineCheckLengthInteger否空

    行首符合的長度，單位：位元組。

    預設取值為 10×1024 位元組。

    如果行首符合的正規表示式在前 N 個位元組即可體現，推薦設定此參數，提升行首符合效率。

    BeginLineTimeoutMsInteger否空

    行首符合的逾時時間，單位：毫秒。

    預設取值為 3000 毫秒。

    如果 3000 毫秒內沒有出現新日誌，則結束符合，將最後一條日誌上傳到日誌服務。

    MaxLogSizeInteger否空

    日誌最大長度，預設取值為 0，單位：位元組。

    預設取值為 512×1024 位元組。

    如果日誌長度超過該值，則不再繼續尋找行首，直接上傳。

    ExternalK8sLabelTagMap，其中 LabelKey 和 LabelValue 為 String 類型否空

    設定 Kubernetes Label（定義在 template.metadata 中）日誌標籤後，iLogtail 將在日誌中新增 Kubernetes Label 相關欄位。

    例如設定 LabelKey 為 app，LabelValue 為k8s_label_app，當 Pod 中包含 Label app=serviceA時，會將該資訊 iLogtail 新增到日誌中，即新增欄位 k8s_label_app: serviceA；若不包含名為 app 的 label 時，新增空欄位 k8s_label_app: 。

    ExternalEnvTagMap，其中 EnvKey 和 EnvValue 為 String 類型否空

    設定容器環境變數日誌標籤後，iLogtail 將在日誌中新增容器環境變數相關欄位。

    例如設定 EnvKey 為VERSION，EnvValue 為env_version，當容器中包含環境變數VERSION=v1.0.0時，會將該資訊以 tag 形式新增到日誌中，即新增欄位 env_version: v1.0.0；若不包含名為 VERSION 的環境變數時，新增空欄位 env_version: 。

    資料處理環境變數

    環境變數類型是否必填預設值範例說明
    ALIYUN_LOG_ENV_TAGSString否空

    設定全域環境變數日誌標籤後，iLogtail 將在日誌中新增 iLogtail 所在容器環境變數相關欄位。多個環境變數名以|分隔。

    例如設定為 node_name|node_ip，當 iLogtail 容器中暴露相關環境變數時，會將該資訊以 tag 形式新增到日誌中，即新增欄位 node_ip:172.16.0.1 和 node_name:worknode。

    MySQL 輸入外掛

    參數類型是否必填預設值範例說明
    Typestring是/service_mysql外掛類型。固定為 service_mysql。
    Addressstring否127.0.0.1:3306rm-*.mysql.rds.aliyuncs.comMySQL 位址。
    Userstring否rootroot用於登入 MySQL 資料庫的使用者名稱。
    Passwordstring否空用於登入 MySQL 資料庫的使用者密碼。如果安全性需求較高，建議將使用者名稱和密碼設定為 xxx，待採集設定同步至本機機器後，在本機檔案 /usr/local/ilogtail/user_log_config.json 中找到對應設定進行修改。具體操作，請參閱修改本機設定。
    重要 如果您在主控台上修改了此參數，同步至本機後會覆蓋本機的設定。
    DataBasestring否/project_database資料庫名稱。
    DialTimeOutMsint否50005000連線 MySQL 資料庫逾時時間，單位：ms。
    ReadTimeOutMsint否50005000讀取 MySQL 查詢結果的逾時時間，單位：ms。
    StateMentstring否/SELECT 陳述式。設定 CheckPoint 為 true 時，Statement 中 SELECT 陳述式的 where 條件中必須包含 CheckPoint 欄位（CheckPointColumn）。支援使用半形問號（?）表示取代符，與 CheckPoint 欄位配合使用。例如設定 CheckPointColumn 為 id，設定 CheckPointStart 為 0，設定 StateMent 為 SELECT * from ... where id > ?。則每次採集後，系統會儲存最後一筆資料的 ID 作為 Checkpoint，下次採集時查詢陳述式中的半形問號（?）將被取代為該 Checkpoint 對應的 ID。
    Limitbool否falsetrue是否使用 Limit 分頁。

    • true：使用。

    • false（預設值）：不使用。

    建議使用 Limit 進行分頁。設定 Limit 為 true 後，進行 SQL 查詢時，系統將自動在 SELECT 陳述式中附加 LIMIT 陳述式。
    PageSizeint否/10分頁大小，Limit 為 true 時必須設定。
    MaxSyncSizeint否00每次同步最大記錄數。預設值為 0，表示無限制。
    CheckPointbool否falsetrue是否使用 CheckPoint。

    • true：使用。

    • false（預設值）：不使用。

    CheckPoint 可作為下次採集資料的起點，實現資料增量採集。
    CheckPointColumnstring否空1CheckPoint 欄位名稱。設定 CheckPoint 為 true 時，需要設定。 警告 該欄位的值必須遞增，否則可能會出現資料漏採集問題（每次查詢結果中的最大值將作為下次查詢的輸入）。
    CheckPointColumnTypestring否空intCheckPoint 欄位的資料類型，支援 int 和 time。int 類型的內部儲存為 int64，time 類型支援 MySQL 的 date、datetime、time 類型。設定 CheckPoint 為 true 時，需要設定。
    CheckPointStartstring否空CheckPoint 欄位的初始值。設定 CheckPoint 為 true 時，需要設定。
    CheckPointSavePerPagebool否truetrue是否每次分頁時儲存一次 CheckPoint。

    • true（預設值）：每次分頁時儲存一次 CheckPoint。

    • false：每次同步完成後儲存一次 CheckPoint。

    IntervalMsint否6000060000同步間隔，預設值為 60000，單位：ms。

    返回參數

    名稱

    類型

    描述

    樣本值

    當前API暫無返回參數

    樣本

    正常返回樣本

    JSON格式

    {}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。