查看云间高速（尊享版）： 1、登录天翼云控制中心； 2、单击 ，选择【网络】单击【云间高速】； 3、进入云间高速服务界面，点击【云间高速管理】，如图所示 查看云间高速（标准版）： 1、登录天翼云控制中心； 2、单击 ，选择【网络】单击【云间高速（标准版）】； 3、进入云间高速服务界面，点击【云间高速（标准版）】，如图所示

本章节介绍了如何在管理控制台创建实例、连接实例的具体操作流程。 使用流程 初次使用天翼云关系数据库SQL Server版，请先了解【约束与限制】。 使用天翼云关系数据库SQL Server版，通常需要以下几个步骤： 1. 创建SQL Server实例。 2. 创建数据库和账号。 3. 申请或释放外网地址。 4. 连接SQL Server实例。

创建云间高速（尊享版）： 1、登录天翼云控制中心； 2、单击 ，选择【网络】单击【云间高速】； 3、进入云间高速服务界面，点击【创建云间高速】，如图所示： 创建云间高速（标准版）： 1、登录天翼云控制中心； 2、单击 ，选择【网络】单击【云间高速（标准版）】； 3、进入云间高速服务界面，点击【创建云间高速（标准版）】，如图所示：

本文为您介绍科研助手相关协议。 科研助手服务协议详情请参见天翼云科研助手服务协议。 科研助手服务等级协议请参见天翼云科研助手服务等级协议。 科研助手计费协议请参见科研助手计费协议。 科研助手社区镜像用户服务协议请参见科研助手镜像服务协议.pdf。 科研助手服务条款请参见科研助手服务条款.pdf。 科研助手SSH服务使用协议科研助手SSH服务使用协议.docx。

本章节介绍公网连接天翼云关系型数据库的流程。 本章介绍如何在管理控制台创建MicrosoftSQLServer实例，并使用弹性公网IP通过公网连接Microsoft SQL Server实例。 步骤一：创建实例。根据业务需求，确认Microsoft SQL Server实例的规格、存储、网络配置、数据库帐户配置信息等。 步骤二：设置安全组规则。从安全组外访问安全组内的关系型数据库实例时，需要为RDS所在安全组配置相应的入方向规则。 步骤三：绑定弹性公网IP。弹性公网IP提供独立的公网IP资源，包括公网IP地址和公网出口带宽服务。可以在虚拟私有云管理控制台申请弹性公网IP并将该弹性公网IP绑定至RDS实例。 步骤四：通过公网连接Microsoft SQL Server实例。

本章节会介绍公网连接天翼云关系型数据库的流程。 本章介绍如何在管理控制台创建PostgreSQL实例，并通过绑定弹性公网IP从公网连接访问PostgreSQL实例。 步骤一：创建实例。根据业务需求，确认MySQL实例的规格、存储、网络配置、数据库帐户配置信息等。 步骤二：设置安全组规则。从安全组外访问安全组内的关系型数据库实例时，需要为RDS所在安全组配置相应的入方向规则。 步骤三：绑定弹性公网IP。弹性公网IP提供独立的公网IP资源，包括公网IP地址和公网出口带宽服务。可以在虚拟私有云管理控制台申请弹性公网IP并将该弹性公网IP绑定至RDS实例。 步骤四：通过psql连接实例。

本文介绍通过查看历史离线分析数据，您可以了解安全加速的运行情况。 简介 可通过筛选项进行组合查询，筛选项包括域名、业务类型、覆盖范围和时间等，其中必选项为域名和时间。 时间选择跨度最长不能超过31天。 安全分析 1.在天翼云SCDN客户控制台的【安全分析】页面，客户可以查看waf、CC攻击日志和waf报表分析、CC报表分析情况。 2.界面中展示的是您所选域名、时间的攻击日志情况。 图 安全分析waf攻击日志 图 安全分析CC攻击日志 业务数据统计分析 1.带宽流量统计 1）在天翼云SCDN客户控制台的【统计分析用量查询】页面，客户可以查看业务的使用情况。 2）界面中展示了所选择域名、时间的流量和带宽统计图表，包括总流量和平均流量信息；带宽峰值和95带宽峰值。 图 统计分析流量带宽 图 回源统计 3.在天翼云SCDN客户控制台的【统计分析用量查询】页面，客户可以查看业务的回源情况。 4.界面中展示了所选择域名、时间的回源流量和回源带宽统计图。 图 统计分析回源流量带宽 图 请求数统计 5.在天翼云SCDN客户控制台的【统计分析请求数】页面，客户可以查看其在使用CDN。 6.界面中展示了所选择域名的总请求数、请求数峰值、请求数谷值等信息。 7.请求数统计包括：防护请求数、静态https请求数、动态请求数等。 图 请求数统计

参数 说明 自动停止 自动停止开关，如果开启开关，开发机将在设定的时间后自动停止；如果关闭开关，开发机由用户手动停止。 自动停止时长 设置自动停止时长，单位小时。可用条件是开启自动停止开关。时长可选择1小时、2小时、4小时、6小时、自定义时长， 自定义时长数值应该为大于0的整数。最大值可设置999小时。 学术加速 开启学术加速后，可加速访问合法合规学术平台 启用SSH 支持通过SSH登录开发机，具体可参考 对外端口 开启该功能，可将开发机的内网端口映射到公网。 启用Docker 开启后，可在开发机内使用 docker run 启动容器，以及 docker push/pull 推拉镜像。 如需启用Docker，开发机需挂载本地盘，Docker数据将存储在本地盘中。 启用 Docker 前需预先分配 GPU 卡和计算资源，被分配给 Docker 的 GPU 卡和计算资源将仅可在 Docker 环境内使用。

合规基线首页主要展示用户创建的所有基线检查作业检查结果,并提供新建检查、凭证管理、白名单的入口。 合规基线的首页是用户创建的合规基线任务列表，每个任务展示了基线检查的名称，最后执行时间等信息。可以通过基线规则和基线规则支持的平台等条件进行查询和筛选，也可以对检查任务进行执行、导出报表、编辑、删除等操作。 查看基线 点击某个基线任务，可查看该任务中的基线检查列表，也可对单个基线进行检查。 执行任务 1.在检查首页页面，选择某一个检查任务，点击后边的“开始检查”按钮后，开始执行该检查任务。 2.导出检查结果点击任务项后边的“导出报表”按钮，可以导出选定的检查任务的检查结果。

异常返回 异常返回时： http code 返回非200。 http body 中返回 error 结构，error结构中包含code、type、message、param等信息，具体可见OpenAPI接口文档中的error结构描述及错误码部分介绍。 错误结果示例 plaintext { "error" : { "code" : "500001", "type" : "INVOKEMODELERROR", "message" : "服务接口异常，请联系管理员" } } 请求示例代码 plaintext 假设慧聚平台用户组AppKey884c8fc4054548a7b1ca1123592f5b7，模型ID96dcaaaaaaaaaaaa5ff55ea377831a，以此为例进行说明。 curl方式请求 plaintext curl request POST url header 'Accept: /' header 'AcceptEncoding: gzip, deflate, br' header 'Authorization: Bearer 884c8fc4054548a7b1ca1123592f5b7' header 'ContentType: application/json' data '{ "model": "4b38a36cabe247c8a996206984c9e2a61", "input" : "A cute baby sea otter" }' python方式请求 plaintext import json import requests URL " headers { "Authorization": "Bearer 884c8fc4054548a7b1ca1123592f5b7", "ContentType": "application/json" } data { "model": "4b38a36cabe247c8a996206984c9e2a61", "input" : "A cute baby sea otter" } try: response requests.post(URL, headersheaders, jsondata) if response.statuscode ! 200: print(response.json()) else: embeddings response.json()["data"][0]["embeddings"] except Exception as e: print(f"Exception: {e}")

变更配置 域名配额扩容：当您的业务需求增加，可在计费周期内“扩容”域名的扫描配额包。支持扩容 专业版配额 、高级版配额 以及 企业版配额 。不支持多个版本同时存在。 专业版升级为高级版：当您是专业版用户时，如果需要将专业版扫描配额包中的二级域名配额全部升级为一级域名配额，可以直接将专业版 升级为 高级版 。 退订 购买漏洞扫描服务的扫描配额包后，如需停止使用，请到费用中心>订单管理>退订管理页面，选择对应的订单进行退订操作。 续费 扫描配额包到期后，您可以进行续费以延长扫描配额包的有效期，也可以设置到期自动续费。 到期与欠费 包周期资源开通成功后，如果没有按时续费，平台会提供一定的保留期。 欠费后，可以查看欠费详情。为防止相关资源不被停止或者释放，请及时进行充值，帐号将进入欠费状态，需要在约定时间内支付欠款。

参数 配置说明 目录和文件 支持选择要备份的目录和文件及不要备份的目录和文件。 注意：选择文件备份目录时，需选择非结构化数据（如视频、图片、附件、日志等）文件产生的数据路径。若选择"/"或包含系统文件的系统整盘、系统盘整个分区（如C盘），任务状态会变为停止。如需有系统盘整盘、整个分区的备份需求可选择整机备份方式实现。 镜像设置 校验方式：启用增量备份或差异备份时，当前备份数据与上次备份数据差异比对方式。 错误处理方式 如果源路径包含系统目录和文件，drnode程序可能无法访问某些特定的系统文件。对于这种情况，给出两种解决办法。此选项默认为“遇到错误，立即停止”。 文件打开方式 在镜像阶段，源端打开文件的方式，该选项只适用于Windows平台的工作机。在增量复制阶段，drnode程序不会读取文件内容。 文件安全属性 用户选择是否同步备份文件权限、用户属性等。此选项默认为同步。

本文通过图文介绍如何新增边缘接入服务IP应用加速服务。 接入说明 边缘接入服务IP应用加速有两种接入方式：域名接入、无域名接入。推荐优先使用域名接入方式；无域名的应用也可以使用无域名接入方式，配置完成后同样会生成一个CNAME，您可以直接使用该CNAME提供服务。 方式一：域名接入方式 前提条件 已经订购边缘安全加速平台边缘接入服务，并且套餐+域名扩展包支持的域名数量未超过限制。 使用域名接入方式时，国内加速的域名需要完成ICP备案，才可以接入边缘安全加速平台边缘接入服务。 域名基本概念 域名级数：域名的各个级别被分开，级数指一个域名由多少级组成，最右边的那个词称为顶级域名。 域名后缀：又被称为顶级域名，比如：.com、.net、.cn等，也存在带两个层级的域名后缀，比如：.com.cn、.net.cn等。 一级域名：也被称为根域名，例如："ctyun.cn"。 二级域名：在一级域名前再加一级，例如："example.ctyun.cn"。 三级域名：在二级域名前再加一级，例如："www.example.ctyun.cn"。 操作步骤 1. 登录边缘安全加速控制台，进入边缘接入控制台的【域名】【IP应用加速接入】页面，这个页面您可以查看已添加的域名/实例的信息，包括域名/实例名称、接入方式、CNAME、加速区域、状态、IPv6解析、DDoS防护、操作等信息。点击左上角【新增接入】。 2. 接入方式选择"域名接入"，选择"域名接入"时必须填写加速域名信息，选择加速区域（中国内地、全球（不含中国内地）、全球），是否启用IPv6。基本信息详细介绍详见：基本信息。 3. 根据您的需要，配置您加速域名的【回源配置】、【访问控制】、【传递用户IP回源】等相关功能。回源配置详细介绍详见：回源配置。IP黑白名单详细介绍详见：IP黑白名单。传递用户IP回源详细介绍详见：传递用户IP回源。 4. 完成加速配置后，点击右下角的下一步，进入安全防护配置页面，按需开启DDoS防护后提交。 5. 新增接入完成后，可通过【IP应用加速接入】首页列表查看该域名所处状态。 6. 域名配置完成，生成域名CNAME，域名状态变更为【已启用】，即可以在【IP应用加速接入】首页列表中，查看对应域名的详情，进行停用/启用/删除等操作，也可以开启IPv6解析开关，修改加速配置或安全防护配置等。

本节介绍了如何在边缘安全加速平台使用安全加速服务的域名规则防护引擎为您的网站做好WEB应用攻击防护。 应用场景 攻击者经常会采用SQL注入、XSS跨站、Webshell上传、命令注入、后门隔离、非法文件请求、路径穿越、常见应用漏洞攻击等Web攻击手段对网站进行攻击。您的网站接入安全与加速服务后，可以通过配置对应的WAF漏洞防护集合规则来抵御这些Web应用类型攻击。 如何配置防护策略 网站接入边缘安全加速平台后，安全与加速服务根据不同的业务场景内置了不同的规则模板，您可以根据业务情况选择规则模板，并且设置规则模板的防护模式。每种规则模板针对不同的场景进行Web防护，减少正常请求的误报漏报，提高在您选择的场景下的拦截非法请求的成功率。 默认提供七种防护规则集合： 全量防护规则：适用于重保等级高，且允许一定程度误报的业务场景。该漏洞规则集防护包含全量规则，绝大部分规则处理动作为拦截（网站防护模式为拦截时则直接进行拦截）。 敏感防护规则集：适用于常规网站，且允许少量误报的业务场景。该漏洞规则集防护等级较为严格，容易误报的规则处理动作为告警，其他规则处理动作为拦截（网站防护模式为拦截时则直接进行拦截），存在一定误报可能性。 宽松防护规则集：适用于常规网站，允许存在一定漏报的业务场景。该漏洞规则集防护等级较为宽松，关闭容易产生误报的规则，可能存在一定漏报。 PHP防护规则集：适用于后台开发语言为PHP的网站业务。该漏洞规则集主要针对后台语言为PHP进行制定，关闭其他容易产生误报的规则。 JAVA防护规则集：适用于后台开发语言为JAVA的网站业务。该漏洞规则集主要针对后台语言为JAVA进行制定，关闭其他容易产生误报的规则。 非PHP和JAVA防护集：适用于后台开发语言明确非PHP和JAVA网站业务。该漏洞规则集主要针对后台语言为非PHP和JAVA进行制定，关闭其他容易产生误报的规则。 下载类业务规则集：适用于下载类业务，即包含zip、rar、tar、gz等下载类后缀的业务网站。该漏洞规则集主要针对下载类业务进行设定规则，关闭其他容易产生误报的规则。 关于域名规则开关的选项说明： 关闭：关闭规则防护，不会对Web攻击进行有效拦截和记录。 告警：WAF不会拦截任何Web攻击，仅会根据域名规则匹配到的Web攻击记录到攻击日志。 拦截：WAF会根据域名规则内容匹配，如果请求与域名规则匹配上会拦截请求，并记录到攻击日志中。 除了控制全量域名规则的开关，您还可以根据您网站特性，选择一些误报率较高的域名规则进行关闭，减少误报率，如下图：

本文为您介绍IP黑白名单防护功能说明，以及如何配置IP黑白名单策略。 IP黑白名单支持对经过云WAF防护域名的访问源IP进行黑白名单设置，来自该IP地址/IP地址段的访问，云WAF将不会做任何检测，直接拦截/放行。 IP黑白名单设置，支持基于域名创建IP黑白名单规则。 支持添加IPv4、IPv6地址，支持添加IP地址段。 IP黑白名单模块的防护检测逻辑优先级高于其他防护模块；IP黑白名单内部检测逻辑，白名单高于黑名单。 前提条件 已开通Web应用防火墙（原生版）实例。 已完成网站域名接入。 规格限制 基础版不支持IP黑白名单功能，请升级到更高版本使用。 不同实例版本支持添加的IP黑白名单规则数量不同，有关各版本规格的详细介绍，请参见产品规格。 若当前版本的IP黑白名单防护规则条数无法满足业务需求时，您可以通过购买规则扩展包或升级版本，以实现规则条数的扩容。一个规则扩展包包含50条IP黑白名单防护规则。 操作步骤 1. 登录天翼云控制中心。 2. 单击页面顶部的区域选择框，选择区域。 3. 在产品服务列表页，选择“安全 > Web应用防火墙（原生版）”。 4. 在左侧导航栏，选择“防护配置 > 对象防护配置”，进入防护配置页面。 5. 在“防护配置”页面上方的“防护对象选择”下拉框，切换到要设置的域名。 6. 在“安全防护”页签定位到“IP黑白名单”模块，可以选择开启/关闭防护状态。点击“前去配置”。 7. 进入IP黑白名单规则列表页，列表会展示已创建规则的相关信息，包括规则状态、规则名称/规则ID、IP地址、类别、过期时间、更新时间、规则描述等。 8. 点击列表上方“新建黑白名单”，进入规则配置页面，完成以下信息配置。 配置项 说明 规则名称 设置规则的名称。 规则名称用于标识当前防护规则，建议您使用有明确含义的名称。 类别 定义该规则类型是“黑名单”或“白名单”。 IP地址 添加IP地址/地址段，支持IPv4和IPv6格式的IP地址/地址段。 过期时间 规则配置后，规则状态开启即生效。可通过设置过期时间，为该规则定义生效时间段。过期时间可选： 永久生效 限定日期：自定义设置失效日期 规则描述 可选参数，设置该规则的备注信息。 9. 单击“确定”，规则创建成功，成功后规则默认启用。您可以在规则列表中查看该规则。

天翼云Prometheus监控服务提供了Remote Read的标准接口，您可以通过这个接口远程访问天翼云上Prometheus的监控数据。本文以开源Prometheus访问天翼云Prometheus监控为例介绍如何使用Remote Read地址。 使用限制 Remote Read接口暂不支持HTTP/2。 前提条件 已创建Prometheus 版实例 远程读取的客户端网络已经与暴露接口打通。 操作指南 步骤一：获取用户的AccessKey和AccessKey Secret 如果您已创建Prometheus实例，且您需要使用AccessKey和AccessKey Secret进行远程读写，则需要先为获取用户的AccessKey ID和AccessKey Secret。 1. 通过实名认证的账号登录天翼云。 2. 进入天翼云账号中心。 3. 点击【安全设置】进入安全设置中心 4. 在用户AccessKey模块，可创建AKSK，或直接查看已生成的AKSK。 步骤二：获取Remote Read地址 1. 登录应用性能监控控制台，左侧菜单选择Prometheus监控，进入实例列表页面。 2. 单击目标实例名称。 3. 在设置页签上，复制Remote Read地址。 步骤三：配置开源版Prometheus 1. 安装开源Prometheus。 2. 编辑Prometheus.yml配置文件，并在文件末尾增加以下内容，将remoteread链接替换为上文步骤二中获取的地址，然后保存文件。 plaintext global: scrapeinterval: 15s evaluationinterval: 15sscrapeconfigs: jobname: 'prometheus' staticconfigs: targets: ['localhost:9090'] remoteread: 替换为您的Remote Read地址。 url: " readrecent: true 3. 重启开源版Prometheus服务。

使用事件总线EventBridge前，您需在产品页开通该服务。本文介绍如何开通事件总线EventBridge。如果您的账号为子用户，必须让天翼云账号为子用户进行授权，才能通过控制台或API访问相应的事件总线EventBridge资源。 前提条件 注册天翼云账号。 步骤一：开通事件总线EventBridge并委托授权 1. 登录天翼云官网，选择产品 > 容器与中间件 > 应用集成 > 事件总线 EventBridge。 2. 在事件总线EventBridge产品页，单击开通。 3. 请仔细阅读事件总线 EventBridge（按量付费）服务协议，选中事件总线 EventBridge（按量付费）服务协议，然后单击立即开通。 4. 开通服务后，账号未委托相关必要权限给事件总线时，需要先进行委托权限，详见服务内联委托管理。 5. 委托成功后，进入事件总线EventBridge管理控制台进行操作。 步骤二：（子账号必选）为子账号授权 1. 使用天翼云账号登录IAM控制台。 2. 在左侧导航栏，选择用户组。 在用户组页面，单击目标子账号用户组授权列的添加权限，详见主子账号和IAM权限管理。 3. 选择权限策略。 权限策略包括系统策略和自定义策略两种，您可以根据需要选择对应的权限策略。 事件总线EventBridge提供以下系统策略，您可以根据权限范围为RAM用户授予相应权限。 权限策略名称 说明 EventBridge admin 管理员权限策略，拥有事件总线EventBridge所有资源的读写权限 EventBridge user 普通用户策略，拥有事件总线EventBridge除订单相关操作之外对其他资源拥有读写权限 EventBridge publisher 拥有事件总线EventBridge事件的发送权限。 EventBridge viewer 只读权限策略，拥有事件总线EventBridge所有资源的只读权限

本文介绍如何校验域名归属权。 客户可根据如下方法一、方法二，任意选择一种方式进行操作验证即可。 方法一：DNS解析验证 示例为ctcdn.cn的解析配置 1、客户需在自己的域名解析服务商，添加天翼云控制台返回的TXT记录值（如下记录值仅为示例）。 记录类型 主机记录 记录值 TXT dnsverify 202207060000002jar4fb2hc79iwjq5cdid87t7rci1sgp33exuyvez4kwonobxt 2、域名解析操作完成后，等待（建议10分钟）DNS解析生效后即可进行解析验证。 解析命令：dig dnsverify.ctcdn.cn txt 3、如解析出来的txt值和天翼云控制台返回的TXT记录值一致，则表示配置正确。 确认配置正确后，可前往天翼云控制台，在新增域名界面点击验证，验证通过就可以正常操作新增域名。 方法二：文件验证 示例为ctcdn.cn的解析配置 1、在您的源站根目录下，创建文件名为：dnsverify.txt的文件，文件内容为天翼云控制台返回的TXT记录值（如下记录值仅为示例） 2、文件在源站根目录下创建完成后，即可进行访问验证（示例为访问 windows验证： linux验证： 3、如访问展示的文件内容和天翼云控制台返回的TXT记录值一致，则表示配置正确。 确认配置正确后，可前往天翼云控制台，在新增域名界面点击验证，验证通过就可以正常操作新增域名。

本文为您介绍Linux系统重启后/etc/hosts自动添加主机名解析的处理方法。 问题描述 重启使用 Linux 系统的云主机后发现 /etc/hosts 文件被全部重写或被添加了主机名和回环地址（例：127.0.0.1、127.0.1.1）的解析，导致域名解析不符合预期或出现问题。 问题原因 云平台 Linux 镜像中的一个核心组件是 cloudinit。作为开源的云初始化程序，cloudinit 主要用于对主机名、初始密码等一些自定义信息进行初始化配置。若 cloudinit 配置中存在对 manageetchosts 的配置，则 cloudinit 会根据具体配置值决定如何调整 /etc/hosts 文件。公共镜像默认不启用 cloudinit 对 /etc/hosts 的修改功能，即 manageetchosts 不做配置或配置为 false（默认值）。若您使用了公共镜像并修改了 cloudinit 配置或使用了私有镜像，则可参考此指导来尝试解决问题。 问题排查思路 /etc/hosts 文件被全部重写可能是因为 cloudinit 配置中将 manageetchosts 配置成了true（若您安装的 cloudinit 版本低于22.3，则还可能是配置成了 template）。此时，cloudinit 会根据/etc/cloud/templates/hosts.tmpl 来重写 /etc/hosts 文件。 而 /etc/hosts 文件被添加主机名解析可能是因为 cloudinit 配置中将 manageetchosts 配置成了 localhost。 解决步骤 1. Cloudinit 配置文件是 /etc/cloud/cloud.cfg，您可能还将自定义配置放于 /etc/cloud/cloud.cfg.d/ 目录下。搜索包含 manageetchosts 配置的文件可使用以下命令： grep rn ‘manageetchosts’ /etc/cloud/ 返回结果示例： 2. 以上述返回结果为例，可以看到在/etc/cloud/cloud.cfg 文件中的第20 行将 manageetchosts 配置成了 localhost，此时您需要修改 cloud.cfg 中的 manageetchosts 配置，即： 原文：manageetchosts: localhost 修改后：

索引策略管理 配置日志索引在Elasticsearch中保存天数，每天凌晨1点删除超过该天数的索引。默认索引保存天数180天。 1. 登录日志审计（原生版）控制台。 2. 在左侧导航栏选择“系统配置 > 数据模型”，在上方选择“索引策略管理”页签。 3. 配置日志分层存储策略，单击“保存修改”，完成配置。 参数 说明 索引分层 是否开启日志分层存储。 默认值为关闭，即不开启日志分层存储。 取值范围： 关闭：与已有存储方案保持一致，所有数据为热存储。 开启：可配置热冷存储，注意只对新数据有效。 索引保存天数 配置日志索引在ElasticSearch中的保存天数，每天凌晨1点删除超过该天数的索引。 取值范围： “索引分层”关闭时，默认值为180天。 “索引分层”开启时，默认值为热存储0~90天，冷存储90~180天。 热存储：用于存储经常被访问的数据，支持数据实时访问，提供高性能的日志查询和分析功能，适用于数据高频查询分析等业务场景。 冷存储：在现有热存储的基础上，为您提供更低成本且可查询、分析的长期数据存储方案。适用于数据审计长期保存的业务场景。 是否打开储存警戒值 储存警戒值打开后，每天凌晨1点删除ElasticSearch中的旧数据，直到ElasticSearch磁盘利用率低于该储存警戒值。 默认关闭。 注意 删除的数据无法恢复，请谨慎开启储存警戒值。

本文主要介绍应用服务网格日志采集。 应用服务网格支持采集控制面（control plane）、数据面（sidecar）日志以及应用服务网格网关日志，您可以在控制台日志中心查看日志。 前提条件 1. 天翼云账号已经开通了云日志服务，如果没有开通可以通过服务网格控制台>网格实例>自定义配置>创建云日志服务。 2. 网格控制面和数据面集群已经安装了日志采集插件logoperator。可以通过ccse控制台>插件>插件市场安装。 启用服务网格日志采集 1. 登录服务网格控制台，在左侧的导航栏中选择网格实例>自定义配置。 2. 选择启用日志服务，可以选择已有的日志项目或者新建日志项目，支持为数据面、控制面和网关分别创建日志单元，您可以参考云日志服务管理日志项目查看已有的项目。如果需要新建项目，应用服务网格控制台会自动为您创建对应名称的项目。 日志中心日志查询 您可以在日志服务控制台查询服务网格控制面和数据面的日志，更多详情可参考云日志服务日志查询。 数据面日志输出格式 目前服务网格的数据面日志访问格式采用Envoy默认格式： plaintext [%STARTTIME%] "%REQ(:METHOD)% %REQ(XENVOYORIGINALPATH?:PATH)% %PROTOCOL%" %RESPONSECODE% %RESPONSEFLAGS% %BYTESRECEIVED% %BYTESSENT% %DURATION% %RESP(XENVOYUPSTREAMSERVICETIME)% "%REQ(XFORWARDEDFOR)%" "%REQ(USERAGENT)%" "%REQ(XREQUESTID)%" "%REQ(:AUTHORITY)%" "%UPSTREAMHOST%"n 以下是一个日志格式的例子： plaintext [20160415T20:17:00.310Z] "POST /api/v1/locations HTTP/2" 204 154 0 226 100 "10.0.35.28" "nsq2http" "cc21d9b0cf5c432b8c7e98aeb7988cd2" "locations" "tcp://10.0.2.1:80" 以下是日志样式字段的说明： 参数 描述 STARTTIME 请求开始时间。 REQ(:METHOD) 请求方法。 REQ(XENVOYORIGINALPATH?:PATH) 请求的原始路径，若无则使用标准路径。 PROTOCOL 请求所使用的协议。 RESPONSECODE 服务器对请求的响应状态码。 RESPONSEFLAGS 响应的标志，提供关于响应的特性信息。 BYTESRECEIVED 接收到的字节数，指示请求消息的大小。 BYTESSENT 发送出去的字节数，指示响应消息的大小。 DURATION 请求处理的持续时间，包括接收到请求到发送响应的时间。 RESP(XENVOYUPSTREAMSERVICETIME) 上游服务的响应时间，表示上游服务处理请求所花费的时间。 REQ(XFORWARDEDFOR) 请求的xff头部。 REQ(USERAGENT) 请求的用户代理，标识发起请求的软件。 REQ(XREQUESTID) 请求的唯一标识符，用于跟踪请求的生命周期。 REQ(:AUTHORITY) 请求的主机名，在HTTP/2中对应请求的authority字段。 RESPONSEFLAGS说明： 完整名称 短名 说明 NoHealthyUpstream UH 没有健康的上游服务，返回503状态码。 UpstreamConnectionFailure UF 连接上游失败，返回503状态码。 UpstreamOverflow UO 上游服务被熔断，返回503状态码。 NoRouteFound NR 找不到路由或者找不到过滤器链，返回404状态码。 UpstreamRetryLimitExceeded URX 超过上游重试次数。 NoClusterFound NC 找不到上游集群。 DurationTimeout DT 请求超时。 DownstreamConnectionTermination DC 下游连接中断。 FailedLocalHealthCheck LH 集群健康检查失败，返回503状态码。 UpstreamRequestTimeout UT 上游服务超时，返回504状态码。 LocalReset LS 连接被本地重置，返回503状态码。 UpstreamRemoteReset UR 连接被上游重置，返回503状态码。 UpstreamConnectionTermination UC 上游连接中断，返回503状态码。 DelayInjected DI 请求被注入了延迟。 FaultInjected FI 请求被注入了错误。 RateLimited RL 请求被限流，返回429错误码。 UnauthorizedExternalService UAEX 请求被外部授权服务拒绝。 RateLimitServiceError RLSE 由于限流服务报错导致请求被拒绝。 InvalidEnvoyRequestHeaders IH 请求头部异常，返回400错误码。 StreamIdleTimeout SI 请求空闲超时，返回408或者504错误。 DownstreamProtocolError DPE 下游请求HTTP协议错误。 UpstreamProtocolError UPE 上游返回的HTTP协议错误。 UpstreamMaxStreamDurationReached UMSDR 请求上游超时。 ResponseFromCacheFilter RFCF 请求通过envoy缓存插件支撑。 NoFilterConfigFound NFCF 由于没有在时间期限内收到filter配置导致请求被中断。 OverloadManagerTerminated OM 请求被过载管理器中断。 DnsResolutionFailed DF DNS解析失败。 DropOverload DO 请求被上游过载保护机制中断，返回503状态码。

本章主要介绍翼MapReduce的 配置受信任IP访问LDAP功能。 操作场景 默认情况下，部署在OMS和集群中的LDAP服务允许任意IP访问。如果需要只允许受信任的IP地址访问LDAP服务，可以配置iptables过滤列表的INPUT策略。 对系统的影响 配置受信任IP访问LDAP以后，未配置的IP无法访问LDAP。扩容前，新增加的IP需要配置为受信任的IP。 前提条件 根据安装规划，收集集群内全部节点的管理平面IP、业务平面IP和所有浮动IP。 获取集群内节点的root用户和密码。 操作步骤 配置OMS LDAP信任的IP地址 1.确定管理节点IP地址，请参见登录管理节点。 2.登录FusionInsight Manager，请参见登录管理系统。 3.选择“系统 > OMS”，在“服务”选择“oldap > 修改配置”，查看OMS LDAP端口号，即“Ldap服务监听端口”参数值。默认为“21750”。 4.以root用户通过主管理节点的IP地址登录主管理节点。 5.执行以下命令，查看iptables过滤列表中INPUT策略。 iptables L 例如未配置任何规则时，INPUT策略显示如下： Chain INPUT (policy ACCEPT) target prot opt source destination 6.执行以下命令，将集群使用的所有IP地址配置为受信任的IP。每个IP需要添加一次。 iptables A INPUT s 受信任IP地址 p tcp dport 端口号 j ACCEPT 例如，将10.0.0.1配置为受信任的IP，可以访问端口21750，执行： iptables A INPUT s 10.0.0.1 p tcp dport 21750 j ACCEPT 7.执行以下命令，将全部IP地址配置为不受信任的IP。已配置为信任IP不受此规则影响。 iptables A INPUT p tcp dport 端口号 j DROP 例如，配置全部IP不能访问端口21750，执行： iptables A INPUT p tcp dport 21750 j DROP 8.执行以下命令，查看iptables过滤列表中修改后INPUT策略。 iptables L 例如配置一个受信任IP后，INPUT策略显示如下： Chain INPUT (policy ACCEPT) target prot opt source destination ACCEPT tcp 10.0.0.1 anywhere tcp dpt:21750 DROP tcp anywhere anywhere tcp dpt:21750 9.执行以下命令，查看iptables过滤列表中存在的规则及相对应的编号。 iptables L n linenumber Chain INPUT (policy ACCEPT) num target prot opt source destination 1 DROP tcp 0.0.0.0/0 0.0.0.0/0 tcp dpt:21750 10.根据实际需求，可执行以下命令，删除iptables过滤列表中的规则。 iptables D INPUT 待删除的编号 例如，删除编号为1的规则，执行： iptables D INPUT 1 11.以root用户通过备管理节点的IP地址登录备管理节点，并重复5到10。

本文介绍科研助手的技术运维类常见问题。 作业运行常见问题 1. 作业提交后，为什么没有立刻启动？ 作业提交后会由平台进行调度，根据优先级排队等待资源，等待时间依资源池繁忙程度而定。一个作业内可以包含多个任务节点和实例，有可能出现作业中某些实例分配了资源开始运行，其它实例还在等待的情况。 2. 作业运行结束后，其中的数据是否还在？ 作业运行结束后，其中的数据将被销毁，请在作业业务逻辑中及时保存数据，例如将数据存储到对象存储等持久化存储介质中。 3. 通过息壤·科研助手提交的作业，是否支持节点间通信？ 同一个集群内的实例，可以通过内网 IP 进行通信，不同集群间实例不能互相通信。 调试和查错常见问题 1. 如何进行开发调试？ 息壤·科研助手提供了开发环境，可现在开发环境进行单机调试。 2. 如果程序执行失败怎么调试？ 程序失败时可以通过查看作业和实例事件获取更多的作业运行信息。如果问题还未能解决，请联系售后技术支持。

告警联系人/组 告警联系人：激活 接口功能介绍 调用此接口可激活告警联系人的手机短息或邮箱，激活后的媒介可接收平台告警信息。 接口约束 告警联系人ID存在。 URI POST /v4/monitor/activatecontact 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 contactID 是 String 告警联系人ID a6fb570f22995bde989cdf0819c687d0 media 是 String 本参数表示媒介。取值范围：sms：手机短信。email：邮箱。根据以上范围取值。 sms code 是 Integer 验证码 123456 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true

本文帮助您了解海量文件服务OceanFS产品的到期提醒和数据保留。 到期提醒 在服务到期（指按周期计费）前7天、3天、1天时系统将向您发送到期提醒短信和邮件，请注意查看并及时处理。 数据保留 服务到期后您的存储资源将暂时被冻结，无法进行读写操作。资源保留期15天，若没有即时续订资源及数据将被销毁。

参数名 类型 是否必填 名称 说明 startTime string 是 开始时间 支持最近30天的时间数据 endTime string 是 结束时间 支持最近30天的时间数据 pageSize string 否 查询每页的数量 不传默认30条；pageSize以及pageNum的乘积不得超过2000 pageNum string 否 查询的页数 不传默认第一页；pageSize以及pageNum的乘积不得超过2000

参数名 类型 是否必填 名称 说明 startTime string 是 开始时间 支持最近30天的时间数据 endTime string 是 结束时间 支持最近30天的时间数据 pageSize string 否 查询每页的数量 不传默认30条；pageSize以及pageNumber的乘积不得超过2000 pageNumber string 否 查询的页数 不传默认第一页；pageSize以及pageNumber的乘积不得超过2000

本章节主要介绍翼MapReduce的配置审计日志转储操作。 操作场景 Manager的审计日志默认保存在数据库中，如果长期保留可能引起数据目录的磁盘空间不足问题，管理员如果需要将审计日志保存到其他归档服务器，可以在FusionInsight Manager设置转储参数及时自动转储，便于管理审计日志信息。 若用户未配置审计日志转储，当审计日志达到十万条，系统自动将这十万条审计日志保存到文件中。保存路径为主管理节点“${BIGDATADATAHOME}/dbdataom/dumpData/iam/operatelog”，保存的文件名格式为“OperateLogstoreYYMMDDHHMMSS.csv”，保存的审计日志历史文件数最大为50。 操作步骤 1. 登录FusionInsight Manager。 2. 选择“审计 > 配置”。 3. 单击“审计日志转储”右侧的开关。 “审计日志转储”默认为不启用，开关显示为表示启用。 4. 根据下表填写转储参数。 审计日志转储参数 参数名 参数解释 参数值 SFTP IP 模式 目标IP的IP地址模式，可选择“IPv4”或者“IPv6”。 IPv4 SFTP IP 指定审计日志转储后存放的SFTP服务器，建议使用基于SSH v2的SFTP服务，否则存在安全风险。 192.168.10.51（举例） SFTP端口 指定审计日志转储后存放的SFTP服务器连接端口。 22（举例） 保存路径 指定SFTP服务器上保存审计日志的路径。 /opt/omm/oms/auditLog（举例） SFTP用户名 指定登录SFTP服务器的用户名。 root（举例） SFTP密码 指定登录SFTP服务器的密码。 SFTP服务器的密码 SFTP公共秘钥 可选参数，指定SFTP服务器的公共密钥，建议配置SFTP的公共密钥，否则可能存在安全风险。 转储模式 指定转储模式 “按数量”：日志到达指定条数（默认10万条）时开始转储 “按时间”：指定某一日期开始转储，转储频率为一年一次。 按数量 按时间 转储日期 当选择“按时间”转储模式时可用。选择一个转储日期后，系统将在此日期开始转储。转储的日志范围为当前年份1月1日0时之前的所有审计日志。 1106（举例） 说明 SFTP公共密钥为空时，系统将进行安全风险提示，确定安全风险后再保存配置。 5. 单击“确定”，设置完成。 说明 审计日志转储文件关键字段参考： “USERTYPE”表示用户类型，“0”表示“人机”用户，“1”表示“机机”用户。 “LOGLEVEL”表示安全级别，“0”表示高危，“1”表示危险，“2”表示一般，“3”表示提示。 “OPERATERESULT”表示操作结果，“0”表示成功，“1”表示失败。

安全运维提供查看和管理云服务安全基本数据，您可以通过界面总览信息快速查看和管理您的资源的安全情况。 未开通服务器安全卫士（原生版）的用户，需要确认服务协议开通后使用。 已开通服务器安全卫士（原生版）的用户，免费版和付费版数据展示存在差异，如有需要请开通付费版本查看。 主要数据包括： 1. 安全总览：包括资产信息（全部服务器、风险服务器、未防护服务器、免费防护服务器对应的个数）和告警处置信息（未处置威胁告警、拦截恶意IP、隔离病毒文件对应的个数）。 2. 威胁告警：实时监控最新威胁告警事件 Top5。 3. 风险漏洞：实时监控最新风险漏洞事件 Top5。 4. 基线核查：实时监控最新威胁入侵事件 Top5。 5. Agent状态：包括在线和离线Agent个数。 6. 风险趋势：可选择切换时间维度：近7天、近14天。

接口描述 检索知识库内容，支持丰富的检索策略。 请求方法 POST 接口要求 无 URI /openapi/v1/index/retrieve 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String json格式 application/json tenantId 是 String 租户ID 562b89493b1a40e1b97ea05e50dd8170 ctyuneoprequestid 是 String 用户请求 id，由用户构造，用户可以通过 uuid 等方法自行生成唯一字符串，用于日志请求追踪 33dfa732b27b464fb15a21ed6845afd5 eopdate 是 String 请求时间，由用户构造，形如 yyyymmddTHHMMSSZ。 20211221T163014Z host 是 String 终端节点域名，固定字段 kqaglobal.ctapi.ctyun.cn EopAuthorization 是 String 由天翼云官网 accessKey 和 securityKey 经签名后生成，参与签名生成的字段包括天翼云官网 accessKey 、securityKey、平台应用的appkey（非必须），用户请求id（非必须），请求时间，终端节点域名（非必须）以及请求体内容。 请求体Body参数 参数 是否必填 参数类型 说明 示例 下级对象 origin 是 Array[Object] 对话历史内容 注意：当前仅支持传入两轮对话上下文 [ { "role": "user", "content": "deepseek什么时候发布的" }, { "role": "assistant", "content": "2025年1月份" }, { "role": "user", "content": "它是由哪家公司研发的？" } ] Chat对象 searchType 是 String 搜索策略设置，有以下三种取值： HYBRIDSEARCH：混合检索； DENSESEARCH: 向量检索； SPARSESEARCH：稀疏/关键字检索； 注意：当指定某一检索模式后，下方params参数中仅该模式对应的配置项会生效，其余模式的参数将被忽略。 "DENSESEARCH" hybridParams 否 Object 混合检索专属配置参数，仅当 searchType 取值为 HYBRIDSEARCH 时生效； 若未传入该参数，系统将使用混合检索的默认配置 { "hybridTopK": 15, "denseWeight": 0.7, "sparseWeight": 0.3 } HybridParams对象 denseParams 否 Object 向量检索专属配置参数，仅当 searchType 取值为 DENSESEARCH 时生效； 若未传入该参数，系统将使用向量检索的默认配置 { "denseSimilarityTopK": 25 } DenseParams对象 sparseParams 否 Object 稀疏/关键词检索参数，仅当 searchType 取值为 SPARSESEARCH 时生效； 若未传入该参数，系统将使用稀疏 / 关键字检索的默认配置数 { "sparseSimilarityTopK":15 } SparseParams对象 searchScope 是 Array[Object] 指定检索的知识库范围，系统仅在该范围內执行检索操作 [ { "infoBaseId": "302", "fileIds": [ 1107， 1108 ] } ] SearchScope对象 enableRewrite 是 Boolean 是否开启历史对话补全改写。 开启后，系统会基于 origin 中的完整对话历史，将最后一轮用户问题补全为语义完整、可独立检索的查询语句，并使用改写后的 query 执行检索 true rerankParams 否 Object 检索结果重排等特殊策略的配置参数； 若未传入，系统将使用结果重排的默认规则 RerankParams对象 Chat对象 参数 是否必填 参数类型 说明 示例 下级对象 role 是 String 角色 user/assistant/system content 是 String 内容 你是谁 HybridParams对象 参数 是否必填 参数类型 说明 示例 下级对象 hybridTopK 否 Int 混合检索阶段召回结果的 TopK 数量； 当 NeedReRankfalse（未开启重排）时，该值即为最终返回给用户的结果数量 取值范围：[1,100] 默认值：15 30 denseWeight 否 float 混合检索中，向量检索结果在最终评分计算时的权重占比。 取值范围：[0,1] 默认值：0.8 注意：denseWeight和sparseWeight之和必须为1 0.8 sparseWeight 否 float 混合检索中，关键字检索结果在最终评分计算时的权重占比。 取值范围：[0,1] 默认值：0.2 注意：denseWeight和sparseWeight之和必须为1 0.2 DenseParams对象 参数 是否必填 参数类型 说明 示例 下级对象 denseSimilarityTopK 否 Int 向量检索阶段召回结果的 TopK 数量； 当 NeedReRankfalse（未开启重排）时，该值即为最终返回给用户的结果数量 取值范围：[1, 100] 默认值：30 30 SparseParams对象 参数 是否必填 参数类型 说明 示例 下级对象 sparseSimilarityTopK 否 Int 关键词检索阶段召回结果的 TopK 数量； 当 NeedReRankfalse（未开启重排）时，该值即为最终返回给用户的结果数量 取值范围：[1,100] 默认值：30 30 SearchScope对象 参数 是否必填 参数类型 说明 示例 下级对象 infobaseId 是 String 知识库ID 600 fileIds 否 Array[Int] 文档ID列表。 fileIds为空时默认检索知识库ID下所有文档 [11,71] RerankParams对象 参数 是否必填 参数类型 说明 示例 下级对象 enableReranking 是 boolean 是否开启检索结果重排功能，开启后系统将对召回的文本切片执行重排策略 true rerankMinScore 否 float 重排阶段文本切片的相似度筛选阈值； 仅 Rank 模型返回的相似度分数大于等于该值的文本切片会被保留召回； 取值范围： [0.01, 1.00] 默认值：0.1 0.5 rerankTopN 否 integer 重排完成后最终返回的文本切片数量（Top N）。 取值范围：[120] 默认值为：5 30 请求代码示例 plaintext Curl X POST " H "ContentType: application/json" H "ctyuneoprequestid:33dfa732b27b464fb15a21ed6845afd5" H "tenantId:XXX" H "EopAuthorization:XXX" H "eopdate:20211109T104641Z" H "host:kqaglobal.ctapi.ctyun.cn" data '{ "origin": [ { "role": "user", "content": "deepseek什么时候发布的" }, { "role": "assistant", "content": "2025年1月份" }, { "role": "user", "content": "它是由哪家公司研发的？" } ], "searchType": "SPARSESEARCH", "hybridParams": { "hybridTopK": 15, "denseWeight": 0.7, "sparseWeight": 0.3 }, "denseParams": { "denseSimilarityTopK": 25 }, "sparseParams": { "sparseSimilarityTopK": 15 }, "searchScope": [ { "infoBaseId": "302", "fileIds": [ 1107, 1108 ] }, { "infoBaseId": "304", "fileIds": [] } ], "enableRewrite": true, "rerankParams": { "enableReranking": true, "rerankMinScore": 0.5, "rerankTopN": 5 } } 返回值说明 1.请求成功返回响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回状态，返回200表示成功 200 message String 返回Success Success returnObj Object 接口返回结果 returnObj表 returnObj表 参数 参数类型 说明 示例 下级对象 matchList Array[Object] 检索到的匹配文本片段列表 MatchListObject对象 count Integer 列表长度 3 MatchListObject表 参数 是否必填 参数类型 说明 示例 下级对象 FileID 是 Long 文件id FileName 是 String 文件名 KnowledgeID 是 Long 知识ID ChunkID 是 Long 文档片段ID ChunkText 是 String 文档片段文本 ContentID 是 Long 内容ID ContentText 是 String 内容文本 SubTitle 是 String 文档摘要 DocTitle 是 String 内容摘要 Score 是 Float 匹配得分 UserName 是 String 用户名 DbName 是 String 知识库名 From 是 String 来源，可以取值（Knowledge/PPT/Image/Excel） QAID 否 Long 问答对id Question 否 String 问题文本 Answer 否 String 答案文本 ScreenShot 是 String PPT截图 ImageShot 是 String 图片截图 HostLogo 否 String 联网搜索的logo地址 Order 否 Long 顺序 Url 否 String 联网搜索的地址 FileType 是 String 文档类型 FileID 是 Long 文件id FileName 是 String 文件名 KnowledgeID 是 Long 知识ID 2.请求失败返回响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 错误码，放置API对应的错误码 40001 message String 失败信息 缺少鉴权信息 error String 返回对应的错误码 KQA40001 返回值示例 1.请求成功返回值示例 plaintext { "statusCode": 200, "error": null, "message": "Success", "returnObj": { "count": 2, "matchList": [ { "FileID": 1108, "FileName": "知识库API.docx", "KnowledgeID": 461419421572632289, "ChunkID": 1, "ChunkText": "知识库API.docx...", "ContentID": 14, "ContentText": "1.请求成功返回值示例...", "SubTitle": "三、 API", "DocTitle": "知识库API.docxn天翼云StateCloud", "Score": 0.064522564, "UserName": "155535", "DbName": "302", "From": "Knowledge", "QAID": null, "Question": null, "Answer": null, "ScreenShot": null, "ImageShot": null, "HostLogo": null, "Order": null, "Url": null, "FileType": "doc" }, { "FileID": 1108, "FileName": "知识库API.docx", "KnowledgeID": 461419421572632275, "ChunkID": 1, "ChunkText": "知识库API.docxn...", "ContentID": 7, "ContentText": "需要在httpclient 的请求头部中加上...", "SubTitle": "二、 如何调用APIn3.拿kAk 作为密钥，eopdate 的年月日值作为数据，算出kdate。", "DocTitle": "知识库API.docxn天翼云StateCloud", "Score": 0.014622092, "UserName": "155535", "DbName": "302", "From": "Knowledge", "QAID": null, "Question": null, "Answer": null, "ScreenShot": null, "ImageShot": null, "HostLogo": null, "Order": null, "Url": null, "FileType": "doc" } ] } } 2.请求失败返回值示例 plaintext { "statusCode": "40004", "error": "KQA40004", "message": "接口执行异常" } 状态码 http状态码 描述 200 表示请求成功 错误码说明 错误码 错误信息 错误描述 40004 业务异常 业务异常，详情见message 40005 知识库不存在

接口描述 检索知识库内容，支持丰富的检索策略。 请求方法 POST 接口要求 无 URI /openapi/v1/index/retrieve 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String json格式 application/json tenantId 是 String 租户ID 562b89493b1a40e1b97ea05e50dd8170 ctyuneoprequestid 是 String 用户请求 id，由用户构造，用户可以通过 uuid 等方法自行生成唯一字符串，用于日志请求追踪 33dfa732b27b464fb15a21ed6845afd5 eopdate 是 String 请求时间，由用户构造，形如 yyyymmddTHHMMSSZ。 20211221T163014Z host 是 String 终端节点域名，固定字段 kqaglobal.ctapi.ctyun.cn EopAuthorization 是 String 由天翼云官网 accessKey 和 securityKey 经签名后生成，参与签名生成的字段包括天翼云官网 accessKey 、securityKey、平台应用的appkey（非必须），用户请求id（非必须），请求时间，终端节点域名（非必须）以及请求体内容。 请求体Body参数 参数 是否必填 参数类型 说明 示例 下级对象 origin 是 Array[Object] 对话历史内容 注意：当前仅支持传入两轮对话上下文 [ { "role": "user", "content": "deepseek什么时候发布的" }, { "role": "assistant", "content": "2025年1月份" }, { "role": "user", "content": "它是由哪家公司研发的？" } ] Chat对象 searchType 是 String 搜索策略设置，有以下三种取值： HYBRIDSEARCH：混合检索； DENSESEARCH: 向量检索； SPARSESEARCH：稀疏/关键字检索； 注意：当指定某一检索模式后，下方params参数中仅该模式对应的配置项会生效，其余模式的参数将被忽略。 "DENSESEARCH" hybridParams 否 Object 混合检索专属配置参数，仅当 searchType 取值为 HYBRIDSEARCH 时生效； 若未传入该参数，系统将使用混合检索的默认配置 { "hybridTopK": 15, "denseWeight": 0.7, "sparseWeight": 0.3 } HybridParams对象 denseParams 否 Object 向量检索专属配置参数，仅当 searchType 取值为 DENSESEARCH 时生效； 若未传入该参数，系统将使用向量检索的默认配置 { "denseSimilarityTopK": 25 } DenseParams对象 sparseParams 否 Object 稀疏/关键词检索参数，仅当 searchType 取值为 SPARSESEARCH 时生效； 若未传入该参数，系统将使用稀疏 / 关键字检索的默认配置数 { "sparseSimilarityTopK":15 } SparseParams对象 searchScope 是 Array[Object] 指定检索的知识库范围，系统仅在该范围內执行检索操作 [ { "infoBaseId": "302", "fileIds": [ 1107， 1108 ] } ] SearchScope对象 enableRewrite 是 Boolean 是否开启历史对话补全改写。 开启后，系统会基于 origin 中的完整对话历史，将最后一轮用户问题补全为语义完整、可独立检索的查询语句，并使用改写后的 query 执行检索 true rerankParams 否 Object 检索结果重排等特殊策略的配置参数； 若未传入，系统将使用结果重排的默认规则 RerankParams对象 Chat对象 参数 是否必填 参数类型 说明 示例 下级对象 role 是 String 角色 user/assistant/system content 是 String 内容 你是谁 HybridParams对象 参数 是否必填 参数类型 说明 示例 下级对象 hybridTopK 否 Int 混合检索阶段召回结果的 TopK 数量； 当 NeedReRankfalse（未开启重排）时，该值即为最终返回给用户的结果数量 取值范围：[1,100] 默认值：15 30 denseWeight 否 float 混合检索中，向量检索结果在最终评分计算时的权重占比。 取值范围：[0,1] 默认值：0.8 注意：denseWeight和sparseWeight之和必须为1 0.8 sparseWeight 否 float 混合检索中，关键字检索结果在最终评分计算时的权重占比。 取值范围：[0,1] 默认值：0.2 注意：denseWeight和sparseWeight之和必须为1 0.2 DenseParams对象 参数 是否必填 参数类型 说明 示例 下级对象 denseSimilarityTopK 否 Int 向量检索阶段召回结果的 TopK 数量； 当 NeedReRankfalse（未开启重排）时，该值即为最终返回给用户的结果数量 取值范围：[1, 100] 默认值：30 30 SparseParams对象 参数 是否必填 参数类型 说明 示例 下级对象 sparseSimilarityTopK 否 Int 关键词检索阶段召回结果的 TopK 数量； 当 NeedReRankfalse（未开启重排）时，该值即为最终返回给用户的结果数量 取值范围：[1,100] 默认值：30 30 SearchScope对象 参数 是否必填 参数类型 说明 示例 下级对象 infobaseId 是 String 知识库ID 600 fileIds 否 Array[Int] 文档ID列表。 fileIds为空时默认检索知识库ID下所有文档 [11,71] RerankParams对象 参数 是否必填 参数类型 说明 示例 下级对象 enableReranking 是 boolean 是否开启检索结果重排功能，开启后系统将对召回的文本切片执行重排策略 true rerankMinScore 否 float 重排阶段文本切片的相似度筛选阈值； 仅 Rank 模型返回的相似度分数大于等于该值的文本切片会被保留召回； 取值范围： [0.01, 1.00] 默认值：0.1 0.5 rerankTopN 否 integer 重排完成后最终返回的文本切片数量（Top N）。 取值范围：[120] 默认值为：5 30 请求代码示例 plaintext Curl X POST " H "ContentType: application/json" H "ctyuneoprequestid:33dfa732b27b464fb15a21ed6845afd5" H "tenantId:XXX" H "EopAuthorization:XXX" H "eopdate:20211109T104641Z" H "host:kqaglobal.ctapi.ctyun.cn" data '{ "origin": [ { "role": "user", "content": "deepseek什么时候发布的" }, { "role": "assistant", "content": "2025年1月份" }, { "role": "user", "content": "它是由哪家公司研发的？" } ], "searchType": "SPARSESEARCH", "hybridParams": { "hybridTopK": 15, "denseWeight": 0.7, "sparseWeight": 0.3 }, "denseParams": { "denseSimilarityTopK": 25 }, "sparseParams": { "sparseSimilarityTopK": 15 }, "searchScope": [ { "infoBaseId": "302", "fileIds": [ 1107, 1108 ] }, { "infoBaseId": "304", "fileIds": [] } ], "enableRewrite": true, "rerankParams": { "enableReranking": true, "rerankMinScore": 0.5, "rerankTopN": 5 } } 返回值说明 1.请求成功返回响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回状态，返回200表示成功 200 message String 返回Success Success returnObj Object 接口返回结果 returnObj表 returnObj表 参数 参数类型 说明 示例 下级对象 matchList Array[Object] 检索到的匹配文本片段列表 MatchListObject对象 count Integer 列表长度 3 MatchListObject表 参数 是否必填 参数类型 说明 示例 下级对象 FileID 是 Long 文件id FileName 是 String 文件名 KnowledgeID 是 Long 知识ID ChunkID 是 Long 文档片段ID ChunkText 是 String 文档片段文本 ContentID 是 Long 内容ID ContentText 是 String 内容文本 SubTitle 是 String 文档摘要 DocTitle 是 String 内容摘要 Score 是 Float 匹配得分 UserName 是 String 用户名 DbName 是 String 知识库名 From 是 String 来源，可以取值（Knowledge/PPT/Image/Excel） QAID 否 Long 问答对id Question 否 String 问题文本 Answer 否 String 答案文本 ScreenShot 是 String PPT截图 ImageShot 是 String 图片截图 HostLogo 否 String 联网搜索的logo地址 Order 否 Long 顺序 Url 否 String 联网搜索的地址 FileType 是 String 文档类型 FileID 是 Long 文件id FileName 是 String 文件名 KnowledgeID 是 Long 知识ID 2.请求失败返回响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 错误码，放置API对应的错误码 40001 message String 失败信息 缺少鉴权信息 error String 返回对应的错误码 KQA40001 返回值示例 1.请求成功返回值示例 plaintext { "statusCode": 200, "error": null, "message": "Success", "returnObj": { "count": 2, "matchList": [ { "FileID": 1108, "FileName": "知识库API.docx", "KnowledgeID": 461419421572632289, "ChunkID": 1, "ChunkText": "知识库API.docx...", "ContentID": 14, "ContentText": "1.请求成功返回值示例...", "SubTitle": "三、 API", "DocTitle": "知识库API.docxn天翼云StateCloud", "Score": 0.064522564, "UserName": "155535", "DbName": "302", "From": "Knowledge", "QAID": null, "Question": null, "Answer": null, "ScreenShot": null, "ImageShot": null, "HostLogo": null, "Order": null, "Url": null, "FileType": "doc" }, { "FileID": 1108, "FileName": "知识库API.docx", "KnowledgeID": 461419421572632275, "ChunkID": 1, "ChunkText": "知识库API.docxn...", "ContentID": 7, "ContentText": "需要在httpclient 的请求头部中加上...", "SubTitle": "二、 如何调用APIn3.拿kAk 作为密钥，eopdate 的年月日值作为数据，算出kdate。", "DocTitle": "知识库API.docxn天翼云StateCloud", "Score": 0.014622092, "UserName": "155535", "DbName": "302", "From": "Knowledge", "QAID": null, "Question": null, "Answer": null, "ScreenShot": null, "ImageShot": null, "HostLogo": null, "Order": null, "Url": null, "FileType": "doc" } ] } } 2.请求失败返回值示例 plaintext { "statusCode": "40004", "error": "KQA40004", "message": "接口执行异常" } 状态码 http状态码 描述 200 表示请求成功 错误码说明 错误码 错误信息 错误描述 40004 业务异常 业务异常，详情见message 40005 知识库不存在

本页介绍了文档数据库服务产品咨询类相关常见问题。 文档数据库服务和社区版MongoDB有什么关系 文档数据库服务是天翼云基于社区版MongoDB提供的高性能NoSQL数据库服务，完全兼容MongoDB协议。文档数据库服务在容灾、备份、恢复、监控、报警等方面提供全套数据库解决方案。可降低管理维护成本，方便您专注于应用开发和业务发展。 使用文档数据库服务要注意什么 使用文档数据库服务需要综合考虑安全性、性能、可用性和数据一致性等方面，合理配置和管理数据库，确保应用程序能够高效稳定地使用文档数据库服务。 当您评估业务对服务可用性有较高的要求时，建议优先选择副本集与分片集群的架构，副本集与分片集群提供了更高的数据可靠性与服务可用性，当发生主节点宕机时，其他的节点可以接替主节点继续提供服务，不影响业务侧的读写。 实例侧的弹性云主机，对用户是不可见的，您只需参考实例基本信息页的连接串配置数据库连接进行数据库服务的访问即可。 在对数据库进行不熟悉的操作时，建议先对数据进行备份，方便数据回档。 您不需要进行数据库的基础运维，但是可以留意一下性能监控，比如机器的磁盘、内存使用率等情况，规格不足时可以进行扩容更好满足业务需求。 什么是文档数据库服务的可用性 文档数据库服务的可用性通常是指数据库系统在正常运行时可以对外提供服务的能力，以及系统在遇到故障或意外情况时能够保持部分或全部功能的可用性。文档数据库服务提供多节点副本集与分片集群的高可用架构。集群节点之间数据自动同步，提升了数据的高可靠性与服务的高可用性。