跳转到主要内容
ZStack
平台运维相关接口/ZMetis 任务

查询ZMetis任务列表

查询当前用户可见的 ZMetis 长时间运行任务列表。

GET/api/v1/zmetis/tasks

操作 ID

ListZmetisTasks

起始版本

1.2.8

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • domain
    String

    域名称。

  • taskType
    String

    已使用过滤结果。

  • taskState
    String

    已使用过滤结果。

  • resourceType
    String

    资源类型。

  • resourceUuid
    String

    资源UUID。若指定，资源会使用该字段值作为UUID。

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • items
    List

    条目列表。

    示例： (nested array)

    • taskId
      String

      任务ID。

      示例： b8b4f3de49de4384a3de0aa0d71d6f31

    • domain
      String

      域名称。

      示例： security.anheng

    • resourceType
      String

      资源类型。

      示例： anheng_instance

    • resourceUuid
      String

      资源UUID。若指定，资源会使用该字段值作为UUID。

      示例： instance-uuid

    • taskType
      String

      资源。

      示例： open

    • taskState
      String

      资源。

      示例： running

    • currentStep
      String

      资源。

      示例： create_cloud_vm

    • failedStep
      String

      资源。

      示例： create_cloud_vm

    • retryOfTaskId
      String

      资源。

      示例： original-task-uuid

    • retryFromStep
      String

      资源。

      示例： create_cloud_vm

    • requestId
      String

      资源。

      示例： request-123

    • steps
      List

      执行步骤列表。

      示例： (nested array)

      • stepCode
        String

        资源。

        示例： create_cloud_vm

      • status
        String

        状态信息。

        示例： running

      • errorCode
        String

        LDAP错误分类编码。

        示例： ANHENG_CLOUD_SESSION_REQUIRED

      • errorMessage
        String

        错误返回消息。

        示例： Cloud session is required to continue this task

      • startedAt
        String

        开始时间。

        示例： 2026-01-15T08:00:00Z

      • finishedAt
        String

        完成时间。

        示例： 2026-01-15T08:00:00Z

    • blockedReasons
      List

      资源。

      示例： (nested array)

      • code
        String

        编码值。

        示例： ANHENG_CLOUD_SESSION_REQUIRED

      • message
        String

        错误返回消息。

        示例： Cloud session is required to continue this task

      • source
        String

        来源信息。

        示例： security.anheng

      • severity
        String

        告警级别。

        示例： error

      • retryable
        Boolean

        资源。

        示例： true

    • retryable
      Boolean

      资源。

      示例： true

    • createdAt
      String

      创建时间。

      示例： 2026-01-15T08:00:00Z

    • updatedAt
      String

      更新时间。

      示例： 2026-01-15T08:00:00Z

    • finishedAt
      String

      完成时间。

      示例： 2026-01-15T08:00:00Z

  • total
    String

    返回结果总数。

    示例： 1

  • limit
    Integer

    最大返回条目数。

    示例： 20

  • offset
    Integer

    查询起始偏移量。

    示例： 20

变更历史

查看全部变更历史

  • 变更时间

    新增请求参数 X-ZStack-Session
    查看 API