下载

描述

碳泽-玉衡漏洞风险管理平台

plugin_spec_version: v2
name: yuheng
title: 碳泽 - 玉衡
description: 碳泽-玉衡漏洞风险管理平台
version: 0.1.2
vendor: chariot
tags:
- YuHeng
- REST API
enable_cache: true
status:
- supported
language: python
types:
  categories_type:
    disabled:
      title:
        en: Disabled
        zh-CN: 禁用的漏洞种类
      type: "[]string"
      required: true
    enabled:
      title:
        en: Enabled
        zh-CN: 启用的漏洞种类
      type: "[]string"
      required: true
  individual_type:
    disabled:
      title:
        en: Disabled
        zh-CN: 禁用的单个检查项
      type: "[]string"
      required: true
    enabled:
      title:
        en: Enabled
        zh-CN: 启用的单个检查项
      type: "[]string"
      required: true
  types_type:
    disabled:
      title:
        en: Disabled
        zh-CN: 禁用的检测项类型
      type: "[]string"
      required: true
    enabled:
      title:
        en: Enabled
        zh-CN: 启用的检查项类型
      type: "[]string"
      required: true
  packetrate_type:
    defeatRateLimit:
      title:
        en: defeatRateLimit
        zh-CN: 默认速率限制，默认为true
      type: boolean
      required: true
      default: true
    maximum:
      title:
        en: Maximum
        zh-CN: 最大（每秒的数据包数量)，默认为0
      type: integer
      required: true
      default: 0
    minimum:
      title:
        en: Minimum
        zh-CN: 最小（每秒的数据包数量)，默认为0
      type: integer
      required: true
      default: 0
  parallelism_type:
    maximum:
      title:
        en: Maximum
        zh-CN: 最大并发，默认为0
      type: integer
      required: true
      default: 0
    minimum:
      title:
        en: Minimum
        zh-CN: 最小并发，默认为0
      type: integer
      required: true
      default: 0
  scandelay_type:
    maximum:
      title:
        en: Maximum
        zh-CN: 最大延迟,取值范围 'PT0S'-'PT30S'，默认'PT0S'
      type: string
      required: true
      default: PT0S
    minimum:
      title:
        en: Minimum
        zh-CN: 最小延迟,取值范围 'PT0S'-'PT30S'，默认'PT0S'
      type: string
      required: true
      default: PT0S
  timeout_type:
    initial:
      title:
        en: Initial
        zh-CN: 初始超时时间,取值范围 'PT0.5S'-'PT30S'，默认'PT0.5S'
      type: string
      required: true
      default: PT0.5S
    maximum:
      title:
        en: Maximum
        zh-CN: 最大超时时间限制,取值范围 'PT0.5S'-'PT30S'，默认'PT3S'
      type: string
      required: true
      default: PT3S
    minimum:
      title:
        en: Minimum
        zh-CN: 最小超时时间限制,取值范围 'PT0.5S'-'PT30S'，默认'PT0.5S'
      type: string
      required: true
      default: PT0.5S
  tcp_type:
    additionalPorts:
      title:
        en: additionalPorts
        zh-CN: 额外端口，默认为空
      type: "[]object"
      required: true
      default: 
    excludedPorts:
      title:
        en: excludedPorts
        zh-CN: 排除端口，默认为空
      type: "[]object"
      required: true
      default: 
    method:
      title:
        en: Method
        zh-CN: 扫描方式，默认SYN
      type: string
      required: true
      default: SYN
      enum:
      - SYN
      - SYN+FIN
      - SYN+ECE
      - Full
    ports:
      title:
        en: Ports
        zh-CN: tp扫描的端口，默认well-known.
      type: string
      required: true
      default: WELL-KNOWN
      enum:
      - ALL
      - WELL-KNOWN
      - CUSTOM
      - NONE
  udp_type:
    additionalPorts:
      title:
        en: additionalPorts
        zh-CN: 额外端口，默认为空
      type: "[]object"
      required: true
      default: 
    excludedPorts:
      title:
        en: excludedPorts
        zh-CN: 排除端口，默认为空
      type: "[]object"
      required: true
      default: 
    ports:
      title:
        en: Ports
        zh-CN: tp扫描的端口，默认well-known.
      type: string
      required: true
      default: WELL-KNOWN
      enum:
      - ALL
      - WELL-KNOWN
      - CUSTOM
      - NONE
  asset_type:
    collectWhoisInformation:
      title:
        en: collectWhoisInformation
        zh-CN: 收集whois信息,默认false
      type: boolean
      required: true
      default: false
    fingerprintMinimumCertainty:
      title:
        en: fingerprintMinimumCertainty
        zh-CN: 最小指纹确定值，默认0.16
      type: float
      required: true
      default: 0.16
    fingerprintRetries:
      title:
        en: fingerprintRetries
        zh-CN: 指纹重试次数，默认4
      type: integer
      required: true
      default: 4
    ipFingerprintingEnabled:
      title:
        en: ipFingerprintingEnabled
        zh-CN: 是否启用指纹识别
      type: boolean
      required: true
    sendArpPings:
      title:
        en: sendArpPings
        zh-CN: 是否发送ARP Ping，默认true
      type: boolean
      required: true
      default: true
    sendIcmpPings:
      title:
        en: sendIcmpPings
        zh-CN: 是否发送CMP Ping，默认false
      type: boolean
      required: true
      default: false
    tcpPorts:
      title:
        en: tcpPorts
        zh-CN: TCP端口，默认为空
      type: "[]integer"
      required: false
      default: 
    treatTcpResetAsAsset:
      title:
        en: treatTcpResetAsAsset
        zh-CN: 不将TCP重置响应视为资产存活的依据。默认为true
      type: boolean
      required: true
      default: true
    udpPorts:
      title:
        en: udpPorts
        zh-CN: UDP端口，默认为空
      type: "[]integer"
      required: false
      default: 
  performance_type:
    packetRate:
      title:
        en: packetRate
        zh-CN: 发包速率限制
      type: packetrate_type
    parallelism:
      title:
        en: Parallelism
        zh-CN: 并发限制
      type: parallelism_type
    retryLimit:
      title:
        en: retryLimit
        zh-CN: 重试限制，默认为3
      type: integer
      required: true
      default: 3
    scanDelay:
      title:
        en: scanDelay
        zh-CN: 延迟限制
      type: scandelay_type
    timeout:
      title:
        en: Timeout
        zh-CN: 超时限制
      type: timeout_type
  server_type:
    servicenamefile:
      title:
        en: serviceNameFile
        zh-CN: 服务名称文件，默认为空
      type: string
      required: true
      default: 
    tcp:
      title:
        en: Tcp
        zh-CN: TCP扫描
      type: tcp_type
    udp:
      title:
        en: Udp
        zh-CN: UDP扫描
      type: udp_type
  paths_type:
    boostrap:
      title:
        en: Boostrap
        zh-CN: 引导路径
      type: string
      required: true
    excluded:
      title:
        en: Excluded
        zh-CN: 排除路径
      type: string
      required: true
    honorRobotDirectives:
      title:
        en: honorRobotDirectives
        zh-CN: Honor机器指令
      type: boolean
      required: true
  patterns_type:
    sensitiveContent:
      title:
        en: sensitiveContent
        zh-CN: 敏感内容正则表达式
      type: string
      required: true
    sensitiveField:
      title:
        en: sensitiveField
        zh-CN: 敏感字段名正则表达式，默认 (p|pass)(word|phrase|wd|code).
      type: string
      required: true
      default: "(p|pass)(word|phrase|wd|code)"
  performanc_type:
    httpDaemonsToSkip:
      title:
        en: httpDaemonsToSkip
        zh-CN: 要跳过的HTTP后台程序
      type: "[]string"
    maximumDirectoryLevels:
      title:
        en: maximumDirectoryLevels
        zh-CN: 爬虫的最高目录级别，默认6
      type: integer
      required: true
      default: 6
    maximumForeignHosts:
      title:
        en: maximumForeignHosts
        zh-CN: 要解析的最大外部主机数量，默认100
      type: integer
      required: true
      default: 100
    maximumLinkDepth:
      title:
        en: maximumLinkDepth
        zh-CN: 爬虫的最大链接深度，默认6
      type: integer
      required: true
      default: 6
    maximumPages:
      title:
        en: maximumPages
        zh-CN: 爬取的最多页面，默认3000
      type: integer
      required: true
      default: 3000
    maximumRetries:
      title:
        en: maximumRetries
        zh-CN: 爬虫请求的最大重试值，默认2
      type: integer
      required: true
      default: 2
    maximumTime:
      title:
        en: maximumTime
        zh-CN: 最多爬取时间（分钟）,'PT0S'表示无限制,取值范围 'PT1M'-'PT16666.6667H'.
      type: string
      required: true
    responseTimeout:
      title:
        en: responseTimeout
        zh-CN: 爬虫响应超时（毫秒）,取值范围 'PT0S'-'PT1H'.默认'PT2M'
      type: string
      required: true
      default: PT2M
    threadsPerServer:
      title:
        en: threadsPerServer
        zh-CN: 每个Web服务器的爬虫线程，默认3
      type: integer
      required: true
      default: 3
  checks_type:
    categories:
      title:
        en: Categories
        zh-CN: 漏洞种类
      type: categories_type
    correlate:
      title:
        en: Correlate
        zh-CN: 扫描期间是否启用关联可靠与定期检查
      type: boolean
      required: true
    individual:
      title:
        en: Individual
        zh-CN: 单个检查项
      type: individual_type
    potential:
      title:
        en: Potential
        zh-CN: 扫描期间是否启用潜在漏洞的检查。
      type: boolean
      required: true
    types:
      title:
        en: Types
        zh-CN: 检查类型
      type: types_type
    unsafe:
      title:
        en: Unsafe
        zh-CN: 扫描期间是否启用不安全检查。
      type: boolean
      required: true
  database_type:
    db2:
      title:
        en: Db2
        zh-CN: DB2数据库
      type: string
      required: true
    oracle:
      title:
        en: Oracle
        zh-CN: Oracle数据库
      type: "[]string"
      required: true
    postgres:
      title:
        en: Postgres
        zh-CN: Postgres数据库
      type: string
      required: true
  discovery_type:
    asset:
      title:
        en: Asset
        zh-CN: 资产发现
      type: asset_type
    performance:
      title:
        en: Performance
        zh-CN: 性能配置
      type: performance_type
    server:
      title:
        en: Server
        zh-CN: 服务发现
      type: server_type
  web_type:
    dontScanMultiUseDevices:
      title:
        en: dontScanMultiUseDevices
        zh-CN: 是否避免扫描多用途设备
      type: boolean
      required: true
    includeQueryStrings:
      title:
        en: includeQueryStrings
        zh-CN: 在爬取时加入查询字符串
      type: boolean
    paths:
      title:
        en: Paths
        zh-CN: 路径
      type: paths_type
    patterns:
      title:
        en: Patterns
        zh-CN: 表达式
      type: patterns_type
    performance:
      title:
        en: Performance
        zh-CN: 性能
      type: performanc_type
    testCommonUsernamesAndPasswords:
      title:
        en: testCommonUsernamesAndPasswords
        zh-CN: 检查常见用户名和密码的使用情况
      type: boolean
      required: true
    testXssInSingleScan:
      title:
        en: testXssInSingleScan
        zh-CN: 单次扫描中测试跨站脚本
      type: boolean
      required: true
    userAgent:
      title:
        en: userAgent
        zh-CN: 用户代理，默认 Mozilla/5.0 (compatible; MSIE 7.0; Windows NT 6.0; .NET CLR 1.1.4322; .NET CLR 2.0.50727)
      type: string
      required: true
      default: Mozilla/5.0 (compatible; MSIE 7.0; Windows NT 6.0; .NET CLR 1.1.4322; .NET CLR 2.0.50727)
connection:
  server:
    title:
      en: Server
      zh-CN: 服务 url
    type: string
    description:
      en: 'Service url, e.g: https://location:port'
      zh-CN: 服务url，例如：https://location:port
    required: true
  username:
    title:
      en: Username
      zh-CN: 用户名
    type: string
    required: true
  pwd:
    title:
      en: Password
      zh-CN: 密码
    type: password
    required: true
actions:
  scanassetsed:
    title: 扫描资产
    description: 返回所有已经完成扫描的资产
    input:
      id:
        title:
          en: Id
          zh-CN: 扫描ID
        type: integer
        required: true
    output:
      data:
        title:
          en: Data
          zh-CN: 返回数据
        type: "[]object"
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scanassetsserver:
    title: 资产服务
    description: 资产服务
    input:
      id:
        title:
          en: Id
          zh-CN: 扫描ID
        type: integer
        required: true
      nodeid:
        title:
          en: nodeId
          zh-CN: 资产ID
        type: integer
        required: true
    output:
      data:
        title:
          en: Data
          zh-CN: 返回数据
        type: "[]object"
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scanassetsvulnerabilities:
    title: 资产漏洞
    description: 资产漏洞
    input:
      id:
        title:
          en: Id
          zh-CN: 扫描ID
        type: integer
        required: true
      nodeid:
        title:
          en: nodeId
          zh-CN: 资产ID
        type: integer
        required: true
    output:
      data:
        title:
          en: Data
          zh-CN: 返回数据
        type: "[]object"
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scanassetsing:
    title: 扫描资产
    description: 返回正在扫描中的资产
    input:
      id:
        title:
          en: Id
          zh-CN: 扫描ID
        type: integer
        required: true
      status:
        title:
          en: Status
          zh-CN: 资产扫描状态
        type: boolean
        required: true
      page:
        title:
          en: Page
          zh-CN: 当前页数,第一页从0开始
        type: integer
        required: true
        default: 0
      size:
        title:
          en: Size
          zh-CN: 每页记录条数，最大值500
        type: integer
        required: true
        default: 10
      sort:
        title:
          en: Sort
          zh-CN: 排序字段
        type: "[]string"
        description:
          en: 'The format is as follows: assets? Sort = address, ASC, which will be sorted in ascending order. When multi field sorting is needed, refer to the following formats: assets? Sort = address, ASC & sort = riskscore, DESC, which will be sorted in ascending order of address and descending in risk score'
          zh-CN: 格式如：assets?sort=address,ASC,将按照地址升序排列。当需要多字段排序时，参考如下格式：assets?sort=address,ASC&sort=riskScore,DESC，将会按照地址升序排列，风险评分降序排列.
        required: true
    output:
      page:
        title:
          en: Page
          zh-CN: 分页情况
        type: object
        required: false
      resources:
        title:
          en: Resources
          zh-CN: 资源集合
        type: "[]object"
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scancondition:
    title: 扫描列表
    description: 根据分页条件返回扫描列表
    input:
      active:
        title:
          en: Action,
          zh-CN: 是否正在扫描
        type: string
        required: true
        enum:
        - 'true'
        - 'false'
      page:
        title:
          en: Page
          zh-CN: 当前页数,第一页从0开始
        type: integer
        required: true
        default: 0
      size:
        title:
          en: Size
          zh-CN: 每页记录条数，最大值500
        type: integer
        required: true
        default: 10
      sort:
        title:
          en: Sort
          zh-CN: 排序字段
        type: "[]string"
        description:
          en: 'The format is as follows: assets? Sort = address, ASC, which will be sorted in ascending order. When multi field sorting is needed, refer to the following formats: assets? Sort = address, ASC & sort = riskscore, DESC, which will be sorted in ascending order of address and descending in risk score'
          zh-CN: 格式如：assets?sort=address,ASC,将按照地址升序排列。当需要多字段排序时，参考如下格式：assets?sort=address,ASC&sort=riskScore,DESC，将会按照地址升序排列，风险评分降序排列.
        required: true
    output:
      page:
        title:
          en: Page
          zh-CN: 分页情况
        type: object
        required: false
      resources:
        title:
          en: Resources
          zh-CN: 资源集合
        type: "[]object"
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scanid:
    title: 扫描 ID
    description: 根据ID返回扫描信息
    input:
      id:
        title:
          en: Id
          zh-CN: 扫描id
        type: integer
        required: true
    output:
      data:
        title:
          en: Data
          zh-CN: 返回数据
        type: object
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scanstatusupdate:
    title: 扫描状态更新
    description: 根据ID更新扫描状态,执行暂停、停止、继续操作。只有运行状态的任务可以暂停(pause)，只有暂停状态的可以继续(resume)，运行和暂停状态的任务可以停止(stop).
    input:
      id:
        title:
          en: Id
          zh-CN: 扫描id
        type: integer
        required: true
      status:
        title:
          en: Status
          zh-CN: 扫描状态
        type: string
        required: true
        enum:
        - pause
        - stop
        - resume
    output:
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scantasksid:
    title: 任务扫描
    description: 根据任务ID返回符合参数状态的扫描记录
    input:
      id:
        title:
          en: Id
          zh-CN: 扫描id
        type: integer
        required: true
      active:
        title:
          en: Action,
          zh-CN: 是否正在扫描
        type: string
        required: true
        enum:
        - 'true'
        - 'false'
      page:
        title:
          en: Page
          zh-CN: 当前页数,第一页从0开始
        type: integer
        required: true
        default: 0
      size:
        title:
          en: Size
          zh-CN: 每页记录条数，最大值500
        type: integer
        required: true
        default: 10
      sort:
        title:
          en: Sort
          zh-CN: 排序字段
        type: "[]string"
        description:
          en: 'The format is as follows: assets? Sort = address, ASC, which will be sorted in ascending order. When multi field sorting is needed, refer to the following formats: assets? Sort = address, ASC & sort = riskscore, DESC, which will be sorted in ascending order of address and descending in risk score'
          zh-CN: 格式如：assets?sort=address,ASC,将按照地址升序排列。当需要多字段排序时，参考如下格式：assets?sort=address,ASC&sort=riskScore,DESC，将会按照地址升序排列，风险评分降序排列.
        required: true
    output:
      page:
        title:
          en: Page
          zh-CN: 分页情况
        type: object
        required: false
      resources:
        title:
          en: Resources
          zh-CN: 资源集合
        type: "[]object"
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scantasksstart:
    title: 开始扫描任务
    description: 开始扫描任务
    input:
      id:
        title:
          en: Id
          zh-CN: 扫描ID
        type: integer
        required: true
      engineid:
        title:
          en: engineId
          zh-CN: 引擎ID
        type: integer
        required: true
      hosts:
        title:
          en: Hosts
          zh-CN: 目标主机
        type: "[]string"
        required: true
      templateid:
        title:
          en: templateId
          zh-CN: 模板ID
        type: string
        required: true
    output:
      data:
        title:
          en: Data
          zh-CN: 返回数据
        type: object
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scantemplates:
    title: 扫描模板列表
    description: 返回所有扫描模板
    output:
      resources:
        title:
          en: Resources
          zh-CN: 资源集合
        type: "[]object"
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scantemplatescreate:
    title: 创建扫描模板
    description: 创建扫描模板
    input:
      checks:
        title:
          en: Checks
          zh-CN: 漏洞检测配置
        type: checks_type
        required: true
      database:
        title:
          en: Database
          zh-CN: 数据库配置
        type: database_type
        required: true
      desc:
        title:
          en: Desc
          zh-CN: 扫描模板描述。
        type: object
        required: true
      discovery:
        title:
          en: Discovery
          zh-CN: 扫描发现配置
        type: discovery_type
        required: true
      discoveryOnly:
        title:
          en: discoveryOnly
          zh-CN: 是否只进行发现扫描
        type: boolean
        required: true
      maxParallelAssets:
        title:
          en: maxParallelAssets
          zh-CN: 最大并发扫描主机数。
        type: integer
        required: true
      maxScanProcesses:
        title:
          en: maxScanProcesses
          zh-CN: 每个资产分配的最大扫描进程数量
        type: integer
        required: true
      name:
        title:
          en: Name
          zh-CN: 模板名称
        type: string
        required: true
      vulnerabilityEnabled:
        title:
          en: vulnerabilityEnabled
          zh-CN: 是否进行漏洞扫描
        type: boolean
        required: true
      web:
        title:
          en: Web
          zh-CN: web扫描配置
        type: web_type
        required: true
      webEnabled:
        title:
          en: webEnabled
          zh-CN: 是否开启web扫描
        type: boolean
        required: true
    output:
      id:
        title:
          en: Id
          zh-CN: 扫描ID
        type: string
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scantemplatesupdate:
    title: 更新扫描模板
    description: 更新扫描模板
    input:
      id:
        title:
          en: Id
          zh-CN: 扫描ID
        type: string
        required: true
      checks:
        title:
          en: Checks
          zh-CN: 漏洞检测配置
        type: checks_type
        required: true
      database:
        title:
          en: Database
          zh-CN: 数据库配置
        type: database_type
        required: true
      desc:
        title:
          en: Desc
          zh-CN: 扫描模板描述。
        type: object
        required: true
      discovery:
        title:
          en: Discovery
          zh-CN: 扫描发现配置
        type: discovery_type
        required: true
      discoveryOnly:
        title:
          en: discoveryOnly
          zh-CN: 是否只进行发现扫描
        type: boolean
        required: true
      maxParallelAssets:
        title:
          en: maxParallelAssets
          zh-CN: 最大并发扫描主机数。
        type: integer
        required: true
      maxScanProcesses:
        title:
          en: maxScanProcesses
          zh-CN: 每个资产分配的最大扫描进程数量
        type: integer
        required: true
      name:
        title:
          en: Name
          zh-CN: 模板名称
        type: string
        required: true
      vulnerabilityEnabled:
        title:
          en: vulnerabilityEnabled
          zh-CN: 是否进行漏洞扫描
        type: boolean
        required: true
      web:
        title:
          en: Web
          zh-CN: web扫描配置
        type: web_type
        required: true
      webEnabled:
        title:
          en: webEnabled
          zh-CN: 是否开启web扫描
        type: boolean
        required: true
    output:
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scantemplatesid:
    title: 扫描模板
    description: 根据ID返回扫描模板的配置
    input:
      id:
        title:
          en: Id
          zh-CN: 扫描ID
        type: string
        required: true
    output:
      data:
        title:
          en: Data
          zh-CN: 返回数据
        type: object
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scantemplatesdelete:
    title: 删除扫描模板
    description: 根据ID删除扫描模板
    input:
      id:
        title:
          en: Id
          zh-CN: 扫描ID
        type: string
        required: true
    output:
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scanengines:
    title: 扫描引擎列表
    description: 根据分页条件返回扫描引擎。
    output:
      resources:
        title:
          en: Resources
          zh-CN: 资源集合
        type: "[]object"
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scanenginescreate:
    title: 创建扫描引擎
    description: 扫描引擎创建。
    input:
      address:
        title:
          en: Address
          zh-CN: 扫描引擎地址
        type: string
        required: true
      id:
        title:
          en: Id
          zh-CN: 扫描引擎ID,0表示新建
        type: integer
        required: true
      name:
        title:
          en: Name
          zh-CN: 扫描引擎名称
        type: string
        required: true
      port:
        title:
          en: Port
          zh-CN: 扫描引擎端口
        type: integer
        required: true
      tasks:
        title:
          en: Tasks
          zh-CN: 使用该扫描引擎的任务ID集合
        type: "[]integer"
        required: true
    output:
      id:
        title:
          en: Id
          zh-CN: 扫描ID
        type: integer
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scanenginesupdate:
    title: 更新扫描引擎
    description: 更新扫描引擎。
    input:
      address:
        title:
          en: Address
          zh-CN: 扫描引擎地址
        type: string
        required: true
      id:
        title:
          en: Id
          zh-CN: 扫描引擎ID,0表示新建
        type: integer
        required: true
      name:
        title:
          en: Name
          zh-CN: 扫描引擎名称
        type: string
        required: true
      port:
        title:
          en: Port
          zh-CN: 扫描引擎端口
        type: integer
        required: true
      tasks:
        title:
          en: Tasks
          zh-CN: 使用该扫描引擎的任务ID集合
        type: "[]integer"
        required: true
    output:
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scanenginesid:
    title: 扫描引擎
    description: 根据ID返回扫描引擎详细配置。
    input:
      id:
        title:
          en: Id
          zh-CN: 扫描引擎ID
        type: integer
        required: true
    output:
      data:
        title:
          en: Data
          zh-CN: 返回数据
        type: object
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scanenginesdelete:
    title: 删除扫描引擎
    description: 根据ID删除扫描引擎。
    input:
      id:
        title:
          en: Id
          zh-CN: 扫描引擎ID
        type: integer
        required: true
    output:
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scanenginesrecord:
    title: 扫描引擎记录
    description: 根据ID返回扫描引擎记录。
    input:
      id:
        title:
          en: Id
          zh-CN: 扫描引擎ID
        type: integer
        required: true
      page:
        title:
          en: Page
          zh-CN: 当前页数,第一页从0开始
        type: integer
        required: true
        default: 0
      size:
        title:
          en: Size
          zh-CN: 每页记录条数，最大值500
        type: integer
        required: true
        default: 10
      sort:
        title:
          en: Sort
          zh-CN: 排序字段
        type: "[]string"
        description:
          en: 'The format is as follows: assets? Sort = address, ASC, which will be sorted in ascending order. When multi field sorting is needed, refer to the following formats: assets? Sort = address, ASC & sort = riskscore, DESC, which will be sorted in ascending order of address and descending in risk score'
          zh-CN: 格式如：assets?sort=address,ASC,将按照地址升序排列。当需要多字段排序时，参考如下格式：assets?sort=address,ASC&sort=riskScore,DESC，将会按照地址升序排列，风险评分降序排列.
        required: true
    output:
      page:
        title:
          en: Page
          zh-CN: 分页情况
        type: object
        required: false
      resources:
        title:
          en: Resources
          zh-CN: 资源集合
        type: "[]object"
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  scanenginestasks:
    title: 扫描引擎任务
    description: 根据ID返回扫描引擎作用的任务。
    input:
      id:
        title:
          en: Id
          zh-CN: 扫描引擎ID
        type: integer
        required: true
      page:
        title:
          en: Page
          zh-CN: 当前页数,第一页从0开始
        type: integer
        required: true
        default: 0
      size:
        title:
          en: Size
          zh-CN: 每页记录条数，最大值500
        type: integer
        required: true
        default: 10
      sort:
        title:
          en: Sort
          zh-CN: 排序字段
        type: "[]string"
        description:
          en: 'The format is as follows: assets? Sort = address, ASC, which will be sorted in ascending order. When multi field sorting is needed, refer to the following formats: assets? Sort = address, ASC & sort = riskscore, DESC, which will be sorted in ascending order of address and descending in risk score'
          zh-CN: 格式如：assets?sort=address,ASC,将按照地址升序排列。当需要多字段排序时，参考如下格式：assets?sort=address,ASC&sort=riskScore,DESC，将会按照地址升序排列，风险评分降序排列.
        required: true
    output:
      page:
        title:
          en: Page
          zh-CN: 分页情况
        type: object
        required: false
      resources:
        title:
          en: Resources
          zh-CN: 资源集合
        type: "[]object"
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  iotprogress:
    title: IOT 扫描进度
    description: IOT 扫描进度
    input:
      id:
        title:
          en: Id
          zh-CN: 扫描ID
        type: integer
        required: true
    output:
      data:
        title:
          en: Data
          zh-CN: 返回数据
        type: object
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  iotresults:
    title: IOT 扫描结果
    description: 扫描结果
    input:
      id:
        title:
          en: Id
          zh-CN: 扫描ID
        type: integer
        required: true
      page:
        title:
          en: Page
          zh-CN: 当前页数,第一页从0开始
        type: integer
        required: true
        default: 0
      size:
        title:
          en: Size
          zh-CN: 每页记录条数，最大值500
        type: integer
        required: true
        default: 10
      sort:
        title:
          en: Sort
          zh-CN: 排序字段
        type: "[]string"
        description:
          en: 'The format is as follows: assets? Sort = address, ASC, which will be sorted in ascending order. When multi field sorting is needed, refer to the following formats: assets? Sort = address, ASC & sort = riskscore, DESC, which will be sorted in ascending order of address and descending in risk score'
          zh-CN: 格式如：assets?sort=address,ASC,将按照地址升序排列。当需要多字段排序时，参考如下格式：assets?sort=address,ASC&sort=riskScore,DESC，将会按照地址升序排列，风险评分降序排列.
        required: true
    output:
      page:
        title:
          en: Page
          zh-CN: 分页情况
        type: object
        required: false
      resources:
        title:
          en: Resources
          zh-CN: 资源集合
        type: "[]object"
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  iotscans:
    title: IOT 扫描列表
    description: IOT 扫描列表
    input:
      id:
        title:
          en: Id
          zh-CN: 任务ID
        type: integer
        required: true
      page:
        title:
          en: Page
          zh-CN: 当前页数,第一页从0开始
        type: integer
        required: true
        default: 0
      size:
        title:
          en: Size
          zh-CN: 每页记录条数，最大值500
        type: integer
        required: true
        default: 10
      sort:
        title:
          en: Sort
          zh-CN: 排序字段
        type: "[]string"
        description:
          en: 'The format is as follows: assets? Sort = address, ASC, which will be sorted in ascending order. When multi field sorting is needed, refer to the following formats: assets? Sort = address, ASC & sort = riskscore, DESC, which will be sorted in ascending order of address and descending in risk score'
          zh-CN: 格式如：assets?sort=address,ASC,将按照地址升序排列。当需要多字段排序时，参考如下格式：assets?sort=address,ASC&sort=riskScore,DESC，将会按照地址升序排列，风险评分降序排列.
        required: true
    output:
      page:
        title:
          en: Page
          zh-CN: 分页情况
        type: object
        required: false
      resources:
        title:
          en: Resources
          zh-CN: 资源集合
        type: "[]object"
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  iotscansstart:
    title: 启动 IOT 扫描
    description: 启动 IOT 扫描
    input:
      id:
        title:
          en: Id
          zh-CN: 任务ID
        type: integer
        required: true
    output:
      data:
        title:
          en: Data
          zh-CN: 返回数据
        type: object
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  iottasks:
    title: IOT 任务列表
    description: IOT 任务列表
    input:
      page:
        title:
          en: Page
          zh-CN: 当前页数,第一页从0开始
        type: integer
        required: true
        default: 0
      size:
        title:
          en: Size
          zh-CN: 每页记录条数，最大值500
        type: integer
        required: true
        default: 10
      sort:
        title:
          en: Sort
          zh-CN: 排序字段
        type: "[]string"
        description:
          en: 'The format is as follows: assets? Sort = address, ASC, which will be sorted in ascending order. When multi field sorting is needed, refer to the following formats: assets? Sort = address, ASC & sort = riskscore, DESC, which will be sorted in ascending order of address and descending in risk score'
          zh-CN: 格式如：assets?sort=address,ASC,将按照地址升序排列。当需要多字段排序时，参考如下格式：assets?sort=address,ASC&sort=riskScore,DESC，将会按照地址升序排列，风险评分降序排列.
        required: true
    output:
      page:
        title:
          en: Page
          zh-CN: 分页情况
        type: object
        required: false
      resources:
        title:
          en: Resources
          zh-CN: 资源集合
        type: "[]object"
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  iottaskscreate:
    title: 创建 IOT 任务
    description: 创建 IOT 任务
    input:
      name:
        title:
          en: Name
          zh-CN: 任务名称
        type: string
        required: true
      target:
        title:
          en: Target
          zh-CN: 任务ip
        type: string
        required: true
    output:
      data:
        title:
          en: Data
          zh-CN: 返回数据
        type: object
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  iottasksid:
    title: IOT 任务
    description: 根据任务ID查询任务
    input:
      id:
        title:
          en: Id
          zh-CN: 任务ID
        type: integer
        required: true
    output:
      data:
        title:
          en: Data
          zh-CN: 返回数据
        type: object
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  iottasksdelete:
    title: 删除 IOT 任务
    description: 删除 IOT 任务
    input:
      id:
        title:
          en: Id
          zh-CN: 任务 ID
        type: integer
        required: true
    output:
      data:
        title:
          en: Data
          zh-CN: 返回数据
        type: object
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  taskcreate:
    title: 创建任务
    description: 创建一个任务，只包含任务基本配置，其余配置需额外创建。创建成功后不会主动发起扫描。
    input:
      name:
        title:
          en: Name
          zh-CN: 任务名称
        type: string
        required: true
      scanTemplateId:
        title:
          en: Scan Template ID
          zh-CN: 扫描模板 ID
        type: string
        required: true
      importance:
        title:
          en: Importance
          zh-CN: 任务级别
        type: string
        required: true
        default: normal
        enum:
        - very_low
        - low
        - normal
        - high
        - very_high
      engineId:
        title:
          en: Engine ID
          zh-CN: 引擎 ID
        type: integer
        required: true
      description:
        title:
          en: Description
          zh-CN: 任务描述
        type: string
      scan:
        title:
          en: Scan Scope
          zh-CN: 扫描目标
        type: object
    output:
      id:
        title:
          en: Data
          zh-CN: 返回数据
        type: object
        required: false
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  taskupdate:
    title: 更新任务
    description: 更新指定ID的任务配置。
    input:
      id:
        title:
          en: Task ID
          zh-CN: 任务 ID
        type: integer
        required: true
      name:
        title:
          en: Name
          zh-CN: 任务名称
        type: string
        required: true
      scanTemplateId:
        title:
          en: Scan Template ID
          zh-CN: 扫描模板 ID
        type: string
        required: true
      importance:
        title:
          en: Importance
          zh-CN: 任务级别
        type: string
        required: true
        default: normal
        enum:
        - very_low
        - low
        - normal
        - high
        - very_high
      engineId:
        title:
          en: Engine ID
          zh-CN: 引擎 ID
        type: integer
        required: true
      description:
        title:
          en: Description
          zh-CN: 任务描述
        type: string
    output:
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
  taskdelete:
    title: 删除任务
    description: 删除指定ID的任务
    input:
      id:
        title:
          en: Task ID
          zh-CN: 任务 ID
        type: integer
        required: true
    output:
      code:
        title:
          en: Code
          zh-CN: 状态码
        type: integer
        required: true
type: 漏洞扫描