Chaitin Tech 任务/任务实例v2 API

The 任务/任务实例v2 API from Chaitin Tech — 14 operation(s) for 任务/任务实例v2.

OpenAPI Specification

chaitin-v2-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: APISec Management account 任务/任务实例v2 API
  version: '26.05'
  description: Generated from APISec skyview APIView classes.
tags:
- name: 任务/任务实例v2
paths:
  /v1/task/{task_type}/instance:
    get:
      deprecated: false
      description: ''
      parameters:
      - description: 任务类型
        example: asset
        in: path
        name: task_type
        required: true
        schema:
          enum:
          - asset
          - attack
          - risk
          type: string
          x-apifox-enum:
          - description: ''
            name: 资产发现
            value: asset
          - description: ''
            name: 暴露面识别
            value: attack
          - description: ''
            name: 风险评估
            value: risk
      - description: 空间ID
        example: 1
        in: query
        name: space
        required: true
        schema:
          type: integer
      - description: 页码
        example: 1
        in: query
        name: page
        required: false
        schema:
          enum:
          - waiting
          - running
          - aborted
          - finished
          - deleting
          type: string
          x-apifox-enum:
          - description: 等待调度
            name: ''
            value: waiting
          - description: 运行中
            name: ''
            value: running
          - description: 已暂停
            name: ''
            value: aborted
          - description: 已完成
            name: ''
            value: finished
          - description: 已终止
            name: ''
            value: deleting
      - description: 分页大小
        example: 20
        in: query
        name: size
        required: false
        schema:
          type: integer
      - description: 任务状态
        example: ''
        in: query
        name: task_status
        required: false
        schema:
          enum:
          - waiting
          - running
          - aborted
          - finished
          - deleting
          type: string
          x-apifox-enum:
          - description: ''
            name: 等待运行
            value: waiting
          - description: ''
            name: 运行中
            value: running
          - description: ''
            name: 已暂停
            value: aborted
          - description: ''
            name: 已完成
            value: finished
          - description: ''
            name: 已终止
            value: deleting
      - description: 搜索任务信息,任务名称、集群模糊搜索
        example: ''
        in: query
        name: query
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                code: 200
                data:
                  current: 1
                  items:
                  - cluster:
                      cluster: default
                      description: 默认集群
                    created_at: '2026-03-17 14:02:10'
                    done: 17
                    finished_at: '2026-03-17 14:15:10'
                    remaining_time: 0
                    schedule_id: 0
                    scope: all
                    scope_data: []
                    task_id: 33
                    task_name: 人工运行
                    task_status: finished
                    total: 17
                    xapp: []
                    xpoc: []
                  size: 10
                  total: 1
                message: ''
              schema:
                properties:
                  code:
                    title: 响应码
                    type: integer
                  data:
                    properties:
                      current:
                        title: 当前页码
                        type: integer
                      items:
                        items:
                          properties:
                            cluster:
                              properties:
                                cluster:
                                  title: 集群名称
                                  type: string
                                description:
                                  title: 集群描述
                                  type: string
                              required:
                              - cluster
                              - description
                              title: 集群
                              type: object
                              x-apifox-orders:
                              - cluster
                              - description
                            created_at:
                              title: 创建时间
                              type: string
                            done:
                              title: 完成编排数量
                              type: integer
                            finished_at:
                              title: 更新时间
                              type: string
                            remaining_time:
                              title: 任务剩余时间
                              type: integer
                            schedule_id:
                              description: 手动执行任务为0
                              title: 周期任务ID
                              type: integer
                            scope:
                              description: 资产发现任务固定为all
                              title: 扫描资产范围
                              type: string
                            scope_data:
                              description: 如果选择资产分组或者资产标签,这里保存对应ID列表
                              items:
                                type: integer
                              title: 扫描资产范围值列表
                              type: array
                            task_id:
                              title: 任务ID
                              type: integer
                            task_name:
                              title: 任务名称
                              type: string
                            task_status:
                              enum:
                              - waiting
                              - running
                              - aborted
                              - finished
                              - deleting
                              type: string
                              x-apifox-enum:
                              - description: ''
                                name: 等待运行
                                value: waiting
                              - description: ''
                                name: 运行中
                                value: running
                              - description: ''
                                name: 已暂停
                                value: aborted
                              - description: ''
                                name: 已完成
                                value: finished
                              - description: ''
                                name: 已终止
                                value: deleting
                            total:
                              title: 编排总数量
                              type: integer
                            xapp:
                              description: 只暴露面识别任务使用
                              items:
                                type: string
                              title: 指纹分组列表
                              type: array
                            xpoc:
                              description: 只风险评估任务使用
                              items:
                                type: string
                              title: 漏洞分组列表
                              type: array
                          type: object
                          x-apifox-orders:
                          - task_id
                          - task_name
                          - schedule_id
                          - cluster
                          - scope
                          - scope_data
                          - xapp
                          - xpoc
                          - done
                          - total
                          - remaining_time
                          - task_status
                          - created_at
                          - finished_at
                        type: array
                      size:
                        title: 分页大小
                        type: integer
                      total:
                        title: 总数
                        type: integer
                    required:
                    - current
                    - size
                    - total
                    - items
                    title: 数据
                    type: object
                    x-apifox-orders:
                    - current
                    - size
                    - total
                    - items
                  message:
                    title: 消息
                    type: string
                required:
                - code
                - message
                - data
                type: object
                x-apifox-orders:
                - code
                - message
                - data
          description: ''
          headers: {}
          x-apifox-name: 成功
      security:
      - apikey-header-TOKEN: []
      summary: 任务实例列表
      tags:
      - 任务/任务实例v2
      x-apifox-folder: 任务/任务实例v2
      x-apifox-status: developing
      x-run-in-apifox: https://app.apifox.com/web/project/4506488/apis/api-430416697-run
    post:
      deprecated: false
      description: ''
      parameters:
      - description: 任务类型
        example: asset
        in: path
        name: task_type
        required: true
        schema:
          enum:
          - asset
          - attack
          - risk
          type: string
          x-apifox-enum:
          - description: ''
            name: 资产发现
            value: asset
          - description: ''
            name: 暴露面识别
            value: attack
          - description: ''
            name: 风险评估
            value: risk
      - description: 空间ID
        example: 1
        in: query
        name: space
        required: false
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            examples: {}
            schema:
              properties:
                cluster:
                  title: 集群
                  type: string
                scope:
                  description: 资产发现任务默认为all,不支持选择
                  enum:
                  - all
                  - bu
                  - tag
                  title: 扫描资产范围
                  type: string
                  x-apifox-enum:
                  - description: ''
                    name: 全部资产
                    value: all
                  - description: ''
                    name: 资产分组
                    value: bu
                  - description: ''
                    name: 资产标签
                    value: tag
                scope_data:
                  description: 资产分组或资产标签ID列表
                  items:
                    type: integer
                  title: 扫描资产范围ID列表
                  type: array
                task_name:
                  title: 任务名称
                  type: string
                xapp:
                  description: 只暴露面识别任务使用
                  items:
                    type: string
                  title: 指纹分组ID列表
                  type: array
                xpoc:
                  description: 只风险评估任务使用
                  items:
                    type: string
                  title: 漏洞分组ID列表
                  type: array
              required:
              - task_name
              - cluster
              - scope
              - scope_data
              type: object
              x-apifox-orders:
              - task_name
              - cluster
              - scope
              - scope_data
              - xapp
              - xpoc
      responses:
        '200':
          content:
            application/json:
              example:
                code: 200
                data:
                  scope: all
                  scope_data: []
                  task_flow: assets-probe
                  task_id: 42
                  xapp: []
                  xpoc: []
                message: ''
              schema:
                properties:
                  code:
                    title: 响应码
                    type: integer
                  data:
                    properties:
                      scope:
                        description: 资产发现任务固定为all
                        title: 扫描范围
                        type: string
                      scope_data:
                        description: 如果选择资产分组或者资产标签,这里保存对应ID列表
                        items:
                          type: integer
                        title: 扫描范围值列表
                        type: array
                      task_flow:
                        title: 任务编排
                        type: string
                      task_id:
                        title: 任务ID
                        type: integer
                      xapp:
                        description: 只暴露面识别任务使用
                        items:
                          type: string
                        title: 指纹分组列表
                        type: array
                      xpoc:
                        description: 只风险评估任务使用
                        items:
                          type: string
                        title: 漏洞分组列表
                        type: array
                    required:
                    - task_flow
                    - xpoc
                    - scope
                    - xapp
                    - task_id
                    - scope_data
                    title: 数据
                    type: object
                    x-apifox-orders:
                    - task_id
                    - task_flow
                    - scope
                    - scope_data
                    - xapp
                    - xpoc
                  message:
                    title: 消息
                    type: string
                required:
                - code
                - message
                - data
                type: object
                x-apifox-orders:
                - code
                - message
                - data
          description: ''
          headers: {}
          x-apifox-name: 成功
      security:
      - apikey-header-TOKEN: []
      summary: 任务实例创建(立即运行)
      tags:
      - 任务/任务实例v2
      x-apifox-folder: 任务/任务实例v2
      x-apifox-status: developing
      x-run-in-apifox: https://app.apifox.com/web/project/4506488/apis/api-430443635-run
  /v1/task/{task_type}/instance/batch-delete:
    delete:
      deprecated: false
      description: ''
      parameters:
      - description: 任务类型
        example: asset
        in: path
        name: task_type
        required: true
        schema:
          enum:
          - asset
          - attack
          - risk
          type: string
          x-apifox-enum:
          - description: ''
            name: 资产发现
            value: asset
          - description: ''
            name: 暴露面识别
            value: attack
          - description: ''
            name: 风险评估
            value: risk
      - description: 空间ID
        example: 1
        in: query
        name: space
        required: false
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            examples: {}
            schema:
              properties:
                pk:
                  items:
                    type: integer
                  title: ID列表
                  type: array
              required:
              - pk
              type: object
              x-apifox-orders:
              - pk
      responses:
        '200':
          content:
            application/json:
              example:
                code: 200
                data:
                  affected: 2
                  ignored: 0
                message: ''
              schema:
                properties:
                  code:
                    title: 响应码
                    type: integer
                  data:
                    properties:
                      affected:
                        title: 成功数量
                        type: integer
                      ignored:
                        title: 忽略数量
                        type: integer
                    required:
                    - affected
                    - ignored
                    title: 数据
                    type: object
                    x-apifox-orders:
                    - affected
                    - ignored
                  message:
                    title: 消息
                    type: string
                required:
                - code
                - message
                - data
                type: object
                x-apifox-orders:
                - code
                - message
                - data
          description: ''
          headers: {}
          x-apifox-name: 成功
      security:
      - apikey-header-TOKEN: []
      summary: 任务实例批量删除
      tags:
      - 任务/任务实例v2
      x-apifox-folder: 任务/任务实例v2
      x-apifox-status: developing
      x-run-in-apifox: https://app.apifox.com/web/project/4506488/apis/api-430442238-run
  /v1/task/{task_type}/instance/status:
    post:
      deprecated: false
      description: ''
      parameters:
      - description: 任务类型
        example: asset
        in: path
        name: task_type
        required: true
        schema:
          enum:
          - asset
          - attack
          - risk
          type: string
          x-apifox-enum:
          - description: ''
            name: 资产发现
            value: asset
          - description: ''
            name: 暴露面识别
            value: attack
          - description: ''
            name: 风险评估
            value: risk
      - description: 空间ID
        example: 1
        in: query
        name: space
        required: false
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            examples: {}
            schema:
              properties:
                pk:
                  items:
                    type: integer
                  title: ID列表
                  type: array
                status:
                  enum:
                  - waiting
                  - aborted
                  title: 操作状态
                  type: string
                  x-apifox-enum:
                  - description: ''
                    name: 重跑
                    value: waiting
                  - description: ''
                    name: 暂停
                    value: aborted
              required:
              - pk
              - status
              type: object
              x-apifox-orders:
              - pk
              - status
      responses:
        '200':
          content:
            application/json:
              example:
                code: 200
                data:
                  affected: 1
                  ignored: 0
                message: ''
              schema:
                properties:
                  code:
                    title: 响应码
                    type: integer
                  data:
                    properties:
                      affected:
                        title: 成功数量
                        type: integer
                      ignored:
                        title: 忽略数量
                        type: integer
                    required:
                    - affected
                    - ignored
                    title: 数据
                    type: object
                  message:
                    title: 消息
                    type: string
                required:
                - code
                - message
                - data
                type: object
          description: ''
          headers: {}
          x-apifox-name: 成功
      security:
      - apikey-header-TOKEN: []
      summary: 任务实例批量重跑、暂停
      tags:
      - 任务/任务实例v2
      x-apifox-folder: 任务/任务实例v2
      x-apifox-status: developing
      x-run-in-apifox: https://app.apifox.com/web/project/4506488/apis/api-430458617-run
  /v1/task/{task_type}/instance/status/count:
    get:
      deprecated: false
      description: ''
      parameters:
      - description: 任务类型
        example: asset
        in: path
        name: task_type
        required: true
        schema:
          enum:
          - asset
          - attack
          - risk
          type: string
          x-apifox-enum:
          - description: ''
            name: 资产发现
            value: asset
          - description: ''
            name: 暴露面识别
            value: attack
          - description: ''
            name: 风险评估
            value: risk
      - description: 空间ID
        example: 1
        in: query
        name: space
        required: false
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              example:
                code: 200
                data:
                  aborted: 0
                  deleting: 0
                  finished: 1
                  running: 0
                  waiting: 0
                message: ''
              schema:
                properties:
                  code:
                    title: 响应码
                    type: integer
                  data:
                    properties:
                      aborted:
                        title: 已暂停
                        type: integer
                      deleting:
                        title: 已终止
                        type: integer
                      finished:
                        title: 已完成
                        type: integer
                      running:
                        title: 运行中
                        type: integer
                      waiting:
                        title: 等待调度
                        type: integer
                    required:
                    - waiting
                    - running
                    - aborted
                    - finished
                    - deleting
                    title: 数据
                    type: object
                    x-apifox-orders:
                    - waiting
                    - running
                    - aborted
                    - finished
                    - deleting
                  message:
                    title: 消息
                    type: string
                required:
                - code
                - message
                - data
                type: object
                x-apifox-orders:
                - code
                - message
                - data
          description: ''
          headers: {}
          x-apifox-name: 成功
      security:
      - apikey-header-TOKEN: []
      summary: 任务实例状态数量
      tags:
      - 任务/任务实例v2
      x-apifox-folder: 任务/任务实例v2
      x-apifox-status: developing
      x-run-in-apifox: https://app.apifox.com/web/project/4506488/apis/api-430397358-run
  /v1/task/{task_type}/instance/{id}:
    get:
      deprecated: false
      description: ''
      parameters:
      - description: 任务类型
        example: asset
        in: path
        name: task_type
        required: true
        schema:
          enum:
          - asset
          - attack
          - risk
          type: string
          x-apifox-enum:
          - description: ''
            name: 资产发现
            value: asset
          - description: ''
            name: 暴露面识别
            value: attack
          - description: ''
            name: 风险评估
            value: risk
      - description: 任务ID
        example: 1
        in: path
        name: id
        required: true
        schema:
          type: integer
      - description: 空间ID
        example: 1
        in: query
        name: space
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              example:
                code: 200
                data:
                  cluster:
                    cluster: default
                    description: 默认集群
                  created_at: '2026-03-19 15:35:37'
                  done: 9
                  finished_at: null
                  remaining_time: 1
                  schedule_id: 0
                  scope: all
                  scope_data: []
                  task_id: 42
                  task_name: 测试
                  task_status: aborted
                  total: 17
                  xapp: []
                  xpoc: []
                message: ''
              schema:
                properties:
                  code:
                    title: 响应码
                    type: integer
                  data:
                    properties:
                      cluster:
                        properties:
                          cluster:
                            title: 集群名称
                            type: string
                          description:
                            title: 集群描述
                            type: string
                        required:
                        - cluster
                        - description
                        title: 集群
                        type: object
                        x-apifox-orders:
                        - cluster
                        - description
                      created_at:
                        title: 创建时间
                        type: string
                      done:
                        title: 完成编排数量
                        type: integer
                      finished_at:
                        nullable: true
                        title: 完成时间
                        type: string
                      remaining_time:
                        title: 任务剩余时间
                        type: integer
                      schedule_id:
                        description: 手动执行任务为0
                        title: 周期任务ID
                        type: integer
                      scope:
                        description: 资产发现任务固定为all
                        title: 扫描资产范围
                        type: string
                      scope_data:
                        description: 如果选择资产分组或者资产标签,这里保存对应ID列表
                        items:
                          type: string
                        title: 扫描资产范围值列表
                        type: array
                      task_id:
                        title: 任务ID
                        type: integer
                      task_name:
                        title: 任务名称
                        type: string
                      task_status:
                        enum:
                        - waiting
                        - running
                        - aborted
                        - finished
                        - deleting
                        title: 任务状态
                        type: string
                        x-apifox-enum:
                        - description: ''
                          name: 等待运行
                          value: waiting
                        - description: ''
                          name: 运行中
                          value: running
                        - description: ''
                          name: 已暂停
                          value: aborted
                        - description: ''
                          name: 已完成
                          value: finished
                        - description: ''
                          name: 已终止
                          value: deleting
                      total:
                        title: 编排总数量
                        type: integer
                      xapp:
                        description: 只暴露面识别任务使用
                        items:
                          type: string
                        title: 指纹分组列表
                        type: array
                      xpoc:
                        description: 只风险评估任务使用
                        items:
                          type: string
                        title: 漏洞分组列表
                        type: array
                    required:
                    - task_id
                    - task_name
                    - schedule_id
                    - cluster
                    - scope
                    - scope_data
                    - xapp
                    - xpoc
                    - done
                    - total
                    - remaining_time
                    - task_status
                    - created_at
                    - finished_at
                    title: 数据
                    type: object
                    x-apifox-orders:
                    - task_id
                    - task_name
                    - schedule_id
                    - cluster
                    - scope
                    - scope_data
                    - xapp
                    - xpoc
                    - done
                    - total
                    - remaining_time
                    - task_status
                    - created_at
                    - finished_at
                  message:
                    title: 消息
                    type: string
                required:
                - code
                - message
                - data
                type: object
                x-apifox-orders:
                - code
                - message
                - data
          description: ''
          headers: {}
          x-apifox-name: 成功
      security:
      - apikey-header-TOKEN: []
      summary: 任务实例查看
      tags:
      - 任务/任务实例v2
      x-apifox-folder: 任务/任务实例v2
      x-apifox-status: developing
      x-run-in-apifox: https://app.apifox.com/web/project/4506488/apis/api-430496683-run
  /v1/task/attack/schedule/xapp/options:
    get:
      deprecated: false
      description: ''
      parameters:
      - description: 空间ID
        example: 1
        in: query
        name: space
        required: false
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              example:
                code: 200
                data:
                - name: 勒索挖矿
                  pk: 124bc30c-d94d-43f6-af86-59d17a34a09b
                - name: 护网行动
                  pk: 2d598441-29cf-4c28-9d23-8e4adcf2fdc8
                - name: 代理服务
                  pk: 4d412f7a-8ed0-490f-96d2-1873dfda256d
                - name: 信创与国产化
                  pk: 7b6ed73a-7fca-4e11-bc5c-e5f3a6ef5cce
                - name: 文件服务
                  pk: ad05bc0e-ab57-4472-b477-94f57ef83cde
                - name: AI-人工智能
                  pk: b01acbb7-df79-4184-8654-513cbc558406
                - name: 数据库服务
             

# --- truncated at 32 KB (90 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/chaitin/refs/heads/main/openapi/chaitin-v2-api-openapi.yml