接口介绍 延长对应Bucket中已启用的合规保留策略Object的保留天数。 接口约束 无 请求URI PUT /v1/worm/update 路径参数 无 Query请求参数 参数 是否必填 参数类型 说明 示例 下级对象 bucket 是 String 桶名 testBucketName regionCode 是 String 区域编码 0001 remainingDays 是 Integer 保留天数，取值范围：大于之前设置的天数，但要小于3651天 2 请求参数 请求header参数 参数 是否必填 参数类型 说明 示例 下级对象 contenttype 是 String 删除复制规则请求header参数，默认为applicatin/json applicatin/json 请求体body参数 无 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 是 Integer 本次请求的结果码 0 error 是 String 错误码，创建成功时，不返回该字段 message 是 String 错误文本信息，创建成功时，为空字符串 returnObj 是 String of Object 返回结果 returnObj 表 returnObj 参数 是否必填 参数类型 说明 示例 下级对象 code 是 String 业务返回码，0表示业务成功 0 data 是 String 业务返回数据 message 是 String 业务消息

本页介绍天翼云TeleDB数据库存储过程开发的变量。 在一个块中使用的所有变量必须在该块的声明小节中事先进行声明，PL/pgSQL 变量可以是任意SQL数据类型，可以是一个简单数据类型、复合类型、RECORD、已经存在的表行类型、表字段类型、游标。

接口功能介绍 通过CTRN获取层版本信息 接口约束 无 URI GET /openapi/v1/layerctrn/ 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id test 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 ctrn 是 String 层的ctrn ctrn:cf:200000002368:testOuterTenantId123456:layers/testLayer/versions/1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 0 error String 错误码 CF0 message String 异常信息 returnObj Object 返回结果 Data 表 Data 参数 参数类型 说明 示例 下级对象 layerName String 层名 version Integer 版本 description String 版本描述信息 compatibleRuntime Array of Strings 版本运行时环境列表 ctrn String 版本唯一标识 code Object 版本代码配置 Code codesize Integer 代码大小 codeChecksum String 代码校验码 createTime String 版本创建时间 buildStatus Boolean 版本构建状态，false 表示构建中，true 表示构建成功 表 Code 参数 参数类型 说明 示例 下级对象 ossBucketName String oss的bucket ossObjectName String oss的name

接口功能介绍 用新的监控项内容（可以是多个）替换监控视图中原有的监控项内容。 一个监控视图，可以包含多个监控项。 接口约束 regionID（资源池）、templateID（监控面板）、viewID（监控视图）存在。 URI POST /v4/monitor/putmonitorview 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID templateID String 是 466d5eb4484311eda9b7005056897257 监控面板ID viewID String 是 f750ec8a487c11eda9b7005056897257 监控视图ID viewTitle String 是 newtitle 新的监控视图名称 itemContent Object 是 新的监控项内容，为任意对象 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否更新成功 true

接口功能介绍 列出所有别名 接口约束 请保证账户余额大于0 URI POST /v1/keyName/listAlias 路径参数 无 Query参数 无 请求参数 请求头header参数 请参见请求消息头 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pageNumber 是 String 页数 1 pageSize 是 String 每页展示的别名数量 10 响应参数 参数 参数类型 说明 示例 下级对象 code String 返回码，取值范围： 200：成功 400：参数缺失或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 200 errorCode String 错误码 KMS.0514 msg String 调用结果信息 生成数据密钥成功 data Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 totalCount int 别名总数 100 pageSize String 每页展示的别名数量 10 pageNumber String 页数 1 aliases String 别名信息 aliases 表 aliases 参数 参数类型 说明 示例 下级对象 alias List 别名信息 aliasList 表 aliasList 参数 参数类型 说明 示例 下级对象 aliasName String 别名 addqweqwsd cmkUuid String 密钥id 00f57b8191d54b6590076195528f8a37

当函数计算运行您的函数时，会将上下文对象传递到执行方法中。该对象包含有关调用、服务、函数和执行环境等信息。 上下文对象context主要包括如下字段： 字段 类型 说明 requestId String 函数请求ID。 credentials Credentials，该结构字段如下： accessKeyId accessKeySecret securityToken 临时密钥信息。 function FunctionMeta，该结构字段如下： name handler memory timeout 当前函数的基本信息。 service ServiceMeta，该结构字段如下： logProject logStore qualifier versionId 当前函数的服务信息。 region String 当前函数的所在地域ID。 accountId String 当前函数的所属账号ID。 logger ContextLog，该结构字段如下： debug info warn error log 日志对象。

接口介绍 此接口用于在指定的Bucket 上设定一个跨域资源共享(CORS)的规则，如果原规则存在则覆盖原规则。 接口约束 无 请求URI PUT /v1/cors/{bucket} 路径参数 参数 是否必填 参数类型 说明 示例 bucket 是 String 桶名称 testBucket Query参数 参数 是否必填 参数类型 说明 示例 下级对象 cors 是 String 固定参数 注：如果query中的参数为固定参数，不需要带值value。 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String 消息体格式 application/xml 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 CORSConfiguration 是 Array of Objects 最多100 个CORSRule 元素的容器 CORSConfiguration 表 CORSConfiguration 参数 是否必填 参数类型 说明 示例 下级对象 CORSRule 是 Array of Objects 一组源和方法 CORSRule 表 CORSRule 参数 是否必填 参数类型 说明 示例 下级对象 AllowedHeader 否 String 设置允许哪些header，注意： 只能使用一个星号（）通配符，且不支持使用这些字符:(<,&) AllowedMethod 否 String 允许执行的跨域请求方法，取值范围为:GET,PUT,DELETE,POST,HEAD PUT AllowedOrigin 是 String 指定允许的跨域请求的来源，允许使用多个元素来指定多个允许的来源, AllowedOrigin中只能使用一个星号()通配符 ExposeHeader 否 String 指定允许用户从应用程序中访问的响应头，不支持使用这些字符:(<,&) test123 MaxAgeSeconds 否 Integer 指定浏览器对特定资源的预取请求返回结果的缓存时间，单位为秒，如果参数<0，按0处理 30

本章节介绍密码服务产品功能。 数据加解密 提供重要数据的加密和解密服务，满足密评中对重要数据传输和存储的机密性要求，基于数据加密技术，能够在数据进入数据库之前对其进行加密处理，从而确保数据的机密性和完整性。 签名验签 提供重要数据的签名和验签服务，满足密评中对重要数据传输和存储的完整性要求以及操作的不可否认性要求。 密钥管理 提供集中的密钥全生命周期管理服务，满足密评中对密钥管理的安全性要求。 安全传输 提供网络通信通道的加密服务，满足密评中对网络和通信安全层面的数据传输机密性和完整性要求。 协同签名 配合移动端密码模块为应用系统移动端提供协同密码服务，满足应用终端身份认证、数据加密合规性要求。 密评服务 为租户侧提供密码方案设计、应用系统密改指导、应用系统密评支撑等服务。

关闭产品实例秒级监控上报 1. 登录控制中心。 2. 在控制中心页面左上角点击，选择区域，本文我们选择华东1。 3. 依次选择“网络”，单击“弹性IP”，进入弹性IP控制台。 4. 单击待开启实例“关闭秒级监控”按钮，出现“秒级监控关闭”二次确认弹窗。 5.点击“确定”完成产品秒级监控数据上报关闭。 关闭产品监控数据写入存储 1. 登录控制中心。 2. 在控制中心页面左上角点击，选择区域，本文我们选择华东1。 3. 依次选择“迁移与管理”，单击“云监控服务”，进入监控概览页面。 4. 单击左侧“企业服务”>“秒级监控”菜单，进入秒级监控管理页面。 5. 单击“关闭”按钮，出现“关闭秒级监控”二次确认弹窗。 6.在“关闭秒级监控”二次确认弹窗，点击“确定”完成产品监控数据写入存储关闭。

关闭产品实例秒级监控上报 1. 登录控制中心。 2. 在控制中心页面左上角点击，选择区域，本文我们选择华东1。 3. 依次选择“网络”，单击“弹性IP”，进入弹性IP控制台。 4. 单击待开启实例“关闭秒级监控”按钮，出现“秒级监控关闭”二次确认弹窗。 5.点击“确定”完成产品秒级监控数据上报关闭。 关闭产品监控数据写入存储 1. 登录控制中心。 2. 在控制中心页面左上角点击，选择区域，本文我们选择华东1。 3. 依次选择“迁移与管理”，单击“云监控服务”，进入监控概览页面。 4. 单击左侧“企业服务”>“秒级监控”菜单，进入秒级监控管理页面。 5. 单击“关闭”按钮，出现“关闭秒级监控”二次确认弹窗。 6.在“关闭秒级监控”二次确认弹窗，点击“确定”完成产品监控数据写入存储关闭。

使用自定义脚本实现数据库备份完成后，可以通过如下操作验证数据库备份结果是否成功。本章节以MY SQL数据库为例进行验证。 步骤1、登录MY SQL数据库，创建新的数据库。 步骤2、创建数据库成功后，创建存储过程，可以参考下图。 创建存储过程 步骤3、进入服务备份控制台，对目标弹性云主机创建数据库备份，并勾选数据库备份。 步骤4、待备份完成后，进入/home/rdadmin/Agent/log/rdagent.log，查看冻结、解冻日志，确定冻结解冻时间。 步骤5、使用新创建的数据库备份恢复目标弹性云主机。恢复成功后，登录云主机和数据库，查看表中最后一条插入数据对应的时间。 步骤6、对比步骤5日志显示的VSS冻结成功时间和步骤4的时间。冻结成功之前会停止插入数据，所以步骤5的时间比步骤4早。若步骤5的时间比步骤4早，则表示引用一致性备份成功。

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

设置 说明 关机方式 关机：正常关机流程。但为避免关机失败，当您选择关机时，普通关机超时会自动执行强制关机操作。 强制关机：等同于断电处理，可能丢失云主机操作系统中未写入磁盘的数据。 关机模式 普通关机模式：普通关机后保留计算、存储、网络资源。 节省关机模式：节省关机后，计算资源（CPU、内存、GPU）均被释放且不计费，其余网络、存储资源继续保留并收费。

接口功能介绍 节点停止 接口约束 无 URI GET /PG/v1/node/stop 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例id 567078229420302954 nodeId 是 Long 节点id 25 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ProjectId 否 String 企业项目id，若不传入则查询默认的企业项目，默认的企业项目id为0 0 regionId 是 String 资源池id，比如实例在资源池A，则需要填写A资源池的id 81f7728662dd11ec810800155d307d5b 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS error String 错误码 returnObj Object 返回结果 NodeStopVO 表 NodeStopVO 参数 参数类型 说明 示例 下级对象 pgEventId Long 任务Id 1 枚举参数 无 请求示例 请求url 请求头header { "ProjectId":"0", "regionId":"81f7728662dd11ec810800155d307d5b" } 请求体body 无

接口功能介绍 节点启动 接口约束 无 URI GET /PG/v1/node/start 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例id 567078229420302954 nodeId 是 Long 节点id 25 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ProjectId 否 String 企业项目id，若不传入则查询默认的企业项目，默认的企业项目id为0 0 regionId 是 String 资源池id，比如实例在资源池A，则需要填写A资源池的id 81f7728662dd11ec810800155d307d5b 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS error String 错误码 returnObj Object 返回结果 NodeStartVO 表 NodeStartVO 参数 参数类型 说明 示例 下级对象 pgEventId Long 任务Id 1 枚举参数 无 请求示例 请求url 请求头header { "ProjectId":"0", "regionId":"81f7728662dd11ec810800155d307d5b" } 请求体body 无

接口功能介绍 节点启动 接口约束 无 URI GET /PG/v1/node/start 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例id 567078229420302954 nodeId 是 Long 节点id 25 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ProjectId 否 String 企业项目id，若不传入则查询默认的企业项目，默认的企业项目id为0 0 regionId 是 String 资源池id，比如实例在资源池A，则需要填写A资源池的id 81f7728662dd11ec810800155d307d5b 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS error String 错误码 returnObj Object 返回结果 NodeStartVO 表 NodeStartVO 参数 参数类型 说明 示例 下级对象 pgEventId Long 任务Id 1 枚举参数 无 请求示例 请求url 请求头header { "ProjectId":"0", "regionId":"81f7728662dd11ec810800155d307d5b" } 请求体body 无

接口功能介绍 创建数据库参数模板 接口约束 无 URI POST /PG/v1/template/create 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ProjectId 否 String 企业项目id，若不传入则查询默认的企业项目，默认的企业项目id为0 0 regionId 是 String 资源池id，比如实例在资源池A，则需要填写A资源池的id。 81f7728662dd11ec810800155d307d5b 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 sourceTemplateId 是 Long 参考的参数模板ID 12 name 是 String 参数模板名字，长度限制：1128 11 description 否 String 参数模板的描述，若不为空，则长度限制：11024 My Template 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS error String 错误码 returnObj Object 返回结果 TemplateCreateVO 表 TemplateCreateVO 参数 参数类型 说明 示例 下级对象 templateId Long 模板Id 1 枚举参数 无

接口功能介绍 提供获取资产同步状态接口 接口约束 接口规范 URI GET /vfw/v2systemvrfbindsyncstatus 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 type 是 String 资产同步类型 eip 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 SyncVrfLogEntity 表 SyncVrfLogEntity 参数 参数类型 说明 示例 下级对象 log String 日志内容 regionId String 资源池ID syncStatus String 同步状态 SUCCESS同步成功 SYNCING同步中 ERROR同步失败 syncSuccessTime String 同步成功时间 uid String 租户ID type String 资产同步类型 eip

接口功能介绍 查询dpi配置详情 接口约束 传参规范 URI GET /vfw/v2dpiinfo 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 firewallId 是 String 防火墙id dca4f9ffaca2447aa24310c1e62c4690 regionId 否 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 DpiEntity 表 DpiEntity 参数 参数类型 说明 示例 下级对象 ddosProtect String DDos防护开关 firewallId String 防火墙id dca4f9ffaca2447aa24310c1e62c4690 regionId String 资源池ID fecnjniakfkn2314ndekqldedcsadfg runmode String 运行模式 avProtect String AV防护开关 vpatch String 虚拟补丁开关 version Integer 版本号 1

本节主要介绍图片处理中URL构成规则。 图片处理服务通过URL来处理图片，以下定义访问方式的规范： 直接显示原图，形式为： /bucket /object /object /object，即支持website的方式访问文件 通过处理参数访问，形式为： /bucket /object@oosImage100w100h90q.jpg .endpoint/object@oosImage100w100h90q.jpg /object@oosImage100w100h90q.jpg，即支持website的方式访问文件 object为用户Bucket上存储的原图片。100w100h90q为转换字符串，用来转换处理图片的一段参数。通过指定转换字符串，可以返回另一张转换处理后的图片。 一个典型的转换字符串，如“100w100h90q.jpg”，代表需要一张宽（w）100px、高（h）100px、质量（q）90%、jpg格式的图：@oosImage120w120h90q.jpg 转换字符串分为3部分：初始操作、转换参数、转换格式： 初始操作（如@oosImage）是一个“@”符号 +“oosImage”+“”管道符号，后面都为转换字符串。 转换参数（如120w120h90q）由一个或多个键值对（以""连接）组成，“值”在前“键”在后，“值”为数字类型，“键”为一位字母。 转换格式（如.jpg）是指定图片转换的输出格式，通过指定转换格式，可以对原图处理并返回指定的图片格式。支持的转换格式为： jpg、webp、png、bmp。

查看NameNode JVM非堆内存使用情况和当前配置 4.在FusionInsight Manager首页，选择“集群 > 待操作集群的名称 > 服务 > HDFS”，弹出“HDFS 服务状态”页面。 5.在“基本信息”区域，单击“NameNode(主)”，显示HDFS WebUI页面。 说明 admin用户默认不具备其他组件的管理权限，如果访问组件原生界面时出现因权限不足而打不开页面或内容显示不全时，可手动创建具备对应组件管理权限的用户进行登录。 6.在HDFS WebUI，单击“Overview”页签，查看Summary部分显示的HDFS中当前文件数量，目录数量和块数量信息。 7.在FusionInsight Manager首页，选择“集群 > 待操作集群的名称 > 服务 > HDFS > 配置 > 全部配置”，在“搜索”中，输入“GCOPTS”，确定当前“HDFS>NameNode”的“GCOPTS”非堆内存参数。 对系统进行调整 8.根据步骤6中的文件数据量和步骤7中NameNode配置的非堆参数，检查当前配置的非堆内存是否不合理。 是，执行步骤9。 否，执行步骤12。 说明 HDFS的文件对象数量（filesystem objectsfiles+blocks）和NameNode配置的JVM参数的对应关系建议如下： 文件对象数量达到10,000,000，则JVM参数建议配置为：Xms6G Xmx6G XX:NewSize512M XX:MaxNewSize512M。 文件对象数量达到20,000,000，则JVM参数建议配置为：Xms12G Xmx12G XX:NewSize1G XX:MaxNewSize1G。 文件对象数量达到50,000,000，则JVM参数建议配置为：Xms32G Xmx32G XX:NewSize3G XX:MaxNewSize3G。 文件对象数量达到100,000,000，则JVM参数建议配置为：Xms64G Xmx64G XX:NewSize6G XX:MaxNewSize6G。 文件对象数量达到200,000,000，则JVM参数建议配置为：Xms96G Xmx96G XX:NewSize9G XX:MaxNewSize9G。 文件对象数量达到300,000,000，则JVM参数建议配置为：Xms164G Xmx164G XX:NewSize12G XX:MaxNewSize12G。 9.按照文件对象数量和非堆内存对应关系，对NameNode的“GCOPTS”参数进行修改。 10.保存配置，选择“概览 > 更多 > 重启服务”。 11.检查本告警是否恢复。 是，处理完毕。 否，执行步骤12。

本页介绍天翼云TeleDB数据库存储过程开发的变量。 在一个块中使用的所有变量必须在该块的声明小节中事先进行声明，PL/pgSQL 变量可以是任意SQL数据类型，可以是一个简单数据类型、复合类型、RECORD、已经存在的表行类型、表字段类型、游标。

接口描述 查询RDS实例的SQL洞察日志保存时长。 接口约束 实例需要已开启SQL洞察 URI GET /v1/collector/sqlcollectorretention 请求参数 请求体Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Integer 返回对象 30 请求示例 /v1/collector/sqlcollectorretention?prodInstId10 请求体body 响应示例 { "message": "SUCCESS", "returnObj": 30, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

本小节主要介绍RDSPostgreSQL的vector插件使用方法。 操作场景 RDSPostgreSQL支持 vector插件，提供了一个新的数据类型，能够存储向量类型数据，并实现向量相似度匹配，为AI产品提供底层数据支持。 前提条件 请确保您的实例内核大版本满足，本插件所支持的内核版本，请参考支持的版本插件列表。 插件使用 安装插件 sql CREATE EXTENSION IF NOT EXISTS vector; 卸载插件 sql DROP EXTENSION IF EXISTS vector; 使用示例 数据存储&查询 创建具有3维的向量列 sql CREATE TABLE items (id bigserial PRIMARY KEY, embedding vector(3)); 插入向量 sql INSERT INTO items (embedding) VALUES ('[1,2,3]'), ('[4,5,6]'); 通过L2距离得到最近邻 sql SELECT FROM items ORDER BY embedding '[3,1,2]'; 通过余弦距离得到最近邻 sql SELECT FROM items ORDER BY embedding '[3,1,2]'; 通过内积得到最近邻， 返回的是负内积，因为Postgres只支持运算符上的ASC顺序索引扫描 sql SELECT FROM items ORDER BY embedding '[3,1,2]'; 距离计算 sql SELECT embedding '[3,1,2]' AS distance FROM items; SELECT (embedding '[3,1,2]') 1 AS innerproduct FROM items; SELECT 1 (embedding '[3,1,2]') AS cosinesimilarity FROM items;

本章介绍如何删除云硬盘快照。 操作场景 主机迁移服务，在迁移任务复制/同步/克隆过程中，会对目的端云硬盘生成相应的快照。删除迁移任务后，任务对应的快照也会删除。若目的端使用了专属分布式存储服务 DSS的云盘，SMS生成的快照会占用DSS存储池容量，占用容量等于实际数据存储容量。您可以参考本章节，按需求删除云硬盘快照。 快照类型包括： 割接快照：迁移完成后，会对目的端磁盘制作割接快照，用于后续业务出现问题可以回滚。建议业务割接稳定后再删除此快照。 同步快照：Windows迁移和Linux块迁移，数据迁移并同步完成后，修改目的端服务器配置前会制作同步快照，以确保下次同步和源端数据一致。删除此快照将无法再次进行同步，请谨慎操作。 克隆快照：Windows、Linux克隆目的端时会制作克隆快照，用于克隆服务器以及克隆完成后返回持续同步状态。 操作步骤 1. 登录主机迁移服务管理控制台。 2. 在左侧导航树中，单击“迁移服务器”，进入迁移服务器列表页面。 3. 在迁移服务器列表页面，选择需要删除云硬盘快照的服务器，在“操作”列单击“更多 > 删除云硬盘快照”。 4. 在弹出的“删除目的端云硬盘快照”窗口中，勾选需要删除的快照类型，单击“确定”。

本节主要介绍函数管理 新建函数 操作步骤 1. 在顶部导航栏选择“库管理”，在对象列表页签下选择“函数”，单击页面左上侧“新建函数”。 2. 在新建函数弹出框中填写函数名称，设置返回值类型及描述信息，单击“确定”，进入函数编辑页面。 3. 在函数编辑页面，您只需在已生成函数的创建模板中编写函数体部分。 4. 在新建函数窗口左上方选择“选项”，您可在选项弹出框中按需设置相关信息，单击“确定”。 您可“保存”当前新建函数，也可单击执行函数，调用该对象，并在页面下方消息栏查看运行情况。 修改或执行函数 操作步骤 1. 在顶部导航栏选择“库管理”，在对象列表页签下选择“函数”，单击页面操作栏的“修改或执行”。 2. 在函数详情页面修改函数信息，按需设置选项，单击“保存”保存修改信息，或者您可直接单击“执行函数”，调用该对象。 删除函数 操作步骤 1. 在顶部导航栏选择“库管理”，在对象列表页签下选择“函数”，单击页面操作栏的“删除函数”。 2. 在删除函数弹出框中，单击“确定”。 注意 删除操作无法恢复，请谨慎选择。 查看函数详情 操作步骤 1. 在顶部导航栏选择“库管理”，在对象列表页签下选择“函数”，单击页面操作栏的“查看函数详情”。 2. 在查看函数详情弹出框中，查看函数详情，单击“关闭”。

配置项 说明 检测项 支持快捷选择系统内置的检测项（包括暴力破解、批量注册、批量导出），或选择自定义接口滥用。 若选择系统内置的检测项，则防护对象会自动填充。 检测项名称 当“检测项”选择“自定义接口滥用”，需要设置检测项名称。 检测项名称不允许重复。 防护开关 拦截：当客户端请求行为匹配检测规则，则拦截客户端请求。 关闭：该检测项不生效。 告警：当客户端请求行为匹配检测规则，不会拦截客户端请求，但会产生攻击日志。 拦截时间 客户端触发检测规则的处置时长。 防护对象 设置需要防护的API资产对象。支持从三个维度设置API防护对象： API：从API资产中选择防护对象。 标签：关联标签的API资产。如：敏感信息包含银行卡号和手机号的API资产。 URI：API资产中，满足正则规则的API资产。 统计周期 设置统计周期。 统计阈值 设置统计阈值。 检测粒度 设置检测粒度，支持设置IP、IP+UA。

接口功能介绍 查询接入点的资源权限列表 接口约束 无 URI POST /v1/applicationAccessPointManage/listPointResourcePolicy 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 list Array of Objects 资源权限列表 resourcePolicyList 表 resourcePolicyList 参数 参数类型 说明 示例 下级对象 aliasName String 密钥别名 testccmk resourceId String 资源id 908b979ecd964d6499b7856a671ebc82 status Integer 资源状态 0 禁用 1 启用 0 resourceType String 资源类型 cmk 密钥资源 cert 证书资源 cmk

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 返回对象 [] VpcForm

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 返回对象 [] NetworkInfo

操作步骤 1. 单击“导入”。 2. 在弹出的对话框中上传符合格式要求的文件。 说明 可单击“测评对象模板下载”，获取模板，根据模板要求提供文件。 3. 单击“导入”，即可将新的测评对象批量导入至系统。