全部產品
Search
文件中心

Simple Log Service:GetMLServiceResults

更新時間:Sep 18, 2026

在阿里雲端日誌服務平台上,提供了基礎資料(Log、Metric、Trace)的智慧分析能力。使用者呼叫相關模型,可以直接得到模型的分析結果。目前主要涉及:日誌資料的NER任務、時間序列資料的異常檢測、高延遲鏈路資料的Span根因定位。

介面說明

該介面服務地址只能是華東 2(上海)、新加坡。 需要具備的基本權限如下:

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "log:Get*"
            ],
            "Resource": [
                "acs:log:*:*:mlservice/sls_builtin_*"
            ],
            "Effect": "Allow"
        }
    ]
}

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

log:GetMLServiceResults

none

*全部資源。

*

無 無

請求文法

POST /ml/service/{serviceName}/analysis HTTP/1.1

路徑參數

名稱

類型

必填

描述

樣本值

serviceName

string

否

服務名。

枚舉值:

  • sls_builtin_service_trace_rca :

    高延遲 trace 請求鏈路分析的服務名。

  • sls_builtin_service_log_struct :

    LogNER 的服務名。

  • sls_builtin_service_metric_anomaly :

    單維度時間序列異常檢測的服務名。

sls_builtin_service_log_struct

請求參數

名稱

類型

必填

描述

樣本值

allowBuiltin

boolean

否

  • true 表示請求允許使用系統內建的服務

  • false 表示請求不允許使用系統內建的服務

枚舉值:

  • true :

    允許使用系統內建的服務。

  • false :

    不允許使用系統內建的服務名。

true

version

string

否

設定演算法的版本號,不同的版本對應不同演算法。

v1

body MLServiceAnalysisParam

否

請求結構體。

枚舉值:

  • others :

    根據不同的 serviceName 有不一樣的說明。

在不同的情況,對於請求中的參數會不一樣,具體如下:

日誌內容實體識別(sls_builtin_service_log_struct)

body.parameter 相關的內容

{
  "is_struct": "true",
  "use_gpu": "true/false",
  "max_fields": "1"
}
  • is_struct 為 true 時,表示日誌格式為 JSON 結構。目前只支援設定為 true

  • use_gpu 表示是否使用 gpu 資源

  • max_fields 表示當日誌格式為 JSON 結構時,最多分析其中的幾個欄位,預設只分析一個欄位

body.input 相關的內容

[
  {
    "{column_name}": "{column_value}"
  }
]

輸入的內容是一個 JSON 結構陣列,其中

  • column_name 表示 JSON 結構的日誌的某個欄位名稱

  • column_value 表示 JSON 結構的日誌的某個欄位的值

時間序列異常檢測(sls_builtin_service_metric_anomaly)

body.parameter 相關的內容

{
  "isOrdered": "true/false",
  "keys": "[]",
  "timeColumnName": "",
  "analysisColumnNames": "[]",
  "interval": "-1"
}
  • isOrdered 表示輸入的資料是否是有序的,如果輸入的序列是按照時間維度從小到大,升序排列的,設定為 true,否則設定為 false

  • interval 表示時間序列的間隔大小,按照秒來描述。比如:序列是每分鐘一個點,則設定為 60;如果不確定序列的間隔,則設定為 -1

  • timeColumnName 表示輸入的序列中,時間維度的名稱

  • analysisColumnNames 表示輸入的序列中,待分析的數值特徵維度的名稱,使用陣列來表示,且需要將這個陣列序列化成字串

  • keys 表示輸入的資料的各列的名稱,使用陣列表示,且需要將這個陣列序列化成字串

body.input 相關的內容

[
  {
    "{column_name}": "{column_value}"
  }
]

輸入的內容是一個陣列,其中

  • column_name 表示序列中某個欄位的名稱

  • column_value 表示序列中某個欄位的值的內容。當 {column_name} 等於 {timeColumnName} 時,對應的值表示的是時間大小,使用 unixtime 時間戳記來表示,單位是秒

高延遲鏈路資料檢測(sls_builtin_service_trace_rca)

body.parameter 相關的內容

{
  "project": "",
  "logstore": "",
  "endpoint": "",
  "role_arn": ""
}
  • project 表示待分析的 Trace 資料儲存在 SLS 中的 Project 的名稱

  • logstore 表示待分析的 Trace 資料儲存在 SLS 中的 Logstore 的名稱

  • endpoint 表示 project 所在地域的 endpoint 資訊,這裡必須使用公網網域,內網網域無法存取

  • role_arn 表示已經對該資源進行授權的角色資訊,這裡務必使用 ETLRole 或者 AuditRole 的 arn 資訊

body.input 相關的內容

[
  {
    "service": "",
    "name": "",
    "from_ts_sec": "",
    "to_ts_sec": "",
    "slo_ts_micro": "",
    "batch_id": "",
    "trace_ids": "[]"
  }
]

輸入的內容是一個陣列,且輸入的陣列的長度是 1,其中對應的參數的含義解釋如下:

  • service 表示某個或者某一批待診斷的 TraceID 的服務名稱,可以從 logstore 中獲得

  • name 表示某個或者某一批待診斷的 TraceID 的服務名稱,可以從 logstore 中獲得

  • from_ts_sec 表示待分析的開始時間戳記,單位是秒

  • to_ts_sec 表示待分析的結束時間戳記,單位是秒

  • batch_id 表示當前待分析的一批 TraceID 的名稱

  • trace_ids 表示當前請求中對應的 trace_id 的清單,使用 JSON 序列化成字串

返回參數

名稱

類型

描述

樣本值

object

傳回的結構體。

枚舉值:

  • 无 :

    無。

  • 無 :

    無

data

array<object>

傳回的資料。

object

資料集結構體。

string

傳回結果。

{'marker': ''}

status

object

任務的狀態。

枚舉值:

  • 无 :

    無。

  • 無 :

    無

string

預設為空,表示傳回所有狀態的任務,支援 success、fail 和 running 狀態。

枚舉值:

  • 无 :

    無。

  • 無 :

    無

200

在不同的情況,對於請求的傳回值會不一樣,具體如下:

日誌內容實體識別(sls_builtin_service_log_struct)

data 相關的內容

[
  {
    "{column_name}": "{column_value}"
  }
]

輸出內容中每一個 JSON 結構與輸入的 JSON 結構日誌相對應,其中

  • column_name 表示 JSON 結構的日誌的被分析了的某個欄位名稱,最多有 max_fields 個欄位被分析

  • column_value 表示 JSON 結構的日誌的被分析了的某個欄位的值,欄位值中的 NER 結果被標籤 <ml_ner_${ner_type}></ml_ner_${ner_type}> 包裹,其中 ${ner_type} 是具體的 NER 類型

時間序列異常檢測(sls_builtin_service_metric_anomaly)

data 相關的內容

[
  {
    "start": "",
    "end": "",
    "label": ""
  }
]
  • start 表示檢測出來的異常區間的開始時間

  • end 表示檢測出來的異常區間的結束時間

  • label 表示檢測出來的當前區間的異常類型
    • SPIKE_UP_TYPE

    • SPIKE_DOWN_TYPE

    • TREND_UP_TYPE

    • TREND_DOWN_TYPE

    • MEANSHIFT_UPWARD_TYPE

    • MEANSHIFT_DOWNWARD_TYPE

高延遲鏈路資料檢測(sls_builtin_service_trace_rca)

data 相關的內容

[
  {
    "traceID": "",
    "service": "",
    "name": "",
    "rootCauses": "[{}]"
  }
]
  • traceID 表示待檢測的 traceID 資訊

  • service 表示當前這個 Trace 的根節點的 service 名稱

  • name 表示當前這個 Trace 的根節點的 name 名稱

  • rootCauses 表示當前這個高延遲請求的 Trace 中,導致高延遲的 span 的清單資訊,使用序列化後的字串來表示。該欄位的值反序列化後的結構如下:

[
  {
    "spanID": "",
    "service": "",
    "name": "",
    "host": "xxxx",
    "predicateDuration": 10
  }
]

樣本

正常返回樣本

JSON格式

{
  "data": [
    {
      "key": "{'marker': ''}"
    }
  ],
  "status": {
    "key": "200"
  }
}

錯誤碼

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

變更歷史

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