全部產品
Search

搜尋本產品

    Cloud Monitor：CreateHybridMonitorTask

    文件中心

    Cloud Monitor：CreateHybridMonitorTask

    更新時間：Jul 10, 2026

    用於建立阿里雲產品或 SLS 日誌的監控項目接入任務。

    介面說明

    請求說明

    • 在呼叫此介面前，請確保已開通企業雲端監控服務。

    • 如果您需要建立 SLS 日誌的監控項目，請確保已開通 SLS 日誌服務，並且已經建立了日誌專案（Project）和日誌庫（Logstore）。

    • 根據不同的TaskType，部分參數是必需的。例如，當TaskType為aliyun_fc時，必須設定YARMConfig；而當TaskType為aliyun_sls時，則需要配置CollectInterval等參數。

    • 對於跨帳號操作，可以透過指定TargetUserId或TargetUserIdList來實現將其他成員的資源接入到企業雲端監控中。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cms:CreateHybridMonitorTask

    create

    *全部資源。

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Namespace

    string

    是

    指標倉庫名稱。

    關於如何取得指標倉庫名稱，請參見 DescribeHybridMonitorNamespaceList 。

    aliyun
    Description

    string

    否

    監控任務描述。

    阿里云产品数据接入任务。
    TaskName

    string

    否

    監控任務名稱。

    • 當TaskType為aliyun_fc時，輸入阿里雲產品的資料接入任務名稱。

    • 當TaskType為aliyun_sls時，輸入 SLS 日誌的監控項目名稱。

    aliyun_task
    TaskType

    string

    是

    監控任務類型。取值：

    • aliyun_fc：阿里雲產品的資料接入任務。

    • aliyun_sls：SLS 日誌的監控項目。

    枚舉值：

    • aliyun_fc :

      aliyun_fc

    • aliyun_sls :

      aliyun_sls

    aliyun_fc
    CollectTargetType

    string

    是

    監控資料的採集目標類型。

    • 當TaskType為aliyun_fc時，輸入aliyun_fc。

    • 當TaskType為aliyun_sls時，輸入 SLS 日誌的 Logstore 組名稱。

    aliyun_fc
    CollectInterval

    string

    否

    監控項目的採集週期。取值：

    • 15

    • 60（預設值）

    單位：秒。

    說明

    僅當TaskType為aliyun_sls時，需要設定該參數。

    枚舉值：

    • 15 :

      15

    • 60 :

      60

    60
    GroupId

    string

    否

    應用程式分組 ID。

    關於如何取得應用程式分組 ID，請參見 DescribeMonitorGroups 。

    說明

    僅當TaskType為aliyun_sls時，需要設定該參數。

    3607****
    YARMConfig

    string

    否

    接入企業雲端監控的阿里雲產品的配置檔案。

    • namespace：阿里雲產品的命名空間。關於如何查詢阿里雲產品的命名空間，請參見 DescribeMetricMetaList 。

    • metric_list：阿里雲服務的監控項目。關於如何查詢阿里雲產品的監控項目，請參見 DescribeMetricMetaList 。

    配置檔案範例如下：

    products:
- namespace: acs_ecs_dashboard
  metric_info:
  - metric_list:
    - cpu_total
    - cpu_idle
    - diskusage_utilization
    - CPUUtilization
    - DiskReadBPS
    - InternetOut
    - IntranetOut
    - cpu_system
- namespace: acs_rds_dashboard
  metric_info:
  - metric_list:
    - MySQL_QPS
    - MySQL_TPS
    說明

    當TaskType為aliyun_fc時，必須設定該參數。

    products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total
    TargetUserId

    string

    否

    成員 ID。

    當您透過管理帳號呼叫 API 時，可以選擇將資源目錄中的任意成員的阿里雲產品接入企業雲端監控。透過資源目錄實現企業跨帳號統一監控目標阿里雲產品。

    說明

    僅當TaskType為aliyun_fc時，需要設定該參數。

    120886317861****
    AttachLabels

    array<object>

    否

    監控項目的標籤。

    說明

    僅當TaskType為aliyun_sls時，需要設定該參數。

    object

    否

    無。

    Value

    string

    否

    監控項目的標籤值。

    testValue
    Name

    string

    否

    監控項目的標籤鍵。

    app_service
    TargetUserIdList

    string

    否

    成員 ID。多個成員 ID 之間用半形逗號（,）分隔。

    說明

    僅當您透過管理帳號呼叫本介面時，需要設定該參數。

    120886317861****
    SLSProcessConfig

    object

    否

    SLS 日誌配置。

    說明

    僅當TaskType為aliyun_sls時，需要設定該參數。

    Filter

    object

    否

    SLS 日誌中參數的篩選條件。

    Relation

    string

    否

    多個參數篩選條件之間的關係。取值：

    • and（預設值）：滿足所有篩選條件，才處理日誌。

    • or：滿足任意篩選條件，即可處理日誌。

    枚舉值：

    • or :

      or

    • and :

      and

    and
    Filters

    array<object>

    否

    SLS 日誌中參數的篩選條件清單。

    object

    否

    無。

    SLSKeyName

    string

    否

    SLS 日誌中篩選的參數名稱。

    code
    Operator

    string

    否

    SLS 日誌中參數值的篩選方式。取值：

    • contain：包含。

    • notContain：不包含。

    • >：大於。

    • <：小於。

    • =：等於。

    • !=：不等於。

    • >=：大於等於。

    • <=：小於等於。

    =
    Value

    string

    否

    SLS 日誌中參數的篩選值。

    200
    Statistics

    array<object>

    否

    SLS 日誌的統計方式。

    object

    否

    無。

    SLSKeyName

    string

    否

    SLS 日誌統計的參數名稱。

    name
    Function

    string

    否

    在計算週期內根據選定的統計方法對日誌資料進行彙總處理。取值：

    • count：計數。

    • sum：求和。

    • avg：平均值。

    • max：最大值。

    • min：最小值。

    • value：週期內取樣。

    • countps：計算統計週期內指定欄位求 count 後的每秒平均值。

    • sumps：計算統計週期內指定欄位求 sum 後的每秒平均值。

    • distinct：去重後計算統計週期內指定欄位出現的次數。

    • distribution：計算欄位值在一個區間內的出現次數。

    • percentile：計算欄位值的分佈值，例如：P50。

    count
    Alias

    string

    否

    SLS 日誌統計結果的別名。

    level_count
    Parameter1

    string

    否

    SLS 日誌的統計值。

    • 當Function為distribution時，表示統計區間的下限，例如：統計 HttpCode 的 2XX 數量，填寫 200。

    • 當Function為percentile時，表示統計分佈的百分位，例如：0.5 表示 P50。

    200
    Parameter2

    string

    否

    SLS 日誌的統計值。

    說明

    僅當Function為distribution時，需要設定該參數。表示統計區間的上限，例如：統計 HttpCode 的 2XX 數量，填寫 299。

    299
    GroupBy

    array<object>

    否

    對資料進行空間維度彙總，相當於 SQL 中的 Group By。

    object

    否

    無。

    SLSKeyName

    string

    否

    SLS 日誌統計的參數名稱。

    code
    Alias

    string

    否

    SLS 日誌統計結果的別名。

    ApiResult
    Express

    array<object>

    否

    SLS 日誌統計結果的擴充欄位的四則運算結果。

    object

    否

    無。

    Express

    string

    否

    SLS 日誌統計結果的擴充欄位的四則運算結果。

    success_count
    Alias

    string

    否

    SLS 日誌統計結果的擴充欄位的四則運算結果的別名。

    SuccRate
    CloudAccessId

    array

    否

    其他雲端廠商接入雲端監控的主帳號 ID 清單。

    string

    否

    其他雲端廠商接入雲端監控的主帳號 ID。

    n5n9ik1b****

    關於公用請求參數的詳情，請參見公用參數。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    無。

    Code

    string

    狀態碼。

    說明

    200 表示成功。

    200
    Message

    string

    錯誤訊息。

    yamlConfigFail
    RequestId

    string

    請求 ID。

    28CEA2E0-3E90-51B2-A7E8-B1ED75534E49
    Success

    string

    操作是否成功。取值：

    • true：成功。

    • false：失敗。

    true
    TaskId

    integer

    監控任務 ID。

    36****

    樣本

    正常返回樣本

    JSON格式

    {
  "Code": "200",
  "Message": "yamlConfigFail",
  "RequestId": "28CEA2E0-3E90-51B2-A7E8-B1ED75534E49",
  "Success": "true",
  "TaskId": 0
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 %s %s
    500 %s %s
    500 InternalError The request processing has failed due to some unknown error.
    403 %s %s
    404 %s %s
    409 %s %s

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

    變更歷史

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