接口功能介绍 一键检测漏洞。 接口约束 此功能为收费功能。确认已经购买系统配额，并且开启服务器防护。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护。 URI POST /v1/vulnerability/now 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String ContentType application/json 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 agentGuidList 否 Array of Strings 作用guid列表 ["testguid"] scopeType 是 String 作用范围 ALL全部主机 OPTIONAL自选主机 ALL vulType 是 Array of Strings 漏洞类型 LINUXlinux漏洞，WINDOWSwindows漏洞, EMERGENCYVUL应急漏洞,APPLICATION应用漏洞,WEBCMSwebcms漏扫 ["LINUX", "WINDOWS"] scanType 否 String 为空默认为ALL全部 ALL全部 VUL指定应急漏洞进行扫描 ALL vulAnnouncementId 否 String 指定的应急漏洞公告id testvulid 响应参数 参数 参数类型 说明 示例 下级对象 error String 返回码 CTCSSCN000000：成功 CTCSSCN000001：失败 CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN000004：鉴权错误 CTCSSCN000005：用户没有付费版配额，功能不可用 CTCSSCN000000 message String 返回信息 success returnObj Object 返回对象 traceId String traceId 211111111111111111111 statusCode String 状态码 200成功 200

接口功能介绍 生成并导出数据密钥 接口约束 请保证账户余额大于0 URI POST /v1/keyCompute/generateAndExportDataKey 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keySpec 否 String 指定生成数据密钥类型 AES256 numberOfBytes 否 String 指定生成的密钥长度 128 publicKeyBlob 是 String base64格式的公钥 wrappingAlgorithm 是 String 使用publicKeyBlob所指定的公钥，加密（Wrap）数据密钥时的加密算法 wrappingKeySpec 是 String Publickeyblob的密钥类型 RSA128 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 加密数据成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 exportedDataKey String 导出的数据密钥密文 AK0Fq+zuxUitFTmOpyJkJb8VsjR7t8RLFGMSLxsiuK6s6/8dyQmlI5lxCxBFDfuRT9bpLqLAlKNm7DM+NzYNNwshq1GsX7+ujaTfHIt5a4QOW5mLdnPEpdpbUfOHzXlV3pvToDC24wPJjw7KcIQMqchfOzuixXWtreEVf8LK4J1hMiVp1VuiDO2HR1dUjk+RZVsQKlZy0xf55qN4uffknp1c7bwv5Fd1mPIVzBjvjdz9h+8gTG2VVygN1uHo0tCCljQRKFGLo67y/E8Dn8qyWANWKhPl0dkjNrOtRvwm1kNK7cunPIECkpYm1lHnBPO3QPkzIC7t5dQJzu3T0iMAAg requestId String 请求id 2a56124813ed4ef7a359e818dce118d8 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 ciphertextBlob String 数据密钥密文 itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba dataKeyId String 数据密钥id 012ea0d1862a488b956e107ffae5059f

接口功能介绍 本接口用于启动设备的云端录制。 接口约束 仅设备绑定的视频录制模板为手动录制且设备和流在线时，可以手动启用云端录制。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI PUT /v2/devices//records/startCloudRecord 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 32388487739092996 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 StreamNum 否 Integer 第几个码流，默认主码流，gb28181和rtmp设备仅支持主码流。取值：1：主码流；2：子码流；3：第三码流。 1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 RecordTaskId String 录制任务 ID，全局唯一标识录制任务。 725245970006753281 CreatedTime String 录制任务创建时间。 20230506 15:29:18 UpdatedTime String 录制任务更新时间。 20230506 15:59:53 RequestId String 请求ID。 4a76b6697563462dbe99955b9d5140c9

本文介绍基础配置所涉及的配置，包括：验证域名归属权、选定加速类型、选定加速区域、IPv6开关。 概述 添加加速域名、验证域名归属权、选定合适的加速类型、选定正确的加速区域，是您使用天翼云全站加速服务最基础且关键的一步。 功能简介 功能 说明 对应说明文档 域名名称 1.即加速域名，为需要使用加速服务的域名，支持泛域名。 2.在添加加速域名环节，需您先通过域名归属权验证，证明您拥有该域名的使用权，才能完成域名添加。 添加加速域名 验证域名归属权 CNAME 完成加速域名添加后，系统会为您分配一个天翼云的CNAME域名， 您需要在您的DNS解析服务商添加CNAME记录，将自己的加速域名指向CNAME域名，这样该域名所有的请求才会转向天翼云的节点，实现加速的目的。 配置CNAME 域名状态 状态分类：已启用、配置中、已停用。 1.当域名状态为【已启用】时，可以在【域名管理>域名列表】对域名配置进行【查看】、【编辑】、【更多】【停用】操作。 2.当域名状态为【配置中】时，可以在【域名管理>域名列表】对域名配置进行【查看】操作。 3.当域名状态为【已停止】时，可以在【域名管理>域名列表】对域名配置进行【查看】、【启用】操作。 —— 加速类型 依据业务特性，选取合适的加速类型。 加速类型 加速区域 切换加速区域，变更全站加速的服务范围。 加速区域 域名类型 天翼云全站加速产品提供三种业务类型的加速：全站加速、上传加速、websocket加速，您可以在添加域名时选择不同的域名类型来对不同的业务进行加速。 域名类型 创建时间 显示该域名在平台首次创建成功的时间。 —— IPv6配置 开启IPv6功能后，您可以在客户端通过IPv6协议访问全站加速节点。 IPv6配置

本节为您介绍云迁移服务CMS服务器迁移中Linux迁移任务相关配置。 自定义分区 根据源机分区自动初始化目标机分区配置，用户可自定义修改。 说明 存储容量修改建议：若需调整分区可通过查看源机分区与平台处查看源机分区查看迁移源信息，参照迁移源文件系统类型，挂载点，分区类型等信息进行目标机分区大小调整操作。具体请参见 1. 单点击“添加目标机分区”新增分区，分区类型包含标准分区、扩展分区、逻辑分区和LVM分区。 2. 您也可以按需进行“管理分区类型”、“管理LVM”、“查看源机分区”、“重置”。

本节主要介绍 图片拼接成GIF接口。 可以将多个图片拼接成gif文件，图片是原始图片，可以针对每个图片添加@oosImage参数，对图片进行单独的处理。原始图片格式支持jpg, png, bmp, webp。如果各个图片的大小不一致，那么以最小的宽高为标准，其他图片的宽高根据此进行缩放。 plaintext @oosImagemergegif&delayTimexx&loop0&object &object &object ... 参数 参数 描述 取值 object object和objectURL中指定的文件，需在同一个存储桶（Bucket）中。object是url 安全Base64编码，EncodedObject urlsafebase64encode(objectName@oosImage图片处理参数)。最多支持同时合并20个图片文件。例如：objectbase64urlecnode(a.jpg@oosImage20w)。 无 objectURL objectURL是第一个要拼接图片的地址，如果要对第一个图片做处理，需要在mergegif参数前面增加管道参数。如果在mergegif后面加管道参数，说明是对拼接后的gif进行处理。 无 delayTime gif文件中每帧的延迟时间。 整数形式，取值是[0, 5000]。单位是毫秒。 loop 是否循环播放。 整数形式，取值： 0：不循环。 1：是循环。 默认值是0。 示例 说明 下面仅给出简单示例，具体使用可以参考示例代码。 将名为docs的存储桶（Bucket）中的文件（Object）：test1.jpg, test2.png, test3.bmp 合并成gif图片。其中为test1.jpg设置宽100，高100；test2.png也设置宽100。使用示例： 链接： plaintext 即 plaintext

本地文档准备 在搭建知识库过程中，如需要引用本地文档，请提前在科研助手中通过【数据存储】功能，将本地数据传至开发机上。此处以数据集管理为例，演示如何创建及挂载。 步骤1：进入科研助手控制台，点击左上角，切换“科研版”； 步骤2：在【数据存储】弹出的选项中，选择【数据集管理】。在【数据集管理】页面中切换至【个人数据集】，点击左上角的【创建数据集】按钮。 此处需注意，数据集选用的可用区和后续开发机的可用区应在同一个可用区，否则无法跨区挂载。此处选择中卫4。其余请按照实际需求选择。 步骤3：刷新页面，可以在列表中看到创建的数据集bcmanual。 步骤4：在数据集右侧单击【查看】按钮，进入文件管理页面，点击右上角【本地上传】【上传文件】，选择您所创建知识库需要的文档。 上传完成后，进行下一步开发机准备。

主题详情 （1）登录管理控制台。 （2）进入Kafka管理控制台。 （3）在实例列表页在操作列，目标实例行点击“管理”。 （4）点击“Topic管理”后进入主题管理页面后点击“更多”，在下拉框中点击“详情”。 Kafka的partitions（分区）和metrics（指标）是Kafka中重要的概念和组件。以下是它们的介绍： 1. 分区（Partitions）： 分区是Kafka中数据的基本单元，用于将数据进行分割和存储。 每个主题（Topic）可以被分成多个分区，每个分区都有一个唯一的标识符（Partition ID）。 分区内的数据按照顺序进行存储，并且每个分区都可以独立地进行读写操作。 分区的数量可以根据需求进行调整，以实现数据的负载均衡和并行处理。 2. 指标（Metrics）： 指标是用于度量和监控Kafka集群和应用程序的关键性能指标。 Kafka提供了一系列的内置指标，用于监控各个组件的运行状况和性能。 这些指标包括生产者（Producer）和消费者（Consumer）的吞吐量、延迟、错误率等。 指标可以通过Kafka的监控工具（如Kafka Manager、Prometheus等）进行收集、展示和分析。 通过使用分区，Kafka能够实现高吞吐量、可扩展性和容错性。而指标则帮助我们了解Kafka集群和应用程序的运行情况，有助于监控和优化系统的性能和稳定性。

本节主要介绍设置告警规则 云监控界面支持设置文档数据库服务告警规则，用户可自定义监控目标与通知策略，及时了解文档数据库服务运行状况，从而起到预警作用。 设置文档数据库服务的告警规则包括设置告警规则名称、监控对象、监控指标、告警阈值、监控周期和是否发送通知等参数。本节介绍了设置文档数据库服务告警规则的具体方法。 说明 更多关于文档数据库服务监控规则的信息，请参见《云监控用户指南》。 自定义告警规则 步骤 1 登录管理控制台。 步骤 2 选择“管理与监管 > 云监控服务”。 步骤 3 在左侧导航树，选择“告警 > 告警规则”。 步骤 4 在“告警规则”页面，单击“创建告警规则”。 步骤 5 在“创建告警规则”界面，根据界面提示配置参数。 此处需要关注如下参数： 资源类型：选择文档数据库服务。 维度：DDS支持实例级别和节点级别的监控维度，不同的监控指标支持的监控维度不同，请参考文档数据库服务监控指标说明。 配置监控维度 步骤 6 告警规则设置完成后，当符合规则的告警产生时，系统会自动进行通知。

组件名称 组件介绍 适用场景 使用限制 HPA Kubernetes内置组件，主要面向在线业务。 在线业务 适用于Deployment、StatefulSet等实现scale接口的对象。 VPA（alpha） 开源社区组件，主要面向大型单体应用。 大型单体应用 适用于无法水平扩展的应用，通常是在Pod出现异常恢复时生效。 Cubescaler CCSE自研插件，主要面向应用资源使用率存在周期性变化的场景。 周期性负载业务 适用于Deployment、StatefulSet等，实现了scale接口的对象。

天翼云为您提供并行文件服务HPFS产品的服务等级协议，请您点击查看。 天翼云并行文件服务HPFS服务等级协议

本节介绍天翼云息壤一体化智算服务平台的功能特性。 平台名称 相关文档 公共算力服务 功能特性 训推服务 功能特性 模型推理服务 功能特性 应用托管 功能特性 科研助手 产品特性

本页介绍天翼云TeleDB数据库的Constraints设计规范。 建议每个table都使用shard key作为主键或者唯一索引。 建议建表时一步到位把主键或者唯一索引也一起建立。 注意 非shard key不可以建立primary key或者unique index。

本页介绍天翼云TeleDB数据库的Constraints设计规范。 建议每个table都使用shard key作为主键或者唯一索引。 建议建表时一步到位把主键或者唯一索引也一起建立。 注意 非shard key不可以建立primary key或者unique index。

参数 参数类型 说明 示例 下级对象 statusCode String 状态码 200成功 error String 返回码 CTCSSCN000000：成功 CTCSSCN000001：失败 CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN000004：鉴权错误 CTCSSCN000005：用户没有付费版配额，功能不可用 CTCSSCN000000 message String 返回信息 成功 returnObj Object 返回对象

参数 参数类型 说明 示例 下级对象 statusCode String 状态码 200成功 error String 返回码 CTCSSCN000000 :成功; CTCSSCN000001:失败; CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用; CTCSSCN000004：鉴权错误; CTCSSCN000005：用户没有付费版配额，功能不可用 CTCSSCN000000 message String 返回信息 成功 returnObj Object 返回对象

参数 参数类型 说明 示例 下级对象 statusCode String 状态码 200成功 error String 返回码 CTCSSCN000000：成功 CTCSSCN000001：失败 CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN000004：鉴权错误 CTCSSCN000005：用户没有付费版配额，功能不可用 CTCSSCN000000 message String 返回信息 成功 returnObj Object 返回对象 map

接口功能介绍 添加接入点的终端节点白名单 接口约束 无 URI POST /v1/userEndpointControl/addEndpointWhitelist 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id bac519a74a774c78850780e1eda40c78 endpointId 是 String 终端节点id endpointwlp72qh2bd ips 是 Array of Strings ip白名单集合 ["1.1.1.1"] enableWhitelist 是 Boolean 是否开启 true 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 请求示例 请求url plaintext 请求头header plaintext { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" }

参数 参数类型 说明 示例 下级对象 statusCode String 状态码 200成功 error String 返回码 CTCSSCN000000：成功 CTCSSCN000001：失败 CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN000004：鉴权错误 CTCSSCN000005：用户没有付费版配额，功能不可用 CTCSSCN000000 message String 返回信息 成功 returnObj Object 返回对象 data

本文为您介绍如何设置天翼云关系数据库MySQL版产品的参数。 背景信息 天翼云关系数据库MySQL版服务开放了部分参数。您可根据业务情况，对实例中的参数值进行调整，确保服务发挥出最优性能，更好的满足您的业务需求。 说明 您也可以根据业务场景将不同的参数设置保存为不同的参数模板，然后根据业务情况，快速批量应用到实例上。关于参数模板的信息，请参见参数模板简介。 注意事项 部分参数值修改之后，需要重启实例，请仔细评估修改操作对业务的的影响。 当实例运行状态异常时，不允许修改实例的参数值。 修改参数值不会立即生效，请稍后刷新页面查看修改结果，或者参数列表上方单击历史记录，查看参数修改结果。 部分参数，例如字符集参数，区分大小写参数等，仅主实例可修改，只读实例跟随主实例同步变更。 操作步骤 修改参数 1. 在天翼云官网首页的顶部菜单栏，选择产品 > 数据库 > 关系型数据库 > 关系数据库MySQL版 ，进入关系数据库MySQL产品页面。然后单击管理控制台 ，进入概览页面。 2. 在左侧导航栏，选择MySQL > 实例管理，进入实例列表页面。然后在顶部菜单栏，选择区域和项目。 3. 在实例列表中，单击目标实例名称，进入实例基本信息页面。 4. 单击参数设置，查看您可以修改的参数列表，界面上展示了每个参数的参数名、修改后是否需要重启、当前值、允许值、描述。 5. 根据业务需求修改相关参数，单击参数列表上方的保存。 6. 单击确定，提交修改参数任务。 您可以参数列表上方单击更多 > 历史修改记录 ，查看参数修改结果。修改参数是否成功，以历史修改记录页面显示结果为准。

本文介绍加速区域的配置规则。 功能介绍 由于境内外的监管要求存在差异，不同的加速区域需要遵守当地的法律要求，天翼云CDN支持“中国内地”、“全球（不含中国内地）”、“全球”三类，对应不同的要求详情请见：使用限制中的“加速域名准入条件”。 配置说明 1. 登录CDN控制台。 2. 单击左侧导航栏【域名管理】【域名列表】。 3. 在【域名列表】页面，找到目标域名【加速区域】列。 4. 单击右侧【】 5. 单击【加速区域】下的选项，可实现不同加速区域的切换，例如，从“中国内地”变更为“全球”。 参数名 说明 中国内地 选择中国内地，表示全球用户的访问，均会被调度至分布在中国内地的节点。天翼云CDN节点中国内地的最新分布情况，详情请见：节点分布。 加速域名请先完成在中国大陆的ICP备案，同时完成公安网备案。 全球（不含中国内地） 选择全球（不含中国内地），表示全球用户的访问，均会被调度至分布在中国澳门、中国台湾、中国香港以及其他国家和地区的节点。天翼云CDN节点全球（不含中国内地）的最新分布情况，详情请见：节点分布。 由于加速区域不包含中国内地，加速域名无需完成在中国大陆的ICP备案和公安网备案。 全球 选择全球，表示全球用户的访问，均会被择优调度至最近的节点进行加速服务。 由于加速区域包含中国内地，加速域名请先完成在中国大陆的ICP备案，同时完成公安网备案。

本文介绍缓存过期时间设置方法。 功能介绍 缓存过期时间指源站资源在CDN节点缓存的时长，在缓存未过期前，对应资源会直接从CDN节点响应给用户；达到预设缓存过期时间后，资源将会被CDN节点标记为缓存过期。此时如果客户端向CDN节点请求该资源，CDN会携带IfModifiedSince请求头或IfNoneMatch请求头回源站校验内容是否有更新，如有更新则获取最新资源并缓存到CDN节点，如无更新则继续使用原有缓存文件。您可以根据业务需求，按指定路径或文件名后缀等方式配置静态资源的缓存过期时间。 注意事项 1. 您可基于天翼云默认推荐的缓存设置，按需进行调整后，直接使用，当前默认推荐配置如下： 2. 如您删除了上述默认推荐设置，且未添加其他任何设置情况下，全局默认优先遵循源站缓存头，包括Pragma:nocache、CacheControl、Expires响应头；其优先级从高到底分别如下：Pragma:nocache、CacheControl:nocache/private/nostore > CacheControl：maxagen (n≥0)>Expires。如源站无任何上述缓存头设置，则在CDN节点上不缓存。默认忽略参数缓存，若不同参数文件内容不同，需设置为不忽略参数。 3. 如果加速域名下的文件访问热度过低（指同个文件在一段时间内被访问的频次过低），则很可能在过期时间到来之前被其他热度更高的文件覆盖。即：即使某个文件配置的缓存时间较长，如1个月，仍有可能在1个月内重复回源。 4. 天翼云CDN节点的缓存时间，最长可以设置为3年，即1095天。

本文介绍当攻击发生且触发平台稳定性红线时的处理预案及注意事项等。 场景说明 天翼云全站加速是公共的加速服务，平台承载着成千上万的域名加速业务，是一个多客户共用的加速平台，默认不提供防攻击服务。当某个客户的域名遭受攻击（例如CC攻击），而出现带宽或QPS异常大幅上涨触发平台稳定性红线时，全站加速平台有权（根据域名业务情况、攻击影响程度等因素综合判断）将对应客户的域名切入专用隔离资源池以隔离异常业务，避免影响其他正常用户的加速服务。在攻击较严重的情况下，同账户下的其他域名也会切入隔离资源池。 域名被切入隔离资源池后，天翼云全站将不再保证服务质量，部分时段可能会出现无法服务的情况。 说明 隔离资源池是天翼云全站的一组特殊节点，这组节点与常规节点之间相互隔离，隔离资源池被用于隔离有风险的加速业务。 注意事项 因被攻击导致域名被切入隔离资源池后，用户访问带来的流量仍然会产生计费账单。 相关建议 如您的域名存在潜在被攻击风险，不希望在上述场景下被切换至隔离资源池，请切换至安全类加速产品，例如：边缘安全加速平台。 相关概念： DDoS：分布式拒绝服务攻击（Distributed Denial of Service，简称DDoS）是指攻击的发出点是分布在不同地方，且所请求的服务往往要消耗大量的系统资源，造成目标主机无法为用户提供正常服务。 CC攻击：攻击者借助代理服务器生成指向受害主机的合法请求，以实现DDoS和伪装的，称为CC(Challenge Collapsar)，CC主要是攻击页面，属于应用层攻击。

本文主要讲述了企业主体变更注意事项及操作流程。 企业主体变更是指变更前与变更后的企业不是同一主体，资源与资金的归属主体发生了变更。 注意事项 实名认证变更生效（审批通过）之前，原实名认证信息仍然有效。 实名认证变更开始到变更生效（审批通过）期间，产生的欠费和新购的资源归属于变更后的主体。 实名认证变更开始到审批驳回期间，产生的欠费和新购的资源归属于原实名认证主体。 同一证件最多可认证5个天翼云账号，如果变更后的证件已经实名过5个天翼云账号（含已注销账号），则无法继续变更。 企业帐号变更企业主体，需要填写实名认证变更申请表并加盖双方企业公章，同时需根据页面提示上传已认证的材料和新认证的材料。 操作步骤 1、登录天翼云官网，点击“我的已实名认证”快速进入实名认证页面。 2、选择“变更企业主体”。 3、阅读实名认证变更影响，并点击确认。 4、根据页面提示，填写变更后的企业信息。 5、根据页面提示，上传变更前已实名认证的材料和新认证的材料。 说明 变更申请表模板为word文件格式，上传的附件格式不支持word，上传请转为图片格式。 企业主体变更申请表 6、勾选协议并点击“提交“，进入审核页面。 说明 变更后的认证信息将在13个工作日内审核完成，请耐心等待审核结果，审核成功，变更即可生效。

接口功能介绍 告警中心告警统计接口 接口约束 此功能为收费功能。确认已经购买服务器配额，并且开启服务器防护。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护。 URI POST /v1/instrusion/event/statistics 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String ContentType application/json 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 timeType 是 String 时间类型 LASTONEDAY最近一天 LASTTHREEDAY最近三天 LASTONEWEEK最近一周 LASTONEMONTH最近一月 LASTTHREEMONTH最近三月 SELFTIME自定义时间 LASTONEDAY startTime 否 String 开始时间 timeTypeSELFTIME时必填 20230101 00:00:00 endTime 否 String 结束时间 timeTypeSELFTIME时必填 20230101 00:00:00 eventCategoryIds 否 Array of Integers 告警类型 1进程异常行为 2恶意软件 3用户异常行为 4恶意网络连接 5其他 [1] eventTypeIds 否 Array of Integers 事件名称 [8200] 响应参数 参数 参数类型 说明 示例 下级对象 error String 返回码 CTCSSCN000000：成功 CTCSSCN000001：失败 CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN000004：鉴权错误 CTCSSCN000005：用户没有付费版配额，功能不可用 0 message String 返回信息 success returnObj Object 返回对象 returnObj traceId String traceId asaadasd11111 statusCode String 状态码 200成功 200 表 returnObj 参数 参数类型 说明 示例 下级对象 emergencyHandleRiskNum Integer 需要紧急处理的告警数量 11 unHandleRiskNum Integer 待处理告警数 11 handledRiskNum Integer 已处理告警数 11 riskHostNum Integer 存在告警的服务器数量 11 isloateFileNum Integer 已隔离文件数 11 interceptIpNum Integer 已拦截ip数 11

接口功能介绍 查询子网列表 接口约束 无 URI POST /v1/applicationAccessPointManage/listSubnet 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 vpcId 是 String vpc id vpcw6sty9v8rr epId 是 String 企业项目id 1 regionToCheck 否 String regionId cnhangzhou 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 list Array of Objects 子网列表 subnetList 表 subnetList 参数 参数类型 说明 示例 下级对象 subnetID String 子网id subnetqc90zmk12u name String 名称 subnetldyopenapi34 description String 描述 ldyopenapitest vpcID String vpc id vpcw6sty9v8rr availabilityZones Array of Strings 子网所在的可用区名 ["az1", "az2"] routeTableID String 路由表id rtbudnix6dfg2 networkAclID String 子网acl id cidr String 子网网段 172.16.14.0/24 gatewayIP String 网关ip 172.16.14.1 start String 子网网段起始IP 172.16.14.3 end String 子网网段结束IP 172.16.14.253 availableIPCount Integer 子网内可用ipv4数目 251 ipv6CIDR String ipv6子网列表 100:1:1f2:7206::/64 ipv6Start String 子网内可用的起始IPv6地址 100:1:1f2:7206::4 ipv6End String 子网内可用的结束IPv6地址 100:1:1f2:7206:ffff:ffff:ffff:fffd ipv6GatewayIP String ipv6网关ip fe80::f816:3eff:fe43:dcba dnsList Array of Strings DNS服务器地址 ["8.8.4.4","114.114.114.114"] ntpList Array of Strings NTP服务器地址 type Integer 子网类型 0 普通子网 1 裸金属子网 0 createdAt String 创建时间 20221008T04:09:40Z updatedAt String 更新时间 20221008T05:09:40Z

参数 描述 行为名称 该行为的名称。长度不超过128个字符，同个应用内名称不能重复。 针对的资源类型 支持Web和Rpc两种类型，此处仅为Rpc。 缓存实例 是否缓存返回值。若开启，则会缓存生成的Fallback对象，在该行为触发时，均复用同一对象。 Rpc限流处理策略 定义Rpc接口访问触发某种规则后的行为表现。目前支持以下两种策略： 1，自定义返回： 自定义返回结果。需设置返回类型和返回的内容，表示Rpc接口访问触发规则后返回自定义的实体类。 2，自定义异常： 抛出自定义异常。需设置异常的类名和异常文本，表示Rpc接口访问触发规则后系统会返回指定的异常信息。 返回类型获取方式 填充返回值类名的方式，分别为： 1，手动输入： 选择手动输入模式，需要填写自定义返回值的全限定类名（返回值类名），然后单击校验进行有效性校验，校验通过后可以创建行为。 2，自动探测： 选择自动探测模式，需要选择创建RPC行为的接口方法（行为关联方法）。 控制台会根据选择的行为关联方法，自动填充方法返回值类名，然后填写完成对象内容（JSON格式）后可以创建行为。 行为关联类名 当返回类型获取方式为自动探测时，需要选择当前Rpc行为关联的接口方法，方法返回值类型即为当前自定义返回值的类型。 返回值类名 选择Rpc限流处理策略为自定义返回时，需填写的类名称路径。 对象内容 选择RPC限流处理策略为自定义返回时，填写当Rpc接口访问触发规则时返回结果的对象内容（JSON格式）。 异常类名 选择Rpc限流处理策略为自定义异常时，需填写的异常类名称路径。 异常信息文本 选择Rpc限流处理策略为自定义异常时，填写Rpc接口访问触发规则后抛出自定义异常的文本信息。

参数 描述 行为名称 该行为的名称。长度不超过128个字符，同个应用内名称不能重复。 针对的资源类型 支持Web和Rpc两种类型，此处仅为Rpc。 缓存实例 是否缓存返回值。若开启，则会缓存生成的Fallback对象，在该行为触发时，均复用同一对象。 Rpc限流处理策略 定义Rpc接口访问触发某种规则后的行为表现。目前支持以下两种策略： 1，自定义返回： 自定义返回结果。需设置返回类型和返回的内容，表示Rpc接口访问触发规则后返回自定义的实体类。 2，自定义异常： 抛出自定义异常。需设置异常的类名和异常文本，表示Rpc接口访问触发规则后系统会返回指定的异常信息。 返回类型获取方式 填充返回值类名的方式，分别为： 1，手动输入： 选择手动输入模式，需要填写自定义返回值的全限定类名（返回值类名），然后单击校验进行有效性校验，校验通过后可以创建行为。 2，自动探测： 选择自动探测模式，需要选择创建RPC行为的接口方法（行为关联方法）。 控制台会根据选择的行为关联方法，自动填充方法返回值类名，然后填写完成对象内容（JSON格式）后可以创建行为。 行为关联类名 当返回类型获取方式为自动探测时，需要选择当前Rpc行为关联的接口方法，方法返回值类型即为当前自定义返回值的类型。 返回值类名 选择Rpc限流处理策略为自定义返回时，需填写的类名称路径。 对象内容 选择RPC限流处理策略为自定义返回时，填写当Rpc接口访问触发规则时返回结果的对象内容（JSON格式）。 异常类名 选择Rpc限流处理策略为自定义异常时，需填写的异常类名称路径。 异常信息文本 选择Rpc限流处理策略为自定义异常时，填写Rpc接口访问触发规则后抛出自定义异常的文本信息。

接口功能介绍 查询子网列表 接口约束 无 URI POST /v1/applicationAccessPointManage/listSubnet 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 vpcId 是 String vpc id vpcw6sty9v8rr epId 是 String 企业项目id 1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 list Array of Objects 子网列表 subnetList 表 subnetList 参数 参数类型 说明 示例 下级对象 subnetID String 子网id subnetqc90zmk12u name String 名称 subnetldyopenapi34 description String 描述 ldyopenapitest vpcID String vpc id vpcw6sty9v8rr availabilityZones Array of Strings 子网所在的可用区名 ["az1", "az2"] routeTableID String 路由表id rtbudnix6dfg2 networkAclID String 子网acl id CIDR String 子网网段 172.16.14.0/24 gatewayIP String 网关ip 172.16.14.1 start String 子网网段起始IP 172.16.14.3 end String 子网网段结束IP 172.16.14.253 availableIPCount Integer 子网内可用ipv4数目 251 ipv6CIDR String ipv6子网列表 100:1:1f2:7206::/64 ipv6Start String 子网内可用的起始IPv6地址 100:1:1f2:7206::4 ipv6End String 子网内可用的结束IPv6地址 100:1:1f2:7206:ffff:ffff:ffff:fffd ipv6GatewayIP String ipv6网关ip fe80::f816:3eff:fe43:dcba dnsList Array of Strings DNS服务器地址 ["8.8.4.4","114.114.114.114"] ntpList Array of Strings NTP服务器地址 type Integer 子网类型 0 createdAt String 创建时间 20221008T04:09:40Z updatedAt String 更新时间 20221008T05:09:40Z

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 接口状态码 2000 code String 错误码，异常时非空 CGW1001 returnObj Object 返回数据 message String 异常描述 success 表 RouteDebugResultVO 参数 参数类型 说明 示例 下级对象 request Object API/Route调试时的实际请求信息 RouteDebugRequestInfo response String API/Route调试时的请求结果 success 表 RouteDebugRequestInfo 参数 参数类型 说明 示例 下级对象 body String API/Route调试时的请求body header String API/Route调试时的请求header method String API/Route调试时的请求方法 token String API/Route调试时的请求token url String API/Route调试时的请求url 枚举参数 无 请求示例 请求url 请求头header { "regionId": "1234567890" } 请求体body { "appId": "a4eeaed8d921701f0de44c96fb7ac8c2", "authType": "NOAUTH or APP", "routeId": "64b9eb7120587e096d60977d", "gwInstanceId": "a4eeaed8d921701f0de44c96fb7ac8c2", "host": "www.test.com", "method": "get", "protocol": "http", "requestBodyType": "form", "requestBody": "[{"key":"id","value":"21"},{"key":"id","value":"22"}]", "requestHeader": "[{"key":"id","value":"21"},{"key":"id","value":"22"}]", "requestQuery": "[{"key":"id","value":"21"},{"key":"id","value":"22"}]", "uri": "/apple/count" }

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 接口状态码 2000 code String 错误码，异常时非空 CGW1001 returnObj Object 返回数据 message String 异常描述 success 表 RouteDebugResultVO 参数 参数类型 说明 示例 下级对象 request Object API/Route调试时的实际请求信息 RouteDebugRequestInfo response String API/Route调试时的请求结果 success 表 RouteDebugRequestInfo 参数 参数类型 说明 示例 下级对象 body String API/Route调试时的请求body header String API/Route调试时的请求header method String API/Route调试时的请求方法 token String API/Route调试时的请求token url String API/Route调试时的请求url 枚举参数 无 请求示例 请求url 请求头header { "regionId": "1234567890" } 请求体body { "appId": "a4eeaed8d921701f0de44c96fb7ac8c2", "authType": "NOAUTH or APP", "routeId": "64b9eb7120587e096d60977d", "gwInstanceId": "a4eeaed8d921701f0de44c96fb7ac8c2", "host": "www.test.com", "method": "get", "protocol": "http", "requestBodyType": "form", "requestBody": "[{"key":"id","value":"21"},{"key":"id","value":"22"}]", "requestHeader": "[{"key":"id","value":"21"},{"key":"id","value":"22"}]", "requestQuery": "[{"key":"id","value":"21"},{"key":"id","value":"22"}]", "uri": "/apple/count" }

接口功能介绍 根据ips规则类型获取所有列表 接口约束 传参规范 URI GET /vfw/v2ipsrulequeryAll 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Array of Objects 接口返回结果 IpsRuleView 表 IpsRuleView 参数 参数类型 说明 示例 下级对象 method String 获取method类别的规则 methodCn String 获取method类别的规则中文 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {} 响应示例 { "statusCode": "800", "message": "成功！", "returnObj": [ { "method": "VulnerabilityCSRF", "methodCn": "漏洞跨站伪造" }, { "method": "MalwareTrafficBackdoorTraffic", "methodCn": "恶意流量后门流量" }, { "method": "VulnerabilityCGIAttack", "methodCn": "漏洞CGI攻击" } ], "error": "CFW0000" }