文档

GetOverview - 获取概览数据信息

更新时间:

获取专业版应用任务调度概览数据信息。

调试

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

授权信息

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

请求参数

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

区域 Region ID

cn-hangzhou
Namespacestring

命名空间 UID

adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSourcestring

命名空间来源,特殊第三方才需要填写

schedulerx
GroupIdstring

应用分组 ID

testSchedulerx.defaultGroup
Operatestring

可选项 query:查询区间数据 query_range:查询区间时许数据

query
MetricTypeinteger

可选项 0:任务类基础信息 1:任务运行信息

0
StartTimelong

数据起始时间戳(单位:秒),如:1684166400

1684166400
EndTimelong

数据结束时间戳(单位:秒),如:1684166400 不填默认为当前时间

1684166400

当前接口查询数据信息对应控制台概览的三块信息内容,相应请求参数配置要求如下

  • 任务基础信息:请求参数配置说明如下,Operate 设置“query”,MetricType 设置为“0”,StartTime 设置为当前时间戳

  • 时间区间任务运行信息:请求参数配置说明如下,Operate 设置“query”,MetricType 设置为“1”,StartTime 设置为业务需要的查询起始时间(不得早于 15 天,当前时序数据存储有效期为 15 天)

  • 时间区间任务运行时序信息:请求参数配置说明如下,Operate 设置“query_range”,MetricType 设置为“1”,StartTime 设置为业务需要的查询起始时间(默认推荐当前 1 小时前,因返回每个时点信息量大不建议设置过早)

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

39090022-1F3B-4797-8518-6B61095F1AF0
Codeinteger

状态码

200
Successboolean

API 调用是否成功。取值如下:

  • true:成功。
  • false:失败。
true
Messagestring

错误信息,仅出错时返回错误信息。

No access permission for the namespace [***]
Datastring

JSON 的概览数据信息,对应控制台概览数据内容,如下三种格式类型结果

  • 基础信息
  • 时间区间任务运行信息:
  • 时间区间任务运行时序信息:返回对应区间 任务触发、运行成功、运行失败三个数据项对应时点的统计信息
基础信息:{"schedulerx_job_counter_disable": "4","schedulerx_job_trigger_counter_running": "0","schedulerx_job_counter_enable": "70","schedulerx_job_counter_all": "74","schedulerx_worker_counter": "2"}

Data 信息会根据三种数据读取,返回不同格式的 JSON 内容,参考如下:

  • 基础信息:
{
  "schedulerx_job_counter_disable": "4",  // 禁用任务数
  "schedulerx_job_counter_enable": "70", // 启用任务数
  "schedulerx_job_counter_all": "74", // 总任务数
  "schedulerx_worker_counter": "2", // 在线机器数
  "schedulerx_job_trigger_counter_running": "0" // 任务运行中实例数
}
  • 时间区间任务运行信息:
{
    "schedulerx_job_trigger_counter_success": "227",  // 
    "schedulerx_job_trigger_counter_all": "225",
    "schedulerx_job_trigger_counter_failed": "0"
}
  • 时间区间任务运行时序信息:返回对应区间 任务触发、运行成功、运行失败三个数据项对应时点的统计信息
[
    {
      "data": [
        [
          1686110400000, 
          4
        ],
        [
          1686110460000,
          5
        ]
      ],
      "name": "触发次数"
    },
    {
      "data": [
        [
          1686110400000,
          0
        ],
        [
          1686110460000,
          0
        ]
      ],
      "name": "执行失败"
    },
    {
      "data": [
        [
          1686110400000,
          4
        ],
        [
          1686110460000,
          5
        ]
      ],
      "name": "执行成功"
    }
  ]

示例

正常返回示例

JSON格式

{
  "RequestId": "39090022-1F3B-4797-8518-6B61095F1AF0",
  "Code": 200,
  "Success": true,
  "Message": "No access permission for the namespace [***]",
  "Data": "基础信息:{\"schedulerx_job_counter_disable\": \"4\",\"schedulerx_job_trigger_counter_running\": \"0\",\"schedulerx_job_counter_enable\": \"70\",\"schedulerx_job_counter_all\": \"74\",\"schedulerx_worker_counter\": \"2\"}"
}

错误码

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

变更历史

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