{
  "name": "cws",
  "display_name": "漏洞扫描服务",
  "description": "",
  "domain": "other",
  "api_version": "2018-03-12",
  "endpoint": "cws.tencentcloudapi.com",
  "actions": [
    {
      "name": "CreateMonitors",
      "description": "本接口（CreateMonitors）用于新增一个或多个站点的监测任务。",
      "parameters": [
        {
          "name": "Urls",
          "type": "array",
          "required": true,
          "description": "站点的url列表",
          "item_type": "string"
        },
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "任务名称"
        },
        {
          "name": "ScannerType",
          "type": "string",
          "required": true,
          "description": "扫描模式，normal-正常扫描；deep-深度扫描"
        },
        {
          "name": "Crontab",
          "type": "integer",
          "required": true,
          "description": "扫描周期，单位小时，每X小时执行一次"
        },
        {
          "name": "RateLimit",
          "type": "integer",
          "required": true,
          "description": "扫描速率限制，每秒发送X个HTTP请求"
        },
        {
          "name": "FirstScanStartTime",
          "type": "string",
          "required": true,
          "description": "首次扫描开始时间"
        }
      ],
      "required": [
        "Urls",
        "Name",
        "ScannerType",
        "Crontab",
        "RateLimit",
        "FirstScanStartTime"
      ]
    },
    {
      "name": "CreateSites",
      "description": "本接口（CreateSites）用于新增一个或多个站点。",
      "parameters": [
        {
          "name": "Urls",
          "type": "array",
          "required": true,
          "description": "站点的url列表",
          "item_type": "string"
        },
        {
          "name": "UserAgent",
          "type": "string",
          "required": false,
          "description": "访问网站的客户端标识"
        }
      ],
      "required": [
        "Urls"
      ]
    },
    {
      "name": "CreateSitesScans",
      "description": "本接口（CreateSitesScans）用于新增一个或多个站点的单次扫描任务。",
      "parameters": [
        {
          "name": "SiteIds",
          "type": "array",
          "required": true,
          "description": "站点的ID列表",
          "item_type": "integer"
        },
        {
          "name": "ScannerType",
          "type": "string",
          "required": true,
          "description": "扫描模式，normal-正常扫描；deep-深度扫描"
        },
        {
          "name": "RateLimit",
          "type": "integer",
          "required": true,
          "description": "扫描速率限制，每秒发送X个HTTP请求"
        }
      ],
      "required": [
        "SiteIds",
        "ScannerType",
        "RateLimit"
      ]
    },
    {
      "name": "CreateVulsMisinformation",
      "description": "本接口（CreateVulsMisinformation）可以用于新增一个或多个漏洞误报信息。",
      "parameters": [
        {
          "name": "VulIds",
          "type": "array",
          "required": true,
          "description": "漏洞ID列表",
          "item_type": "integer"
        }
      ],
      "required": [
        "VulIds"
      ]
    },
    {
      "name": "CreateVulsReport",
      "description": "本接口 (CreateVulsReport) 用于生成漏洞报告并返回下载链接。",
      "parameters": [
        {
          "name": "SiteId",
          "type": "integer",
          "required": false,
          "description": "站点ID"
        },
        {
          "name": "MonitorId",
          "type": "integer",
          "required": false,
          "description": "监控任务ID"
        }
      ],
      "required": []
    },
    {
      "name": "DeleteMonitors",
      "description": "本接口 (DeleteMonitors) 用于删除用户监控任务。",
      "parameters": [
        {
          "name": "MonitorIds",
          "type": "array",
          "required": true,
          "description": "监控任务ID列表",
          "item_type": "integer"
        }
      ],
      "required": [
        "MonitorIds"
      ]
    },
    {
      "name": "DeleteSites",
      "description": "本接口 (DeleteSites) 用于删除站点。",
      "parameters": [
        {
          "name": "SiteIds",
          "type": "array",
          "required": true,
          "description": "站点ID列表",
          "item_type": "integer"
        }
      ],
      "required": [
        "SiteIds"
      ]
    },
    {
      "name": "DescribeConfig",
      "description": "本接口 (DescribeConfig) 用于查询用户配置的详细信息。",
      "parameters": [],
      "required": []
    },
    {
      "name": "DescribeMonitors",
      "description": "本接口 (DescribeMonitors) 用于查询一个或多个监控任务的详细信息。",
      "parameters": [
        {
          "name": "MonitorIds",
          "type": "array",
          "required": false,
          "description": "监控任务ID列表",
          "item_type": "integer"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤条件",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "过滤键的名称。"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "一个或者多个过滤值。",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为10，最大值为100"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeSiteQuota",
      "description": "本接口 (DescribeSiteQuota) 用于查询用户购买的扫描次数总数和已使用数。",
      "parameters": [],
      "required": []
    },
    {
      "name": "DescribeSites",
      "description": "本接口 (DescribeSites) 用于查询一个或多个站点的详细信息。",
      "parameters": [
        {
          "name": "SiteIds",
          "type": "array",
          "required": false,
          "description": "站点ID列表",
          "item_type": "integer"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤条件",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "过滤键的名称。"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "一个或者多个过滤值。",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为10，最大值为100"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeSitesVerification",
      "description": "本接口 (DescribeSitesVerification) 用于查询一个或多个待验证站点的验证信息。",
      "parameters": [
        {
          "name": "Urls",
          "type": "array",
          "required": true,
          "description": "站点的url列表",
          "item_type": "string"
        }
      ],
      "required": [
        "Urls"
      ]
    },
    {
      "name": "DescribeVuls",
      "description": "本接口 (DescribeVuls) 用于查询一个或多个漏洞的详细信息。",
      "parameters": [
        {
          "name": "SiteId",
          "type": "integer",
          "required": false,
          "description": "站点ID"
        },
        {
          "name": "MonitorId",
          "type": "integer",
          "required": false,
          "description": "监控任务ID"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤条件",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "过滤键的名称。"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "一个或者多个过滤值。",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为10，最大值为100"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeVulsNumber",
      "description": "本接口 (DescribeVulsNumber) 用于查询用户网站的漏洞总计数量。",
      "parameters": [],
      "required": []
    },
    {
      "name": "DescribeVulsNumberTimeline",
      "description": "本接口 (DescribeVulsNumberTimeline) 用于查询漏洞数随时间变化统计信息。",
      "parameters": [],
      "required": []
    },
    {
      "name": "ModifyConfigAttribute",
      "description": "本接口 (ModifyConfigAttribute) 用于修改用户配置的属性。",
      "parameters": [
        {
          "name": "NoticeLevel",
          "type": "string",
          "required": false,
          "description": "漏洞告警通知等级，4位分别代表：高危、中危、低危、提示"
        }
      ],
      "required": []
    },
    {
      "name": "ModifyMonitorAttribute",
      "description": "本接口 (ModifyMonitorAttribute) 用于修改监测任务的属性。",
      "parameters": [
        {
          "name": "MonitorId",
          "type": "integer",
          "required": true,
          "description": "监测任务ID"
        },
        {
          "name": "Urls",
          "type": "array",
          "required": true,
          "description": "站点的url列表",
          "item_type": "string"
        },
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "任务名称"
        },
        {
          "name": "ScannerType",
          "type": "string",
          "required": true,
          "description": "扫描模式，normal-正常扫描；deep-深度扫描"
        },
        {
          "name": "Crontab",
          "type": "integer",
          "required": true,
          "description": "扫描周期，单位小时，每X小时执行一次"
        },
        {
          "name": "RateLimit",
          "type": "integer",
          "required": true,
          "description": "扫描速率限制，每秒发送X个HTTP请求"
        },
        {
          "name": "FirstScanStartTime",
          "type": "string",
          "required": true,
          "description": "首次扫描开始时间"
        },
        {
          "name": "MonitorStatus",
          "type": "integer",
          "required": true,
          "description": "监测状态：1-监测中；2-暂停监测"
        }
      ],
      "required": [
        "MonitorId",
        "Urls",
        "Name",
        "ScannerType",
        "Crontab",
        "RateLimit",
        "FirstScanStartTime",
        "MonitorStatus"
      ]
    },
    {
      "name": "ModifySiteAttribute",
      "description": "本接口 (ModifySiteAttribute) 用于修改站点的属性。",
      "parameters": [
        {
          "name": "SiteId",
          "type": "integer",
          "required": true,
          "description": "站点ID"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "站点名称"
        },
        {
          "name": "NeedLogin",
          "type": "integer",
          "required": false,
          "description": "网站是否需要登录扫描：0-未知；-1-不需要；1-需要"
        },
        {
          "name": "LoginCookie",
          "type": "string",
          "required": false,
          "description": "登录后的cookie"
        },
        {
          "name": "LoginCheckUrl",
          "type": "string",
          "required": false,
          "description": "用于测试cookie是否有效的URL"
        },
        {
          "name": "LoginCheckKw",
          "type": "string",
          "required": false,
          "description": "用于测试cookie是否有效的关键字"
        },
        {
          "name": "ScanDisallow",
          "type": "string",
          "required": false,
          "description": "禁止扫描器扫描的目录关键字"
        }
      ],
      "required": [
        "SiteId"
      ]
    },
    {
      "name": "VerifySites",
      "description": "本接口 (VerifySites) 用于验证一个或多个待验证站点。",
      "parameters": [
        {
          "name": "Urls",
          "type": "array",
          "required": true,
          "description": "站点的url列表",
          "item_type": "string"
        }
      ],
      "required": [
        "Urls"
      ]
    }
  ]
}