调用SearchOmsOpenAPIMonitorMetric查询指定项目的监控指标_云数据库 OceanBase 版(OceanBase)-阿里云帮助中心

查询指定项目的监控指标。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
WorkerGradeId	string	否	传输实例的 ID。通常公有云上创建项目，需要先购买传输实例。	g_abcdefj***
PageNumber	integer	否	页序号，分页查询时生效。	1
PageSize	integer	否	页大小，分页查询时生效。	1
ProjectId	string	是	查询项目 ID。	p_abcdefj
Metric	string	是	查询增量指标。 CONNECTOR_IOPS：迁移流量。 CONNECTOR_SINK_COMMIT_TIME：目标端平均提交时间。 CONNECTOR_RPS：增量 RPS。 CONNECTOR_DELAY：增量延迟。 CONNECTOR_SINK_EXECUTE_TIME：目标端平均写入时间。	CONNECTOR_IOPS
BeginTime	long	是	查询起始时间，秒级时间戳。	1656512800
EndTime	long	是	查询结束时间，秒级时间戳。	1656512860
MaxPointNum	long	是	最多查询点数。	5

返回参数

名称	类型	描述	示例值
	object	返回结果。
Success	boolean	是否调用成功。	true
ErrorDetail	object	错误详情。
Code	string	错误码（新）。	CM-RESOAT111111
Level	string	错误等级，包括 CRITICAL、ERROR 和 WARN。	ERROR
Message	string	错误描述（新）。	A system error occurred.
Proposal	string	建议（新）。	Contact the administrator.
Code	string	错误码（旧）。	INNER_ERROR
Message	string	错误描述（旧）。	A system error occurred.
Advice	string	建议（旧）。	Contact the administrator.
RequestId	string	请求 ID。	XCVSADGDFSGDFGFDGFDGDFGDFGDFGDFGDSGDS
PageNumber	integer	页序号，分页查询时生效。	1
PageSize	integer	页大小，分页查询时生效。	1
TotalCount	long	总数，分页查询时生效。	1
Cost	string	请求耗时，单位为秒。	1
Data	object []	返回的业务数据列表信息。
Metric	string	指标的名称。	CONNECTOR_TPS
Tags	object	指标的标签集合。
	string	指标的标签。	test
DataPoints	object []	指标数据列表。
Timestamp	long	毫秒级时间戳。	1656669613
Value	double	时间对应的值。	200

示例

正常返回示例

JSON格式

{
  "Success": true,
  "ErrorDetail": {
    "Code": "CM-RESOAT111111",
    "Level": "ERROR",
    "Message": "A system error occurred.",
    "Proposal": "Contact the administrator. "
  },
  "Code": "INNER_ERROR",
  "Message": "A system error occurred.",
  "Advice": "Contact the administrator. ",
  "RequestId": "XCVSADGDFSGDFGFDGFDGDFGDFGDFGDFGDSGDS",
  "PageNumber": 1,
  "PageSize": 1,
  "TotalCount": 1,
  "Cost": "1",
  "Data": [
    {
      "Metric": "CONNECTOR_TPS",
      "Tags": {
        "key": "test"
      },
      "DataPoints": [
        {
          "Timestamp": 1656669613,
          "Value": 200
        }
      ]
    }
  ]
}