华为云用户手册

  • 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
  • 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 表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
  • 响应示例 状态码: 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
  • URI POST /v5/{project_id}/{resource_type}/{resource_id}/tags/create 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度:1 最大长度:256 resource_type 是 String 资源类别,hss 最小长度:1 最大长度:64 resource_id 是 String 资源ID 最小长度:0 最大长度:128
  • 请求示例 创建标签键TESTKEY20220831190155(标签值为2)和标签键test(标签值为hss)。 POST https://{endpoint}/v5/05e1e8b7ba8010dd2f80c01070a8d4cd/hss/fbaa9aca-2b5f-11ee-8c64-fa163e139e02/tags/create { "tags" : [ { "key" : "TESTKEY20220831190155", "value" : "2" }, { "key" : "test", "value" : "hss" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:32 最大长度:512 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of ResourceTagInfo objects 标签对象列表 数组长度:0 - 1024 sys_tags 否 Array of ResourceTagInfo objects 标签对象列表 数组长度:0 - 1024 表4 ResourceTagInfo 参数 是否必选 参数类型 描述 key 否 String 键。最大长度128个unicode字符。 key不能为空 最小长度:1 最大长度:128 value 否 String 值 最小长度:1 最大长度:128
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_num Integer 总数 data_list Array of IsolatedFileResponseInfo objects 已隔离文件详情 数组长度:0 - 100 表5 IsolatedFileResponseInfo 参数 参数类型 描述 host_id String 服务器ID host_name String 服务器名称 file_hash String 文件哈希 file_path String 文件路径 isolation_status String 隔离状态,包含如下: isolated : 已隔离 restored : 已恢复 isolating : 已下发隔离任务 restoring : 已下发恢复任务 file_attr String 文件属性 update_time Integer 更新时间,毫秒
  • 响应示例 状态码: 200 已隔离文件列表 { "data_list" : [ { "file_attr" : "0", "file_hash" : "58693382bc0c9f60ef86e5b37cf3c2f3a9c9ec46936901eaa9131f7ee4a09bde", "file_path" : "C:\\Users\\Public\\Public Docker\\system32.exe", "host_id" : "5a41ca47-8ea7-4a65-a8fb-950d03d8638e", "host_name" : "ecs-wi-800211", "isolation_status" : "isolated", "update_time" : 1698304933717 } ], "total_num" : 1 }
  • URI GET /v5/{project_id}/event/isolated-file 表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 isolation_status 否 String 隔离状态,包含如下: isolated : 已隔离 restored : 已恢复 isolating : 已下发隔离任务 restoring : 已下发恢复任务 最小长度:0 最大长度:32 offset 否 Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 最小值:0 最大值:2000000 缺省值:0 limit 否 Integer 每页显示个数 最小值:10 最大值:1000 缺省值:10
  • URI POST /v5/{project_id}/host-management/protection 表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参数 参数 是否必选 参数类型 描述 version 是 String 主机开通的版本,包含如下: hss.version.null :无,代表关闭防护。 hss.version.basic :基础版。 hss.version.advanced :专业版。 hss.version.enterprise :企业版。 hss.version.premium :旗舰版。 hss.version.wtp :网页防篡改版。 最小长度:1 最大长度:128 charging_mode 否 String 付费模式,当version不为“hss.version.null”时,则需必填该参数 packet_cycle : 包周期 on_demand : 按需 最小长度:1 最大长度:64 resource_id 否 String HSS配额ID,不填该参数时,则随机选择对应版本配额 最小长度:1 最大长度:128 host_id_list 是 Array of strings 服务器列表 最小长度:1 最大长度:128 数组长度:0 - 2097152 tags 否 Array of TagInfo objects 资源标签列表 数组长度:0 - 2097152 表5 TagInfo 参数 是否必选 参数类型 描述 key 否 String 键。最大长度128个unicode字符。 key不能为空 最小长度:1 最大长度:128 value 否 String 值。最大长度255个unicode字符。 最小长度:1 最大长度:255
  • 请求示例 切换ID为71a15ecc-049f-4cca-bd28-5e90aca1817f的服务器防护版本为基础版。 { "version" : "hss.version.basic", "charging_mode" : "packet_cycle", "resource_id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda", "host_id_list" : [ "71a15ecc-049f-4cca-bd28-5e90aca1817f" ], "tags" : [ { "key" : "服务", "value" : "hss" } ] }
  • 基本概念 帐号 用户注册时的帐号,帐号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于帐号是付费主体,为了确保帐号安全,建议您不要直接使用帐号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由帐号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看帐号ID和用户ID。通常在调用API的鉴权过程中,您需要用到帐号、用户和密码等信息。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region,通用Region指面向公共租户提供通用云服务的Region;专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区(AZ,Availability Zone) 一个AZ是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您帐号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中创建资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。 图1 项目隔离模型 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息,请参见企业管理服务用户指南。 父主题: 使用前必读
  • 请求示例 创建名称为test的服务器组,服务器组中包含的服务器ID为15dac7fe-d81b-43bc-a4a7-4710fe673972。 POST https://{endpoint}/v5/{project_id}/host-management/groups { "group_name" : "test", "host_id_list" : [ "15dac7fe-d81b-43bc-a4a7-4710fe673972" ] }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:1 最大长度:32768 region 是 String region id 最小长度:0 最大长度:128 表4 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 服务器组名称 最小长度:1 最大长度:128 host_id_list 是 Array of strings 服务器ID列表 最小长度:1 最大长度:128 数组长度:1 - 10000
  • URI POST /v5/{project_id}/host-management/groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 最小长度:1 最大长度:256 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID,查询所有企业项目时填写:all_granted_eps 缺省值:0 最小长度:1 最大长度:256
  • 响应示例 状态码: 200 ListJarPackageHostInfo { "data_list" : [ { "agent_id" : "2d0fe7824005bf001220ad9d892e86f8af44a7d3608dab11165008ce439d3583", "catalogue" : "util", "container_id" : "", "file_name" : "rt.jar", "file_type" : "jar", "gid" : 0, "hash" : "04bf14e3b1da55d95561ca78cb29caa909410051dbe047e91ad6f5c1dedb8d6d", "host_id" : "103ed820-62e5-4754-b0f8-3e47b6dd49d2", "host_ip" : "192.168.1.76", "host_name" : "正在测试勿删", "mode" : "-rw-------", "name" : "Java Runtime Environment", "path" : "/CloudResetPwdUpdateAgent/depend/jre/lib/rt.jar", "pid" : 1614, "proc_path" : "/CloudResetPwdUpdateAgent/depend/jre/bin/java", "record_time" : 1690513169986, "uid" : 0, "version" : "1.8.0_252", "size" : 128, "container_name" : "aaaa", "package_path" : "/CloudResetPwdUpdateAgent/depend/jre/bin/java", "is_embedded" : 0 } ], "total_num" : 1 }
  • URI GET /v5/{project_id}/asset/midwares/detail 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度:20 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 租户企业项目ID 最小长度:0 最大长度:64 file_name 是 String 文件名称 最小长度:1 最大长度:256 category 否 String 类别,包含如下: host : 主机 container : 容器 最小长度:0 最大长度:64 host_name 否 String 服务器名称 最小长度:0 最大长度:64 host_ip 否 String 服务器IP 最小长度:0 最大长度:64 limit 否 Integer 默认10 最小值:10 最大值:100 缺省值:10 offset 否 Integer 默认是0 最小值:0 最大值:300000 缺省值:0 part_match 否 Boolean 是否模糊匹配,默认false表示精确匹配
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_num Integer 总数 最小值:0 最大值:10000 data_list Array of JarPackageHostInfo objects 服务器列表 数组长度:0 - 10000 表5 JarPackageHostInfo 参数 参数类型 描述 agent_id String agent_id 最小长度:1 最大长度:64 host_id String 主机id 最小长度:0 最大长度:128 host_name String 服务器名称 最小长度:0 最大长度:256 host_ip String 服务器ip 最小长度:0 最大长度:128 file_name String Jar包名称 最小长度:0 最大长度:256 name String Jar包名称(不带后缀) 最小长度:0 最大长度:256 catalogue String Jar包类型 最小长度:0 最大长度:32 file_type String Jar包后缀 最小长度:0 最大长度:32 version String Jar包版本 最小长度:0 最大长度:64 path String Jar包路径 最小长度:0 最大长度:512 hash String Jar包hash 最小长度:0 最大长度:512 size Integer Jar包大小 最小值:0 最大值:2147483647 uid Integer uid 最小值:0 最大值:2147483647 gid Integer gid 最小值:0 最大值:2147483647 mode String 文件权限 最小长度:0 最大长度:32 pid Integer 进程id 最小值:0 最大值:2147483647 proc_path String 进程可执行文件路径 最小长度:0 最大长度:1024 container_id String 容器实例id 最小长度:0 最大长度:128 container_name String 容器名称 最小长度:0 最大长度:256 package_path String 包路径 最小长度:0 最大长度:1024 is_embedded Integer 显示的是否是嵌套包 最小值:0 最大值:2147483647 record_time Long 扫描时间 最小值:0 最大值:4070880000000
  • 请求示例 创建agent_id为0253edfd-30e7-439d-8f3f-17c54c997064,检测漏洞Id列表为urgent_vul_id_list的应急漏洞检测任务 POST https://{endpoint}/v5/{project_id}/vulnerability/scan-task?enterprise_project_id=XXX { "manual_scan_type" : "urgent_vul", "batch_flag" : false, "range_type" : "specific_host", "agent_id_list" : [ "0253edfd-30e7-439d-8f3f-17c54c997064" ], "urgent_vul_id_list" : [ "URGENT-CVE-2023-46604", "URGENT-HSSVD-2020-1109", "URGENT-CVE-2022-26134", "URGENT-CVE-2023-22515", "URGENT-CVE-2023-22518", "URGENT-CVE-2023-28432", "URGENT-CVE-2023-37582", "URGENT-CVE-2023-33246", "URGENT-CNVD-2023-02709", "URGENT-CVE-2022-36804", "URGENT-CVE-2022-22965", "URGENT-CVE-2022-25845", "URGENT-CVE-2019-14439", "URGENT-CVE-2020-13933", "URGENT-CVE-2020-26217", "URGENT-CVE-2021-4034", "URGENT-CVE-2021-44228", "URGENT-CVE-2022-0847" ] }
  • URI GET /v5/{project_id}/asset/processes/detail 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度:1 最大长度:256 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目 最小长度:1 最大长度:256 host_name 否 String 主机名称 最小长度:1 最大长度:256 host_ip 否 String 主机ip 最小长度:1 最大长度:256 path 否 String 进程路径 最小长度:1 最大长度:256 category 否 String 类型,默认为host,包含如下: host:主机 container:容器 最小长度:0 最大长度:64 limit 否 Integer 默认10 最小值:10 最大值:100 缺省值:10 offset 否 Integer 默认是0 最小值:0 最大值:2000000 缺省值:0
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_num Integer 主机统计信息总数, 最小值:0 最大值:10000 data_list Array of ProcessesHostResponseInfo objects 主机统计信息列表 数组长度:0 - 10000 表5 ProcessesHostResponseInfo 参数 参数类型 描述 hash String 文件hash 最小长度:1 最大长度:256 host_ip String 主机ip 最小长度:1 最大长度:256 host_name String 主机名称 最小长度:1 最大长度:256 launch_params String 启动参数 最小长度:1 最大长度:256 launch_time Long 启动时间 最小值:0 最大值:4070880000000 process_path String 进程路径 最小长度:1 最大长度:256 process_pid Integer 进程pid 最小值:0 最大值:65535 run_permission String 文件权限 最小长度:1 最大长度:256 container_id String 容器id 最小长度:1 最大长度:128 container_name String 容器名称 最小长度:1 最大长度:256
  • 响应示例 状态码: 200 具备该进程的主机信息 { "total_num" : 1, "data_list" : [ { "hash" : "xxxxxx96a7ceb67731c0158xxxxxxff8456914d8275d221671d1190e888xxxxx", "host_ip" : "192.168.0.1", "host_name" : "ecs-euler-z00800211", "launch_params" : "", "launch_time" : 1673504622000, "process_path" : "/CloudResetPwdUpdateAgent/bin/wrapper", "process_pid" : 888, "run_permission" : "rwx------", "container_id" : "ce794b8a6071f5fd7e4d142dab7b36bedf2c7a4f6083fb82e5bbc82709b50018", "container_name" : "hss_imagescan_W73V1WO6" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_num Long 风险总数 最小值:0 最大值:9223372036854775807 data_list Array of CheckRuleRiskInfoResponseInfo objects 数据列表 数组长度:0 - 2147483647 表5 CheckRuleRiskInfoResponseInfo 参数 参数类型 描述 severity String 风险等级,包含如下: Low : 低危 Medium : 中危 High : 高危 最小长度:0 最大长度:255 check_name String 基线名称 最小长度:0 最大长度:256 check_type String 基线类型 最小长度:0 最大长度:256 standard String 标准类型,包含如下: cn_standard : 等保合规标准 hw_standard : 华为标准 qt_standard : 青腾标准 最小长度:0 最大长度:16 check_rule_name String 检查项 最小长度:0 最大长度:2048 check_rule_id String 检查项ID 最小长度:0 最大长度:64 host_num Integer 影响服务器数量 最小值:0 最大值:2147483647 scan_result String 检测结果,包含如下: pass failed 最小长度:0 最大长度:64 status String 状态,包含如下: safe : 无需处理 ignored : 已忽略 unhandled : 未处理 fixing : 修复中 fix-failed : 修复失败 verifying : 验证中 最小长度:0 最大长度:64 enable_fix Integer 是否支持一键修复,1:支持一键修复,0:不支持 最小值:0 最大值:2147483647 enable_click Boolean 该检查项的修复&忽略&验证按钮是否可点击,true:按钮可点击,false:按钮不可点击 rule_params Array of CheckRuleFixParamInfo objects 支持传递参数修复的检查项可传递参数的范围 数组长度:0 - 2147483647 表6 CheckRuleFixParamInfo 参数 参数类型 描述 rule_param_id Integer 检查项参数ID 最小值:0 最大值:10 rule_desc String 检查项参数描述 最小长度:0 最大长度:256 default_value Integer 检查项参数默认值 最小值:0 最大值:2147483647 range_min Integer 检查项参数可取最小值 最小值:0 最大值:2147483647 range_max Integer 检查项参数可取最大值 最小值:0 最大值:2147483647
  • 请求示例 查询企业项目id为xxx下的基线名称为SSH、检查标准为“ 云安全 实践”的检查项列表。 GET https://{endpoint}/v5/{project_id}/baseline/risk-config/SSH/check-rules?standard=hw_standard&enterprise_project_id=xxx { "standard" : "hw_standard" }
  • 响应示例 状态码: 200 指定安全配置项的检查项列表 { "total_num" : 1, "data_list" : [ { "check_rule_id" : "1.1", "check_rule_name" : "Rule:Ensure that permissions on /etc/ssh/sshd_config are configured.", "check_type" : "SSH", "host_num" : 2, "standard" : "hw_standard", "scan_result" : "failed", "severity" : "High", "status" : "unhandled", "enable_fix" : 1, "enable_click" : true, "rule_params" : [ { "rule_param_id" : 1, "rule_desc" : "设置超时时间", "default_value" : 5, "range_min" : 1, "range_max" : 10 }, { "rule_param_id" : 2, "rule_desc" : "设置重启次数", "default_value" : 10, "range_min" : 1, "range_max" : 20 } ] } ] }
共100000条