Chaitin Tech List API

openapi: 3.0.3
info:
  title: APISec Management account List API
  version: '26.05'
  description: Generated from APISec skyview APIView classes.
tags:
- name: List
paths:
  /list:
    delete:
      parameters:
      - description: 扫描器名称
        example: 扫描器名称
        in: query
        name: name
        schema:
          description: 扫描器名称
          example: 扫描器名称
          format: string
          properties: {}
          type: string
      - description: 扫描器版本号
        example: 扫描器版本号
        in: query
        name: version
        schema:
          description: 扫描器版本号
          example: 扫描器版本号
          format: string
          properties: {}
          type: string
      - description: 主机名称
        example: 主机名称
        in: query
        name: host_name
        schema:
          description: 主机名称
          example: 主机名称
          format: string
          properties: {}
          type: string
      - description: 主机IP地址
        example: 1.1.1
        in: query
        name: host_ip
        schema:
          description: 主机IP地址
          example: 1.1.1
          format: string
          properties: {}
          type: string
      - description: 探针类型列表 2为本地探针
        example: '[2]'
        in: query
        name: type
        schema:
          description: 探针类型列表 2为本地探针
          example: '[2]'
          format: '[]uint'
          items:
            enum:
            - 2
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
      - description: 扫描组ID列表
        example: '[1,2]'
        in: query
        name: group_id
        schema:
          description: 扫描组ID列表
          example: '[1,2]'
          format: '[]uint'
          items:
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
      - description: 扫描器状态列表 1 注册 2 在线 3 离线 4 异常
        example: '1'
        in: query
        name: state
        schema:
          description: 扫描器状态列表 1 注册 2 在线 3 离线 4 异常
          example: '1'
          format: '[]uint'
          items:
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
      - description: 1本地 2旁路 3集群节点 4集群旁路
        in: query
        name: source_type
        schema:
          description: 1本地 2旁路 3集群节点 4集群旁路
          format: '[]uint'
          items:
            enum:
            - 1
            - 2
            - 3
            - 4
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
      - description: 集群ID列表
        in: query
        name: cluster_id
        schema:
          description: 集群ID列表
          format: '[]uint'
          items:
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
      - description: 扫描探针ID
        example: '[1,2]'
        in: query
        name: id
        schema:
          description: 扫描探针ID
          example: '[1,2]'
          format: '[]uint'
          items:
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
      - description: 数据启始位置
        example: '1'
        in: query
        name: offset
        schema:
          description: 数据启始位置
          example: 1
          format: int
          properties: {}
          type: integer
      - description: 数据页大小
        example: '1'
        in: query
        name: page_size
        schema:
          description: 数据页大小
          example: 1
          format: int
          properties: {}
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/git.in.chaitin.net.veinmind.backend.api.api.agent.ScannerListRes'
          description: ''
      tags:
      - List
    get:
      parameters:
      - description: 扫描器名称
        example: 扫描器名称
        in: query
        name: name
        schema:
          description: 扫描器名称
          example: 扫描器名称
          format: string
          properties: {}
          type: string
      - description: 扫描器版本号
        example: 扫描器版本号
        in: query
        name: version
        schema:
          description: 扫描器版本号
          example: 扫描器版本号
          format: string
          properties: {}
          type: string
      - description: 主机名称
        example: 主机名称
        in: query
        name: host_name
        schema:
          description: 主机名称
          example: 主机名称
          format: string
          properties: {}
          type: string
      - description: 主机IP地址
        example: 1.1.1
        in: query
        name: host_ip
        schema:
          description: 主机IP地址
          example: 1.1.1
          format: string
          properties: {}
          type: string
      - description: 探针类型列表 2为本地探针
        example: '[2]'
        in: query
        name: type
        schema:
          description: 探针类型列表 2为本地探针
          example: '[2]'
          format: '[]uint'
          items:
            enum:
            - 2
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
      - description: 扫描组ID列表
        example: '[1,2]'
        in: query
        name: group_id
        schema:
          description: 扫描组ID列表
          example: '[1,2]'
          format: '[]uint'
          items:
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
      - description: 扫描器状态列表 1 注册 2 在线 3 离线 4 异常
        example: '1'
        in: query
        name: state
        schema:
          description: 扫描器状态列表 1 注册 2 在线 3 离线 4 异常
          example: '1'
          format: '[]uint'
          items:
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
      - description: 1本地 2旁路 3集群节点 4集群旁路
        in: query
        name: source_type
        schema:
          description: 1本地 2旁路 3集群节点 4集群旁路
          format: '[]uint'
          items:
            enum:
            - 1
            - 2
            - 3
            - 4
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
      - description: 集群ID列表
        in: query
        name: cluster_id
        schema:
          description: 集群ID列表
          format: '[]uint'
          items:
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
      - description: 扫描探针ID
        example: '[1,2]'
        in: query
        name: id
        schema:
          description: 扫描探针ID
          example: '[1,2]'
          format: '[]uint'
          items:
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
      - description: 数据启始位置
        example: '1'
        in: query
        name: offset
        schema:
          description: 数据启始位置
          example: 1
          format: int
          properties: {}
          type: integer
      - description: 数据页大小
        example: '1'
        in: query
        name: page_size
        schema:
          description: 数据页大小
          example: 1
          format: int
          properties: {}
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/git.in.chaitin.net.veinmind.backend.api.api.agent.ScannerListRes'
          description: ''
      tags:
      - List
    head:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/git.in.chaitin.net.veinmind.backend.api.api.agent.ScannerListReq'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/git.in.chaitin.net.veinmind.backend.api.api.agent.ScannerListRes'
          description: ''
      tags:
      - List
    options:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/git.in.chaitin.net.veinmind.backend.api.api.agent.ScannerListReq'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/git.in.chaitin.net.veinmind.backend.api.api.agent.ScannerListRes'
          description: ''
      tags:
      - List
    patch:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/git.in.chaitin.net.veinmind.backend.api.api.agent.ScannerListReq'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/git.in.chaitin.net.veinmind.backend.api.api.agent.ScannerListRes'
          description: ''
      tags:
      - List
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/git.in.chaitin.net.veinmind.backend.api.api.agent.ScannerListReq'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/git.in.chaitin.net.veinmind.backend.api.api.agent.ScannerListRes'
          description: ''
      tags:
      - List
    put:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/git.in.chaitin.net.veinmind.backend.api.api.agent.ScannerListReq'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/git.in.chaitin.net.veinmind.backend.api.api.agent.ScannerListRes'
          description: ''
      tags:
      - List
    trace:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/git.in.chaitin.net.veinmind.backend.api.api.agent.ScannerListReq'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/git.in.chaitin.net.veinmind.backend.api.api.agent.ScannerListRes'
          description: ''
      tags:
      - List
components:
  schemas:
    git.in.chaitin.net.veinmind.backend.module.agent.model.ScannerListOne:
      properties:
        name:
          description: 扫描探针名称
          example: 扫描探针名称
          format: string
          properties: {}
          type: string
        group_name:
          description: 扫描组名称
          example: '1'
          format: string
          properties: {}
          type: string
        host_name:
          description: 主机名称
          example: 主机名称
          format: string
          properties: {}
          type: string
        host_ip:
          description: 主机IP地址
          example: 1.1.1.1
          format: string
          properties: {}
          type: string
        version:
          description: 扫描探针版本号
          example: vemind-v1.1.1
          format: string
          properties: {}
          type: string
        log_level:
          description: 日志输出级别(error,warn,info,debug)，默认 info
          enum:
          - error,warn,info,debug
          format: string
          properties: {}
          type: string
        cluster_node_info:
          $ref: '#/components/schemas/git.in.chaitin.net.veinmind.backend.module.agent.model.ClusterNodeInfo'
        cpu:
          description: 当前 CPU 占用(0.3 代表占单核 30%)，0 代表未知
          example: 0.3
          format: float64
          properties: {}
          type: number
        cpu_limit:
          description: 当前 CPU 限制(0.3 代表单核 30%)，-1 代表无限制，0 代表未知
          example: 1
          format: float64
          properties: {}
          type: number
        heartbeat:
          description: 心跳时间
          example: 1679626209
          format: int64
          properties: {}
          type: integer
        memory:
          description: 当前内存占用(Byte)，0 代表未知
          example: 134217728
          format: int64
          properties: {}
          type: integer
        memory_limit:
          description: 当前内存限制(Byte)，-1 代表无限制，0 代表未知
          example: 1073741824
          format: int64
          properties: {}
          type: integer
        disk_read:
          description: 当前磁盘IO读
          example: 1232452
          format: int64
          properties: {}
          type: integer
        disk_write:
          description: 当前磁盘IO写
          example: 1232452
          format: int64
          properties: {}
          type: integer
        net_in:
          description: 网络入带宽
          example: 1232452
          format: int64
          properties: {}
          type: integer
        net_out:
          description: 网络出带宽
          example: 1232452
          format: int64
          properties: {}
          type: integer
        run_secure_task_num:
          description: 当前探针正在运行的安全任务数量
          example: 1
          format: uint
          properties: {}
          type: integer
        _:
          format: uint
          properties: {}
          type: integer
        id:
          description: 扫描探针ID
          example: 1
          format: uint
          properties: {}
          type: integer
        type:
          description: 探针类型 2为本地探针
          example: 1
          format: uint
          properties: {}
          type: integer
        source_type:
          description: 1本地 2旁路 3集群节点
          example: 1
          format: uint
          properties: {}
          type: integer
        state:
          description: 扫描器状态 1 注册 2 在线 3 离线 4 异常
          example: 1
          format: uint
          properties: {}
          type: integer
        log_size:
          description: 日志存储量(MB)'，默认 10MB
          format: int
          properties: {}
          type: integer
      type: object
    git.in.chaitin.net.veinmind.backend.api.api.agent.ScannerListRes:
      items:
        $ref: '#/components/schemas/git.in.chaitin.net.veinmind.backend.module.agent.model.ScannerListOne'
      properties: {}
      type: array
    git.in.chaitin.net.veinmind.backend.api.api.agent.ScannerListReq:
      properties:
        name:
          description: 扫描器名称
          example: 扫描器名称
          format: string
          properties: {}
          type: string
        version:
          description: 扫描器版本号
          example: 扫描器版本号
          format: string
          properties: {}
          type: string
        host_name:
          description: 主机名称
          example: 主机名称
          format: string
          properties: {}
          type: string
        host_ip:
          description: 主机IP地址
          example: 1.1.1
          format: string
          properties: {}
          type: string
        type:
          description: 探针类型列表 2为本地探针
          example: '[2]'
          format: '[]uint'
          items:
            enum:
            - 2
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
        group_id:
          description: 扫描组ID列表
          example: '[1,2]'
          format: '[]uint'
          items:
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
        state:
          description: 扫描器状态列表 1 注册 2 在线 3 离线 4 异常
          example: '1'
          format: '[]uint'
          items:
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
        source_type:
          description: 1本地 2旁路 3集群节点 4集群旁路
          format: '[]uint'
          items:
            enum:
            - 1
            - 2
            - 3
            - 4
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
        cluster_id:
          description: 集群ID列表
          format: '[]uint'
          items:
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
        id:
          description: 扫描探针ID
          example: '[1,2]'
          format: '[]uint'
          items:
            format: uint
            properties: {}
            type: integer
          properties: {}
          type: array
        offset:
          description: 数据启始位置
          example: 1
          format: int
          properties: {}
          type: integer
        page_size:
          description: 数据页大小
          example: 1
          format: int
          properties: {}
          type: integer
      type: object
    git.in.chaitin.net.veinmind.backend.module.agent.model.ClusterNodeInfo:
      properties:
        name:
          description: 集群名称
          example: 集群名称
          format: string
          properties: {}
          type: string
        node_name:
          description: 集群节点名称
          example: 集群节点名称
          format: string
          properties: {}
          type: string
        id:
          description: 集群ID
          example: 1
          format: uint
          properties: {}
          type: integer
      type: object