华为云用户手册

发布订阅服务器兼容矩阵 表1 发布订阅服务器兼容矩阵 发布者（除Web版之外） 分发服务器（除Web版之外） 订阅服务器 SQL Server 2019 SQL Server 2019 RDS for SQL Server支持的全部版本 SQL Server 2017 SQL Server 2019 SQL Server 2017 SQL Server 2016 SQL Server 2019 SQL Server 2017 SQL Server 2016 SQL Server 2014 SQL Server 2019 SQL Server 2017 SQL Server 2016 SQL Server 2014 SQL Server 2012 SQL Server 2019 SQL Server 2017 SQL Server 2016 SQL Server 2014 SQL Server 2012 SQL Server 2008 R2 SQL Server 2019 SQL Server 2017 SQL Server 2016 SQL Server 2014 SQL Server 2012 SQL Server 2008 R2

创建订阅 在“实例管理”页面，选择目标实例，单击实例名称，进入实例的“基本信息”页面。 在左侧导航栏选择“发布订阅”。 选择“订阅”页签，单击“创建订阅”。 单击“添加发布”。 在弹出框中，设置发布参数，单击“确定”。 选择发布：勾选分发服务器及已创建的发布，单击同步到右侧，即从已勾选的分发服务器上同步数据到当前实例。 RDS for SQL Server支持的发布订阅服务器参考发布订阅服务器兼容矩阵。 订阅方式：推送订阅 同步策略：选择数据订阅的同步方式，支持按天、按周、按月自定义策略。 图1 添加发布 选择目标数据库，即选择需要把发布订阅到当前实例哪个数据库，单击“确定”。 图2 选择目标数据库 查看已创建的订阅。 图3 订阅 单击“删除”，删除订阅。

相关参数说明 对于和CPU相关的参数（即参数值与CPU变动有关，内存变动时不会影响取值）：threadpool_size、slave_parallel_workers，参考如下表格规则重置参数值： 表2 CPU变更场景下重置参数值 场景 参数值无修改 参数值有修改 升配（CPU升高） 重置为新规格的默认值 在修改值与新规格默认值之间优先取较大的值，即Max(default，custom) 降配（CPU降低） 重置为新规格的默认值 在修改值与新规格默认值之间优先取较小的值，即Min(default，custom) 对于和内存相关的参数（即参数值与内存变动有关，CPU变动时不会影响取值）：innodb_buffer_pool_size、innodb_log_buffer_size、innodb_log_files_in_group、max_connections、innodb_page_cleaners、innodb_buffer_pool_instances和back_log，参考如下表格规则重置参数值： 表3 内存变更场景下重置参数值 场景 参数值无修改 参数值有修改 升配（内存升高） 重置为新规格的默认值 在修改值与新规格默认值之间优先取较大的值，即Max(default，custom) 降配（内存降低） 重置为新规格的默认值 在修改值与新规格默认值之间优先取较小的值，即Min(default，custom) 以下参数没有修改时，重置为新规格默认值，有修改时保留修改值：innodb_io_capacity、innodb_io_capacity_max。

约束限制 账户余额大于等于0元，才可变更规格。 当实例进行CPU/内存规格变更时，该实例不可被删除。 当实例进行CPU/内存规格变更时，不能对该实例做如下操作：重启数据库、扩容磁盘、修改参数组、创建手动备份、创建数据库账号、创建数据库等。 RDS for MySQL实例支持规格升配，也支持降配。 本地盘规格变更时，变更后的目标规格的存储上限不能小于当前实例的存储容量。 变更规格会临时占用IP，且变更后不会立即释放（默认12小时后释放）。变更规格前，请确保有未被使用的内网地址（主备实例：2个未被使用的内网地址；单机实例：1个未被使用的内网地址；只读实例：1个未被使用的内网地址），否则变更规格会失败。 变更过程中若存在大事务，可能导致变更失败。 变更规格会导致业务中断，请确保您的应用有自动重连机制。请在业务低峰期变更规格，在业务高峰期执行会导致变更时长变长。 关于变更规格所需的时间（非业务高峰期）： 对于云盘存储类型的实例，此过程需要5～15分钟。 对于本地盘存储类型的实例，需要通过备份恢复到新本地盘机器的方式进行规格变更，花费的总体时间与数据量相关。 超过变更时长，请及时联系华为云客服。 选择可维护时间段变更规格，提交后在定时任务中可选择立即切换（如果界面没有立即切换，请联系客服申请），关于变更规格所需的时间：业务高峰期时，可能存在复制时延高的情况，切换所需时间可能会较长。

计费说明 表1 计费说明 计费模式 变更操作 对费用的影响 包年/包月 规格升配 升配后，新规格将在原来已有的时间周期内生效。 您需要按照与原规格的价格差，结合使用周期内的剩余时间，补交差价。 例如：（以下价格仅作示例，实际价格以控制台显示为准） 客户于2023/6/1在华北-北京四购买规格为通用型 2vCPUs 8GB的RDS for MySQL 5.7单机实例，SSD云盘存储，存储空间40GB，购买周期为一个月。此时实例价格为230元/月。 客户在2023/6/15将规格变更为通用型 4vCPUs 8GB，实例价格为400元/月。 升配费用 = 新规格价格 x 剩余周期 - 旧规格价格 x 剩余周期 公式中的剩余周期为每个自然月的剩余天数/对应自然月的最大天数。 本示例中，剩余周期=15（6月份剩余未使用天数）/ 30（6月份最大天数）= 0.5，代入公式可得升配费用 = 400 x 0.5 - 230 x 0.5 = 85元 规格降配 降配后，新规格将在原来已有的时间周期内生效。 RDS按照与原规格的价格差，结合使用周期内的剩余时间，退回差价。 例如：（以下价格仅作示例，实际价格以控制台显示为准） 客户于2023/6/1在华北-北京四购买规格为通用型 2vCPUs 8GB的RDS for MySQL 5.7单机实例，SSD云盘存储，存储空间40GB，购买周期为一个月。此时实例价格为230元/月。 客户在2023/6/15将规格变更为通用型 2vCPUs 4GB，实例价格为196元/月。 退回费用 = 旧规格价格 x 剩余周期 - 新规格价格 x 剩余周期 公式中的剩余周期为每个自然月的剩余天数/对应自然月的最大天数。 本示例中，剩余周期=15（6月份剩余未使用天数）/ 30（6月份最大天数）= 0.5，代入公式可得退回费用 = 230 x 0.5 - 196 x 0.5 = 17元 按需计费 规格升配 变更规格成功后，新规格按小时计费。具体请参见产品价格详情。 规格降配

开启CBR备份的约束限制 备份时长与实例数据量大小成正比，如果数据量较大，可联系客服开通CBR快照备份功能提高备份速率。 开启CBR备份后，备份策略为快照备份，已有的自动备份和手动备份的恢复功能正常使用。 开启CBR备份后，当数据库实例被删除时，实例的自动备份将被同步删除，手动备份不会被删除。 实例在进行CBR快照备份时，不支持下发DDL操作，如果有正在执行的DDL操作，会在DDL操作结束后再进行快照备份。 开启CBR备份后，下一次生成的全量备份为快照备份，使用该备份进行恢复，为CBR快照恢复。

操作场景 创建云数据库RDS实例时，系统默认开启自动备份策略，安全考虑，实例创建成功后不可关闭。您可根据业务需要设置自动备份策略，云数据库RDS服务按照您设置的自动备份策略对数据库进行备份。 云数据库RDS服务的备份操作是实例级的，而不是数据库级的。当数据库故障或数据损坏时，可以通过备份恢复数据库，从而保证数据可靠性。备份以压缩包的形式存储在对象存储服务上，以保证用户数据的机密性和持久性。由于开启备份会损耗数据库读写性能，建议您选择业务低峰时间段设置自动备份。 设置自动备份策略后，会按照策略中的备份时间段和备份周期进行全量备份。实例在执行备份时，按照策略中的保留天数进行存放，备份时长和实例的数据量有关。 在进行全量备份的同时系统每5分钟或一定数据量时会自动生成增量备份，用户不需要设置。生成的增量备份可以用来将数据恢复到指定时间点。

未开启CBR备份的约束限制 备机故障、备机复制时延超过240s的主备实例，备份会到主机上执行。 当数据库实例被删除时，实例的自动备份将被同步删除，手动备份不会被删除。 全量备份时不允许重启数据库，请谨慎选择备份时间段。 全量备份时，会连接备份所属的实例，校验该实例的状态。如果校验存在以下两种情况，则校验不通过，会自动进行校验重试。如果重试结束后，仍然无法满足，则备份失败。 备份所属的实例正在执行DDL操作。 从备份所属的实例获取备份锁失败。 全量备份会占用节点资源，尤其是磁盘带宽。可能会导致实例吞吐量下降，复制时延等问题。

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 compute_flavor_groups Array of objects 规格组信息。 详情请参见表4。 表4 compute_flavor_groups元素结构说明 名称 参数类型 说明 group_type String 规格组类型。 枚举值： X86 ARM compute_flavors Array of objects 规格信息。 详情请参见表5。 表5 compute_flavors元素结构说明 参数 参数类型 描述 id String 数据库代理规格ID。 code String 数据库代理规格码。 cpu String CPU大小。例如：1表示1U。 mem String 内存大小，单位为GB。 db_type String 数据库类型。 az_status Object 可用区信息，其中key是该规格绑定的可用区，value是该规格在对应可用区中的状态。仅展示数据库主实例所在可用区规格状态。 取值： normal：正常 abandon：禁用 正常响应样例 { "compute_flavor_groups" : [ { "group_type" : "X86", "compute_flavors" : [ { "id" : "3208f282-7815-4ff8-9466-90a6fedd6b52", "code" : "rds.proxy.large.2", "cpu" : "2", "mem" : "4", "db_type" : "Proxy", "az_status" : { "aaa" : "normal" } } ] } ] } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/proxy/flavors 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 表2 请求参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

响应消息 正常响应要素说明 名称 说明 workflowId 任务ID。 instanceId 实例ID。 nodeId 节点ID。 正常响应样例 { "workflowId":"072beb09-0573-40bf-bfe8-4be5cec9e85a", "instanceId":"794c38e5309344818f4b33b86ebce9b4in03", "nodeId":"b94ba815747040f1b0d641cd13364a06no03" } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 字段说明 名称 参数类型 说明 proxy_query_info_list Array of objects 数据库实例下的数据库代理信息列表。 请参见表3。 max_proxy_num Integer 支持同时开启的数据库代理的最大数量。 max_proxy_node_num Integer 单个数据库代理支持选择的最大节点数量。 support_balance_route_mode_for_favored_version Boolean 是否支持创建数据库代理时设置负载均衡路由模式。 表3 proxy_query_info_list字段数据结构说明 名称 参数类型 说明 proxy Object 数据库代理信息。 请参见表4。 master_instance Object 数据库主实例信息。 请参见表7。 readonly_instances Array of objects 数据库只读实例信息。 请参见表7。 proxy_security_group_check_result Boolean 安全组是否放通该数据库代理到数据库的网络地址。 表4 proxy字段数据结构说明 参数 参数类型 描述 pool_id String 数据库代理实例ID。 status String 数据库代理状态。取值： ENABLING：表示数据库代理正在开启。 DISABLING：表示数据库代理正在关闭。 CHANGING_NODE_NUM：表示数据库代理正在调整节点数量。 SCALING: 表示数据库代理正在规格变更。 UPGRADING: 表示数据库代理正在升级内核版本。 IPMODIFYING: 表示数据库代理正在修改读写分离地址。 RESTARTING: 表示数据库代理正在重启进程。 TRANSACTION_SPLITTING: 表示数据库代理正在变更事务拆分功能状态。 CONNECTION_POOL_SWITCH_OPERATING: 表示数据库代理正在变更会话连接池类型。 PORT_MODIFYING: 表示数据库代理正在修改端口。 PROXY_SSL_SWITCHING: 表示数据库代理正在变更SSL状态。 ALT_SWITCH_OPERATING: 表示数据库代理正在变更ALT状态。 CHANGING_RESOURCES: 表示数据库代理正在进行资源变更。 NORMAL: 表示数据库代理正常。 ABNORMAL: 表示数据库代理异常。 FAILED: 表示数据库代理创建失败。 FROZEN: 表示数据库代理已冻结。 address String 读写分离地址。 port Integer 端口号。 delay_threshold_in_seconds Integer 延时阈值，单位：秒。 cpu String 数据库代理规格的CPU大小。 mem String 数据库代理规格的内存大小。 node_num Integer 数据库代理节点个数。 nodes Array of objects 数据库代理节点信息列表。 请参见表5。 mode String 数据库代理集群模式。取值： Cluster：集群模式 Ha：主备模式 flavor_info Object 数据库代理规格信息。 请参见表6。 transaction_split String 数据库代理事务拆分开关状态。 true：开启。 false：关闭。 connection_pool_type String 连接池类型。 取值： CLOSED：关闭连接池。 SESSION：开启会话级连接池。 pay_mode String 数据库代理计费模式。 取值： 0：按需计费 1：包周期计费 name String 数据库代理名称。 proxy_mode String 数据库代理读写模式。取值： readwrite：读写模式 readonly：只读模式 dns_name String 数据库代理读写分离地址内网域名。该字段为空表示未申请读写内网域名。 subnet_id String 数据库代理实例所属子网ID。 seconds_level_monitor_fun_status String 数据库代理秒级监控状态。 枚举值： off on alt_flag Boolean ALT开关状态。 force_read_only Boolean 是否强制读路由到只读。 route_mode Integer 数据库代理路由模式。取值： 0：表示权重负载模式。 1：表示负载均衡模式（数据库主实例不接受读请求）。 2：表示负载均衡模式（数据库主实例接受读请求）。 ssl_option Boolean ssl开关状态。 support_balance_route_mode Boolean 数据库代理是否支持开启负载均衡路由模式。 support_proxy_ssl Boolean 数据库代理是否支持开启ssl功能。 support_switch_connection_pool_type Boolean 数据库代理是否支持切换会话连接池类型。 support_transaction_split Boolean 数据库代理是否支持开启事务拆分。 表5 nodes字段数据结构说明 参数 参数类型 描述 id String 数据库代理节点ID。 status String 数据库代理节点状态。 取值： NORMAL: 表示节点正常。 ABNORMAL: 表示节点节点状态异常。 CREATING: 表示节点正在创建中。 CREATEFAIL: 表示节点创建失败。 role String 数据库代理节点角色。 master：主节点。 slave：备节点。 az_code String 数据库代理节点所在可用区。 frozen_flag Integer 数据库代理节点是否被冻结。 取值： 0：未冻结。 1：冻结。 表6 flavor_info字段数据结构说明 参数 参数类型 描述 group_type String 规格类型。 枚举值： X86 ARM code String 规格码。 表7 readonly_instances字段数据结构说明 参数 参数类型 描述 id String 数据库主实例或只读实例ID。 status String 节点状态。 name String 数据库实例名称。 weight Integer 数据库实例读权重。 available_zones Array of objects 可用区信息。 请参见表8。 表8 available_zones字段数据结构说明 参数 参数类型 描述 code String 可用区编码。 description String 可用区描述。 正常响应样例 { "proxy_query_info_list" : [ { "proxy" : { "pool_id" : "e06ecf4dfea8409690c87a9ee6582b0dpo01", "status" : "NORMAL", "address" : "192.168.0.1", "port" : 3306, "delay_threshold_in_seconds" : 30, "cpu" : "2", "mem" : "4", "node_num" : 2, "nodes" : [ { "id" : "3079919890f24fb8ab284571fc409058pn01", "status" : "NORMAL", "role" : "master", "az_code" : "aaa", "frozen_flag" : 0 }, { "id" : "804430ac9068419fa5e49d5ca0684172pn01", "status" : "NORMAL", "role" : "master", "az_code" : "aaa", "frozen_flag" : 0 } ], "mode" : "Cluster", "flavor_info" : { "group_type" : "X86", "code" : "rds.proxy.large.2" }, "transaction_split" : "false", "connection_pool_type" : "CLOSED", "pay_mode" : "0", "name" : "test-hll", "proxy_mode" : "readwrite", "route_mode" : 1, "dns_name" : "", "subnet_id" : "2f75f35c-62ca-43b7-9954-8fd1e6be4641", "ssl_option" : false, "force_read_only" : false, "seconds_level_monitor_fun_status" : "off", "alt_flag" : false, "support_transaction_split" : true, "support_switch_connection_pool_type" : true, "support_balance_route_mode" : true, "support_proxy_ssl" : true }, "master_instance" : { "id" : "920ec36cef814a8b830a5bed50d9a088in01", "status" : "normal", "name" : "rds-2c54", "weight" : 0, "available_zones" : [ { "code" : "aaa", "description" : "az3" } ] }, "readonly_instances" : [ { "id" : "f9462b58982d484fb64fd9880504d863in01", "status" : "abnormal", "name" : "replica-f966", "weight" : 0, "available_zones" : [ { "code" : "aaa", "description" : "az3" } ] } ], "proxy_security_group_check_result" : false } ], "max_proxy_num" : 4, "max_proxy_node_num" : 4, "support_balance_route_mode_for_favored_version" : true } 异常响应 请参见异常请求结果。

请求示例 更新数据库db1的插件pg_stat_statements。 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in03/extensions { "database_name" : "db1", "extension_name" : "pg_stat_statements" }

API概览 通过使用漏洞管理服务提供的接口，您可以完整的使用漏洞管理服务的所有功能。 类型 说明 网站域名管理 网站域名相关接口，包含创建域名、获取域名、删除域名，以及更新或获取域名配置。 网站任务管理 网站任务相关接口，包含创建扫描任务并启动、获取扫描任务详情、取消或重启扫描任务和获取域名的历史扫描任务。 网站报告管理 网站报告相关接口，包含获取扫描结果、业务风险扫描结果，以及更新漏洞的误报状态。 主机管理 主机相关接口，包含创建主机，获取主机，删除主机。 主机任务管理 主机任务相关接口，包含启动或停止扫描任务。 主机报告管理 主机报告相关接口，包含主机扫描结果获取。 主机组管理 主机组相关接口，包含主机组创建，获取，删除。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 Content-Type: application/json X-Auth-Token: ABCDEFJ....

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

从控制台获取项目ID 在调用接口的时候，部分URL中需要填入项目编号，所以需要获取到项目编号。项目编号获取步骤如下： 登录管理控制台。 单击用户名，在下拉列表中单击“基本信息”。 在基本信息页面单击“管理我的凭证”。 在“API凭证”“我的凭证”页面的项目列表中查看项目ID。 单击用户名，在下拉列表中单击“我的凭证”“My Credential”。 在“我的凭证”“My Credential”页面的项目列表中查看项目ID。 图1 查看项目ID 图2 查看项目ID 图3 查看项目ID 图4 查看项目ID

响应示例 状态码： 200 OK { "total" : 1, "data" : [ { "risk_id" : "fff18e42a6deeffb83f9e37f741e687ed2a3dd1a", "risk_url" : "https://127.0.0.1:8080/links/index.php1", "risk_type" : "dead_link", "risk_content" : "http://evilllllllllll.com/code.txt700", "risk_status" : "repairing", "find_time" : "2021-09-18 16:26:24" } ] }

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 业务风险总数 最小值：0 最大值：100000 data Array of BusinessRiskItem objects 业务风险列表 数组长度：0 - 100000 表5 BusinessRiskItem 参数 参数类型 描述 risk_id String 业务风险ID 最小长度：40 最大长度：40 risk_url String 有风险的URL 最小长度：1 最大长度：256 risk_type String 业务风险类型: text - 不合规文字 image - 不合规图片 dead_link - 不合规链接（死链） dark_link - 不合规链接（暗链） business_risk - 业务风险 枚举值： text image dead_link dark_link business_risk find_time String 业务风险发现时间 最小长度：0 最大长度：19 risk_content String 业务风险内容 最小长度：0 最大长度：100000 risk_status String 漏洞状态: repairing - 未修复 repaired - 已修复 false_report - 误报，已忽略 枚举值： repairing repaired false_report 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256 状态码： 418 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256

URI GET /v3/{project_id}/hostscan/groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String project_id 最小长度：32 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页查询，偏移量，表示从此偏移量开始查询 最小值：0 最大值：200 缺省值：0 limit 否 Integer 分页查询，每页显示的条目数量 最小值：1 最大值：100 缺省值：5

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 群组总数 最小值：0 最大值：1000 items Array of Group objects 群组列表 数组长度：0 - 1000 表5 Group 参数 参数类型 描述 id String 群组ID 最小长度：1 最大长度：64 name String 群组名称 最小长度：1 最大长度：24 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256 状态码： 418 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256

响应示例 状态码： 200 OK { "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 } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 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 漏洞风险等级统计 表5 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 扫描任务配置 表6 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 表7 VulnsLevel 参数 参数类型 描述 high Integer 高危漏洞数 最小值：0 最大值：1000 middle Integer 中危漏洞数 最小值：0 最大值：1000 low Integer 低危漏洞数 最小值：0 最大值：1000 hint Integer 提示危漏洞数 最小值：0 最大值：1000 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256 状态码： 418 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256 状态码： 418 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 info_code String 状态码: success - 成功 failure - 失败 枚举值： success failure info_description String 返回的提示信息 最小长度：0 最大长度：64 状态码： 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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 端口总数 最小值：0 最大值：100000 data Array of PortItem objects 端口信息列表 数组长度：0 - 100000 表5 PortItem 参数 参数类型 描述 port Integer 端口号 最小值：0 最大值：65535 service String 服务 最小长度：0 最大长度：1000 protocol String 端口协议: TCP UDP 枚举值： TCP UDP status String 端口状态: filtered - 过滤的 open - 开放 枚举值： filtered open 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256 状态码： 418 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256

响应示例 状态码： 200 OK { "total" : 1, "data" : [ { "port" : 22, "service" : "Secure Shell (SSH), secure logins, file transfers (scp, sftp) and port forwarding", "protocol" : "TCP", "status" : "open" } ] }

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

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 items Array of HostItemWithId objects 创建的主机列表 数组长度：1 - 100 total Integer 主机总数 最小值：0 最大值：100 表6 HostItemWithId 参数 参数类型 描述 ip String 主机IP 最小长度：7 最大长度：15 name String 主机名称 最小长度：1 最大长度：64 os_type String 操作系统类型: linux windows 枚举值： linux windows group_id String 主机组id 最小长度：1 最大长度：64 ssh_credential_id String linux主机ssh授权登录信息ID 最小长度：1 最大长度：64 jumper_server_id String linux跳板机信息ID 最小长度：1 最大长度：64 smb_credential_id String windows主机smb授权登录信息ID 最小长度：1 最大长度：64 id String 主机ID 最小长度：1 最大长度：64 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256 状态码： 418 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：50 error_msg String 错误描述 最小长度：0 最大长度：256