接口功能介绍 调用此接口可查询信息配置的基本信息和告警对象。 接口约束 参见请求参数说明。 URI GET /v4/monitor/querynoticetemplatevariable 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 group 是 String 本参数表示分组名称。取值范围： basic：基本信息。 entity：告警对象。 根据以上范围取值。 basic dimension 是 String 告警维度。取值范围： ecs：云主机。 disk：磁盘。 pms：物理机。 ... 云监控服务，具体服务参见云监控：查询服务维度及监控项 ecs 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Array of Objects 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 name String lable名称 basic.idc description String lable描述 资源池名称

6、请求代码示例 json Curl X POST " H "ContentType: application/json" H "ctyuneoprequestid:33dfa732b27b464fb15a21ed6845afd5" H "appkey:XXX" H "EopAuthorization:XXX" H "eopdate:20211109T104641Z" H "host:aiglobal.ctapi.ctyun.cn" data '{"data":["AAAAAAAAA...."]}' 7、返回值说明 请求成功返回响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 是 Int 返回状态，返回 0 表示成功，返回错误代码参考下面的错误代码列表。 0 message 是 String 如果statusCode 为 0，返回 success；如果statusCode 非 0，则返回对应的可读错误信息。 success returnObj 是 Dict 返回对象 returnObj 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 politic 是 List 审核场景 / politic[] 表politic 参数 是否必填 参数类型 说明 示例 下级对象 label 是 Int 分类标签值 0 / classname 是 String 分类标签描述 违规 / confidence 是 Float 该段文本违规的置信度 0.98 / 请求失败返回响应参数 参数 是否必填 参数类型 说明 示例 下级对象 code 是 Int 错误码，放置API对应的错误码 4010 message 是 Str 返回对应的错误信息 error details 是 Str 返回对应的错误描述 文件大小不符合要求 error 是 String 返回对应的错误码 AIOP4101

通知模板 通知模板：查询变量 接口功能介绍 调用此接口可查询信息配置的基本信息和告警对象。 接口约束 参见请求参数说明。 URI GET /v4/monitor/querynoticetemplatevariable 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 group 是 String 本参数表示分组名称。取值范围：basic：基本信息。entity：告警对象。 根据以上范围取值。 basic dimension 是 String 告警维度。取值范围：ecs：云主机。disk：磁盘。pms：物理机。...详见“告警规则：获取告警服务维度关系”接口返回。 ecs 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Array of Objects 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 name String lable名称 basic.idc description String lable描述 资源池名称

在设置Web安全防护功能之前，您需要先进行安全基础配置。 前提条件 已开通Web应用防火墙（边缘云版）。 已新增域名并成功接入WAF，具体操作请见WAF接入 操作步骤 1. 登录Web应用防火墙（边缘云版）控制台 2. 在左侧导航栏中选择【域名管理】—【域名列表】，选择您要防护的域名，单击操作列【安全防护】 3. 进入【安全基础配置】页面 配置说明 配置项 说明 防护模式 防护模式：域名防护开关，为防护功能的全局按钮，用于控制功能是否生效 开启：开启web防护 关闭：关闭web防护，策略不生效 处理动作 处理动作：全局处理动作 拦截：当处理动作为拦截时，各防护功能的处理动作依照其配置生效； 告警：当处理动作为告警时，各防护功能的处理动作如果配置为拦截，则也生效为告警。 漏洞防护配置 设置漏洞防护配置，根据下拉提示选择适配网页业务的模板 全量防护规则集：适用于重保等级高，且允许一定程度误报的业务场景。该漏洞规则集防护包含全量规则，绝大部分规则处理动作为拦截（网站防护模式为拦截时则直接进行拦截），容易出现误报，请谨慎选择； 敏感防护规则集：适用于常规网站，且允许少量误报的业务场景。该漏洞规则集防护等级较为严格，容易误报的规则处理动作为告警，其他规则处理动作为拦截（网站防护模式为拦截时则直接进行拦截），存在一定误报可能性； 宽松防护规则集：适用于常规网站，允许存在一定漏报的业务场景。该漏洞规则集防护等级较为宽松，关闭容易产生误报的规则，则可能存在一定漏报，接入后请及时关注； PHP防护规则集：适用于后台开发语言为PHP的网站业务。该漏洞规则集主要针对后台语言为PHP进行制定，关闭其他容易产生误报的规则，接入后请及时关注； JAVA防护规则集：适用于后台开发语言为JAVA的网站业务。该漏洞规则集主要针对后台语言为JAVA进行制定，关闭其他容易产生误报的规则，接入后请及时关注； 非PHP和JAVA防护集：适用于后台开发语言明确非PHP和JAVA网站业务。该漏洞规则集主要针对后台语言为非PHP和JAVA进行制定，关闭其他容易产生误报的规则，接入后请及时关注； 下载类业务规则集：适用于下载类业务，即包含zip、rar、tar、gz等下载类后缀的业务网站。该漏洞规则集主要针对下载类业务进行设定规则，关闭其他容易产生误报的规则，接入后请及时关注； 注意：域名刚接入时建议使用【敏感防护规则集】，能够适用于大部分常规网站 静态文件后缀 在【静态文件后缀】输入框中输入无需检测的文件后缀，多个用英文;分隔，输入并提交保存后，边缘云WAF将不对这些文件类型进行检测 默认值：css;js;pjpeg;flv;mp4;mp3;wmv;wma;avi;apk;rpm;deb;bin;ogg;mpg;mpeg;f4v;rm;3gp;img;cur;jpe;ico;msi;cab;pdf;aac;swc;doc;docx;xls;xlsx;ppt;pptx;rmvb;ipa;sis;xap;m3u8;ts;gif;jpg;jpeg;swf;png;bmp

本章节为您介绍微服务引擎专享版的版本支持机制。 版本号说明 版本号格式为：{major}.{minor}.{patch}。 其中： {major}.{minor}为正式版本号。 {patch}为补丁版本号。 例如，v1.3.1。1.3为正式版本号，1为补丁版本号。 版本支持机制 微服务引擎创建 只能创建最新版本的微服务引擎，不支持创建指定版本微服务引擎。 微服务引擎维护 支持同时维护最新的3个正式版本。 微服务引擎版本升级 正式版本升级，支持当前最新的3个正式版本中的2个较低版本升级到最新版本。例如，当前最新的3个正式版本为1.3、1.2、1.1，则支持由1.1、1.2升级到1.3。 说明 当引擎升级已超出可支持升级的版本范围，例如由1.0升级到1.3，可能导致微服务引擎的管理功能不可用，请谨慎操作。 您可以通过联系技术支持工程师，进行升级前风险评估。 补丁版本升级，微服务引擎后台提供补丁版本自动升级，例如由1.3.0升级到1.3.1。 版本约束 微服务引擎版本升级后，不支持版本回滚。

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

参数名称 说明 取值样例 操作类型 风险操作的类型，包括“登录”和“操作”。当选择“操作”时，可以选择“全部操作”，或选择“数据定义（DDL）”、“数据操作（DML）”或“数据控制（DCL）”的操作。 操作 操作对象 单击“添加操作对象”后，输入“schema”、“目标表”和“字段”信息。单击“确定”，添加操作对象。 执行结果 设置“影响行数”和“执行时长”的执行条件后，输入行数和时长值

接口功能介绍 接受共享镜像。 接口约束 无 URI POST /v3/shareImage/acceptShareMirrors 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID rg1234567890abcdef1234567890abcd 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 imageOidList 是 Array of Strings 镜像ID列表 响应参数 参数 参数类型 说明 示例 下级对象 code Integer 状态码 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "imageOidList":["miggfapw5e4e5i20ab6wu36","miranfo6aknzrnx4m4nbw1s"] } 响应示例 { "code":0 } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 拒绝共享镜像。 接口约束 无 URI POST /v3/shareImage/rejectShareMirrors 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID rg1234567890abcdef1234567890abcd 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 imageOidList 是 Array of Strings 镜像ID列表 响应参数 参数 参数类型 说明 示例 下级对象 code Integer 状态码 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "imageOidList":["miggfapw5e4e5i20ab6wu36","miranfo6aknzrnx4m4nbw1s"] } 响应示例 { "code":0 } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 更改接入点的资源权限 接口约束 无 URI POST /v1/applicationAccessPointManage/changePointResourcePolicy 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d policyType 是 String 权限类型 allow cmkList 否 Array of Strings 密钥资源列表 ["908b979ecd964d6499b7856a671ebc82"] certList 否 Array of Strings 证书资源列表 ["908b979ecd964d6499b7856a671ebc82"] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 returnObj error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 13e2aeb065364db1a8cc611f3edd63ee

接口功能介绍 获取接入点的接口权限详情 接口约束 无 URI POST /v1/applicationAccessPointManage/listPointUriPolicy 路径参数 无 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 Strings 接口权限详情 ["kms:cmk:create","kms:cmk:create"] 枚举参数 无 请求示例 请求url 请求头header { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body { "applicationId": "b2160c2c9c704ca9b8080d186c97280d" }

接口功能介绍 更新密钥描述接口 接口约束 请保证账户余额大于0 URI POST /v1/keyManage/updateKeyDescription 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥加密的数据密钥密文 474e569e8814474a948bdbcf6d853eff description 否 String 描述 abcd 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 更新密钥描述成功 returnObj Object 接口返回结果 null returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id de4138537a8b42c3a1a80ce1898f3476 枚举参数 无 请求示例 请求url 无 请求头header { "regionId": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body { "cmkUuid": "27e658cf3b904987adfdfe8700ee4f59", "description": "描述更改1" }

vpn用户服务修改。 接口功能介绍 vpn用户服务修改 接口约束 支持集群模式资源池。 URI POST /v4/vpn/ipsecuserservice/update 路径参数 无 Query参数 无 请求参数 请求header参数 无 请求body参数 参数 是否必填 参数类型 说明 示例 下级对象 ipsecServiceName 是 String IPSCE 服务名称 ipsec111 regionID 是 String 资源池ID b342b77ef26b11ecb0ac0242ac110002 ipsecServiceID 是 String vpn用户服务ID 35d5fa99c0404bb0806a8be317cc4d89 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 否 Integer 返回状态码 取值范围: 800：成功 900：失败 800 errorCode 否 String 业务细分码，为product.module.code三段式码 message 否 String 失败时的错误描述，一般为英文描述 description 否 String 失败时的错误描述，一般为中文描述 returnObj 否 Object 返回对象 returnObj 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 logMark 否 String 链路追踪ID 74cb2e661f9545daaac5ee013470fd96

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

本节为您介绍数据安全相关内容。 了解数据 在准备云迁移之前，需要确保全面了解自己的数据及其需求。这意味着迁移团队必须深入了解当前和未来的数据使用情况，并理解公司数据治理框架所制定的存储和保留策略。为了处理数据理解和优化任务，可以借助各种云管理工具，例如重复数据删除软件。这些工具可以帮助识别和处理冗余数据，提高存储效率。同时，保护云数据也是非常重要的，这需要准确了解云数据的内容以及最终的使用和处理方式。这包括确认哪些数据属于敏感信息，需要采取额外的安全措施来保护，以及确保符合数据隐私和合规性要求。 了解数据合规要求 除了了解数据本身外，企业在云迁移期间还需要了解适用于其数据集的任何合规要求。例如，GDPR、PCIDSS和HIPAA等监管框架对许多企业施加严格的要求，其中包括在数据迁移前剥离个人身份信息。因此，企业必须确保选择的云基础设施提供商满足合规要求，同时加强API安全性控制，并采取措施对个人身份信息进行去标识化或剥离，以保护用户隐私。此外，还需要实施适当的用户访问特权管理，限制数据的访问权限。这些措施有助于确保在云迁移过程中的数据合规性和安全性。 传输过程中加密数据 云迁移中传输数据可能带来额外的安全漏洞。保护敏感信息的一种有效方法是使用源端到目标端加密。这个过程通常使用像传输层安全(TLS)之类的加密协议来完成，该协议在所有数据离开开源系统之前对其进行加密，并在数据到达目标系统后对其进行解解密，从而增添额外的安全层。根据需要的保护程度，有多种加密算法可供选择，不过大多数使用AES或RSA等现代行业标准。公司还应确保安全地存储访问所需的加密密钥和凭据，并定期备份，以防数据丢失。利用提供内置加密服务的云提供商可以简化这个过程。在开始迁移之前，公司仍然应该进行尽职调查，以确保自己拥有适当的工具和安全措施。

接口描述 续订询价 接口约束 无 URI POST /v1/eop/reneworderprice 请求参数 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cycleType 是 String 取值范围：3表示按月订购，5表示按一年订购，6表示按两年订购、7表示按三年订购。与cycleCount配合使用，cycleCount属性为1，cycleType取值为3 表示订购1个月。 3 cycleCount 是 Integer 续订周期数量。 2表示续订2个月（值需大于零，不超过384个月） 1 resourceIds 是 Array String数组，主虚拟资源ID（批量续订时资源不能超过10个）可通过【根据主订单id查询订单详情】接口返回的masterResourceId字段获取 [ "48cd3a5e9b964657a1f31c58a8b98ae4"] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 价格明细 PriceDetail PriceDetail 参数 参数类型 说明 示例 下级对象 isSucceed Boolean 询价请求是否成功 true totalPrice BigDecimal 订单总价 542.0 finalPrice BigDecimal 订单最终价格 542.0 subOrderPrices Array 子订单明细 SubOrderPrice SubOrderPrice 参数 参数类型 说明 示例 下级对象 totalPrice BigDecimal 子订单总价 462.0 finalPrice BigDecimal 子订单最终价格 462.0 serviceTag String 服务平台 PAAS orderItemPrices Array 订单项价格 OrderItemPrice OrderItemPrice 参数 参数类型 说明 示例 下级对象 itemId String 订单项ID "1daaeb363cc949929cfd29745a6750ce" resourceType String 资源名称 PGSQLVM totalPrice BigDecimal 商品总价 462.0 finalPrice BigDecimal 最终价格 462.0

操作步骤 1. 按需编辑应用 YAML，添加读写带宽或 IOPS 限制注解。 2. 应用 YAML 到集群： plaintext kubectl apply f .yaml 3. 部署后，Pod 启动时自动生效，无需额外操作。 4. 若需调整限速参数，修改注解后重新部署/滚动升级 Pod。 测试与验证流程 1. 部署带磁盘限速注解的测试 Pod（如上 YAML 示例）。 2. 进入 Pod 内部，运行 fio 工具进行磁盘性能测试： plaintext kubectl exec it n demo sh fio namefiotest ioenginelibaio direct1 filename/test/fiotest bs4k rwrandrw rwmixread50 size1G timebased runtime60 iodepth8 numjobs1 groupreporting 3. 观察 fio 输出，确认读写带宽与 IOPS 已被限制在注解设定范围内。 4. 可对比未限速和限速下的 fio 测试结果，验证限速效果。 常见问题与说明 注解配置无效？ 请确认集群和节点已启用磁盘限速能力，且注解拼写正确。 查存储卷类型，部分类型（如 hostPath）受限速支持影响。 限速效果与预期不符？ 实际带宽/IOPS 受节点硬件、存储类型等多因素影响，建议多次测试取均值。 Pod 启动报错或无效？ 检查注解单位和格式，确保符合规范。 注意 建议仅对有实际需求的业务配置磁盘限速，避免资源浪费。 修改限速参数需滚动升级或重建 Pod 以生效。 测试时建议隔离环境，避免影响其他业务。

接口功能介绍 更新转发规则 接口约束 仅支持更新策略名称和描述，未见策略名称字段；域名和URL字段不支持修改。 URI POST /v4/elb/updaterule 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 clientToken 是 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 区域ID 81f7728662dd11ec810800155d307d5b ID 否 String 转发规则ID, 该字段后续废弃 xxxx policyID 否 String 转发规则ID, 推荐使用该字段, 当同时使用 ID 和 policyID 时，优先使用 policyID xxxx priority 否 Integer 优先级，数字越小优先级越高，取值范围为：1100(目前不支持配置此参数,只取默认值100) 100 description 否 String 支持拉丁字母、中文、数字, 特殊字符：~!@ $%^&()+ <>?:'{},./;'[,]·！@ ￥%……&（） —— +{},《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 128 desc conditions 否 Array of Objects 匹配规则数据 conditions action 否 Object 规则目标 action 表 conditions 参数 是否必填 参数类型 说明 示例 下级对象 type 是 String 类型。取值范围：servername（服务名称）、urlpath（匹配路径） urlpath serverNameConfig 否 Object 服务名称 serverNameConfig urlPathConfig 否 Object 匹配路径 urlPathConfig 表 serverNameConfig 参数 是否必填 参数类型 说明 示例 下级对象 serverName 否 String 服务名称 xxxx 表 urlPathConfig 参数 是否必填 参数类型 说明 示例 下级对象 urlPaths 否 String 匹配路径 /// matchType 否 String 匹配类型。取值范围：ABSOLUTE，PREFIX，REG REG 表 action 参数 是否必填 参数类型 说明 示例 下级对象 type 是 String 默认规则动作类型。取值范围：forward、redirect、deny(目前暂不支持配置为deny) forward forwardConfig 否 Object 转发配置 forwardConfig redirectListenerID 否 String 重定向监听器ID，当type为redirect时，此字段必填 xxzzzz 表 forwardConfig 参数 是否必填 参数类型 说明 示例 下级对象 targetGroups 否 Array of Objects 后端服务组 targetGroup 表 targetGroup 参数 是否必填 参数类型 说明 示例 下级对象 targetGroupID 是 String 后端服务组ID tgxxx weight 否 Integer 权重，取值范围：1256。默认为100 100

接口功能介绍 查看指定资源池内的所有监控面板的具体内容，或者查看某一指定监控面板的内容。 接口约束 regionID（资源池）存在，如果查询指定监控面板内容，则需要templateID（监控面板）存在。 URI GET /v4/monitor/describemonitor 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID templateID String 否 0bf803e8504911ed8fb7005056897257 监控面板ID pageNo Integer 否 1 页码，默认为1 page Integer 否 1 页码，默认为1，建议使用pageNo，该参数后续会下线 pageSize Integer 否 2 页大小，默认为10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 templateList Array of Objects 监控面板具体内容 templateList totalCount Integer 查询到的监控面板个数 1 page Integer 页码，建议参考请求参数pageNo，该参数后续会下线 1 pageSize Integer 页大小，建议参考请求参数pageSize，该参数后续会下线 10 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 14 表templateList 参数 参数类型 说明 示例 下级对象 templateID String 监控面板ID 0bf803e8504911ed8fb7005056897257 name String 监控面板名称 whGHk regionCtyunID String 监控面板所属资源池ID 81f7728662dd11ec810800155d307d5b fuserLastUpdated String 上次更新时间 20221020T07:30:19Z list Array of Objects 监控视图具体内容 list 表list 参数 参数类型 说明 示例 下级对象 title String 监控视图名称 testViewName content Array of Objects 监控项具体内容，为keyvalue格式 content viewID String 监控视图ID 4cb790ae489411edb386005056897257 表content 参数 参数类型 说明 示例 下级对象 {itemName} String 监控项名称 dim {value} Object 监控项值，与监控项名称组成keyvalue格式，可以为任意内容 turntest8

本页介绍天翼云TeleDB数据库元数据pgprofilecostweight的内容。 存储pgprofile中资源限制的权重配置。 名称 类型 定义 cpuweight int32 CPU 使用的权重 connectweight int32 连接使用的权重 blksweight int32 数据块读取的权重 sgaweight int32 共享缓冲区使用的权重

功能集 功能 功能描述 应用生命周期管理 创建/部署/更新/查看/启动/停止/删除应用 创建/部署/更新/查看/启动/停止/删除应用。 高级设置 设置启动命令 CAE 会根据预设的启动参数来启动容器 高级设置 设置环境变量 应用在系统中运行更需要配置特定的环境变量 高级设置 设置 Hosts 绑定 CAE 支持应用级别的实例，通过绑定 Hosts 对主机名进行解析，方便应用实例通过主机名进行访问 高级设置 设置持久化日志 CAE 集成了云日志服务的日志收集功能，支持将业务文件日志（容器内日志文件）、容器标准输出日志（stdio）无限制行数地收集至 ALS，便于您聚合分析。 高级设置 设置 NAS 存储 将 NAS 挂载至 CAE 应用实例，可以有效解决应用数据地持久化存储需求，并实现应用实例之间地数据共享 高级设置 设置 OSS 存储 OSS 适用于读多写少地场景，例如挂载配置文件或者前端静态文件等 高级设置 设置应用生命周期管理 如果您精通 K8s，且需要在应用容器启动前或者关闭前执行相关操作，例如运行前部署资源或者停止前优雅下线应用，可以设置应用生命周期管理 高级设置 设置配置项 配置项能够将环境配置信息和容器镜像解耦，方便您修改应用配置 配置管理 配置项（ConfigMap） 配置项是一种存储应用所需配置信息地资源类型，它可以作为容器运行环境中的环境变量，便于应用部署后灵活变更容器配置，也可以通过挂载配置文件的方式向容器中注入配置信息 配置管理 保密字典（Secret） 保密字典是一种用于存储和管理密钥、证书等敏感信息的资源类型。为避免敏感数据暴露到镜像或应用与任务部署参数中，推荐您使用 CAE 命名空间级别的保密字典 弹性管理 手动扩缩 在应用的实例负载过高时以手动方式添加新应用实例，在应用闲置时减少应用实例，能够高效利用应用资源、降低成本 弹性管理 自动扩缩 在分布式应用管理中，弹性伸缩能够感知应用内各个实例的状态，并根据实例状态自动增加或减少实例数量，即扩容或缩容 版本管理 版本回退 应用修改配置并部署后，会自动生成一个基于时间点的应用版本，您可以查看对应时间点应用版本的配置，也可以操作版本回退到指定时间点的应用版本 应用访问 基于 ELB 实现应用公网及私网访问 在 CAE 中部署应用后，可以通过添加公网 ELB 实现公网访问应用，也可以添加私网 ELB 实现同 VPC 内私网访问应用 注册中心 CAE 内置注册中心 CAE 为用户提供免费的内置 Nacos 注册中心，在无需购买或自建注册中心的情况下即可部署微服务应用到 CAE 平台 注册中心 自建 Nacos 注册中心 CAE 支持使用自建 Nacos 注册中心实现服务的注册与发现功能 微服务治理 无损上线 在应用启动过程中，无损上线为应用提供服务延迟注册、服务就绪检查和服务小流量预热的保护能力 微服务治理 无损下线 在应用执行部署、停止、回滚、缩容和重置时，通过无损下线来保证应用正常关闭 微服务治理 金丝雀灰度 对于部署在 CAE 的 Spring Cloud 或 Dubbo 微服务应用，为了确保升级操作的安全性，您可以通过启用灰度发布（即金丝雀发布）的灰度规则进行小规模验证，验证通过后再全量升级 微服务治理 限流降级 CAE 支持使用微服务引擎 MSE 实现应用的限流降级，全面保障应用的可用性 运维管理 基础监控 CAE 对应用所运行设备的 CPU、负载、内存、网络和磁盘进行数据采集与分析，并以动态图的方式展示，方便实时、直观地了解应用所运行设备地状态 运维管理 应用监控 CAE 为多种语言和框架提供无侵入的应用监控能力 运维管理 一键启停 CAE 为应用提供了一键启停按钮，方便用户进行运维操作，同时还支持批量启停操作

级别 最小磁盘 容错能力 可用容量 适用场景 RAID0 2 无 100% 临时数据/高速缓存 RAID1 2 单磁盘故障 50% 系统盘/关键服务 RAID5 3 单磁盘故障 (N1)/N 文件服务器 RAID6 4 双磁盘故障 (N2)/N 大容量存储 RAID10 4 镜像组内故障 50% 高负载数据库

创建DWS连接 1.单击CDM集群后的“作业管理”，进入作业管理界面，再选择“连接管理 > 新建连接”，进入选择连接器类型的界面。 2.连接器类型选择“数据仓库服务（DWS）”后单击“下一步”配置DWS连接参数，必填参数如下表“DWS连接参数”所示，可选参数保持默认即可。 参数名 说明 取值样例 名称 输入便于记忆和区分的连接名称。 dwslink 数据库服务器 DWS数据库的IP地址或域名。 192.168.0.3 端口 DWS数据库的端口。 8000 数据库名称 DWS数据库的名称。 dbdemo 用户名 拥有DWS数据库的读、写和删除权限的用户。 dbadmin 密码 用户的密码。 使用Agent 是否选择通过Agent从源端提取数据。 是 Agent 单击“选择”，选择连接Agent中已创建的Agent。 导入模式 COPY模式：将源数据经过DWS管理节点后拷贝到数据节点。如果需要通过Internet访问DWS，只能使用COPY模式。 COPY 3.单击“保存”完成创建连接。 创建迁移作业 1.选择“表/文件迁移 > 新建作业”，开始创建从Oracle导出数据到DWS的任务。 详见下图：创建Oracle到DWS的迁移任务 作业名称：用户自定义便于记忆、区分的任务名称。 源端作业配置 −源连接名称：选择创建Oracle连接中的“oraclelink”。 −模式或表空间：待迁移数据的数据库名称。 −表名：待迁移数据的表名。 −高级属性里的可选参数一般情况下保持默认既可，详细说明请参见配置常见关系数据库源端参数。 目的端作业配置 −目的连接名称：选择上述 创建DWS连接中的连接“dwslink”。 −模式或表空间：选择待写入数据的DWS数据库。 −自动创表：只有当源端和目的端都为关系数据库时，才有该参数。 −表名：待写入数据的表名，可以手动输入一个不存在表名，CDM会在DWS中自动创建该表。 −存储模式：可以根据具体应用场景，建表的时候选择行存储还是列存储表。一般情况下，如果表的字段比较多（大宽表），查询中涉及到的列不多的情况下，适合列存储。如果表的字段个数比较少，查询大部分字段，那么选择行存储比较好。 −扩大字符字段长度：当目的端和源端数据编码格式不一样时，自动建表的字符字段长度可能不够用，配置此选项后CDM自动建表时会将字符字段扩大3倍。 −导入前清空数据：任务启动前，是否清除目的表中数据，用户可根据实际需要选择。 2.单击“下一步”进入字段映射界面，CDM会自动匹配源和目的字段，如下图“表到表的字段映射”所示。 如果字段映射顺序不匹配，可通过拖拽字段调整。 单击，可批量映射字段。 CDM的表达式已经预置常用字符串、日期、数值等类型的字段内容转换。 3.单击“下一步”配置任务参数，一般情况下全部保持默认即可。 该步骤用户可以配置如下可选功能： 作业失败重试：如果作业执行失败，可选择是否自动重试，这里保持默认值“不重试”。 作业分组：选择作业所属的分组，默认分组为“DEFAULT”。在CDM“作业管理”界面，支持作业分组显示、按组批量启动作业、按分组导出作业等操作。 是否定时执行：如果需要配置作业定时自动执行，请参见 配置定时任务。这里保持默认值“否”。 抽取并发数：设置同时执行的抽取任务数。可适当调大参数，提升迁移效率。 是否写入脏数据：表到表的迁移容易出现脏数据，建议配置脏数据归档。 作业运行完是否删除：这里保持默认值“不删除”。 4.单击“保存并运行”，回到作业管理界面，在作业管理界面可查看作业执行进度和结果。 5.作业执行成功后，单击作业操作列的“历史记录”，可查看该作业的历史执行记录、读取和写入的统计数据。 在历史记录界面单击“日志”，可查看作业的日志信息。 说明 如遇目的端写太久导致迁移超时，请减少Oracle连接器中“一次请求行数”参数值的设置。

本文以“通过SSH远程安装Agent”为例介绍如何安装Agent，更多安装Agent的方法请参Agent管理。 通过SSH远程安装Agent 您可以通过SSH协议将Agent自动安装到需要审计的服务器上，目前仅支持Linux系统。 在界面上输入需要审计的服务器IP、SSH端口、root用户名、密码，天翼云数据库审计通过scp协议将agent安装包传输到宿主机上并自动安装。 1. 在菜单栏选择“系统管理 > Agent管理”进入“Agent管理”页面，选择“Agent安装”页签。 2. 单击“开始安装”进入通过SSH远程安装Agent页面，编辑审计服务器IP，并添加安装Agent的服务器，单击“安装”。 填写参数说明请参见下表： 参数 参数说明 审计服务器IP 默认为当前的审计服务器IP，用户可以根据需要修改。 安装Agent的服务器 输入需要安装Agent的服务器IP及该服务器root账户的密码，默认端口为22，用户可以根据实际情况修改。 支持表单格式和文本格式输入。 支持IPv4和IPv6。 最多填写20个。 说明 单击“安装状态”可进入“安装状态”查看页面，可进行以下操作： 单击“卸载”可远程卸载已经成功安装了的Agent。 单击“重新安装”可对未成功安装Agent的服务器重新安装。 将光标悬停至“安装失败”后的图标，查看安装失败原因。 若您的业务部署在一类节点的资源池上，审计服务器IP需改为数据库审计所在的VPC组的公网IP。（一类节点可参考[支持的区域](/document/10446453/10489850

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id machineId body Long 是 机器资源唯一标识 storePath body String 是 存储位置 retain body Integer 是 备份保留份数，0表示全部清除，最大保留份数为7，即取值范围07 autoBackup body Integer 是 自动备份开关，0表示关闭，1表示打开 weekdays body List 是 自动备份的日期列表 autoBackupTime body String 是 自动备份时间

HBase数据库管理 进入到翼MR Manager以后，点击菜单“租户与资源 > HBase数据库管理”，进入HBase数据库管理页面。如图所示： 支持HBase命名空间的新建、删除。 支持表的新建、禁用、存储配额设置、列簇设置、分区设置、表用户设置。 支持从快照恢复数据。

实例容灾 云数据库ClickHouse双副本实例支持集群高可用，当租户选择主备的实例类型时，如果单节点发生故障，此时可以将业务路由到其他节点，从而实现高可用。 数据删除 租户删除云数据库ClickHouse实例时，存储在数据库实例中的数据都会被删除，任何人都无法查看及恢复数据。

接口介绍 此接口用于获取Bucket上的CORS 配置信息。 接口约束 无 请求URI GET /v1/cors/{bucket} 路径参数 参数 是否必填 参数类型 说明 示例 bucket 是 String 桶名称 testBucket Query参数 参数 是否必填 参数类型 说明 示例 下级对象 cors 是 String 固定参数 注：如果query中的参数为固定参数，不需要带值value。 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 CORSConfiguration 是 Array of Objects 最多100 个CORSRules 元素的容器 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

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据对象 returnObj 表 returnObj

目前只支持升配询价:增加带宽和连接数。 接口功能介绍 VPN网关升配询价，目前只支持升配询价:增加带宽和连接数。 接口约束 有已经下单成功VPN网关。 URI POST /v4/vpn/gateway/querypriceupgrade 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID, 例:100054c0416811e9a6690242ac110002 bandwidth 是 Integer 带宽，单位为Mbps connectionLimit 是 Integer VPN网关连接数限制 resourceID 是 String VPN网关资源ID linkResourceID 是 String VPN连接资源ID 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 否 Integer 返回状态码(800为成功，900为失败) message 否 String 失败时的错误描述，一般为英文描述 description 否 String 失败时的错误描述，一般为中文描述 returnObj 否 Object 返回对象 returnObj errorCode 否 String 业务细分码，为product.module.code三段式码 表 returnObj 参数 是否必填 参数类型 说明 示例 下级对象 totalPrice 否 Float 所有订单总共价格 finalPrice 否 Float 所有订单最终价格 isSucceed 否 Boolean 是否成功 subOrderPrices 否 Array of Objects 子订单价格列表 orderPrice 表 orderPrice 参数 是否必填 参数类型 说明 示例 下级对象 serviceTag 否 String 产品标签 totalPrice 否 Float 订单总共价格 finalPrice 否 Float 订单最终价格 orderItemPrices 否 Array of Objects 订单资源价格列表 orderItemPrice cycleType 否 Integer 订单周期 表 orderItemPrice 参数 是否必填 参数类型 说明 示例 下级对象 itemId 否 String 订单资源ID resourceType 否 String 本参数表示订单资源类型。 取值范围： VPNGETWAY VPNLINK totalPrice 否 Float 订单资源总共价格 finalPrice 否 Float 订单资源最终价格

VPN用户服务查看。 接口功能介绍 vpn用户服务查看 接口约束 支持集群模式资源池。 URI GET /v4/vpn/ipsecuserservice/list 路径参数 无 Query参数 无 请求参数 请求header参数 无 请求body参数 get请求包含body参数,报文头指定application/json,且body结构对象需要转json。 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID b342b77ef26b11ecb0ac0242ac110002 queryContent 否 String Query Content模糊查询 ipsec111 projectID 否 String project ID 0 ipsecServiceName 否 String IPSCE 服务名称 ipsec111 ipsecServiceID 否 String vpn用户服务ID 35d5fa99c0404bb0806a8be317cc4d89 pageSize 否 Integer 每页行数 1 pageNo 否 Integer 页码 1 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 否 Integer 返回状态码 取值范围: 800：成功 900：失败 800 errorCode 否 String 业务细分码，为product.module.code三段式码 message 否 String 失败时的错误描述，一般为英文描述 description 否 String 失败时的错误描述，一般为中文描述 returnObj 否 Object 返回对象 returnObj 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 totalCount 否 Integer 查询的总记录数 3 currentCount 否 Integer 当前页记录数 2 totalPage 否 Integer 总页数 2 logMark 否 String 链路追踪ID 74cb2e661f9545daaac5ee013470fd96 results 否 Array of Objects 列表 results 表results 参数 是否必填 参数类型 说明 示例 下级对象 ipsecServiceName 否 String IPSCE SERVICE名称 ipsec111 ipsecServiceID 否 String vpn用户服务ID 35d5fa99c0404bb0806a8be317cc4d89 ipAddress 否 String IPAddress 111.0.0.1 createTime 否 String create time 20230621 01:39:01 vpnConnectionID 否 String vpn connection ID 908dhfa99c0404bb0806a8be317cc4d89