跳转到主要内容
ZStack
平台运维相关接口/平台综合

执行批量

执行批次操作多个资源类型。

POST/api/v1/batch

操作 ID

ExecuteBatch

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • request
    Object必填

    请求。

    • resourceType
      String

      资源类型。

      示例： platform

    • action
      String

      动作名称。

      示例： delete

    • items
      List

      条目列表。

      示例： (nested array)

      • id
        String

        资源ID。

        示例： item-001

      • params
        LinkedHashMap

        附加参数键值对。

        示例： (nested object)

    • dryRun
      Boolean

      是否仅模拟执行而不实际应用变更。

      示例： false

    • failFast
      Boolean

      快速失败。

      示例： false

响应状态

200 OK
200 OK

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

  • resourceType
    String

    资源类型。

    示例： platform

  • action
    String

    动作名称。

    示例： delete

  • totalCount
    Integer

    总数量。

    示例： 10

  • successCount
    Integer

    成功数量。

    示例： 9

  • failureCount
    Integer

    失败数量。

    示例： 1

  • dryRun
    Boolean

    是否仅模拟执行而不实际应用变更。

    示例： false

  • results
    List

    结果列表。

    示例： (nested array)

    • id
      String

      资源ID。

      示例： item-001

    • success
      Boolean

      操作是否成功。true 表示成功，false 表示失败。

      示例： true

    • httpStatus
      Integer

      HTTP状态。

      示例： 200

    • error
      String

      错误码。操作成功时为 null，失败时返回具体错误信息。

      示例： resource not found

    • dryRunEstimate
      String

      预估影响描述干运行模式。

      示例： Would delete 1 platform

  • processedAt
    String

    已处理时间。

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