本节介绍了设置RDS for MySQL本地Binlog日志保留时长的操作场景、注意事项、操作步骤等相关内容。 操作场景 RDS for MySQL支持设置本地Binlog日志的清理，所有需要清理的本地日志都会在Binlog备份成功后删除，您可以根据需求灵活设置本地Binlog保留时长，合理利用实例使用空间。 说明 RDS默认开启Binlog，无需额外配置，binlogformat格式为row。 在RDS界面，仅支持在主实例中设置Binlog日志清理，只读实例的Binlog日志清理周期和主实例保持一致。 如果存在异常的只读或备节点，不会清理本地Binlog日志，防止清理后出现只读或备节点无法正常复制的情况。 Binlog本地保留时长，可设置范围为0~724小时。 清理Binlog日志时，即使设置保留时长为0，RDS也会保证主节点的Binlog同步到备节点、只读节点全部完成、并且备份成功到OBS以后才会执行清理。如果选择的保留时长大于0，例如设置1天，那么在Binlog同步及备份成功后，本地Binlog日志将会继续保留1天，到期后自动删除。如需查看Binlog日志，请参见下载Binlog备份文件。 注意事项 界面设置的Binlog过期时间以小时为单位，通过命令查看“expirelogsdays”（5.7版本参数）和“binlogexpirelogsseconds”（8.0版本参数）过期时间单位为天，不建议作为参考依据。查看具体的Binlog过期时间时，以界面设置的为准。 操作步骤 步骤 1 登录管理控制台。 步骤 2 单击管理控制台左上角的 ，选择区域。 步骤 3 选择“数据库 > 关系型数据库”。进入关系型数据库信息页面。 步骤 4 在“实例管理”页面，选择目标实例，单击实例名称，进入实例的“基本信息”页签。 步骤 5 在左侧导航栏，单击“备份恢复”，在“Binlog备份”子页签下，单击“Binlog本地保留设置”。 步骤 6 在“Binlog本地保留设置”弹出框中，设置保留时长，单击“确定”。 结束

指标类型 指标名称 单位 描述 调用次数 函数总调用（FunctionTotalInvocations） 次 基于预留和按量模式统计的函数总调用次数。按1分钟或1小时粒度统计求和。 调用次数 基于预留模式的调用（FunctionProvisionInvocations） 次 基于预留模式统计的函数总调用次数。按1分钟或1小时粒度统计求和。 HTTP状态码统计 函数HTTP状态码2xx请求数（FunctionHTTPStatus2xx） 次 每秒处理的请求中返回HTTP状态为2xx的请求数，按粒度1分钟、5分钟或1小时统计求和。 HTTP状态码统计 函数HTTP状态码3xx请求数（FunctionHTTPStatus3xx） 次 每秒处理的请求中返回HTTP状态为3xx的请求数，按粒度1分钟、5分钟或1小时统计求和。 HTTP状态码统计 函数HTTP状态码4xx请求数（FunctionHTTPStatus4xx） 次 每秒处理的请求中返回HTTP状态为4xx的请求数，按粒度1分钟、5分钟或1小时统计求和。 HTTP状态码统计 函数HTTP状态码5xx请求数（FunctionHTTPStatus5xx） 次 每秒处理的请求中返回HTTP状态为5xx的请求数，按粒度1分钟、5分钟或1小时统计求和。 错误次数 服务端错误（FunctionServerErrors） 次 在调用某个指定函数时，由于函数计算系统原因导致函数未被执行的总调用次数。按1分钟或1小时粒度统计求和。 错误次数 客户端错误（FunctionClientErrors） 次 在某一地域内调用函数时，由于函数计算客户端错误导致函数未被执行或执行未成功，且返回 4xx 状态码的总调用次数。按1分钟或1小时粒度统计求和。 部分状态码示例如下： 400 ：参数错误。 403 ：缺少权限。 404 ：资源找不到。 412 ：自定义运行时实例启动失败等。 499 ：客户端连接断开。 错误次数 函数错误（FunctionFunctionErrors） 次 在调用某个指定函数时，由于函数自身原因导致函数调用失败的次数。按1分钟或1小时粒度统计求和。 流控错误 并发实例超上限（FunctionConcurrencyThrottles） 次 在调用函数时，由于函数并发实例超上限导致函数调用失败，且返回 429 状态码的总调用次数。按1分钟或1小时粒度统计求和。 流控错误 实例总数超上限（FunctionResourceThrottles） 次 在调用函数时，由于函数实例总数超上限导致函数执行失败，且返回 503 状态码的总调用次数。按1分钟或1小时粒度统计求和。 函数执行时间 平均时间（FunctionAvgDuration） 毫秒 函数代码从执行开始到结束的时间，且平台时间不计入在内。按1分钟或1小时粒度统计求平均。 函数执行时间 函数P90执行时间（FunctionP90Duration） 毫秒 函数代码从执行开始到结束的时间，且平台时间不计入在内。按粒度统计求P90值（90%请求的执行时间都小于统计值）。 函数执行时间 函数P99执行时间（FunctionP99Duration） 毫秒 函数代码从执行开始到结束的时间，且平台时间不计入在内。按粒度统计求P99值（99%请求的执行时间都小于统计值）。 函数执行时间 函数最大执行时间（FunctionMaxDuration） 毫秒 函数代码从执行开始到结束的时间，且平台时间不计入在内。按1分钟或1小时粒度统计求最大值。 端到端延时 平均延时（FunctionLatencyAvg） 毫秒 在调用时，函数执行请求从抵达函数计算系统开始到离开函数计算系统所消耗的时间，且包含平台消耗的时间。按1分钟或1小时粒度统计求平均时间。 内存使用情况 内存配额（FunctionMemoryLimitMB） MB 在调用函数时，函数可使用的内存上限。如果函数实际消耗内存超过此上限，则会出现内存溢出OOM错误。函数所有实例按1分钟或1小时粒度取最大值。 内存使用情况 已使用内存（FunctionMaxMemoryUsage） MB 在调用函数时，函数执行所消耗的内存，表示函数实际消耗的内存。函数所有实例按1分钟或1小时粒度取最大值。 函数按量实例数 函数按量实例数上限（FunctionOndemandInstanceQuota） 个 函数按量实例数上限，可通过按量实例进行配置，若不主动配置则不展示。 函数按量实例数 函数已使用按量实例数（FunctionOndemandActiveInstance） 个 在调用函数时，函数执行实际占用的按量实例数。 函数预留实例数 函数预留实例数（FunctionProvisionedCurrentInstance） 个 在调用函数时，函数执行实际占用的预留实例数。 vCPU使用情况（实例级别指标） vCPU配额（FunctionvCPUQuotaCores） vCPU 函数的vCPU配额。 vCPU使用情况（实例级别指标） 最大vCPU（FunctionMaxvCPUCores） vCPU 函数实际使用的vCPU数，其中1代表1vCPU，按1分钟或1小时粒度统计多个实例求最大值。 vCPU使用情况（实例级别指标） 平均vCPU（FunctionAvgvCPUCores） vCPU 函数实际使用的vCPU数，其中1代表1vCPU，按1分钟或1小时粒度统计多个实例求平均值。 vCPU利用率（实例级别指标） 最大利用率（FunctionMaxvCPUUtilization） % 函数实际使用的vCPU核数占vCPU配额的比例。按1分钟或1小时粒度统计多个实例求最大值。 vCPU利用率（实例级别指标） 平均利用率（FunctionAvgvCPUUtilization） % 函数实际使用的vCPU核数占vCPU配额的比例。按1分钟或1小时粒度统计多个实例求平均值。 网络流量（实例级别指标） 入网流量（FunctionRXBytesPerSec） Mbps 函数单位时间的入网流量。 网络流量（实例级别指标） 出网流量（FunctionTXBytesPerSec） Mbps 函数单位时间的出网流量。 内存使用情况（实例级别指标） 最大使用内存（FunctionMaxMemoryUsageMB） MB 函数实例实际使用的内存。按1分钟或1小时粒度统计求最大值。 内存使用情况（实例级别指标） 平均使用内存（FunctionAvgMemoryUsageMB） MB 函数实例实际使用的内存。按1分钟或1小时粒度统计求平均值。 内存使用率（实例级别指标） 最大使用率（FunctionMaxMemoryUtilization） % 函数实例实际使用的内存占内存配额的比例。按1分钟或1小时粒度统计多个实例求最大值。 内存使用率（实例级别指标） 平均使用率（FunctionAvgMemoryUtilization） % 函数实例实际使用的内存占内存配额的比例。按1分钟或1小时粒度统计多个实例求平均值。

本文为您介绍证书管理功能模块详情。 证书管理组件为您提供高可用、高安全的密钥和证书托管能力，您可以通过KMS提供的云原生接口实现签名验签运算。 证书生命周期管理 证书管理模块提供高可用、高安全的密钥和证书托管能力，您可以通过控制台或API集中管理证书。 功能 说明 证书托管 支持管理密钥和证书，可以生成证书请求、导入证书和证书链、启用/禁用证书、吊销或删除证书等。 密钥安全存储 证书管家使用托管密码机保障证书密钥的产生、存储安全。 API便于集成 支持多个API接口，帮助在开发环境高效集成证书服务，快速进行产品部署，为您提供快速开发上线证书相关功能的能力。 支持的证书类型 证书类型 说明 数字证书（含私钥） 支持通过证书管理服务生成证书请求，导入或导出数字证书及其证书链，证书私钥由KMS硬件安全模块保护。 Ukey证书（不含私钥） 支持将Ukey中的证书（不含私钥）导出并存入KMS，由KMS统一托管，并支持调用KMS提供的接口实现身份认证中的验签运算。 证书运算API KMS提供云原生的证书运算类API，帮助在开发环境高效集成证书服务，快速实现证书调用。 功能 说明 参考文档 加密解密 证书公钥运算：使用指定证书加密数据。 证书私钥运算：使用指定证书解密数据。 证书公钥加密 证书私钥解密 签名验签 证书私钥运算：使用指定证书生成数字签名。 证书公钥运算：使用指定证书验证数字签名。 证书私钥签名 证书公钥验签

功能名称 功能描述 站点自动开通 22个人工环节优化为3个，IPRAN/OTN接入7个工作日开通，具备自动化能力的云资源池分钟级开通。 新增应用场景 支持大中小企业客户全国境内/外广域组网、入云。 差异化QoS分级 标准服务可提供“钻石、白金、金、银、铜、BE”6个QoS等级，保障客户不同应用的指标要求。 业务全流程可视化 实现客户自助查看业务开通进展、业务完整网络拓扑、电路运行状态、故障告警提醒、电路流量监测，提供多种产品增值功能，多维度持续提升客户满意度。 支持调整站点的接入电路速率 在创建完成站点后，可以在公共传输通道的控制台页面对指定站点的接入电路速率进行调整。 支持对站点接入电路速率的随选调整 在创建完成站点后，可以在公共传输通道的控制台页面对指定站点的接入电路速率在约定时间内进行变更。 支持查看站点的开通进度 用户在创建站点或发起站点变更功能后，可以在站点列表页的“状态”列中查看当前业务的开通进度。

本章节主要介绍如何使用Linux gsql客户端连接集群。 用户在创建好数据仓库集群，开始使用集群数据库之前，需要使用数据库SQL客户端连接到数据库。DWS提供了与集群版本配套的Linux gsql命令行客户端工具，您可以使用Linux gsql客户端通过集群的公网地址或者内网地址访问集群。 它的运行环境是Linux操作系统，在使用Linux gsql客户端远程连接DWS集群之前，需要准备一个Linux主机用于安装和运行Linux gsql客户端。如果通过公网地址访问集群，也可以将Linux gsql客户端安装在用户自己的Linux主机上，但是该Linux主机必须具有公网地址。若DWS集群没有配置公网IP，为方便起见，推荐您创建一台Linux弹性云主机（简称ECS）。 （可选）准备ECS作为gsql客户端主机 创建弹性云主机的操作步骤，请参见《弹性云主机用户指南》中的“快速入门 > 创建弹性云主机”章节。 创建的弹性云主机需要满足如下要求： 弹性云主机需要与DWS 集群具有相同的区域、可用区。 如果使用DWS 提供的gsql命令行客户端连接DWS 集群，弹性云主机的镜像必须满足如下要求： 镜像的操作系统必须是gsql客户端所支持的下列Linux操作系统： −“Redhat x8664”客户端工具支持在以下系统中使用： RHEL 6.4~7.6 CentOS 6.4~7.4 EulerOS 2.3 −“SUSE x8664”客户端工具支持在以下系统中使用： SLES 11.1~11.4 SLES 12.0~12.3 如果客户端通过内网地址访问集群，请确保创建的弹性云主机与DWS 集群在同一虚拟私有云里。 虚拟私有云相关操作请参见《虚拟私有云用户指南》中“虚拟私有云和子网”。 如果客户端通过公网地址访问集群，请确保创建的弹性云主机和DWS 集群都要有弹性IP。 创建弹性云主机时，参数“弹性IP”需设置为“自动分配”或“使用已有”。 弹性云主机对应的安全组规则需要确保能与DWS 集群提供服务的端口网络互通。 安全组相关操作请参见《虚拟私有云用户指南》中“安全组”章节。 请确认弹性云主机的安全组中存在符合如下要求的规则，如果不存在，请在弹性云主机的安全组中添加相应的规则： −方向：出方向 −协议：必须包含TCP，例如TCP、全部。 −端口：需要包含DWS 集群提供服务的数据库端口，例如，设置为“165535”或者具体的DWS 数据库端口。 −目的地址：设置的IP地址需要包含所要连接的DWS集群的地址，例如，设置为“0.0.0.0/0”或者具体的DWS 集群的连接地址。 DWS 集群的安全组规则需要确保DWS 能接受来自客户端的网络访问。 请确认DWS 集群的安全组中存在符合如下要求的规则，如果不存在，请在DWS 集群的安全组中添加相应的规则。 −方向：入方向 −协议：必须包含TCP，例如TCP、全部。 −端口：设置为DWS 集群提供服务的数据库端口，例如“8000”。 −源地址：设置的IP地址需要包含DWS 客户端主机的IP地址，例如“192.168.0.10/32”。

本最佳实践文档旨在为用户提供一个基于升腾通用推理镜像的自定义部署样例,流程涵盖代码包准备、模型准备、部署流程等关键维度。 一、引言 本文围绕昇腾通用推理镜像的自定义部署展开最佳实践梳理，旨在从代码包准备、模型准备、部署流程等关键维度，提供一套可复用的最佳实践。通过标准化的操作指南，帮助开发者快速掌握昇腾推理镜像的自定义部署方法。 二、模型准备 1.开发机完成推理代码开发和调试 开发机界面启动VSCode。 编写推理服务代码 推理服务代码要满足openai api接口规范，当前平台支持的接口能力请参考【训推服务平台】帮助手册【推理服务API】< IDE内启动推理服务准备验证 调用/验证推理服务接口 2. 保存代码包 在VSCode列表页面保存开发机中的代码到代码包。

本文主要介绍天翼云函数工作流服务等级协议。 天翼云函数工作流服务等级协议详情请参见这里

本页为您介绍天翼云快销产品的相关协议。 天翼云快销产品服务等级协议详情请参见这里

本文介绍视频直播服务协议。 视频直播产品采用《天翼云CDN服务协议》，详情请参见天翼云CDN服务协议。

本文为您介绍如何激活智能网关APP业务。 操作场景 智能网关APP是智能网关的客户端软件版本，创建完智能网关APP实例后，需要进行激活操作。 前提条件 注册天翼云账号，并完成实名认证。具体操作，请参见天翼云账号注册流程。 您已创建智能网关APP实例。 操作步骤 1. 登录控制中心。 2. 在控制中心页面左上角点击，选择区域，本文我们选择华东1。 3. 依次选择“网络”，单击“天翼云SDWAN”，进入天翼云SDWAN总览页面。 4. 选择“智能网关APP”。 5. 在目标智能网关APP实例的“操作”列，单击“激活”，根据激活页面提示进行参数配置，具体参数可参考如下： 参数 说明 区域 选择需要接入的区域。 绑定SDWAN 选择要绑定的SDWAN实例。 6. 单击“确认”按钮。

您可以通过添加实例功能完成访问控制关联智能网关设备。 操作场景 用户为访问控制规则关联智能网关实例，实现对智能网关设备转发流量的访问控制。 前提条件 注册天翼云账号，并完成实名认证。具体操作，请参见天翼云账号注册流程。 您已经完成智能网关实例、访问控制的创建。 操作步骤 1. 登录控制中心。 2. 在控制中心页面左上角点击，选择区域，本节我们选择华东1。 3. 依次选择“网络”，单击“天翼云SDWAN”，进入天翼云SDWAN总览页面。 4. 选择“访问控制”，单击目标访问控制“操作”列的“添加实例”。 5. 选择需要关联的智能网关实例，支持多选。 6. 单击“确定”，完成访问控制关联智能网关。 说明 用户也可以进入“目标访问控制详情”页面。单击“关联实例 >添加实例”，可添加智能网关实例。

本节为您介绍如何完成智能网关App实例的升配操作。 操作场景 您的智能网关APP实例的带宽峰值已不能满足当前业务时，可以在控制台进行升配操作。 前提条件 注册天翼云账号，并完成实名认证。具体操作，请参见天翼云账号注册流程。 您已完成智能网关APP实例的创建。 操作步骤 1. 登录控制中心。 2. 在控制中心页面左上角点击，选择区域，本节我们选择华东1。 3. 依次选择“网络”，单击“天翼云SDWAN”，进入天翼云SDWAN总览页面。 4. 选择“智能网关APP”。 5. 进入智能网关APP列表页，在目标实例名称所在行，单击“升配”，进入升配页面。 6. 在升配页面，根据需求选择适当的带宽峰值。 7. 确认信息无误后，勾选“服务协议”，单击“确认下单”。

本节为您介绍如何完成智能网关App实例的续订操作。 操作场景 为确保智能网关APP实例能够持续提供服务，请在实例欠费之前及时完成续费操作，以避免停机对您的服务造成影响。 前提条件 注册天翼云账号，并完成实名认证。具体操作，请参见天翼云账号注册流程。 您已完成智能网关APP实例的创建。 操作步骤 1. 登录控制中心。 2. 在控制中心页面左上角点击，选择区域，本节我们选择华东1。 3. 依次选择“网络”，单击“天翼云SDWAN”，进入天翼云SDWAN总览页面。 4. 选择“智能网关APP”。 5. 进入智能网关APP列表页，在目标实例名称所在行，单击“续订”，进入续订页面。 6. 续订页面会展示已购买的设备信息，所有的业务默认全部续订。 7. 选择续订时长，单击“确认下单”。

本节为您介绍专线链路备份的操作场景、前提条件和操作步骤。 操作场景 智能网关硬件版设备支持链路级的专线备份，当主用链路发生故障时，自动切换至备用链路。 前提条件 注册天翼云账号，并完成实名认证。具体操作，请参见天翼云账号注册流程。 您已经完成智能网关硬件版的创建，且未进行链路设置。 操作步骤 1. 登录控制中心。 2. 在控制中心页面左上角点击，选择区域，本节我们选择华东1。 3. 依次选择“网络”，单击“天翼云SDWAN”，进入天翼云SDWAN总览页面。 4. 单击“智能网关”，在智能网关实例列表页面，单击目标智能网关实例“操作”列的“链路设置”。 5. 在链路设置界面，根据页面提示进行专线链路备份设置。 6. 单击“确认”按钮。

本文为您介绍编辑告警联系组的操作场景、前提条件和操作步骤。 操作场景 当告警联系组的组名、备注、组内联系人需要发生改变时，您可以在控制台进行修改。 前提条件 注册天翼云账号，并完成实名认证。具体操作，请参见天翼云账号注册流程。 您已完成告警联系组的创建。 操作步骤 1. 登录控制中心。 2. 在控制中心页面左上角点击，选择区域，本文我们选择华东1。 3. 依次选择“管理与部署”，单击“云监控”，进入监控概览页面。 4. 单击“告警服务”下拉菜单，单击“告警联系人/组”，进入告警联系人管理页面。 5. 单击“告警联系组”页签，在组名称所在“操作”列，单击“修改”，进入编辑联系组页面。 6. 在编辑联系组页面，根据页面提示进行修改，单击“确认”按钮。

本文为您介绍创建告警联系组的操作场景、前提条件和操作步骤。 操作场景 告警通知将发送给对应告警联系组中的联系人，因此需要设置告警联系组。 前提条件 注册天翼云账号，并完成实名认证。具体操作，请参见天翼云账号注册流程。 您已完成告警联系人的创建。 操作步骤 1. 登录控制中心。 2. 在控制中心页面左上角点击，选择区域，本文我们选择华东1。 3. 依次选择“管理与部署”，单击“云监控”，进入监控概览页面。 4. 单击“告警服务”下拉菜单，单击“告警联系人/组”，进入告警联系人管理页面。 5. 单击“告警联系组”页签，单击“添加联系组”按钮，进入新建联系组页面。 6. 在新建联系组页面，操作相关联系人。 7. 点击“确定”按钮，完成告警联系组的创建。

byteaoutput (enum) 设置bytea类型值的输出格式。有效值是hex（默认）和 escape（传统格式）。不管这个设置的值如何，bytea类型总是接受这两种格式的输入。 xmlbinary (enum) 设置二进制值如何被编码为XML。例如，这适用于通过xmlelement函数或xmlforest函数将bytea值转换到 XML 值。可能的值有base64和hex，它们都是用 XML 模式标准定义的。默认值是base64。这里的实际选择都是根据爱好做出的，只受客户端应用中可能存在的限制的约束。两种方法都支持所有可能的值，尽管十六进制编码将比 base64 编码更大。 xmloption (enum) 当在XML和字符串值之间进行转换时，无论设置DOCUMENT或 CONTENT都是隐式的。 有效值是DOCUMENT和CONTENT。 缺省值是CONTENT。 当在 XML 和字符串值之间进行转换时，设置DOCUMENT或CONTENT都是隐式的。 有效值是DOCUMENT和CONTENT。默认值是CONTENT。根据 SQL 标准，设置这个选项的命令是：SET XML OPTION { DOCUMENT CONTENT }。 ginpendinglistlimit (integer) 当启用fastupdate时，设置正在使用的GIN挂起列表的最大尺寸。如果列表增长大于这个最大尺寸， 通过移动块存储的主要的GIN数据结构项进行清理。 默认值为四字节(4MB)。 为单个GIN索引改变索引存储参数来重写此设置。

本节介绍如何删除QoS策略。 操作场景 用户删除已创建的QoS策略。 前提条件 注册天翼云账号，并完成实名认证。具体操作，请参见天翼云账号注册流程。 您已经完成QoS策略的创建，且QoS策略没有关联智能网关实例。 操作步骤 1. 登录控制中心。 2. 在控制中心页面左上角点击，选择区域，本节我们选择华东1。 3. 依次选择“网络”，单击“天翼云SDWAN”，进入天翼云SDWAN总览页面。 4. 选择“QoS策略”，单击目标QoS策略“操作”列的“删除”。 5. 单击“确定”，完成QoS策略删除。

介绍分布式消息服务Kafka认证与访问控制方式 分布式消息服务Kafka支持CTIAM身份认证和多种访问控制，多维度保障您数据的安全。 身份认证 CTIAM 统一身份认证（Identity and Access Management， 简称：CTIAM）是提供用户进行权限管理的基础服务，可以帮助您安全的控制天翼云服务和资源的访问及操作权限，包括：用户身份认证、权限分配、访问控制等功能。具体介绍请参考统一身份认证产品介绍。 您可以创建IAM用户，并为其设置关联分布式消息服务Kafka实例权限，该用户就可以通过用户名和密码访问授权的实例资源。具体请参见统一身份认证快速入门创建IAM用户。 访问控制 权限控制 购买分布式消息服务Kafka实例之后，您可以使用CTIAM为企业中的员工设置不同的访问权限，以达到不同员工之间的权限隔离，通过CTIAM进行精细的权限管理。 VPC和子网 虚拟私有云（Virtual Private Cloud，VPC）为分布式消息服务Kafka构建隔离、私密的虚拟网络环境，提升数据库的安全性，并简化用户的网络部署。您可以完全掌控自己的专有网络，VPC丰富的功能帮助您灵活管理云上网络，包括创建子网、设置安全组和网络ACL、管理路由表、申请弹性公网IP和带宽等。通过子网与其他网络隔离，独享网络资源，提高网络安全性。具体内容请参见虚拟私有云用户指南创建虚拟私有云和子网 。 安全组 安全组是一个逻辑上的分组，可以为同一个虚拟私有云内具有相同安全保护需求并相互信任的Kafka实例提供相同的访问策略。您可以通过为数据库实例设置安全组，开通需访问Kafka实例的IP地址和端口，来保证保障其运行环境的安全性和稳定性。具体请参见配置安全组

本章节主要介绍集群规格变更的操作。 规格变更 在购买数据仓库服务(DWS)集群时，有多种节点规格供您选择，您可根据业务需要选择合适的节点规格。当集群创建成功后，随着业务量的增长，您可以对集群进行扩容，从而增加集群节点。 扩容集群 随着用户的数据仓库容量和性能需求的变化，您可以在管理控制台调整已有集群的大小，以便充分利用数据仓库服务(DWS) 提供的计算资源和存储资源。 说明 新增的节点默认是按需计费。 云数仓集群扩容时使用与当前集群相同的存储规格。 如果您是因集群存储容量不足而扩容集群，建议您在扩容前先执行VACUUM清理和回收存储空间，数据仓库服务(DWS)数据仓库中保存的数据在删除后，可能没有释放占用的磁盘空间形成脏数据，导致磁盘浪费。如果执行VACUUM后，已使用存储容量仍然占用过高，您再进行扩容。 扩容对系统的影响 扩容前，需退出创建了临时表的客户端连接，因为在扩容过程中及扩容成功之前创建的临时表将会失效，操作临时表也会失败。但是扩容后创建的临时表不受影响。 在执行“扩容”操作后，集群会进行一次自动快照，快照创建成功后进行集群扩容。 正在扩容的集群将禁用重启集群、扩容集群、创建快照、重置集群管理员密码和删除集群的功能。 扩容过程中，集群会自动重启，因此集群会有一段时间变为“不可用”状态，重启成功后集群变回“可用”状态。然后在扩容结束阶段，系统会将集群中用户数据在全部节点重新动态分布。 离线扩容（离线重分布模式）过程中，用户应该停止所有业务或运行少量查询语句。表重分布期间会对表加共享锁，所有插入、更新、删除操作和表DDL操作都会长时间阻塞，会出现等锁超时情况。一旦表重分布完成，用户可以正常访问该表。在重分布执行过程中，用户应当避免执行超过20分钟的查询（在重分布执行时申请写锁的默认时间为20分钟）。否则可能导致重分布出现等待加锁超时失败的问题。 在线扩容（在线重分布模式）过程中，表重分布期间用户可以对该表执行插入、更新、删除，但重分布过程仍然会短时间阻塞用户的数据更新操作，会影响用户语句的执行性能。扩容重分布过程会消耗大量的CPU和IO资源，因此会对用户作业性能影响较大，用户应该尽可能在停止业务情况下或业务轻载的情况下执行扩容重分布。用户也可以考虑分段扩容重分布策略，在系统负载很小的情况下采用高并发进行扩容重分布，在系统负载大的情况下停止扩容重分布或采用低并发进行扩容重分布。 扩容后，如果集群创建新快照，将包含扩容节点上的数据。 如果集群扩容失败，数据库会在后台自动执行扩容回滚操作，集群会恢复到扩容前的节点个数。 如果回滚成功，集群仍可以正常使用，用户可以重新执行“扩容”操作，如果仍扩容失败，请及时联系技术支持人员进行处理。 如果数据库因为某些异常原因后台回滚失败，则集群可能会变为“不可用”状态，此时无法再执行“扩容”或重启集群的操作，请及时联系技术支持人员进行处理。 扩容重分布过程中(包括离线重分布和在线重分布模式），不支持创建、修改、删除数据库和表空间。 离线重分布模式的扩容过程中，数据库不支持DDL和DCL操作，正在重分布的表只支持DQL操作，在线重分布模式的扩容过程中，数据库支持部分DDL和DCL操作。 在线重分布模式下在重分布的表支持插入、删除、更新和部分DDL，支持的功能为： a.重分布过程中用户可进行正在重分布的本地表的INSERT、DELETE、UPDATE、MERGE INTO、OVERWRITE、UPSERT业务。 b.重分布过程中用户可进行正在重分布的本地表跨节点组的关联查询业务。 c.重分布过程中用户可进行正在重分布的本地表的DROP、TRUNCATE、TRUNCATEPARTITION业务。 d.在线重分布模式下正在重分布的本地表不支持如下功能： 表正在重分布过程中用户不能执行ALTER TABLE语句，典型的包括增加、删除字段，重命名，修改schema，但TRUNCATE PARTITION除外。 表正在重分布过程中用户不能创建、修改、删除索引。 表正在重分布过程中用户不能对该表执行vacuum full和cluster语句。 表正在重分布过程中用户不能修改字段依赖的SEQUENCE对象，包括创建和修改字段依赖的SEQUENCE对象，典型的语句是CREATE/ALTER SEQUENCE ... OWNED BY。

本文主要介绍共享备份。 在对云主机和磁盘数据进行备份后，可将备份共享给其他账户使用。共享的备份可用于创建磁盘或云主机等操作。 背景说明 发起方： 仅支持在同一区域的不同用户间共享。 加密备份无法共享。共享的目标项目应与被共享的备份位于同一区域，暂不支持跨区域共享。 共享者在删除共享备份后，共享备份接收方的备份也将会被删除。如果共享备份接收方已使用备份创建磁盘或云主机等，则创建的资源不会被删除。 接收方： 共享备份接收方至少拥有一个备份存储库用于存放共享备份，存储库的剩余容量需要大于接收的共享备份的容量。 共享备份接收方可以选择是否接收备份，接收备份后可将备份用于创建新的磁盘或云主机。 共享者在删除共享备份后，共享备份接收方的备份也将会被删除。如果共享备份接收方已使用备份创建磁盘或云主机等，则创建的资源不会被删除。 发起方操作步骤 1. 登录云服务备份管理控制台。 a. 登录管理控制台。 b. 单击管理控制台左上角的，选择区域。 c. 单击“”，选择“存储 > 云服务备份”。选择对应的备份目录。 2. 在云主机备份或云硬盘备份页面，选择“备份副本”页签，通过筛选条件查看备份。 3. 单击目标备份“操作”列下的“更多 > 共享”，打开共享页面。展开的页面显示了该备份的备份名称、服务器名称/磁盘名称、备份ID、备份类型、区域和共享类型。 添加共享 图 共享备份 a. 共享类型选择“共享备份”。 a. 在输入框中输入待共享目标用户的项目ID。 b. 单击对话框中的“添加”，待添加的项目ID会出现在列表中。可以继续添加帐号项目ID。可以将备份共享给10个项目。 c. 单击“确定”，完成共享添加。 取消共享 a. 共享类型选择“取消共享”，在弹出的对话框中确认需要删除的共享项目信息，勾选不再需要共享的备份，单击“确定”。如下图所示。 图 取消共享

本页介绍天翼云TeleDB数据库启动实例。 操作场景 当实例处于停止状态时，TeleDB支持手动启动实例，启动实例所有组件进程。 操作步骤 1. 以用户名和密码登录分布式数据库TeleDB控制台，在左侧导航单击实例列表，进入实例列表页面。 2. 在实例列表页面，单击目标实例所在行的详情，进入实例详情页面。 3. 在实例详情页面，在操作下拉框，单击启动实例，出现提示对话框。 4. 在提示 对话框，单击确定启动实例。 5. 您在单击立即前往，跳转至任务管理中查看执行情况。

本页介绍天翼云TeleDB数据库启动实例。 操作场景 当实例处于停止状态时，TeleDB支持手动启动实例，启动实例所有组件进程。 操作步骤 1. 以用户名和密码登录分布式数据库TeleDB控制台，在左侧导航单击实例列表，进入实例列表页面。 2. 在实例列表页面，单击目标实例所在行的详情，进入实例详情页面。 3. 在实例详情页面，在操作下拉框，单击启动实例，出现提示对话框。 4. 在提示 对话框，单击确定启动实例。 5. 您在单击立即前往，跳转至任务管理中查看执行情况。

本页介绍天翼云TeleDB数据库元数据pgclsuser的内容。 存储行列级安全访问策略的用户信息。 名称 类型 定义 polid int16 策略ID privilege int16 权限值 userid Oid 用户的OID maxreadlabel int16 最大读取标签ID maxwritelabel int16 最大写入标签ID minwritelabel int16 最小写入标签ID defaultreadlabel int16 默认读取标签ID defaultwritelabel int16 默认写入标签ID defaultrowlabel int16 默认行标签ID username NameData 用户名

参数 描述 虚拟私有云 TaurusDB数据库实例所在的虚拟专用网络，可以对不同业务进行网络隔离，以提高网络安全性。 您需要选择所需的虚拟私有云和子网。如果没有可选的虚拟私有云，TaurusDB会为您分配一个默认的虚拟私有云（defaultvpc），您也可以使用已有、新建VPC和子网。 须知 TaurusDB实例创建完成后不支持切换虚拟私有云，请谨慎选择所属虚拟私有云。 内网安全组 内网安全组限制实例的安全访问规则，加强TaurusDB数据库服务与其他服务间的安全访问。请确保所选取的内网安全组允许客户端访问数据库实例。 如果不创建内网安全组或没有可选的内网安全组，TaurusDB数据库服务默认为您分配内网安全组资源。 IPv6 启用IPv6前，请确保数据库实例所在的VPC和子网已开启IPv6配置，在VPC和子网开启IPv6配置的应用场景和操作步骤。 启用IPv6后，数据库实例可在双堆栈模式下运行，即可以拥有两个不同版本的IP地址：IPv4地址和IPv6地址。此时实例通过IPv4和IPv6进行通信，且IPv4和IPv6通信彼此独立。

本页介绍分布式融合数据库HTAP的参数模板功能。 参数模板简介 数据库参数是数据库系统运行的关键配置信息，设置合适的的参数值能够提高数据库的稳定性和性能，更好的满足您的业务需求。为了方便您对实例的参数进行管理，天翼云分布式融合数据库HTAP提供参数模板，您可以根据您的业务场景将不同的参数设置保存为不同的自定义参数模板。并根据业务的不同实现应用合适的自定义参数模板。 在控制台中，有默认的参数模板，也可以自定义参数模板，这些参数模板都可以应用到实例中。自定义参数模板可以进行复制、修改参数值、修改描述和删除，不同参数模板之间可以进行比较差异。同时支持查看参数模板的应用实例记录和参数值修改记录，也可以查看当前实例的真实参数值。 前提条件 应用参数模板时，需要分布式融合数据库HTAP实例正常运行。故障、删除状态的实例，无法应用参数模板。当分布式融合数据库HTAP实例再次启动或恢复后，即可正常应用。 注意事项 为了天翼云分布式融合数据库HTAP的正常运行，目前参数组仅支持部分参数设置。 不合适的参数设置可能会影响业务的正常运行，请您仔细评估参数对业务的影响。 参数模板中的有些参数受限于当前机器操作系统配置，或者依赖其他参数，所以可能导致配置的值于实际生效值不一致，这是正常现象。 应用参数模板到实例上之后，会断开实例当前所有连接的会话。

本章节主要介绍翼MapReduce的配置资源池的队列容量策略操作。 操作场景 添加资源池后，需要为Yarn任务队列配置在此资源池中可使用资源的容量策略，队列中的任务才可以正常在这个资源池中执行。 该任务指导系统管理员通过FusionInsight Manager配置队列策略。使用Superior调度器的租户队列，可以配置使用不同资源池的资源。 前提条件 已登录FusionInsight Manager。 已添加资源池。 任务队列不与其他队列相关联资源池，除了默认资源池。 操作步骤 1. 在FusionInsight Manager，单击“租户资源”。 2. 单击“动态资源计划”页签。 3. 单击“资源分布策略”页签。 4. “集群”参数选择待操作的集群名称，然后在“资源池”选择指定的资源池。 5. 在“资源分配”列表指定队列的“操作”列，单击“修改”。 6. 在“修改资源分配”窗口的“资源配置策略”页签设置任务队列在此资源池中的资源配置策略。 “权重”：表示租户能获得的资源。其初始值与最小资源百分比值一致。 “最小资源”：表示租户能获得的最少资源。 “最大资源”：表示租户能获得的最多资源。 “预留资源”：表示保留给租户自身队列，且不能借用给其他租户队列的资源。 7. 在“修改资源分配”窗口的“用户策略”页签设置用户策略。 说明 defaultUser(builtin)表示如果一个用户未配置策略，则默认使用defaultUser所指定的策略。该策略不可删除。 单击“添加用户策略”添加用户策略。 − “用户名”：表示用户的名称。 − “权重”：表示用户能获得的资源。 − “最多核数”：表示用户最多可以使用的虚拟核数。 − “最大内存”：表示用户最大可以使用的内存。 单击“操作”列的“修改”修改现有用户策略。 单击“操作”列的“清除”删除现有用户策略。 8. 单击“确定”保存配置。

本页介绍天翼云TeleDB数据库修改单个节点上参数。 操作步骤 1. 以用户名和密码登录分布式数据库TeleDB控制台，在左侧导航单击参数管理。 2. 在数据库参数 页签，在搜索框中输入配置项搜索 需修改的参数，单击查询， 查找要修改的目标节点。 3. 在查找出的参数行，单击编辑 按钮，出现编辑配置项 对话框。 4. 将修改值根据自己的需求设置为需调整后的参数，单击确定， 出现提示 对话框。 5. 您可单击立即前往 查看任务详情。

本页介绍天翼云TeleDB数据库如何添加、编辑和删除VIP。 用户可以连接VIP去访问实例数据库。 操作步骤 1. 以用户名和密码登录分布式数据库TeleDB控制台。 2. 在左侧导航树上，选择资源管理 > VIP管理 ，进入VIP管理 页面。 3. 添加VIP 1. 在VIP管理 页面，单击添加VIP ，出现添加VIP对话框。 2. 在添加VIP 对话框，选择IP类型 ，输入IP地址 ，单击确定完成VIP添加。 4. 编辑VIP 在VIP管理页面，单击目标VIP所在行的编辑 ，对VIP进行修改。 5. 删除VIP 单击目标VIP所在行的删除 ，可删除该条VIP。 说明 只能删除未启用状态且未被实例节点使用的的VIP。

创建流程本文以创建一个执行 HTTP 请求的简单流程为例,介绍如何通过云工作流控制台创建流程。概述云工作流的流程(Cloudflow)用于定义业务逻辑和流程执行所需的通用信息。例如,一个订单管理流程可 创建流程 本文以创建一个执行 HTTP 请求的简单流程为例，介绍如何通过云工作流控制台创建流程。 概述 云工作流的流程（Cloudflow）用于定义业务逻辑和流程执行所需的通用信息。例如，一个订单管理流程可能包含：创建订单、处理支付、预留库存、配送商品和通知等。流程创建完成后，您可以多次执行该流程，每次执行时输入内容可能不同（如每次下单时输入订单信息）。云工作流支持丰富的控制原语，包括串行、并行、选择性执行任务，以及针对数据集的批量并行任务。 操作步骤 1. 登录 云工作流控制台，在顶部菜单栏选择地域。 2. 在 工作流列表 页面，点击 创建工作流。 3. 在弹出的 创建工作流 对话框中，选择 使用空白画布 ，选择 工作流模式 ，设置 工作流名称 和 描述 ，然后点击 创建。 本文以创建快速模式的工作流为例。关于不同工作流模式的说明，请参见 标准工作流 和 快速工作流。 4. 在 CloudFlow Studio 页面，选择状态浏览区的常用节点 Http，长按鼠标左键拖动至画布，出现横线或竖线时松开鼠标，将节点放入流程。 5. 单击选中 Http 节点，设置其基本配置、输入配置、输出配置和错误处理。 基本配置 重点项如下，其余可保持默认。输入、输出和错误配置详见输入和输出和错误处理。 6. 输入配置 重点项如下： 配置项 说明 示例值 节点名称 当前节点的名称 Req 请求方法 选择 HTTP 请求方法，如 GET POST 请求 URL 填写完整的 HTTP 服务 URL < 下一个状态 选择下一个节点，无则选 End End 1. （可选）点击 工作流配置 页签，设置流程角色信息。依次点击 保存 和 退出。 若已创建 IAM 委托角色，可直接选择现有 IAM 委托角色，执行角色相关详细看控制台操作执行角色说明。 本文示例为调用 HTTP 请求，无需配置委托角色。若流程涉及集成云产品服务，需配置具备相应权限策略的角色。

接口描述 检索知识库内容，支持丰富的检索策略。 请求方法 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 知识库不存在