DescribeDataAgentMetrics - 查询DataAgent指标-数据管理 DMS-阿里云帮助中心

查询DataAgent指标

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:DescribeDataAgentMetrics

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
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	查询范围起始时间	1782835200000
EndTime	integer	查询范围结束时间	1782836200000
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": 1782835200000,
    "EndTime": 1782836200000,
    "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."
}

错误码

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

变更历史

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