更新时间:2024-11-06 GMT+08:00

查询实例运行状态

功能介绍

此接口可以查询实例运行状态,包括当天、昨天、前天以及近7天的实例状态情况。

URI

  • URI格式

    GET /v2/{project_id}/factory/monitor/task-statistics-overview?is_own={is_own}&query_days={query_days}

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

    参数名

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,获取方法请参见项目ID和账号ID

    is_own

    String

    是否查询当前用户的实例,默认为false,表示查询全部用户实例,为true时,表示查询当前用户的实例。

    query_days

    String

    查询的天数,取值范围为:today、yesterday、before_yesterday、all,默认为today,表示查询今天的数据,支持查询近7天的数据。

    today:查询当天的实例状态数量,

    yesterday:查询昨天的实例状态数量,

    before_yesterday:查询前天的实例状态数量,

    all查询7天前到当天的实例状态总量。

请求参数

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

String

工作空间id。

  • 如果不设置该参数,默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据,需要带上该消息头。

X-Auth-Token

String

IAM Token

最小长度:0

最大长度:4096

响应参数

表3 响应参数说明

参数名

是否必选

参数类型

说明

fail_count

Integer

失败的实例数量

force_success_count

Integer

强制成功的实例数量

freeze_count

Integer

冻结的实例数量

ignore_success_count

Integer

忽略失败的实例数量

manual_stop_count

Integer

取消的实例数量

pause_count

Integer

暂停的实例数量

running_count

Integer

运行中的实例数量

running_exception_count

Integer

异常的实例数量。

skip_count

Integer

跳过的实例数量

success_count

Integer

运行成功的实例数量

waiting_confirm_count

Integer

待确认执行的实例数量

waiting_count

Integer

等待运行的实例数量

total_count

Integer

实例总数

请求示例

GET /v2/b384b9e9ab9b4ee8994c8633aabc9505/factory/monitor/task-statistics-overview?is_own=false&query_days=today

响应示例

  • 成功响应

    HTTP状态码 200

    {
        "fail_count": 0,
        "force_success_count": 0,
        "freeze_count": 0,
        "ignore_success_count": 0,
        "manual_stop_count": 0,
        "pause_count": 0,
        "running_count": 0,
        "running_exception_count": 0,
        "skip_count": 0,
        "success_count": 1,
        "total_count": 1,
        "waiting_confirm_count": 0,
        "waiting_count": 0
    }
  • 失败响应

    HTTP状态码 400

    {
        "error_code": "DLF.21113",
        "error_msg": "The task query parameters [today2] are incorrect. Currently, the supported types of parameters are today, yesterday, before_yesterday, and all."
    }