调用BatchExport接口使用Cursor导出监控数据-云监控-阿里云-云监控(CMS)-阿里云帮助中心

调用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

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
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

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。