华为云用户手册

请求示例 修改指定实例的信息，修改实例名称为dcs002，端口为6379，设置自动备份策略。 PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id} { "name" : "dcs002", "description" : "instance description", "port" : 6379, "maintain_begin" : "18:00:00", "maintain_end" : "19:00:00", "security_group_id" : "18e9309f-f81a-4749-bb21-f74576292162", "instance_backup_policy" : { "backup_type" : "auto", "save_days" : "1,", "periodical_backup_plan" : { "backup_at" : [ "1", "2", "3", "4", "6", "7" ], "period_type" : "weekly", "begin_at" : "00:00-01:00" } } }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 实例名称 由英文字符开头，只能由英文字母、数字、中划线和下划线组成。 创建单个实例时，名称长度为4到64位的字符串。批量创建实例时，名称长度为4到56位的字符串，且实例名称格式为“自定义名称-n”，其中n从000开始，依次递增。例如，批量创建两个实例，自定义名称为dcs_demo，则两个实例的名称为dcs_demo-000和dcs_demo-001。 description 否 String 实例的描述信息 长度不超过1024的字符串。 说明： \与"在json报文中属于特殊字符，如果参数值中需要显示\或者"字符，请在字符前增加转义字符\，比如\或者"。 最小长度：0 最大长度：1024 port 否 Integer 修改Redis实例的访问端口。端口范围为1~65535的任意数字。 修改后，Redis实例的所有连接将会中断，业务需要重新连接Redis的新端口。 只有Redis4.0、Redis5.0和Redis6.0基础版实例支持修改端口号。 最小值：1 最大值：65535 rename_commands 否 RenameCommandResp object 命令重命名列表。 maintain_begin 否 String 维护时间窗开始时间，为UTC时间，格式为HH:mm:ss。 维护时间窗开始和结束时间必须为指定的时间段，可参考查询维护时间窗时间段获取。 开始时间必须为18:00:00、19:00:00等。 该参数不能单独为空，若该值为空，则结束时间也为空。 maintain_end 否 String 维护时间窗结束时间，为UTC时间，格式为HH:mm:ss。 维护时间窗开始和结束时间必须为指定的时间段，可参考查询维护时间窗时间段获取。 结束时间在开始时间基础上加一个小时，即当开始时间为18:00:00时，结束时间为19:00:00。 该参数不能单独为空，若该值为空，则开始时间也为空。 security_group_id 否 String 安全组ID。 可从虚拟私有云服务的控制台界面，或者通过查询安全组列表的API接口查询得到。 约束：只有Redis 3.0和Memcached支持 instance_backup_policy 否 BackupPolicy object 备份策略，实例类型为主备和集群时支持。 表3 RenameCommandResp 参数 是否必选 参数类型 描述 command 否 String 命令command flushall 否 String 命令flushall flushdb 否 String 命令flushdb hgetall 否 String 命令hgetall keys 否 String 命令keys 表4 BackupPolicy 参数 是否必选 参数类型 描述 backup_type 是 String 备份类型。 auto：自动备份 manual：手动备份 save_days 否 Integer 当backup_type设置为auto时，该参数为必填。 保留天数，单位：天，取值范围：1-7。由自动切换为手动时，保留自动备份策略信息。 periodical_backup_plan 否 BackupPlan object 备份计划，当backup_type设置为auto时，该参数为必填。由自动切换为手动时，保留自动备份策略信息。 表5 BackupPlan 参数 是否必选 参数类型 描述 timezone_offset 否 String 备份的时区。该参数已废弃，没有实际作用。 backup_at 是 Array of integers 每周的周几开始备份，取值1-7，1代表周一，7代表周日。由自动切换为手动时，保留自动备份策略信息。 period_type 是 String 备份周期类型，目前支持“weekly”。由自动切换为手动时，保留自动备份策略信息。 begin_at 是 String 备份开始执行时间，该时间为UTC时间，例如“00:00-01:00”代表UTC时间0点开始执行备份。只能是整点时间段，间隔时间限定为一个小时。由自动切换为手动时，保留自动备份策略信息。

响应示例 状态码： 200 设置热key自动分析配置成功。 { "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3", "enable_auto_scan" : true, "schedule_at" : [ "21:00" ], "updated_at" : "2020-06-17T02:42:40.793Z" } 状态码： 400 非法请求。 { "error_code" : "DCS.4922", "error_msg" : "Does not support hotkey analyze." }

请求示例 设置热key自动分析任务，每日缓存分析时间为21：00。 PUT https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey/autoscan { "enable_auto_scan" : true, "schedule_at" : [ "21:00" ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 instance_id String 所属实例ID。 enable_auto_scan Boolean 是否开启缓存分析定时任务。 schedule_at Array of strings 每日分析时间，时间格式为21:00，时间为UTC时间。 updated_at String 配置更新时间，时间格式为2020-06-15T02:21:18.669Z。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信（暂未使用，赋值为null）。 最大长度：1024 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信（暂未使用，赋值为null）。 最大长度：1024 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信（暂未使用，赋值为null）。 最大长度：1024 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信（暂未使用，赋值为null）。 最大长度：1024 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信（暂未使用，赋值为null）。 最大长度：1024

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 tags Array of Tag objects 标签列表。 表3 Tag 参数 参数类型 描述 key String 标签键，最大长度128个字符。 values Array of strings 标签值。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024

响应示例 状态码： 200 批量删除缓存实例成功。 { "results" : [ { "result" : "success", "instance" : "54602a9d-5e22-4239-9123-77e350df4a34" }, { "result" : "success", "instance" : "7166cdea-dbad-4d79-9610-7163e6f8b640" } ] }

请求示例 批量删除缓存实例。 DELETE https://{dcs_endpoint}/v2/{project_id}/instances?all_failure={all_failure} { "instances" : [ "54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640" ] }

URI DELETE /v2/{project_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 all_failure 否 Boolean 是否批量删除创建失败的缓存实例。取值如下： true，表示删除租户所有创建失败的缓存实例，此时请求参数instances可为空； false或者其他值，表示删除instances参数数组中指定的缓存实例。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 results Array of BatchOpsResult objects 删除/重启/清空实例的结果。 表5 BatchOpsResult 参数 参数类型 描述 result String 操作结果，取值有success或failed。 instance String 缓存实例ID。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024

响应示例 状态码： 200 批量下发停止迁移任务成功。 查询迁移任务状态为TERMINATED，即停止成功。 { "migration_tasks" : [ { "result" : "success", "task_id" : "b21989ec-2889-4b8e-99db-19c073425ec2" }, { "result" : "failed", "task_id" : "5130d57f-640a-435b-bc3a-0fb1860a5340" } ] } 状态码： 400 非法请求。 { "error_msg" : "invalid migration task id in the request.", "error_code" : "DCS.4855" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 migration_tasks Array of StopMigrationTaskResult objects 数据迁移任务列表。 表4 StopMigrationTaskResult 参数 参数类型 描述 result String 下发停止迁移任务操作结果。 枚举值： success failed task_id String 数据迁移任务ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024

响应示例 状态码： 200 重置密码成功。 { "job_id" : "ff80808284d4c6d50184e8cff10248bd", "instance_id" : "10fda556-51c3-4cfa-ab6f-37667428da6e" } 状态码： 400 非法请求。 { "error_code" : "DCS.4961", "error_msg" : "Acl account request param invalid." }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 instance_id String 账号所属实例ID。 job_id String 修改ACL账号访问权限JOB的ID。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度：1024 error_code String 错误码 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null） 最大长度：1024

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度：1024 error_code String 错误码。 最大长度：9 error_ext_msg String 扩展错误信息（暂未使用，赋值为null）。 最大长度：1024

审计 云审计服务（Cloud Trace Service，CTS），是华为云安全解决方案中专业的日志审计服务，提供对各种云资源操作记录的收集、存储和查询功能，可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。 用户开通云审计服务并创建和配置追踪器后，CTS可记录CSS服务的操作事件用于审计。 CTS的详细介绍和开通配置方法，请参见CTS快速入门。 CSS服务支持云审计的操作列表请参见支持云审计的关键操作。 图1 云审计服务 在您开启了云审计服务后，系统会记录云搜索服务的相关操作，且控制台保存最近7天的操作记录。如何在云审计服务管理控制台查看最近7天的CSS服务操作记录请参见查看审计日志。

与其他服务之间的关系 CSS与其他服务的关系如图1所示。 图1 CSS与其他服务的关系 表1 CSS服务于其他服务的关系 相关服务 交互功能 虚拟私有云（Virtual Private Cloud，简称VPC） 云搜索服务CSS的集群创建在虚拟私有云（VPC）的子网内，VPC通过逻辑方式进行网络隔离，为用户的集群提供安全、隔离的网络环境。详细请参考虚拟私有云用户指南。 弹性云服务器（Elastic Cloud Server，简称ECS） 云搜索服务CSS的集群中每个节点为一台弹性云服务器（ECS）。创建集群时将自动创建弹性云服务器作为节点。 云硬盘（Elastic Volume Service，简称EVS） 云搜索服务CSS使用云硬盘（EVS）存储索引数据。创建集群时，将自动创建云硬盘用于集群存储。 对象存储服务（Object Storage Service，简称OBS） 云搜索服务CSS的集群快照存储在对象存储服务（OBS）的桶中。详细请参考对象存储服务用户指南。 统一身份认证服务（Identity and Access Management，简称IAM） 云搜索服务CSS使用统一身份认证服务（IAM）进行鉴权。详细请参考统一身份认证服务用户指南。 云监控服务（Cloud Eye） 云搜索服务使用云监控服务实时监测集群的指标信息，保障服务正常运行。云搜索服务当前支持的监控指标为磁盘使用率和集群健康状态。用户通过磁盘使用率指标可以及时了解集群的磁盘使用情况。通过集群健康状态指标，用户可以了解集群的健康状态。详细请参考云监控服务用户指南。 云审计服务（Cloud Trace Service，简称CTS） 云审计服务（CTS）可以记录与CSS云搜索服务相关的操作事件，便于日后的查询、审计和回溯。详细请参考云审计服务用户指南。

责任共担 华为云秉承“将公司对网络和业务安全性保障的责任置于公司的商业利益之上”。针对层出不穷的云安全挑战和无孔不入的云安全威胁与攻击，华为云在遵从法律法规业界标准的基础上，以安全生态圈为护城河，依托华为独有的软硬件优势，构建面向不同区域和行业的完善云服务安全保障体系。 安全性是华为云与您的共同责任，如图1所示。 华为云：负责云服务自身的安全，提供安全的云。华为云的安全责任在于保障其所提供的 IaaS、PaaS 和 SaaS 各类各项云服务自身的安全，涵盖华为云数据中心的物理环境设施和运行其上的基础服务、平台服务、应用服务等。这不仅包括华为云基础设施和各项云服务技术的安全功能和性能本身，也包括运维运营安全，以及更广义的安全合规遵从。 租户：负责云服务内部的安全，安全地使用云。 华为云租户的安全责任在于对使用的 IaaS、PaaS 和 SaaS 类各项云服务内部的安全以及对租户定制配置进行安全有效的管理，包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统，虚拟防火墙、API 网关和高级安全服务，各项云服务，租户数据，以及身份帐号和密钥管理等方面的安全配置。 《华为云安全白皮书》详细介绍华为云安全性的构建思路与措施，包括云安全战略、责任共担模型、合规与隐私、安全组织与人员、基础设施安全、租户服务与租户安全、工程安全、运维运营安全、生态安全。 图1 华为云安全责任共担模型 父主题： 安全

参数填写 表1 验证备案类型参数说明 参数 说明 地域 对于个人备案，请根据您的身份证所在地、或实际居住地选择备案提交的地域。是否允许跨省备案，需以各地管局要求为准。 对于单位备案，请根据主体证件签发地（如营业执照工商注册地），选择备案提交的地域。不能选择非企业主体证件签发地的省份。 主办单位性质 请按照实际单位性质进行选择。 如：企业法定代表人请选择“企业”，事业法定代表人请选择“事业单位”。 其中，个人备案与单位备案的介绍，请参见个人备案与单位备案FAQ。 主办单位名称 请输入主办单位名称。 证件类型 请根据主办单位性质，选择正确的证件类型。 证件号码 请输入主办单位证件号码。 资源类型 请选择需要备案的对应云服务， 如选择ECS，需为包周期且不小于1个月。 如使用备案授权码，请到“授权码管理”中申请。如何获取及使用“备案授权码”，具体请参考如何获取及使用“备案授权码”。 按需购买云服务器，暂不支持备案。 互联网信息服务类型 网站备案请选择网站。 APP备案请选择APP。 域名/APP名称 网站备案请填写需备案的域名，格式如：huaweicloud.com APP备案请填写需备案的APP名称。

注意事项 验证备案类型时，需注意以下事项： 需注意证件类型、证件号码、域名等全部填写正确。如： 企业、域名从未申请过备案，证件号码填写统一社会信用代码； 企业或域名已在工信部做过备案，证件类型、证件号码务必填写与工信部备案的一致（若不确定请联系原接入商查询）。 同一网站多个域名时，验证备案类型只需填写一个域名，且为顶级域名，如：*****.com。 不同网站的域名，请分开填写验证备案类型。 验证备案类型的信息通过验证后不可再修改，请务必填写正确。若验证的关键信息填写错误需整条撤销后重新单击“我要备案”填写。

结构化模板日志详情 GAUSSV5审计日志示例 表1 结构化模板示例 模板名称 示例日志 GAUSSV5审计日志 { "username": "rdsAdmin", "client_conninfo": "cm_agent@10.254.95.70", "instanceId": "96e86f462bbc4f2286d7c8274815d0fein14", "detail_info": "xid=30818, SET statement_timeout = 10000000;n", "thread_id": "140463114942208@713872403507507", "result": "ok", "database": "postgres", "local_port": "8001", "userid": "10", "nodeId": "06c267fad8054a0abcb17cfa3b8f260cno14", "node_name": "dn_6001_6002_6003", "object_name": "statement_timeout", "time": "2022-08-15 17:53:23+08", type: "set_parameter", "remote_port": "50952" } 结构化字段及字段说明 表2 结构化字段 字段 示例 描述 类型 username rdsAdmin 用户名 string client_conninfo cm_agent@10.254.95.70 客户端连接信息 string instanceId 96e86f462bbc4f2286d7c8274815d0fein14 实例ID string detail_info xid=30818, SET statement_timeout = 10000000;n 执行的SQL语句 string thread_id 140463114942208@713872403507507 线程ID string result ok SQL执行结果 string database postgres 使用的数据库 string local_port 8001 本地端口 string userid 10 用户ID string nodeId 06c267fad8054a0abcb17cfa3b8f260cno14 节点ID string node_name dn_6001_6002_6003 节点名称 string object_name statement_timeout 对象的名称 string time 2022-08-15 17:53:23+08 审计日志时间 string type set_parameter SQL开始执行时间 string remote_port 50952 远程端口 string

操作步骤 登录控制台。 单击页面右上角的用户名，选择“统一身份认证”。 在“统一身份认证”页面中，单击“委托”，进入委托页面。 单击右上角“创建委托”，参考下表设置参数。 表1 创建委托 名称 说明 委托名称 标识该委托代理的名称，示例：lts_ecm_trust。 委托类型 选择“云服务”。 云服务 选择“弹性云服务器ECS 裸金属服务器BMS”。 持续时间 选择“永久”。 描述 可选参数，用于补充说明该委托代理的详细信息。 单击“下一步”，在选择策略页面，无需进行授权。 单击“下一步”，关闭提示窗页面，返回委托页面，即可看到创建成功的委托名称。

响应示例 状态码： 200 OK { "total" : 1, "data" : [ { "task_id" : "017281b97c9845b08174895992ba179643028", "task_name" : "测试任务1", "url" : "https://127.0.0.1:8080", "task_type" : "normal", "domain_name" : "127.0.0.1:8080", "task_settings" : { "task_config" : { "scan_mode" : "normal", "port_scan" : false, "weak_pwd_scan" : false, "cve_check" : false, "text_check" : false, "picture_check" : false, "malicious_code" : false, "malicious_link" : false } }, "create_time" : "2021-09-18 16:26:24", "start_time" : "2021-09-18 16:26:24", "end_time" : "2021-09-18 17:00:00", "task_status" : "success", "progress" : 100, "reason" : "Successful. Your website is very safe!", "pack_num" : 5, "score" : 100, "safe_level" : "safety", "statistics" : { "high" : 0, "middle" : 0, "low" : 0, "hint" : 0 } } ] }

URI GET /v3/{project_id}/webscan/tasks/histories 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户的project_id，获取方法请参见获取项目ID。 最小长度：32 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 domain_id 是 String 网站域名ID 最小长度：32 最大长度：32 offset 否 Integer 分页查询，偏移量，表示从此偏移量开始查询 最小值：0 最大值：10000 缺省值：0 limit 否 Integer 分页查询，每页显示的条目数量 最小值：1 最大值：10000 缺省值：5

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 网站历史扫描任务总数 最小值：0 最大值：100000 data Array of ShowTasksResponseBody objects 网站历史扫描任务列表 数组长度：0 - 100000 表5 ShowTasksResponseBody 参数 参数类型 描述 task_name String 任务名称 最小长度：1 最大长度：16 url String 待扫描的目标网址 最小长度：1 最大长度：256 task_type String 扫描任务类型: normal - 普通任务 monitor - 监测任务 缺省值：normal 枚举值： normal monitor task_id String 任务ID 最小长度：32 最大长度：50 domain_name String 网站域名 最小长度：1 最大长度：256 task_settings TaskSettings object 扫描任务设置 create_time String 创建任务的时间 最小长度：0 最大长度：19 start_time String 任务启动的时间 最小长度：0 最大长度：19 end_time String 任务结束的时间 最小长度：0 最大长度：19 task_status String 任务状态: running - 正在运行 success - 成功 canceled - 已取消 waiting - 正在等待 ready - 已就绪，排队中 failure - 失败 枚举值： running success canceled waiting ready failure schedule_status String 监测任务状态: running - 正在运行 waiting - 正在等待 finished - 已完成 枚举值： running waiting finished progress Integer 任务进度 最小值：0 最大值：100 reason String 任务状态描述 最小长度：0 最大长度：128 pack_num Long 包总数 最小值：0 最大值：100000 score Integer 安全分数 最小值：0 最大值：100 safe_level String 安全等级: safety - 安全 average - 中风险 highrisk - 高风险 枚举值： safety average highrisk statistics VulnsLevel object 漏洞风险等级统计 表6 TaskSettings 参数 参数类型 描述 timer String 普通任务的定时启动时间 最小长度：0 最大长度：19 trigger_time String 监测任务的定时触发时间 最小长度：0 最大长度：19 task_period String 监测任务的定时触发周期: everyday - 每日 threedays - 每三天 everyweek - 每星期 everymonth - 每月 枚举值： everyday threedays everyweek everymonth task_config task_config object 扫描任务配置 表7 task_config 参数 参数类型 描述 scan_mode String 扫描模式: fast - 快速扫描 normal - 标准扫描 deep - 深度扫描 缺省值：normal 枚举值： fast normal deep port_scan Boolean 是否进行端口扫描 缺省值：true weak_pwd_scan Boolean 是否进行弱密码扫描 缺省值：true cve_check Boolean 是否进行CVE漏洞扫描 缺省值：true text_check Boolean 是否进行网站内容合规文字检测 缺省值：true picture_check Boolean 是否进行网站内容合规图片检测 缺省值：false malicious_code Boolean 是否进行网站挂马检测 缺省值：false malicious_link Boolean 是否进行链接健康检测（死链、暗链、恶意外链） 缺省值：false 表8 VulnsLevel 参数 参数类型 描述 high Integer 高危漏洞数 最小值：0 最大值：1000 middle Integer 中危漏洞数 最小值：0 最大值：1000 low Integer 低危漏洞数 最小值：0 最大值：1000 hint Integer 提示危漏洞数 最小值：0 最大值：1000 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256 状态码： 401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256 状态码： 418 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256

响应示例 状态码： 200 OK { "info_code" : "success", "info_description" : "Operation succeeded", "usage_notice" : "使用须知： 1、您的账号已完成实名认证，且非受限账号。 2、您确认您已获得对扫描对象进行扫描的相关合法权利。 3、您确认您的扫描行为有合法合理目的，且符合适用的法律法规要求，不得利用本服务从事任何黑灰产等非法活动。 4、若您违反上述承诺，我们有权立即终止您对本服务的使用，并要求您对我们及相关第三方因此遭受的损失进行赔偿。" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 info_code String 状态码: success - 成功 failure - 失败 枚举值： success failure info_description String 返回的提示信息 最小长度：0 最大长度：64 usage_notice String 网站域名认证使用须知 最小长度：0 最大长度：1000 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256 状态码： 418 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：102400 表3 请求Body参数 参数 是否必选 参数类型 描述 domain_name 是 String 网站域名 最小长度：1 最大长度：256 auth_mode 否 String 认证方式: file - 文件认证 auto - 一键认证 free - 免认证，选择此项默认已阅读并了解下述使用要求 使用须知： 1、您的账号已完成实名认证，且非受限账号。 2、您确认您已获得对扫描对象进行扫描的相关合法权利。 3、您确认您的扫描行为有合法合理目的，且符合适用的法律法规要求，不得利用本服务从事任何黑灰产等非法活动。 4、若您违反上述承诺，我们有权立即终止您对本服务的使用，并要求您对我们及相关第三方因此遭受的损失进行赔偿。 缺省值：file 枚举值： file auto free

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：102400 表3 请求Body参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID 最小长度：32 最大长度：50 action 是 String 对扫描任务的操作: cancel - 取消扫描任务 restart - 重启扫描任务 枚举值： cancel restart