全部產品
Search
文件中心

CloudMonitor:通過HTTP上報監控資料

更新時間:Jun 19, 2024

本文為您介紹通過HTTP上報監控資料的配置方法。

服務地址

CloudMonitor用於上報自訂事件的服務地址,請參見上報監控資料的服務地址

請求文法

通過HTTP方式上報監控資料的請求文法如下:
POST /metric/custom/upload HTTP/1.1 
Authorization:<AuthorizationString>
Content-Length:<Content Length>
Content-MD5:<Content MD5>
Content-Type:application/json
Date:<GMT Date>
Host: metrichub-cms-cn-hangzhou.aliyuncs.com
x-cms-signature:hmac-sha1
x-cms-api-version:1.0
x-cms-ip:192.168.XX.XX
User-Agent:cms-java-sdk-v-1.0
[{"dimensions":{"key":"value"},"groupId":12345,"metricName":"TestMetric","period":60,"time":"20210827T143329.213+0800","type":0,"values":{"value":10}}]

請求參數

通過HTTP方式上報監控資料的要求標頭和請求參數說明如下表所示。
  • 要求標頭
    Header類型描述樣本
    AuthorizationString內容:AccessKeyId:SignStringtestKey:F86ADF652A6466FCCD860B867D9518D48C24E7F6
    Content-LengthLongRFC 2616中定義的HTTP請求的Body長度。請求Body按UTF-8編碼後的位元組數。
    說明 如果請求無Body部分,則無需提供該要求標頭。
    151
    Content-MD5String請求Body經過MD5計算後的字串,計算結果為大寫字母和數字字串。
    說明 如果請求無Body部分,則無需提供該要求標頭。
    215614AA47799058C009D3E20B19B83A
    Content-TypeString發送端發送的實體資料的資料類型。只支援application/jsonapplication/json
    DateStringHTTP請求中的標準時間頭(遵循RFC 1123格式,使用GMT標準時間)。

    樣本:Mon, 3 Jan 2010 08:33:47 GMT

    Fri, 27 Aug 2021 06:33:55 GMT
    HostStringHTTP請求的完整Host名稱(不包括如https://這樣的協議頭)。

    樣本:metrichub-cms-cn-hangzhou.aliyuncs.com

    metrichub-cms-cn-hangzhou.aliyuncs.com
    x-cms-api-versionStringAPI版本。目前的版本1.0。1.0
    x-cms-signatureString簽名演算法。目前,CloudMonitor只支援數位簽章演算法HMAC-SHA1。hmac-sha1
    x-cms-ipString上報監控資料的伺服器IP地址。192.168.XX.XX
    User-AgentString用戶端說明。cms-java-sdk-v-1.0
  • 請求參數
    名稱類型是否必選描述
    groupIdLong應用分組ID。
    metricNameString監控項名稱。詳情請參見雲端服務監控項
    dimensionsObject維度Map,用於查詢指定資源的監控資料。

    格式:key-value索引值對形式的集合,常用的key-value集合為instanceId:i-abcdefgh12****

    timeString指標產生時間。支援的格式如下:
    • yyyyMMdd’T’HHmmss.SSSZ

      例如:20171012T132456.888+0800

    • long

      例如:1508136760000

    typeInt

    上報數值的類型。0為原始值,1為彙總資料。

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

    periodString

    彙總周期。單位:秒。

    如果type為1,則需要上傳該參數,取值:
    • 60
    • 300
    valuesObject指標值集合。

    如果type為0,則Key只能與Value相同,上報原始值,CloudMonitor會按周期將原始值彙總為多個值。例如:最大、計數、求和等。

返回樣本

通過HTTP方式上報監控資料的代碼返回樣本如下:

{
  "code":"200",//200表示成功。
  "msg":""//正常上報時返回msg為空白。
}