GetMonitorData - 获取应用监控数据

调用GetMonitorData接口,获取Elasticsearch Serverless应用监控的指标数据。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
es-serverless:GetMonitorData
  • 全部资源
    *

请求语法

POST /openapi/es-serverless/emon/metrics/query

请求参数

名称类型必填描述示例值
bodystring

请求体信息。

{"start":1689245180581,"end":1689246950582,"queries":[{"metric":"aliyunes.elasticsearch.index.docs.count","aggregator":"sum","downsample":"avg","tags":{"resource":"{appName}"},"filters":[],"granularity":"auto"}]}

返回参数

名称类型描述示例值
object
codestring

错误码。

InternalServerError
messagestring

错误信息。

internal server error
requestIdstring

请求 ID。

2C5DAA30-****-5181-9B87-9D6181016197
successboolean

调用结果。

true
resultarray<object>

返回结果。

object
integrityfloat

数据完整性。

1
summaryfloat

返回值中的一个属性,暂无含义。

172455913.18935508
messageWatermarklong

请求到达服务端的时间戳,用于排查问题。

1689566839447
dpsobject

指标实时监控数据。格式为{时间戳:数据}

{ "1689480600":28676235.104761902 }
tagsobject

标签。

{ "indexName":"test" }
metricstring

指标名称。

elasticsearch-server.logic_cpu.cpu

示例

正常返回示例

JSON格式

{
  "code": "InternalServerError",
  "message": "internal server error",
  "requestId": "2C5DAA30-****-5181-9B87-9D6181016197",
  "success": true,
  "result": [
    {
      "integrity": 1,
      "summary": 172455913.18935508,
      "messageWatermark": 1689566839447,
      "dps": {
        "1689480600": 28676235.104761902
      },
      "tags": {
        "indexName": "test"
      },
      "metric": "elasticsearch-server.logic_cpu.cpu"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史