GetInstanceStatusStatistic - 获取实例运行状态统计数据

更新时间:
复制 MD 格式

用GetInstanceStatusCount获取实例任务不同运行状态的数量统计。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:*

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

ProjectId

integer

是

DataWorks 工作空间的 ID。您可以登录 DataWorks 管控台,进入工作空间配置页面获取工作空间 ID。

1234

ProjectEnv

string

是

运行的环境,包括 PROD(生产环境)和 DEV(开发环境)。

枚举值:

  • PROD :

    生产环境

  • DEV :

    开发环境

PROD

BizDate

string

是

获取不同实例状态数量的业务日期。格式为 yyyy-MM-dd。

2020-01-01

SchedulerType

string

否

调度的类型,取值如下:

  • NORMAL:周期调度

  • MANUAL:手动调度

  • PAUSE:暂停调度

  • SKIP:空跑

枚举值:

  • PAUSE :

    暂停调度

  • SKIP :

    空跑

  • MANUAL :

    手动调度

  • NORMAL :

    周期调度

NORMAL

DagType

string

否

Dag Type 的类型:

  • MANUAL:手动任务工作流

  • SMOKE_TEST:冒烟测试工作流

  • SUPPLY_DATA:补数据

  • BUSINESS_PROCESS_DAG:一次性业务流程工作流

枚举值:

  • DAILY :

    周期任务工作流

  • SUPPLY_DATA :

    补数据工作流

  • SMOKE_TEST :

    冒烟测试工作流

  • MANUAL :

    手动任务工作流

  • BUSINESS_PROCESS_DAG :

    一次性业务流程工作流

MANUAL

SchedulerPeriod

string

否

调度周期。

  • MINUTE:分钟。

  • HOUR:小时。

  • DAY:天。

  • WEEK:周。

  • MONTH:月。

枚举值:

  • MONTH :

    月

  • HOUR :

    小时

  • MINUTE :

    分钟

  • WEEK :

    周

  • DAY :

    天

DAY

返回参数

名称

类型

描述

示例值

object

返回实体。

RequestId

string

请求 ID,用于定位日志,排查问题。

0000-ABCD-EFG****

StatusCount

object

实例状态的数量统计。

FailureCount

integer

运行失败的实例数量。

1

WaitTimeCount

integer

等待运行的实例数量。

1

RunningCount

integer

运行中的实例数量。

1

SuccessCount

integer

运行成功的实例数量。

1

TotalCount

integer

实例的总数。

1

NotRunCount

integer

未运行的实例数量。

1

WaitResCount

integer

等待资源的实例数量。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "0000-ABCD-EFG****",
  "StatusCount": {
    "FailureCount": 1,
    "WaitTimeCount": 1,
    "RunningCount": 1,
    "SuccessCount": 1,
    "TotalCount": 1,
    "NotRunCount": 1,
    "WaitResCount": 1
  }
}

错误码

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

变更历史

更多信息,参考变更详情。