华为云用户手册

URI GET /v5/{project_id}/baseline/risk-config/{check_name}/check-rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 最小长度：20 最大长度：64 check_name 是 String 基线名称 最小长度：0 最大长度：256 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，查询所有企业项目时填写：all_granted_eps 最小长度：0 最大长度：64 standard 是 String 标准类型，包含如下: cn_standard : 等保合规标准 hw_standard : 华为标准 qt_standard : 青腾标准 最小长度：0 最大长度：32 result_type 否 String 结果类型，包含如下： safe ： 已通过 unhandled : 未通过，且未忽略的 ignored : 未通过，且已忽略的 缺省值：unhandled 最小长度：0 最大长度：64 check_rule_name 否 String 检查项名称，支持模糊匹配 最小长度：0 最大长度：2048 severity 否 String 风险等级，包含如下: Security : 安全 Low : 低危 Medium : 中危 High : 高危 Critical : 危急 最小长度：0 最大长度：255 host_id 否 String 主机ID，不赋值时，查租户所有主机 最小长度：0 最大长度：64 limit 否 Integer 每页数量 最小值：0 最大值：200 缺省值：10 offset 否 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 最小值：0 最大值：2000000 缺省值：0

请求示例 查询所属组织为aaa，镜像名称为centos7，镜像版本为common的私有镜像并且标准类型为华为规范的指定安全配置项的检查项列表。 GET https://{endpoint}/v5/{project_id}/image/baseline/risk-configs/{check_name}/rules?offset=0&limit=200&image_type=private_image&namespace=aaa&image_name=centos7/test&image_version=common&standard=hw_standard&enterprise_project_id=all_granted_eps

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_num Integer 风险总数 最小值：0 最大值：2147483647 data_list Array of ImageRiskConfigsCheckRulesResponseInfo objects 数据列表 数组长度：0 - 2147483647 表5 ImageRiskConfigsCheckRulesResponseInfo 参数 参数类型 描述 severity String 风险等级，包含如下: Security : 安全 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 scan_result String 检测结果，包含如下： pass 通过 failed 未通过 最小长度：0 最大长度：64

响应示例 状态码： 200 指定安全配置项的检查项列表 { "total_num" : 1, "data_list" : [ { "check_rule_id" : "1.1", "check_rule_name" : "规则：口令锁定策略.", "check_name" : "CentOS 7", "check_type" : "CentOS 7", "standard" : "hw_standard", "scan_result" : "failed", "severity" : "High" } ] }

URI GET /v5/{project_id}/image/baseline/risk-configs/{check_name}/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 最小长度：1 最大长度：256 check_name 是 String 基线名称 最小长度：0 最大长度：128 表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 standard 是 String 标准类型，包含如下: cn_standard : 等保合规标准 hw_standard : 华为标准 qt_standard : 青腾标准 最小长度：0 最大长度：32 result_type 否 String 结果类型，包含如下： pass ： 已通过 failed : 未通过 缺省值：unhandled 最小长度：0 最大长度：64 check_rule_name 否 String 检查项名称，支持模糊匹配 最小长度：0 最大长度：2048 severity 否 String 风险等级，包含如下: Security : 安全 Low : 低危 Medium : 中危 High : 高危 Critical : 危急 最小长度：0 最大长度：255 instance_id 否 String 企业仓库实例ID，swr共享版无需使用该参数 最小长度：0 最大长度：128

响应示例 状态码： 200 安全配置项的检查结果 { "check_rule_num" : 17, "check_type_desc" : "This policy checks the basic security configuration items of the SSH service to improve the security of the SSH service.", "failed_rule_num" : 15, "host_num" : 2, "ignored_rule_num" : 1, "passed_rule_num" : 14, "severity" : "Medium" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 severity String 风险等级，包含如下: Low : 低危 Medium : 中危 High : 高危 最小长度：0 最大长度：65534 check_type String 基线类型 最小长度：0 最大长度：256 check_type_desc String 基线描述 最小长度：0 最大长度：65534 check_rule_num Integer 检查项总数量 最小值：0 最大值：2147483647 failed_rule_num Integer 未通过的检查项数量 最小值：0 最大值：2147483647 passed_rule_num Integer 已通过的检查项数量 最小值：0 最大值：2147483647 ignored_rule_num Integer 已忽略的检查项数量 最小值：0 最大值：2147483647 host_num Long 受影响的服务器的数量 最小值：0 最大值：2147483647

URI GET /v5/{project_id}/baseline/risk-config/{check_name}/detail 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 最小长度：20 最大长度：64 check_name 是 String 基线名称 最小长度：0 最大长度：256 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，查询所有企业项目时填写：all_granted_eps 最小长度：0 最大长度：64 standard 是 String 标准类型，包含如下: cn_standard : 等保合规标准 hw_standard : 华为标准 qt_standard : 青腾标准 最小长度：0 最大长度：32 host_id 否 String 主机ID，不赋值时，查租户所有主机 最小长度：0 最大长度：64 limit 否 Integer 每页数量 最小值：0 最大值：200 缺省值：10 offset 否 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 最小值：0 最大值：2000000 缺省值：0

响应示例 状态码： 200 服务器安全配置检测结果列表 { "total_num" : 1, "data_list" : [ { "check_name" : "Docker", "check_rule_num" : 25, "check_type" : "Docker", "check_type_desc" : "Configuring security audit of Docker's host configurations and container-running-related contents based on Docker Container Security Specifications V1_0.", "failed_rule_num" : 20, "host_num" : 0, "scan_time" : 1661716860935, "severity" : "High", "standard" : "hw_standard" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_num Long 记录总数 最小值：0 最大值：2147483647 data_list Array of SecurityCheckInfoResponseInfo objects 服务器配置检测结果列表 数组长度：0 - 2147483647 表5 SecurityCheckInfoResponseInfo 参数 参数类型 描述 severity String 风险等级，包含如下: 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 host_num Integer 影响的服务器数量 最小值：0 最大值：2097152 scan_time Long 最新检测时间 最小值：0 最大值：2097152 check_type_desc String 基线描述信息 最小长度：0 最大长度：65534

URI GET /v5/{project_id}/baseline/risk-configs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 最小长度：1 最大长度：256 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，查询所有企业项目时填写：all_granted_eps 最小长度：0 最大长度：256 check_name 否 String 基线名称 最小长度：0 最大长度：256 group_id 否 String 策略组ID 最小长度：0 最大长度：128 severity 否 String 风险等级，包含如下: Security : 安全 Low : 低危 Medium : 中危 High : 高危 最小长度：1 最大长度：32 standard 否 String 标准类型，包含如下: cn_standard : 等保合规标准 hw_standard : 华为标准 qt_standard : 青腾标准 最小长度：1 最大长度：32 host_id 否 String 服务器id 最小长度：0 最大长度：128 limit 否 Integer 每页显示数量，默认10 最小值：0 最大值：200 缺省值：10 offset 否 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 最小值：0 最大值：2000000 缺省值：0

URI POST /v5/{project_id}/ransomware/protection/close 表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参数 参数 是否必选 参数类型 描述 host_id_list 是 Array of strings 需要关闭勒索防护的主机ID列表 最小长度：0 最大长度：64 数组长度：0 - 20 agent_id_list 是 Array of strings 需要关闭勒索防护的agentID列表 最小长度：0 最大长度：64 数组长度：0 - 20 close_protection_type 是 String 关闭防护类型，包含如下： close_all : 关闭所有防护 close_anti : 关闭勒索防护 close_backup : 关闭备份功能 最小长度：0 最大长度：64

请求示例 关闭服务器勒索病毒防护，目标服务器ID为71a15ecc-049f-4cca-bd28-5e90aca1817f，目标服务器的Agent ID为c9bed5397db449ebdfba15e85fcfc36accee954daf5cab0528bab59bd8。 POST https://{endpoint}/v5/{project_id}/ransomware/protection/close { "close_protection_type" : "close_anti", "host_id_list" : [ "71a15ecc-049f-4cca-bd28-5e90aca1817f" ], "agent_id_list" : [ "c9bed5397db449ebdfba15e85fcfc36accee954daf5cab0528bab59bd8" ] }

响应示例 状态码： 200 备份策略信息 { "enabled" : true, "id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda", "name" : "HSS_84b5266c14ae489fa6549827f032dc62", "operation_type" : "backup", "operation_definition" : { "day_backups" : 0, "max_backups" : "-1", "month_backups" : 0, "retention_duration_days" : 5, "timezone" : "UTC+08:00", "week_backups" : 0, "year_backups" : 0 }, "trigger" : { "properties" : { "pattern" : [ "FREQ=DAILY;INTERVAL=2;BYHOUR=14;BYMINUTE=00" ] } } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 enabled Boolean 策略是否启用 id String 策略ID 最小长度：1 最大长度：128 name String 策略名称 最小长度：1 最大长度：128 operation_type String 备份类型。备份（backup）、复制(replication)，包含如下2种。 backup ：备份。 replication ：复制。 最小长度：1 最大长度：128 operation_definition OperationDefinitionInfo object 策略属性 保留规则 trigger BackupTriggerInfo object 备份:策略时间调度规则 表5 OperationDefinitionInfo 参数 参数类型 描述 day_backups Integer 保留日备个数，该备份不受保留最大备份数限制。取值为0到100。若选择该参数，则timezone 也必选。最小值：0,最大值：100 最小值：0 最大值：100 max_backups Integer 单个备份对象自动备份的最大备份数。取值为-1或0-99999。-1代表不按备份数清理。若该字段和retention_duration_days字段同时为空，备份会永久保留。最小值：1,最大值：99999,缺省值：-1 最小值：-1 最大值：99999 month_backups Integer 保留月备个数，该备份不受保留最大备份数限制。取值为0到100。若选择该参数，则timezone 也必选。最小值：0, 最大值：100 最小值：0 最大值：100 retention_duration_days Integer 备份保留时长，单位天。最长支持99999天。-1代表不按时间清理。若该字段和max_backups 参数同时为空，备份会永久保留。最小值：1, 最大值：99999, 缺省值：-1 最小值：-1 最大值：99999 timezone String 用户所在时区,格式形如UTC+08:00,若没有选择年备，月备，周备，日备中任一参数，则不能选择该参数。 最小长度：0 最大长度：256 week_backups Integer 保留周备个数，该备份不受保留最大备份数限制。取值为0到100。若选择该参数，则timezone 也必选。 最小值：0 最大值：100 year_backups Integer 保留年备个数，该备份不受保留最大备份数限制。取值为0到100。若选择该参数，则timezone 也必选。最小值：0，最大值：100 最小值：0 最大值：100 表6 BackupTriggerInfo 参数 参数类型 描述 id String 调度器id 最小长度：0 最大长度：256 name String 调度器名称 最小长度：0 最大长度：256 type String 调度器类型,目前只支持 time,定时调度。 最小长度：0 最大长度：256 properties BackupTriggerPropertiesInfo object 调度器属性 表7 BackupTriggerPropertiesInfo 参数 参数类型 描述 pattern Array of strings 调度器的调度策略，长度限制为10240个字符，参照iCalendar RFC 2445规范，但仅支持FREQ、BYDAY、BYHOUR、BYMINUTE四个参数，其中FREQ仅支持WEEKLY和DAILY，BYDAY支持一周七天（MO、TU、WE、TH、FR、SA、SU），BYHOUR支持0-23小时，BYMINUTE支持0-59分钟，并且时间点间隔不能小于一小时，一个备份策略可以同时设置多个备份时间点，一天最多可以设置24个时间点。 最小长度：0 最大长度：256 数组长度：0 - 24 start_time String 调度器开始时间，例如：2020-01-08 09:59:49 最小长度：0 最大长度：256

URI GET /v5/{project_id}/backup/policy 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 最小长度：1 最大长度：256 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，查询所有企业项目时填写：all_granted_eps 缺省值：0 最小长度：1 最大长度：256

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_num Integer 总数 data_list Array of PolicyGroupResponseInfo objects 策略组列表 数组长度：0 - 100 表5 PolicyGroupResponseInfo 参数 参数类型 描述 group_name String 策略组名 group_id String 策略组ID description String 描述信息 deletable Boolean 是否允许删除该策略组 host_num Integer 关联服务器数 default_group Boolean 是否是默认策略组 support_os String 支持的操作系统，包含如下: Linux ：支持Linux系统 Windows : 支持Windows系统 support_version String 支持的版本，包含如下: hss.version.basic ：基础版策略组 hss.version.advanced : 专业版策略组 hss.version.enterprise : 企业版策略组 hss.version.premium : 旗舰版策略组 hss.version.wtp : 网页防篡改版策略组 hss.version.container.enterprise : 容器版策略组

响应示例 状态码： 200 策略组列表 { "data_list" : [ { "default_group" : true, "deletable" : false, "description" : "container policy group for linux", "group_id" : "c831f177-226d-4b91-be0f-bcf98d04ef5d", "group_name" : "tenant_linux_container_default_policy_group ", "host_num" : 0, "support_version" : "hss.version.container.enterprise", "support_os" : "Linux" }, { "default_group" : true, "deletable" : false, "description" : "enterprise policy group for windows", "group_id" : "1ff54b90-1b3e-42a9-a1da-9883a83385ce", "group_name" : "tenant_windows_enterprise_default_policy_group ", "host_num" : 0, "support_version" : "hss.version.enterprise", "support_os" : "Windows" }, { "default_group" : true, "deletable" : false, "description" : "enterprise policy group for linux", "group_id" : "1069bcc0-c806-4ccd-a35d-f1f7456805e9", "group_name" : "tenant_linux_enterprise_default_policy_group ", "host_num" : 1, "support_version" : "hss.version.enterprise", "support_os" : "Linux" }, { "default_group" : true, "deletable" : false, "description" : "premium policy group for windows", "group_id" : "11216d24-9e91-4a05-9212-c4c1d646ee79", "group_name" : "tenant_windows_premium_default_policy_group ", "host_num" : 0, "support_version" : "hss.version.premium", "support_os" : "Linux" }, { "default_group" : true, "deletable" : false, "description" : "premium policy group for linux", "group_id" : "e6e1228a-7bb4-424f-a42b-755162234da7", "group_name" : "tenant_linux_premium_default_policy_group ", "host_num" : 0, "support_version" : "hss.version.premium", "support_os" : "Windows" } ], "total_num" : 5 }

URI GET /v5/{project_id}/policy/groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 最小长度：1 最大长度：256 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 租户企业项目ID，查询所有企业项目时填写：all_granted_eps 缺省值：0 最小长度：1 最大长度：256 group_name 否 String 策略组名 最小长度：1 最大长度：256 offset 否 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 最小值：0 最大值：100000 缺省值：0 limit 否 Integer 每页显示个数 最小值：10 最大值：200 缺省值：10

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 HSS.0001 invalid param error 参数不合法 请检查参数是否合法 500 HSS.0041 Query host extend info error 查询信息出错 请检查参数是否合法 父主题： 附录

请求示例 修改备份策略，目标备份策略ID为af4d08ad-2b60-4916-a5cf-8d6a23956dda。 PUT https://{endpoint}/v5/{project_id}/backup/policy { "enabled" : true, "policy_id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda", "operation_definition" : { "day_backups" : 0, "max_backups" : -1, "month_backups" : 0, "retention_duration_days" : 5, "timezone" : "UTC+08:00", "week_backups" : 0, "year_backups" : 0 }, "trigger" : { "properties" : { "pattern" : [ "FREQ=DAILY;INTERVAL=2;BYHOUR=14;BYMINUTE=00" ] } } }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 最小长度：1 最大长度：32768 region 是 String region id 最小长度：0 最大长度：128 表4 请求Body参数 参数 是否必选 参数类型 描述 enabled 否 Boolean 策略是否启用，缺省值：true policy_id 是 String 策略ID 最小长度：1 最大长度：256 operation_definition 否 OperationDefinitionRequestInfo object 调度参数 trigger 否 BackupTriggerRequestInfo object 策略时间调度规则 表5 OperationDefinitionRequestInfo 参数 是否必选 参数类型 描述 day_backups 否 Integer 保留日备个数，该备份不受保留最大备份数限制。取值为0到100。若选择该参数，则timezone 也必选。最小值：0,最大值：100 最小值：0 最大值：100 max_backups 否 Integer 单个备份对象自动备份的最大备份数。取值为-1或0-99999。-1代表不按备份数清理。若该字段和retention_duration_days字段同时为空，备份会永久保留。最小值：1,最大值：99999,缺省值：-1 最小值：-1 最大值：99999 month_backups 否 Integer 保留月备个数，该备份不受保留最大备份数限制。取值为0到100。若选择该参数，则timezone 也必选。最小值：0, 最大值：100 最小值：0 最大值：100 retention_duration_days 否 Integer 备份保留时长，单位天。最长支持99999天。-1代表不按时间清理。若该字段和max_backups 参数同时为空，备份会永久保留。最小值：1, 最大值：99999, 缺省值：-1 最小值：-1 最大值：99999 timezone 否 String 用户所在时区,格式形如UTC+08:00,若没有选择年备，月备，周备，日备中任一参数，则不能选择该参数。 最小长度：0 最大长度：256 week_backups 否 Integer 保留周备个数，该备份不受保留最大备份数限制。取值为0到100。若选择该参数，则timezone 也必选。 最小值：0 最大值：100 year_backups 否 Integer 保留年备个数，该备份不受保留最大备份数限制。取值为0到100。若选择该参数，则timezone 也必选。最小值：0，最大值：100 最小值：0 最大值：100 表6 BackupTriggerRequestInfo 参数 是否必选 参数类型 描述 properties 是 BackupTriggerPropertiesRequestInfo object 策略执行时间规则 表7 BackupTriggerPropertiesRequestInfo 参数 是否必选 参数类型 描述 pattern 是 Array of strings 调度规则。限制24条规则。调度器的调度规则，可参照iCalendar RFC 2445规范中的事件规则，但仅支持FREQ、BYDAY、BYHOUR、BYMINUTE、INTERVAL等参数，其中FREQ仅支持WEEKLY和DAILY，BYDAY支持一周七天（MO、TU、WE、TH、FR、SA、SU），BYHOUR支持0-23小时，BYMINUTE支持0-59分钟，并且间隔不能小于一小时，一天最大24个时间点。例如，周一到周天，每天14:00调度，其规则为：'FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00'。每天14:00调度，其规则为'FREQ=DAILY;INTERVAL=1;BYHOUR=14;BYMINUTE=00'。 最小长度：1 最大长度：256 数组长度：0 - 24

URI PUT /v5/{project_id}/backup/policy 表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参数 参数 是否必选 参数类型 描述 policy_id 是 String 策略ID 最小长度：0 最大长度：128 policy_name 是 String 策略名称 最小长度：0 最大长度：128 protection_mode 是 String 防护动作，包含如下2种。 alarm_and_isolation ：告警并自动隔离。 alarm_only ：仅告警。 最小长度：0 最大长度：128 bait_protection_status 是 String 是否开启诱饵防护，包含如下1种, 默认为开启防护诱饵防护。 opened ：开启。 closed ：关闭。 最小长度：0 最大长度：128 protection_directory 是 String 防护目录,多个目录请用英文分号隔开，最多支持填写20个防护目录 最小长度：1 最大长度：128 protection_type 是 String 防护文件类型 最小长度：1 最大长度：128 exclude_directory 否 String 排除目录(选填)，多个目录请用英文分号隔开，最多支持填写20个排除目录 最小长度：1 最大长度：128 agent_id_list 否 Array of strings 关联server 最小长度：1 最大长度：128 数组长度：0 - 10000 operating_system 是 String 操作系统，包含如下： Windows : Windows系统 Linux : Linux系统 最小长度：0 最大长度：64 runtime_detection_status 否 String 是否运行时检测，包含如下2种，暂时只有关闭一种状态，为保留字段。 opened ：开启。 closed ：关闭。 最小长度：0 最大长度：128 process_whitelist 否 Array of TrustProcessInfo objects 进程白名单 数组长度：0 - 20 表5 TrustProcessInfo 参数 是否必选 参数类型 描述 path 否 String 进程路径 最小长度：0 最大长度：128 hash 否 String 进程hash 最小长度：0 最大长度：128

请求示例 修改勒索病毒防护策略，目标服务器操作系统类型为Linux，防护策略ID为0253edfd-30e7-439d-8f3f-17c54c997064，防护动作为仅告警。 PUT https://{endpoint}/v5/{project_id}/ransomware/protection/policy { "bait_protection_status" : "opened", "protection_type" : "docx", "exclude_directory" : "", "operating_system" : "Linux", "policy_id" : "0253edfd-30e7-439d-8f3f-17c54c997064", "policy_name" : "aaa", "protection_mode" : "alarm_only", "protection_directory" : "/root", "runtime_detection_status" : "closed", "agent_id_list" : [ "" ] }

URI PUT /v5/{project_id}/ransomware/protection/policy 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 最小长度：1 最大长度：256 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，查询所有企业项目时填写：all_granted_eps 缺省值：0 最小长度：1 最大长度：256

概述 欢迎使用主机安全服务（Host Security Service，HSS）。主机安全服务是提升主机整体安全性的服务，通过主机管理、风险预防、入侵检测、高级防御、安全运营、网页防篡改功能，全面识别并管理主机中的信息资产，实时监测主机中的风险并阻止非法入侵行为，帮助企业构建服务器安全体系，降低当前服务器面临的主要安全风险。 您可以使用本文档提供的API对主机安全服务进行相关操作。 在调用主机安全服务API之前，请确保已经充分了解主机安全服务相关概念，详细信息请参见产品介绍。 父主题： 使用前必读

响应示例 状态码： 200 勒索病毒防护服务器列表 { "total_num" : 1, "data_list" : [ { "agent_id" : "2758d2a61598fd9144cfa6b201049e7c0af8c3f1280cd24e3ec95a2f0811a2a2", "agent_status" : "online", "backup_error" : { "error_code" : 1, "error_description" : "已綁定至其它存储库，无法开启备份" }, "ransom_protection_status" : "opened", "backup_protection_status" : "failed_to_turn_on_backup", "count_backuped" : 0, "count_protect_event" : 0, "group_id" : "7c659ea3-006f-4687-9f1c-6d975d955f37", "group_name" : "333", "host_id" : "caa958ad-a481-4d46-b51e-6861b8864515", "host_ip" : "100.85.119.68", "host_name" : "Euler", "host_status" : "ACTIVE", "os_name" : "EulerOS", "os_type" : "Linux", "private_ip" : "100.85.123.9", "protect_policy_id" : "0253edfd-30e7-439d-8f3f-17c54c99706", "protect_policy_name" : "tst", "protect_status" : "opened" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_num Integer 总数 最小值：0 最大值：2097152 data_list Array of ProtectionServerInfo objects 查询勒索防护服务器列表 数组长度：0 - 10241 表5 ProtectionServerInfo 参数 参数类型 描述 host_id String 服务器ID 最小长度：0 最大长度：128 agent_id String Agent ID 最小长度：0 最大长度：128 host_name String 服务器名称 最小长度：0 最大长度：128 host_ip String 弹性公网IP地址 最小长度：0 最大长度：128 private_ip String 私有IP地址 最小长度：0 最大长度：128 os_type String 操作系统类型，包含如下2种。 Linux ：Linux。 Windows ：Windows。 最小长度：0 最大长度：128 os_name String 系统名称 最小长度：0 最大长度：128 host_status String 服务器状态，包含如下2种。 ACTIVE ：运行中。 SHUTOFF ：关机。 最小长度：1 最大长度：32 ransom_protection_status String 勒索防护状态，包含如下4种。 closed ：关闭。 opened ：开启。 opening ：开启中。 closing ：关闭中。 最小长度：0 最大长度：128 agent_version String agent版本 最小长度：1 最大长度：128 protect_status String 防护状态，包含如下2种。 closed ：未防护。 opened ：防护中。 最小长度：1 最大长度：32 group_id String 服务器组ID 最小长度：1 最大长度：128 group_name String 服务器组名称 最小长度：1 最大长度：128 protect_policy_id String 防护策略ID 最小长度：1 最大长度：128 protect_policy_name String 防护策略名称 最小长度：1 最大长度：128 backup_error backup_error object 备份错误信息 backup_protection_status String 是否开启备份，包含如下3种。 failed_to_turn_on_backup: 无法开启备份 closed ：关闭。 opened ：开启。 最小长度：0 最大长度：128 count_protect_event Integer 防护事件数 最小值：0 最大值：2097152 count_backuped Integer 已有备份数 最小值：0 最大值：2097152 agent_status String Agent状态 最小长度：1 最大长度：128 version String 主机开通的版本，包含如下7种输入。 hss.version.null ：无。 hss.version.basic ：基础版。 hss.version.advanced ：专业版。 hss.version.enterprise ：企业版。 hss.version.premium ：旗舰版。 hss.version.wtp ：网页防篡改版。 hss.version.container.enterprise ：容器版。 最小长度：1 最大长度：32 host_source String 服务器类型，包含如下3种输入。 ecs ：ecs。 outside ：线下主机。 workspace ： 云桌面 。 最小长度：1 最大长度：32 vault_id String 存储库ID 最小长度：0 最大长度：128 vault_name String 存储库名称 最小长度：0 最大长度：128 vault_size Integer 总容量，单位GB 最小值：0 最大值：2097152 vault_used Integer 已使用容量，单位MB 最小值：0 最大值：2097152 vault_allocated Integer 已分配容量，单位GB，指绑定的服务器大小 最小值：0 最大值：2097152 vault_charging_mode String 存储库创建模式，按需：post_paid，包周期：pre_paid 最小长度：0 最大长度：128 vault_status String 存储库状态。 available ：可用。 lock ：被锁定。 frozen：冻结。 deleting：删除中。 error：错误。 最小长度：0 最大长度：128 backup_policy_id String 备份策略ID，若为空，则为未绑定状态，若不为空，通过backup_policy_enabled字段判断策略是否启用 最小长度：1 最大长度：128 backup_policy_name String 备份策略名称 最小长度：1 最大长度：128 backup_policy_enabled Boolean 策略是否启用 resources_num Integer 已绑定服务器（个） 最小值：0 最大值：2097152 表6 backup_error 参数 参数类型 描述 error_code Integer 错误编码，包含如下2种。 0 ：无错误信息。 1 ：已綁定至其它存储库，无法开启备份。 2 ：备份库已超过最大限额。 3 ：CBR接口调用异常。 最小值：0 最大值：128 error_description String 错误描述 最小长度：1 最大长度：128