全部產品
Search

搜尋本產品

    Cloud Monitor：PutCustomMetric

    文件中心

    Cloud Monitor：PutCustomMetric

    更新時間：Jun 11, 2026

    調用PutCustomMetric介面上報自訂監控資料。

    介面說明

    說明

    推薦您使用企業雲監控中的介面 PutHybridMonitorMetricData 。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cms:PutCustomMetric

    create

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    MetricList

    array<object>

    是

    監控資料清單。

    object

    否

    Type

    string

    是

    上報數值類型。N 的取值範圍：1~21。取值：

    • 0：原始資料。

    • 1：彙總資料。

    說明

    當上報彙總資料時，建議週期為 60 秒和 300 秒的資料均上報，否則無法正常查詢跨度大於 7 天的監控資料。

    0
    MetricName

    string

    是

    監控項名稱。N 的取值範圍：1~21。詳情請參見雲端服務監控項。

    cpu_total
    Time

    string

    否

    指標發生的時間。N 的取值範圍：1~21。支援以下兩種類型：

    • UTC 時間。格式：YYYY-MM-DDThh:mm:ssZ，例如：20171012T132456.888+0800。

    • Long 型時間戳。例如：1508136760000。

    1508136760000
    GroupId

    string

    是

    應用程式分組 ID。N 的取值範圍：1~21。

    說明

    如果監控項不屬於任何應用程式分組， 則輸入 0。

    12345
    Values

    string

    是

    指標值集合。N 的取值範圍：1~21。

    說明

    如果上報數值的類型為 0，則上報的是原始值，雲監控會按週期將原始值彙總為多個值，例如：最大、計數、求和等。

    {"value":10.5}
    Dimensions

    string

    是

    維度 Map，用於查詢指定資源的監控資料。N 的取值範圍：1~21。

    格式：key-value 索引值對形式的集合，常用的 key-value 集合為：{"Key":"Value"}。

    Key 和 Value 的長度為 1~64 個字元，超過 64 個字元時截取前 64 個。

    Key 和 Value 的取值可包含英文字母、數字、點號（.）、短劃線（-）、底線（_）、正斜線（/）和反斜線（\）。

    說明

    Dimensions 傳入時需要使用 JSON 字串表示該 Map 物件，必須按順序傳入。

    {"sampleName1":"value1","sampleName2":"value2"}
    Period

    string

    否

    彙總週期。N 的取值範圍：1~21。單位：秒，取值：60 或 300。

    說明

    如果上報數值的類型為 1，則需要設定該參數。

    60

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Code

    string

    狀態代碼。

    說明

    200 表示成功。

    200
    Message

    string

    錯誤訊息。

    The request has failed due to a temporary failure of the server.
    RequestId

    string

    請求 ID。

    05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0

    樣本

    正常返回樣本

    JSON格式

    {
  "Code": "200",
  "Message": "The request has failed due to a temporary failure of the server.",
  "RequestId": "05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 %s %s
    500 %s %s
    500 InternalError %s
    403 %s %s
    404 %s %s

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

    變更歷史

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