华为云用户手册

  • URI GET /v5/{project_id}/asset/midwares 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度:20 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 租户企业项目ID 最小长度:0 最大长度:64 file_name 否 String jar包名称 最小长度:0 最大长度:256 category 否 String 类别,包含如下: host : 主机 container : 容器 最小长度:0 最大长度:64 limit 否 Integer 默认10 最小值:10 最大值:200 缺省值:10 offset 否 Integer 默认是0 最小值:0 最大值:2000000 缺省值:0
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_num Integer Jar包统计信息总数 最小值:0 最大值:10000 data_list Array of JarPackageStatisticsResponseInfo objects Jar包统计信息列表 数组长度:0 - 300000 表5 JarPackageStatisticsResponseInfo 参数 参数类型 描述 file_name String Jar包名称 最小长度:0 最大长度:256 num Integer Jar包统计信息总数 最小值:0 最大值:300000
  • 请求示例 修改 漏洞扫描 策略,扫描周期为每天,扫描范围为指定主机,指定的主机id为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,策略状态为开启 PUT https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/vulnerability/scan-policy?enterprise_project_id=all_granted_eps { "scan_period" : "one_day", "scan_range_type" : "specific_host", "host_ids" : [ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ], "status" : "open" }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:1 最大长度:32768 表4 请求Body参数 参数 是否必选 参数类型 描述 scan_period 是 String 扫描周期 one_day : 每天 three_day : 每三天 one_week : 每周 最小长度:1 最大长度:32 scan_range_type 是 String 扫描主机的范围,包含如下: -all_host : 扫描全部主机 -specific_host : 扫描指定主机 最小长度:0 最大长度:32 host_ids 否 Array of strings 主机ID列表;当scan_range_type的值为specific_host时必填 最小长度:1 最大长度:128 数组长度:0 - 20000 scan_vul_types 否 Array of strings 扫描的漏洞类型列表 最小长度:0 最大长度:32 数组长度:0 - 2147483647 status 是 String 扫描策略状态,包含如下: -open : 开启 -close : 关闭 最小长度:0 最大长度:32
  • URI PUT /v5/{project_id}/vulnerability/scan-policy 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 最小长度:1 最大长度:256 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业租户ID,注:修改漏洞扫描策略将影响租户账号下所有主机的漏洞扫描行为,因此开通了多企业项目的用户,该参数须填写“all_granted_eps”才能执行漏洞策略修改。 缺省值:0 最小长度:0 最大长度:256
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_num Long 总数 最小值:0 最大值:2147483647 data_list Array of VulScanTaskInfo objects 漏洞扫描任务列表 数组长度:0 - 2147483647 表5 VulScanTaskInfo 参数 参数类型 描述 id String 任务ID 最小长度:1 最大长度:256 scan_type String 扫描任务的类型,包含如下: -manual : 手动扫描任务 -schedule : 定时扫描任务 最小长度:0 最大长度:128 start_time Long 扫描任务开始的时间 最小值:0 最大值:2147483647 end_time Long 扫描任务结束的时间 最小值:0 最大值:2147483647 scan_vul_types Array of strings 该任务扫描的漏洞类型列表 最小长度:1 最大长度:32 数组长度:1 - 2147483647 status String 扫描任务的执行状态,包含如下: -running : 扫描中 -finished : 扫描完成 最小长度:1 最大长度:32 scanning_host_num Integer 该任务处于扫描中状态的主机数量 最小值:0 最大值:2147483647 success_host_num Integer 该任务已扫描成功的主机数量 最小值:0 最大值:2147483647 failed_host_num Integer 该任务已扫描失败的主机数量 最小值:0 最大值:2147483647
  • 请求示例 查询任务类型为手动扫描,task_id为195db604-2008-4e8b-a49e-389ab0175beb漏洞扫描任务信息,默认查询第一页10条 GET https://{endpoint}/v5/{project_id}/vulnerability/scan-tasks?offset=0&limit=10&enterprise_project_id=XXX { "scan_type" : "manual", "task_id" : "195db604-2008-4e8b-a49e-389ab0175beb" }
  • 响应示例 状态码: 200 漏洞扫描任务列表 { "total_num" : 10, "data_list" : [ { "id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx", "scan_type" : "manual", "start_time" : 1679042408195, "end_time" : 1679042408295, "scan_vul_types" : [ "linux_vul" ], "status" : "running", "scanning_host_num" : 1, "success_host_num" : 1, "failed_host_num" : 1 } ] }
  • URI GET /v5/{project_id}/vulnerability/scan-tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 最小长度:1 最大长度:256 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 租户企业项目ID,查询所有企业项目时填写:all_granted_eps 缺省值:0 最小长度:0 最大长度:256 limit 否 Integer 每页显示个数 最小值:0 最大值:200 缺省值:10 offset 否 Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 最小值:0 最大值:2000000 缺省值:0 scan_type 否 String 扫描任务的类型,包含如下: -manual : 手动扫描任务 -schedule : 定时扫描任务 最小长度:0 最大长度:32 task_id 否 String 扫描任务ID 最小长度:0 最大长度:32 min_start_time 否 Long 扫描任务开始时间的最小值 最小值:0 最大值:9999999999999 max_start_time 否 Long 扫描任务开始时间的最大值 最小值:0 最大值:9999999999999
  • URI GET /v5/{project_id}/image/baseline/risk-configs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 最小长度:1 最大长度:256 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 租户企业项目ID,查询所有企业项目时填写:all_granted_eps 缺省值:0 最小长度:1 最大长度:256 image_type 是 String 镜像类型,包含如下: private_image : 私有镜像仓库 shared_image : 共享镜像仓库 local_image : 本地镜像 instance_image : 企业镜像 最小长度:1 最大长度:32 offset 否 Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 最小值:0 最大值:2000000 缺省值:0 limit 否 Integer 每页显示个数 最小值:10 最大值:200 缺省值:10 namespace 否 String 组织名称 最小长度:0 最大长度:64 image_name 否 String 镜像名称 最小长度:0 最大长度:128 image_version 否 String 镜像版本名称 最小长度:0 最大长度:64 check_name 否 String 基线名称 最小长度:0 最大长度:256 severity 否 String 风险等级,包含如下: Security : 安全 Low : 低危 Medium : 中危 High : 高危 最小长度:0 最大长度:32 standard 否 String 标准类型,包含如下: cn_standard : 等保合规标准 hw_standard : 华为标准 qt_standard : 青腾标准 最小长度:0 最大长度:256 instance_id 否 String 企业仓库实例ID,swr共享版无需使用该参数 最小长度:0 最大长度:128
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_num Integer 总数 最小值:0 最大值:2147483647 data_list Array of ImageRiskConfigsInfoResponseInfo objects 配置检测列表 数组长度:0 - 2147483647 表5 ImageRiskConfigsInfoResponseInfo 参数 参数类型 描述 severity String 风险等级,包含如下: Security : 安全 Low : 低危 Medium : 中危 High : 高危 最小长度:1 最大长度:32 check_name String 基线名称 最小长度:0 最大长度:256 check_type String 基线类型 最小长度:0 最大长度:256 standard String 标准类型,包含如下: cn_standard : 等保合规标准 hw_standard : 华为标准 qt_standard : 青腾标准 最小长度:1 最大长度:16 check_rule_num Integer 检查项数量 最小值:0 最大值:2097152 failed_rule_num Integer 风险项数量 最小值:0 最大值:2097152 check_type_desc String 基线描述信息 最小长度:0 最大长度:65534
  • 请求示例 查询私有镜像中命名空间为scc_hss_container,镜像名称为euleros,镜像版本为2.2的镜像安全配置检测结果列表。 GET https://{endpoint}/v5/{project_id}/image/baseline/risk-configs?offset=0&limit=200&image_type=private_image&namespace=scc_hss_container&image_name=euleros/test&image_version=2.2.6&enterprise_project_id=all_granted_eps
  • 响应示例 状态码: 200 镜像配置检测结果列表 { "total_num" : 1, "data_list" : [ { "check_name" : "CentOS 7", "check_rule_num" : 3, "check_type" : 3, "check_type_desc" : "本规范着重于从XXX", "failed_rule_num" : 0, "severity" : "Low", "standard" : "cn_standard" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_num Integer 总数 event_type_list Array of integers 支持筛选的事件类型 最小值:0 最大值:2147483647 数组长度:0 - 30000 data_list Array of AlarmWhiteListResponseInfo objects 告警白名单详情 数组长度:0 - 100 表5 AlarmWhiteListResponseInfo 参数 参数类型 描述 enterprise_project_name String 企业项目名称 hash String SHA256 description String 描述信息 event_type Integer 事件类型,包含如下: 1001 : 通用恶意软件 1002 : 病毒 1003 : 蠕虫 1004 : 木马 1005 : 僵尸网络 1006 : 后门 1010 : Rootkit 1011 : 勒索软件 1012 :黑客工具 1015 : Webshell 1016 : 挖矿 1017 : 反弹Shell 2001 : 一般漏洞利用 2012 : 远程代码执行 2047 : Redis漏洞利用 2048 : Hadoop漏洞利用 2049 : MySQL漏洞利用 3002 : 文件提权 3003 : 进程提权 3004 : 关键文件变更 3005 : 文件/目录变更 3007 : 进程异常行为 3015 : 高危命令执行 3018 : 异常Shell 3027 : Crontab可疑任务 3029 :系统安全防护被禁用 3030 :备份删除 3031 :异常注册表操作 3036 : 容器镜像阻断 4002 : 暴力破解 4004 : 异常登录 4006 : 非法系统账号 4014 : 用户账号添加 4020 : 用户密码窃取 6002 : 端口扫描 6003 : 主机扫描 13001 : Kubernetes事件删除 13002 : Pod异常行为 13003 : 枚举用户信息 13004 : 绑定集群用户角色 white_field String 加白字段,包含如下: "file/process hash" # 进程/文件hash "file_path" # 文件路径 "process_path" # 进程路径 "login_ip" # 登录ip "reg_key" #注册表key "process_cmdline" # 进程命令行 "username" # 用户名 最小长度:1 最大长度:20 field_value String 加白字段值 最小长度:1 最大长度:128 judge_type String 通配符,包含如下: "equal" # 相等 "contain" # 包含 最小长度:1 最大长度:10 update_time Integer 更新时间,毫秒
  • 响应示例 状态码: 200 告警白名单列表 { "data_list" : [ { "enterprise_project_name" : "所有项目", "event_type" : 1001, "hash" : "9ab079e5398cba3a368ccffbd478f54c5ec3edadf6284ec049a73c36419f1178", "description" : "/opt/cloud/3rdComponent/install/jre-8u201/bin/java", "update_time" : 1665715677307, "white_field" : "process/file hash", "judge_type" : "contain", "field_value" : "abcd12345612311112212323" } ], "event_type_list" : [ 1001 ], "total_num" : 1 }
  • URI GET /v5/{project_id}/event/white-list/alarm 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 最小长度:20 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 租户企业项目ID,查询所有企业项目时填写:all_granted_eps 最小长度:0 最大长度:64 hash 否 String SHA256 最小长度:64 最大长度:64 event_type 否 Integer 事件类型,包含如下: 1001 : 通用恶意软件 1002 : 病毒 1003 : 蠕虫 1004 : 木马 1005 : 僵尸网络 1006 : 后门 1010 : Rootkit 1011 : 勒索软件 1012 :黑客工具 1015 : Webshell 1016 : 挖矿 1017 : 反弹Shell 2001 : 一般漏洞利用 2012 : 远程代码执行 2047 : Redis漏洞利用 2048 : Hadoop漏洞利用 2049 : MySQL漏洞利用 3002 : 文件提权 3003 : 进程提权 3004 : 关键文件变更 3005 : 文件/目录变更 3007 : 进程异常行为 3015 : 高危命令执行 3018 : 异常Shell 3027 : Crontab可疑任务 3029 :系统安全防护被禁用 3030 :备份删除 3031 :异常注册表操作 3036 : 容器镜像阻断 4002 : 暴力破解 4004 : 异常登录 4006 : 非法系统账号 4014 : 用户账号添加 4020 : 用户密码窃取 6002 : 端口扫描 6003 : 主机扫描 13001 : Kubernetes事件删除 13002 : Pod异常行为 13003 : 枚举用户信息 13004 : 绑定集群用户角色 最小值:1000 最大值:30000 offset 否 Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 最小值:0 最大值:2000000 缺省值:0 limit 否 Integer 每页显示个数 最小值:10 最大值:1000 缺省值:10
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_num Integer 总数 data_list Array of BlockedIpResponseInfo objects 已拦截IP详情 数组长度:0 - 100 表5 BlockedIpResponseInfo 参数 参数类型 描述 host_id String 服务器ID host_name String 服务器名称 src_ip String 攻击源IP login_type String 登录类型,包含如下: "mysql" # mysql服务 "rdp" # rdp服务服务 "ssh" # ssh服务 "vsftp" # vsftp服务 intercept_num Integer 拦截次数 最小值:0 最大值:2147483647 intercept_status String 拦截状态,包含如下: "intercepted" # 已拦截 "canceled" # 已解除拦截 "cancelling" # 待解除拦截 block_time Long 开始拦截时间,毫秒 最小值:0 最大值:9223372036854775807 latest_time Long 最近拦截时间,毫秒 最小值:0 最大值:9223372036854775807
  • 响应示例 状态码: 200 已拦截IP列表 { "data_list" : [ { "block_time" : 1698715135407, "host_id" : "1c62fe52-0c84-4ee4-8dba-d892c5ad0ab0", "host_name" : "dfx-a00607964-0011", "intercept_num" : 230, "intercept_status" : "canceled", "latest_time" : 1698715296786, "login_type" : "ssh", "src_ip" : "100.85.239.180" } ], "total_num" : 1 }
  • URI GET /v5/{project_id}/event/blocked-ip 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 最小长度:20 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 租户企业项目ID,查询所有企业项目时填写:all_granted_eps 最小长度:0 最大长度:64 last_days 否 Integer 查询时间范围天数,与自定义查询时间begin_time,end_time互斥 最小值:1 最大值:30 host_name 否 String 服务器名称 最小长度:1 最大长度:64 src_ip 否 String 攻击源IP intercept_status 否 String 拦截状态,包含如下: intercepted : 已拦截 canceled : 已解除拦截 cancelling : 待解除拦截 最小长度:0 最大长度:32 offset 否 Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 最小值:0 最大值:2000000 缺省值:0 limit 否 Integer 每页显示个数 最小值:10 最大值:1000 缺省值:10
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_num Integer 进程统计信息总数, 最小值:0 最大值:10000 data_list Array of AppStatisticResponseInfo objects 进程统计信息列表 数组长度:0 - 10000 表5 AppStatisticResponseInfo 参数 参数类型 描述 app_name String 软件名称 最小长度:1 最大长度:128 num Integer 进程数量 最小值:0 最大值:100000
  • URI GET /v5/{project_id}/asset/app/statistics 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度:1 最大长度:256 表2 Query参数 参数 是否必选 参数类型 描述 app_name 否 String 软件名称 最小长度:1 最大长度:256 enterprise_project_id 否 String 企业项目 最小长度:1 最大长度:256 limit 否 Integer 默认10 最小值:10 最大值:100 缺省值:10 offset 否 Integer 偏移量,为页数*每页显示条数 最小值:0 最大值:10000 缺省值:0 category 否 String 类别,默认为host,包含如下: host:主机 container:容器 最小长度:0 最大长度:64
  • 响应示例 状态码: 200 漏洞列表 { "total_num" : 1, "data_list" : [ { "description" : "It was discovered that FreeType did not correctly handle certain malformed font files. If a user were tricked into using a specially crafted font file, a remote attacker could cause FreeType to crash, or possibly execute arbitrary code.", "host_id_list" : [ "caa958ad-a481-4d46-b51e-6861b8864515" ], "host_num" : 1, "scan_time" : 1661752185836, "severity_level" : "Critical", "repair_necessity" : "Critical", "solution_detail" : "To upgrade the affected software", "type" : "linux_vul", "unhandle_host_num" : 0, "url" : "https://ubuntu.com/security/CVE-2022-27405", "vul_id" : "USN-5528-1", "vul_name" : "USN-5528-1: FreeType vulnerabilities" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_num Long 总数 最小值:0 最大值:2147483647 data_list Array of VulInfo objects 软件漏洞列表 数组长度:0 - 2147483647 表5 VulInfo 参数 参数类型 描述 vul_name String 漏洞名称 最小长度:0 最大长度:256 vul_id String 漏洞ID 最小长度:0 最大长度:64 label_list Array of strings 漏洞标签 最小长度:0 最大长度:65534 数组长度:0 - 2147483647 repair_necessity String 修复必要性 最小长度:0 最大长度:64 severity_level String 漏洞级别 最小长度:0 最大长度:64 host_num Integer 受影响服务器台数 最小值:0 最大值:2147483647 unhandle_host_num Integer 未处理服务器台数 最小值:0 最大值:2147483647 scan_time Long 最近扫描时间 最小值:0 最大值:9223372036854775807 solution_detail String 解决方案 最小长度:0 最大长度:65534 url String URL链接 最小长度:0 最大长度:2083 description String 漏洞描述 最小长度:0 最大长度:65534 type String 漏洞类型,包含如下: -linux_vul : linux漏洞 -windows_vul : windows漏洞 -web_cms : Web-CMS漏洞 -app_vul : 应用漏洞 最小长度:0 最大长度:128 host_id_list Array of strings 主机列表 最小长度:0 最大长度:128 数组长度:0 - 2147483647 cve_list Array of cve_list objects CVE列表 数组长度:1 - 10000 patch_url String 补丁地址 最小长度:0 最大长度:512 repair_priority String 修复优先级 Critical 紧急 High 高 Medium 中 Low 低 最小长度:1 最大长度:32 hosts_num VulnerabilityHostNumberInfo object 影响主机 repair_success_num Integer 修复成功次数 最小值:0 最大值:1000000 fixed_num Long 修复数量 最小值:0 最大值:1000000 ignored_num Long 忽略数量 最小值:0 最大值:1000000 verify_num Integer 验证数量 最小值:0 最大值:1000000 表6 cve_list 参数 参数类型 描述 cve_id String CVE ID 最小长度:1 最大长度:32 cvss Float CVSS分值 最小值:0 最大值:10 表7 VulnerabilityHostNumberInfo 参数 参数类型 描述 important Integer 重要主机数量 最小值:0 最大值:10000 common Integer 一般主机数量 最小值:0 最大值:10000 test Integer 测试主机数量 最小值:0 最大值:10000
  • URI GET /v5/{project_id}/vulnerability/vulnerabilities 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 最小长度:1 最大长度:256 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业租户ID,“0”表示默认企业项目,查询所有企业项目时填写:all_granted_eps 缺省值:0 最小长度:0 最大长度:256 type 否 String 漏洞类型,包含如下: -linux_vul : linux漏洞 -windows_vul : windows漏洞 -web_cms : Web-CMS漏洞 -app_vul : 应用漏洞 最小长度:0 最大长度:32 vul_id 否 String 漏洞ID 最小长度:0 最大长度:256 vul_name 否 String 漏洞名称 最小长度:0 最大长度:256 limit 否 Integer 每页显示个数 最小值:0 最大值:200 缺省值:10 offset 否 Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 最小值:0 最大值:2000000 缺省值:0 repair_priority 否 String 修复优先级 Critical 紧急 High 高 Medium 中 Low 低 最小长度:1 最大长度:10 handle_status 否 String 处置状态,包含如下: unhandled :未处理 handled : 已处理 缺省值:unhandled 最小长度:1 最大长度:32 cve_id 否 String 漏洞编号 最小长度:0 最大长度:32 label_list 否 String 漏洞标签 最小长度:0 最大长度:128 status 否 String 漏洞状态 最小长度:0 最大长度:32 asset_value 否 String 资产重要性 important common test 最小长度:0 最大长度:32 group_name 否 String 服务器组名称 最小长度:0 最大长度:256
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_num Integer 总数 最小值:0 最大值:10000 data_list Array of AppResponseInfo objects 软件列表 数组长度:0 - 10000 表5 AppResponseInfo 参数 参数类型 描述 agent_id String agent_id 最小长度:0 最大长度:128 host_id String 主机id 最小长度:1 最大长度:128 host_name String 服务器名称 最小长度:1 最大长度:256 host_ip String 服务器ip 最小长度:1 最大长度:256 app_name String 软件名称 最小长度:1 最大长度:128 version String 版本号 最小长度:1 最大长度:128 update_time Long 更新时间 最小值:0 最大值:2147483647 recent_scan_time Long 最近扫描时间 最小值:0 最大值:2147483647 container_id String 容器id 最小长度:1 最大长度:128 container_name String 容器名称 最小长度:1 最大长度:256
  • URI GET /v5/{project_id}/asset/apps 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度:1 最大长度:256 表2 Query参数 参数 是否必选 参数类型 描述 host_id 是 String 主机id 最小长度:0 最大长度:128 host_name 否 String 主机名称 最小长度:0 最大长度:128 app_name 否 String 软件名称 最小长度:0 最大长度:128 host_ip 否 String 主机ip 最小长度:0 最大长度:128 version 否 String 版本号 最小长度:0 最大长度:128 install_dir 否 String 安装目录 最小长度:0 最大长度:512 enterprise_project_id 否 String 企业项目 最小长度:1 最大长度:256 limit 否 Integer 默认10 最小值:10 最大值:100 缺省值:10 offset 否 Integer 默认是0 最小值:0 最大值:10000 缺省值:0 category 否 String 类别,默认为host,包含如下: host:主机 container:容器 最小长度:0 最大长度:64 part_match 否 Boolean 是否模糊匹配,默认false表示精确匹配
  • 响应示例 状态码: 200 单台主机安装的app { "total_num" : 1, "data_list" : [ { "agent_id" : "c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8", "host_id" : "55dac7fe-d81b-43bc-a4a7-4710fe673972", "host_name" : "xxxx", "host_ip" : "192.168.0.126", "app_name" : "acl", "version" : "2.2.51-14.eulerosv2r7", "update_time" : 1668150671981, "recent_scan_time" : 1668506044147, "container_id" : "ce794b8a6071f5fd7e4d142dab7b36bedf2c7a4f6083fb82e5bbc82709b50018", "container_name" : "hss_imagescan_W73V1WO6" } ] }
  • 请求示例 类型为私有镜像的镜像进行批量扫描,body体传参镜像列表,operate_all没有传参,说明需要镜像列表批量扫描。 POST https://{endpoint}/v5/{project_id}/image/batch-scan { "image_type" : "private_image", "image_info_list" : [ { "image_name" : "openjdk", "image_version" : "v8.8", "namespace" : "test" }, { "image_name" : "openjdk1", "image_version" : "v1.0", "namespace" : "test1" } ] } 类型为私有镜像的镜像进行全量扫描,body体没有传参镜像列表,operate_all=true,说明需要镜像列表全量扫描。 POST https://{endpoint}/v5/{project_id}/image/batch-scan { "image_type" : "private_image", "operate_all" : true }
  • URI POST /v5/{project_id}/image/batch-scan 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 最小长度:1 最大长度:256 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 租户企业项目ID,查询所有企业项目时填写:all_granted_eps 缺省值:0 最小长度:1 最大长度:256
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:1 最大长度:32768 region 是 String region id 最小长度:0 最大长度:128 表4 请求Body参数 参数 是否必选 参数类型 描述 repo_type 否 String 仓库类型,现阶段接入了swr镜像仓库,包含如下: SWR : SWR镜像仓库 最小长度:1 最大长度:32 image_info_list 否 Array of BatchScanSwrImageInfo objects 要扫描的镜像信息列表,operate_all参数为false时为必填 数组长度:0 - 10241 operate_all 否 Boolean 若为true全量查询,可筛选条件全部查询,若image_info_list为空,则必填 namespace 否 String 组织名称 最小长度:1 最大长度:256 image_name 否 String 镜像名称 最小长度:1 最大长度:256 image_version 否 String 镜像版本 最小长度:1 最大长度:256 image_type 是 String 镜像类型,包含如下: private_image : 私有镜像仓库 shared_image : 共享镜像仓库 最小长度:1 最大长度:32 scan_status 否 String 扫描状态,包含如下: unscan : 未扫描 success : 扫描完成 scanning : 扫描中 failed : 扫描失败 download_failed : 下载失败 image_oversized : 镜像超大 最小长度:1 最大长度:32 latest_version 否 Boolean 仅关注最新版本镜像 image_size 否 Long 镜像大小 最小值:0 最大值:2147483547 缺省值:0 start_latest_update_time 否 Long 创建时间开始日期 最小值:0 最大值:2147483547 缺省值:0 end_latest_update_time 否 Long 创建时间结束日期 最小值:0 最大值:2147483547 缺省值:0 start_latest_scan_time 否 Long 最近一次扫描完成时间开始日期 最小值:0 最大值:2147483547 缺省值:0 end_latest_scan_time 否 Long 最近一次扫描完成时间结束日期 最小值:0 最大值:2147483547 缺省值:0 表5 BatchScanSwrImageInfo 参数 是否必选 参数类型 描述 namespace 否 String 命名空间 最小长度:1 最大长度:64 image_name 否 String 镜像名称 最小长度:1 最大长度:128 image_version 否 String 镜像版本 最小长度:1 最大长度:128 instance_id 否 String 企业实例ID 最小长度:1 最大长度:128 instance_url 否 String 下载企业镜像URL 最小长度:0 最大长度:256
共100000条