GetOverview
获取专业版应用任务调度概览数据信息
服务地址：
华东1（杭州）
输入参数
只看必填
RegionId区域Region ID
Namespace命名空间UID
NamespaceSource命名空间来源
GroupId应用分组ID
Operate可选项
MetricType可选项
StartTime数据起始时间戳（单位：秒）
EndTime数据结束时间戳（单位：秒）
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

请求参数

字段名称字段详情
RegionIdstring

区域 Region ID

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
Namespacestring

命名空间 UID

示例值:adcfc35d-e2fe-4fe9-bbaa-20e90ffc****参考取值来源:
    ListNamespaces
    CreateNamespace
NamespaceSourcestring

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

示例值:schedulerx
GroupIdstring

应用分组 ID

示例值:testSchedulerx.defaultGroup参考取值来源:
    ListGroups
    CreateAppGroup
Operatestring

可选项展开详情

示例值:query枚举值:queryquery_range
MetricTypeinteger<int32>

可选项展开详情

示例值:0枚举值:01
StartTimeinteger<int64>

数据起始时间戳（单位：秒），如：1684166400

注意 该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。
示例值:1684166400
EndTimeinteger<int64>

数据结束时间戳（单位：秒），如：1684166400 展开详情

注意 该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。
示例值:1684166400

请求说明

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

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

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

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

返回参数

字段名称字段详情
RequestIdstring

请求唯一 ID。

示例值:39090022-1F3B-4797-8518-6B61095F1AF0
Codeinteger<int32>

状态码。

示例值:200
Successboolean

API 调用是否成功。取值如下：展开详情

示例值: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": "执行成功"
    }
  ]
变更历史
变更时间变更内容概要操作
2024-12-20
变更返回参数
2024-10-18
变更返回参数