获取专业版应用任务调度概览数据信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| edas:ReadSchedulerxOverviewQuery | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 区域 Region ID | cn-hangzhou |
| Namespace | string | 否 | 命名空间 UID | adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
| NamespaceSource | string | 否 | 命名空间来源，特殊第三方才需要填写 | schedulerx |
| GroupId | string | 否 | 应用分组 ID | testSchedulerx.defaultGroup |
| Operate | string | 是 | 可选项
| query |
| MetricType | integer | 是 | 可选项
| 0 |
| StartTime | long | 是 | 数据起始时间戳（单位：秒），如：1684166400 | 1684166400 |
| EndTime | long | 否 | 数据结束时间戳（单位：秒），如：1684166400 不填默认为当前时间 | 1684166400 |
当前接口查询数据信息对应控制台概览的三块信息内容，相应请求参数配置要求如下
-
任务基础信息：请求参数配置说明如下，Operate 设置“query”，MetricType 设置为“0”，StartTime 设置为当前时间戳
-
时间区间任务运行信息：请求参数配置说明如下，Operate 设置“query”，MetricType 设置为“1”，StartTime 设置为业务需要的查询起始时间（不得早于 15 天，当前时序数据存储有效期为 15 天）
-
时间区间任务运行时序信息：请求参数配置说明如下，Operate 设置“query_range”，MetricType 设置为“1”，StartTime 设置为业务需要的查询起始时间（默认推荐当前 1 小时前，因返回每个时点信息量大不建议设置过早）
返回参数
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\"}",
"AccessDeniedDetail": {
"AuthAction": "",
"AuthPrincipalDisplayName": "",
"AuthPrincipalOwnerId": "",
"AuthPrincipalType": "",
"EncodedDiagnosticMessage": "",
"NoPermissionType": "",
"PolicyType": ""
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-10-18 | OpenAPI 返回结构发生变更 | 查看变更详情 |