DescribeDataAgentMetrics - 查询DataAgent指标

更新时间:
复制 MD 格式

查询DataAgent指标

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

MetricNames

string

指标名称(支持英文逗号分隔)

data_agent_session_per_user

StartTime

integer

查询范围起始时间

1782835200000

EndTime

integer

查询范围结束时间

1782836200000

MetricType

string

指标类型,取值:

  • basic:基础指标。

  • high_level:高阶指标。

basic

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

67E910F2-4B62-5B0C-ACA3-7547695C****

Data

object

返回结构体

StartTime

integer

查询范围起始时间

2026-01-01 00:00:00

EndTime

integer

查询范围结束时间

2026-01-13T14:30:20.582182728+08:00

Metrics

array<object>

指标列表

object

MetricName

string

指标名称

data_agent_session_per_user

Success

boolean

请求是否成功

True

Value

string

指标值

1

ErrorMessage

string

调用失败时,返回的错误信息

Timeout

MetricType

string

指标类型

basic

Success

boolean

请求是否成功,返回值如下:

  • true:请求成功。

  • false:请求失败。

true

ErrorCode

string

错误码,请求异常时返回

UnknownError

ErrorMessage

string

错误信息

Specified parameter Tid is not valid.

示例

正常返回示例

JSON格式

{
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "Data": {
    "StartTime": 0,
    "EndTime": 0,
    "Metrics": [
      {
        "MetricName": "data_agent_session_per_user",
        "Success": true,
        "Value": "1",
        "ErrorMessage": "Timeout"
      }
    ],
    "MetricType": "basic"
  },
  "Success": true,
  "ErrorCode": "UnknownError",
  "ErrorMessage": "Specified parameter Tid is not valid."
}

错误码

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

变更历史

更多信息,参考变更详情