調用BatchExport介面使用Cursor匯出監控資料-CloudMonitor-阿里雲 - Cloud Monitor

調用BatchExport介面匯出在Cursor介面中定義的監控資料。

介面說明

前提條件

請確保您已調用 Cursor 介面取得初始的Cursor。

使用說明

本文將提供一個範例，匯出雲端產品acs_ecs_dashboard的監控項cpu_idle的某個初始Cursor的監控資料，且每次最多傳回 1000 筆資料。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cms:BatchExport

list

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
Namespace	string	是	雲端產品的資料命名空間。關於如何取得雲端產品的資料命名空間，請參見雲端產品監控項。說明本參數必須與 Cursor 介面中的請求參數`Namespace`相同。	acs_ecs_dashboard
Metric	string	是	雲端產品的監控項名稱。關於如何取得雲端產品的監控項名稱，請參見雲端產品監控項。說明本參數必須與 Cursor 介面中的請求參數`Metric`相同。	cpu_idle
Cursor	string	是	循環調用本介面匯出資料時，必須輸入`Cursor`的值。`Cursor`值的取得方法如下：當您初次調用本介面時，必須先調用 Cursor 介面，取得`Cursor`的值。更多資訊，請參見 Cursor 。當您再次調用本介面時，可以從上次調用本介面的傳回資料中取得`Cursor`的值。	eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****
Length	integer	是	每次最多傳回的資料筆數。取值範圍：1~10000。	1000
Measurements	array	否	用於自訂傳回資料的測量值。預設傳回全部測量值。例如：雲端產品`acs_ecs_dashboard`的監控指標`cpu_idle`下有三個測量值的欄位，分別是`Average`、`Maximum`或`Minimum`，如果只需要傳回`Average`和`Maximum`兩欄，則該參數設定為`["Average", "Maximum"]`陣列即可。關於如何取得雲端產品的監控指標的測量值，請參見雲端產品監控項的`statistics`欄。
	string	否	測量值欄名。	Maximum

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

返回參數

名稱	類型	描述	樣本值
	object	無。
Message	string	傳回資訊。	success
Code	integer	狀態碼。說明 200 表示成功。	200
Success	boolean	操作是否成功。取值： true：成功。 false：失敗。	true
RequestId	string	請求 ID。	251402CD-305C-1617-808E-D8C11FC8138D
Cursor	string	用於再次調用本介面。說明如果傳回結果為`null`，則說明監控資料匯出完成。	v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***
Length	integer	本次調用資料傳回的筆數。	1000
Anchor	integer	後端請求資料的時間戳。時間戳越大，表示匯出資料越靠近目前時間。	1678781819000
HasNext	boolean	資料是否已完成匯出。取值： true：部分資料未完成匯出。 false：資料已完成匯出。	true
DataResults	array	目前調用的傳回資料。
	MetricStat	匯出資料。具體如下： Namespace：雲端產品的資料命名空間，例如：`acs_ecs_dashboard`。 Metric：雲端產品的監控項名稱，例如：`cpu_idle`。 Timestamp：監控資料的時間戳（單位：毫秒），例如：1641454680000。 Period：監控資料的統計週期（單位：秒），例如：60。 Dimensions：用於識別監控對象（執行個體）的 Dimension 資訊，例如：`[{"Label":"userId", "Value":""20654616023382**"}, {"Label":"InstanceId", "Value":""i-2ze2d6j5uhg20x4"}]`。 Associated：監控對象（執行個體）的附加資訊，例如：標籤資訊之類，key:value 鍵值對形式的集合，例如：`{"group":"test**", "name":"Alice"}`。 Measurements：指標的測量值（預設多值模式），例如：`{"Average":60,"Maximum":85}`。 LogTime：監控資料的記錄時間（單位：毫秒），對於非原始資料（彙總後的資料），`LogTime`為空（NULL）。

樣本

正常返回樣本

JSON格式

{
  "Message": "success",
  "Code": 200,
  "Success": true,
  "RequestId": "251402CD-305C-1617-808E-D8C11FC8138D",
  "Cursor": "v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***",
  "Length": 1000,
  "Anchor": 1678781819000,
  "HasNext": true,
  "DataResults": [
    {
      "Namespace": "acs_ecs_dashboard",
      "Metric": "cpu_idle",
      "Period": 60,
      "Timestamp": 1641454680000,
      "Dimensions": [
        {
          "Label": "instanceId",
          "Value": "i-dferwret*****"
        }
      ],
      "Associated": {
        "key": "{\"group\":\"test****\", \"name\":\"Alice\"}"
      },
      "Measurements": {
        "key": "{\"Average\":60,\"Maximum\":85}"
      },
      "LogTime": 1683686550073
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
500	%s	%s
403	%s	%s
404	%s	%s
503	%s	%s

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

變更歷史

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