更新时间:2022-04-16 GMT+08:00
分享

查询作业监控信息(废弃)

功能介绍

该API用于查询作业监控信息, 支持同时查询多个作业的监控信息。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    POST /v1.0/{project_id}/streaming/jobs/metrics

  • 参数说明
    表1 URI参数说明

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

请求消息

表2 请求参数说明

参数名称

是否必选

参数类型

说明

job_ids

Array of Long

作业ID列表。

响应消息

表3 响应参数说明

参数名称

是否必选

参数类型

说明

is_success

Boolean

请求是否成功。

message

String

消息内容。

metrics

Object

作业列表信息。具体请参考表4

表4 payload参数说明

参数名称

是否必选

参数类型

说明

jobs

Array of Objects

所有作业监控信息。具体请参考表5

表5 jobs参数说明

参数名称

是否必选

参数类型

说明

job_id

Long

作业ID。

metrics

Object

作业的所有输入输出监控信息。具体请参考表6

表6 metrics参数说明

参数名称

是否必选

参数类型

说明

sources

Array of Objects

所有输入流。请参见表7

sinks

Array of Objects

所有输出流。请参见表7

total_read_rate

Double

总输入速率。

total_write_rate

Double

总输出速率。

表7 source/sinks参数说明

参数名称

是否必选

参数类型

说明

name

String

输入流或输出流名称。

records

Long

总记录数。

corrupted_records

Long

脏数据记录数。

示例

  • 请求样例
    {
        "job_ids": [298765, 298766]
    }
  • 响应样例
    {
        "is_success": true,
        "message": "消息内容",
        "metrics": {
            "jobs": [
                {
                    "job_id": 0,
                    "metrics": {
                        "sources": [
                            {
                                "name": "Source: KafKa_6070_KAFKA_SOURCE",
                                "records": 0,
                                "corrupted_records": 0
                            }
                        ],
                        "sinks": [
                            {
                                "name": "Source: KafKa_6070_KAFKA_SOURCE",
                                "records": 0,
                                "corrupted_records": 0
                            }
                        ],
                        "total_read_rate": 100,
                        "total_write_rate": 100
                    }
                }
            ]
        }
    }

状态码

表8 状态码

状态码

描述

200

查询作业监控信息成功。

400

输入参数无效。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码

分享:

    相关文档

    相关产品

close