Chaitin Tech device/avscantask API

终端管理/杀毒扫描任务

OpenAPI Specification

chaitin-device-avscantask-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: APISec Management account device/avscantask API
  version: '26.05'
  description: Generated from APISec skyview APIView classes.
tags:
- name: device/avscantask
  description: 终端管理/杀毒扫描任务
paths:
  /device/avscantask:
    post:
      summary: 创建任务
      deprecated: false
      description: ''
      tags:
      - device/avscantask
      parameters:
      - name: X-CS-Header-App
        in: header
        description: 应用id
        required: true
        example: '{{app}}'
        schema:
          type: string
      - name: X-CS-Header-Company
        in: header
        description: 公司id
        required: true
        example: '{{company_id}}'
        schema:
          type: string
      - name: X-CS-Header-Crypt
        in: header
        description: 加密算法,请参考:https://servaltech.feishu.cn/docs/doccnQCZ2cw32uazgNSO0DFwceb
        required: true
        example: ''
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: 对于支持「ETAG」的接口,将上一次请求的响应header的Etag,填入到下一次请求。若匹配,则返回304(无变更),否则会返回新版本的数据 + 新Etag
        required: true
        example: string
        schema:
          type: string
      - name: X-CS-Header-Debug
        in: header
        description: ''
        required: true
        example: '{{debug}}'
        schema:
          type: string
      - name: Accept-Language
        in: header
        description: ''
        required: true
        example: zh
        schema:
          type: string
      - name: X-Cs-Header-Timezone
        in: header
        description: ''
        required: true
        example: Asia/Shanghai
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      - name: Accept
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                file_scan_mode:
                  type: string
                scope:
                  type: string
                scan_mode:
                  type: string
                dirs_scan_options:
                  type: object
                  properties:
                    Windows:
                      type: array
                      items:
                        type: object
                        properties:
                          path:
                            type: string
                        required:
                        - path
                    macOS:
                      type: array
                      items:
                        type: object
                        properties:
                          path:
                            type: string
                        required:
                        - path
                    Linux:
                      type: array
                      items:
                        type: object
                        properties:
                          path:
                            type: string
                        required:
                        - path
                    Kylin:
                      type: array
                      items:
                        type: object
                        properties:
                          path:
                            type: string
                        required:
                        - path
                    UOS:
                      type: array
                      items:
                        type: object
                        properties:
                          path:
                            type: string
                        required:
                        - path
                  required:
                  - Windows
                  - macOS
                  - Linux
                  - Kylin
                  - UOS
                file_size_lower_measure:
                  type: string
                file_size_lower:
                  type: integer
                file_size_upper_measure:
                  type: string
                file_size_upper:
                  type: integer
                advanced_option:
                  type: boolean
                file_type_included:
                  type: array
                  items:
                    type: string
                binding_config:
                  type: object
                  properties:
                    source:
                      type: string
                    include:
                      type: object
                      properties:
                        device_ids:
                          type: array
                          items:
                            type: string
                      required:
                      - device_ids
                    exclude:
                      type: object
                      properties: {}
                  required:
                  - source
                  - include
                  - exclude
              required:
              - name
              - file_scan_mode
              - scope
              - scan_mode
              - dirs_scan_options
              - file_size_lower_measure
              - file_size_lower
              - file_size_upper_measure
              - file_size_upper
              - advanced_option
              - file_type_included
              - binding_config
            example:
              name: '12321321312'
              file_scan_mode: low_disturb
              scope: common
              scan_mode: custom
              dirs_scan_options:
                Windows:
                - path: C:\Users
                - path: D:\
                - path: E:\
                macOS:
                - path: /Library
                - path: /Users
                - path: /private
                - path: /Volumes
                Linux:
                - path: /home
                - path: /data
                Kylin:
                - path: /home
                - path: /data
                UOS:
                - path: /home
                - path: /data
              file_size_lower_measure: MB
              file_size_lower: 0
              file_size_upper_measure: MB
              file_size_upper: 100
              advanced_option: false
              file_type_included:
              - compressed
              binding_config:
                source: av_scan
                include:
                  device_ids:
                  - d1247921-d4fd-4f6c-9f62-504684f8f288
                  - 1c16c892-242c-467c-add4-8ab0f00f26e9
                exclude: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      category:
                        type: string
                      store_size:
                        type: integer
                      policy_mask:
                        type: integer
                      create_time:
                        type: string
                      create_by_id:
                        type: string
                      update_by_id:
                        type: string
                      expand:
                        type: object
                        properties: {}
                      sn:
                        type: string
                      store_uint:
                        type: string
                      update_time:
                        type: string
                      code:
                        type: string
                      latest_used_staff_id:
                        type: 'null'
                      description:
                        type: 'null'
                      company_id:
                        type: string
                      latest_used_device_id:
                        type: 'null'
                      uid:
                        type: string
                      brand:
                        type: string
                    required:
                    - id
                    - category
                    - store_size
                    - policy_mask
                    - create_time
                    - create_by_id
                    - update_by_id
                    - expand
                    - sn
                    - store_uint
                    - update_time
                    - code
                    - latest_used_staff_id
                    - description
                    - company_id
                    - latest_used_device_id
                    - uid
                    - brand
                required:
                - code
                - msg
                - data
              example:
                code: 3465
                msg: string
                data:
                  id: 1696
                  category: string
                  store_size: 2857
                  policy_mask: 9711
                  create_time: string
                  create_by_id: string
                  update_by_id: string
                  expand: {}
                  sn: string
                  store_uint: string
                  update_time: string
                  code: string
                  latest_used_staff_id: null
                  description: null
                  company_id: string
                  latest_used_device_id: null
                  uid: string
                  brand: string
      security: []