参数 是否必填 参数类型 说明 示例 下级对象 templateId 是 Long 拼接模板ID 100000000004

指标名称 指标含义 取值范围 健康状态 该指标用于统计测量监控对象的状态 green（健康）、yellow（可用）、red（异常） 磁盘使用率 该指标用于统计测量对象的磁盘使用率 0100% JVM 内存使用率 实例各个节点平均/最大JVM使用率 0100% CPU 使用率 实例各个节点平均/最大CPU使用率 0100% 实例写入QPS 当前实例的每秒写入速率 ≥ 0 实例查询QPS 当前实例的每秒查询速率 ≥ 0 实例索引数量 当前实例的索引数量 ≥ 0 实例分片数量 当前实例的分片数量 ≥ 0 实例文档数量 当前实例的文档数量 ≥ 0 写入延迟 完成单次索引写入的平均/最大时间 ≥ 0 ms 查询延迟 完成单次搜索操作所需的平均/最大时间 ≥ 0 ms 1分钟负载 实例1分钟所有节点的平均/最大负载 ≥ 0

接口功能介绍 吊销已签发的证书 接口约束 1.已有证书管理服务资源，且已完成证书申请 URI POST /v1/certificate/revoke 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 id 是 String 证书 id 5b9fead7e9ff4f1589ffff22cd3c4bf3 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 200 message String 提示信息 Success returnObj Object 返回数据结构体 CsrDetail error String 错误码,仅错误时返回 CCMS100000063 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "id": "5b9fead7e9ff4f1589ffff22cd3c4bf3" } 响应示例 { "statusCode": 200, "message": "Success" } 状态码 请参考 状态码 错误码 请参考 错误码

参数 参数说明 取值样例 资源类型 配置告警规则监控的服务名称。 NAT网关 维度 用于指定告警规则对应指标的维度名称 公网NAT网关 监控范围 告警规则适用的资源范围，可选择资源分组或指定资源。 说明 当选择资源分组时，该分组下任何资源满足告警策略时，都会触发告警通知。 选择指定资源时，勾选具体的监控对象，单击 将监控对象同步到右侧对话框。 指定资源 选择类型 根据需要可选择从模板导入或自定义创建。 自定义创建 模板 选择需要导入的模板。您可以选择系统预置的默认告警模板，或者选择自定义模板。 告警策略 触发告警规则的告警策略。 告警级别 根据告警的严重程度不同等级，可选择紧急、重要、次要、提示。 重要

接口功能介绍 调用此接口可查询站点监控任务。 接口约束 资源池ID不能为空。 URI GET /v4/monitor/querysitemonitor 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID siteID String 否 64ea16644347558e9bc6651341c2fa15 站点监控任务ID protocol String 否 http 探测类型 可取值 http ping tcp udp name String 否 siteMonitor1修改 站点监控任务名称，支持中英文 search String 否 baidu 对站点地址（address）进行模糊搜索 pageNo Integer 否 1 页码，默认为1 page Integer 否 1 页码，默认为1，建议使用pageNo，该参数后续会下线 pageSize Integer 否 1 页大小，默认为10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 siteList Array of Objects 站点监控任务列表 site totalCount Integer 总记录数 2 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 2 page Integer 页码，建议参考请求参数pageNo，该参数后续会下线 1 pageSize Integer 页大小，建议参考请求参数pageSize，该参数后续会下线 10 表site 参数 参数类型 说明 示例 下级对象 regionID String 资源池ID 81f7728662dd11ec810800155d307d5b siteID String 站点监控任务ID 64ea16644347558e9bc6651341c2fa15 monitorID String 站点监控任务ID（底层） dkql20221109161309 name String 站点监控任务名称 siteMonitor1修改 protocol String 探测类型 http address String 站点地址 evalInterval Integer 探测间隔，单位：秒 60 probePoint Array of String 探测点 ["EastChina","NorthChina"] lastChange String 最近更新时间 20221109T08:13:09Z status Boolean 状态 true

本文介绍Redis排行榜功能 业务场景 在一个在线游戏中，我们需要实时统计玩家的得分，并展示排行榜，以便玩家之间进行竞争和比较。为了满足实时性和高并发的需求，我们决定使用 Redis 来实现一个排行榜。 业务要求 实时统计玩家的得分，并根据得分排序生成排行榜。 提供查询指定玩家排名的功能，以便玩家可以查看自己在排行榜中的位置。 需求分析 排行榜需要能够实时更新，并能够处理高并发的请求。 排行榜数据需要持久化，以防止数据丢失。 实现方案 使用分布式缓存Redis，可以实现一个商品热销排行榜的功能。它的优势在于：数据保存在内存中，性能非常好，读写速度非常快，而且提供字符串（String）、链表（List）、集合（Set）、哈希（Hash）等多种便利数据类型。 具体实现方案如下： 使用 Redis 的有序集合（Sorted Set）来存储玩家得分，并根据得分进行排序。 每个玩家的得分作为有序集合的分值，玩家ID作为有序集合的成员。 使用 Redis 提供的有序集合相关命令来实现排行榜的更新、查询和排名等功能。 使用 Redis 的持久化功能，如 AOF 或 RDB，来保证排行榜数据的持久性。 核心代码 以下是一个简化的示例代码，展示了如何使用 Redis 实现排行榜的关键部分： // 玩家得分增加 public void increasePlayerScore(String playerId, int score) { Jedis jedis new Jedis("localhost"); jedis.zincrby("playerscores", score, playerId); jedis.close(); } // 获取玩家排名 public long getPlayerRank(String playerId) { Jedis jedis new Jedis("localhost"); long rank jedis.zrevrank("playerscores", playerId); jedis.close(); return rank ! null ? rank + 1 : 1; // 返回排名（从1开始），若未找到则返回1 } // 获取排行榜前 N 名玩家 public List getTopPlayers(int count) { Jedis jedis new Jedis("localhost"); Set players jedis.zrevrange("playerscores", 0, count 1); jedis.close(); return new ArrayList<>(players); } 在上述示例代码中，我们使用 Redis 的有序集合来存储玩家的得分，使用 zincrby 命令来增加玩家的得分，使用 zrevrank 命令来获取

共享盘类型选择 安全需求优先 NAS 共享盘：如果您极其重视数据安全，且希望数据仅在天翼AI云电脑环境内流转，不暴露在公网环境中，NAS 共享盘是匹配高密级数据场景的选择。它只能通过AI云电脑挂载访问，这种特性极大地降低了数据在公网环境下可能面临的安全风险，为数据提供了更可靠的安全保障。例如，对于一些对数据保密性要求极高的企业，如金融、科研等行业，其核心数据的存储和共享使用 NAS 共享盘能有效防止数据泄露。 网络共享盘：虽然网络共享盘也具备一定的安全措施，但由于支持公网访问，相比之下，数据面临的安全风险会略高一些。不过，它的权限管控和访问审计功能非常强大，能通过细致的权限设置和全面的操作记录，对企业内部的数据访问进行严格管理和监控，从而在一定程度上保障数据安全。适用于对合规性管理要求较高的大型企业，即便数据在公网环境下有访问需求，也能通过严格的权限和审计机制降低风险。 功能需求侧重 NAS 共享盘：主要功能在于满足基本的文件共享存储需求。在企业内部，员工可以便捷地共享办公文档、项目资料等，提供一个集中的文件管理平台。如果您的企业或团队主要需求是简单高效地进行文件共享，对其他复杂功能需求较少，NAS 共享盘完全可以满足日常工作中的文件协作需求。 网络共享盘：除了文件共享功能外，更强调权限管控、访问审计以及与其他企业系统的集成功能。对于大型企业而言，不同部门和职位对数据的访问和操作权限有严格要求，网络共享盘能够设置细致的权限，满足这种精细化管理需求。同时，与 ERP、CRM 等系统的集成功能，能实现企业数据的无缝流通，提高整体信息化管理水平，促进业务流程的自动化和数据的统一管理，适合业务流程复杂、信息化程度高的大型企业。

功能类别 功能描述 模型适配前机器环境检查确认 硬件环境检查：服务器、存储、网络等硬件型号及环境检查。 软件环境检查（系统软件）：操作系统、HDK固件驱动、CANN版本、镜像等版本检查。 软件环境检查（模型训推软件）：训练推理框架、Python、运行库等版本检查。 NPU健康状态检查：NPU卡数、型号、显存容量及运行状态检查。 网络检查（功能）：网络连通性检查，设备防火墙检查。 网络检查（性能）：P2P、D2H、H2D、D2H带宽检查。 HCCL功能性能检查：单多机HCCL allreduce、allgather带宽检查。 Aicore、HBM压测：Aicore、HBM压测。 HPFS存储检查：HPFS存储空间，挂载路径检查。 镜像及容器检查：docker镜像及容器启动功能检查。 模型训练集群验证：验证集群环境下开源模型单多机训练功能性能，包括loss，TPS及MFU指标。 模型适配 适配模型GPU基准验证：待适配模型在GPU环境下的基准验证，收集loss曲线，计算MFU、TPS等模型指标，计算模型训练效果的算法性能指标（如准确率、召回率、PPL、Rouge等）。 模型NPU适配度验证评估：评估待适配模型是否有不支持算子，评估该模型训练框架、依赖库的软件版本范围和约束。 模型算子开发：待适配模型算子开发及算子优化。 模型预训练适配（预训练）。 模型微调训练适配（全量微调）。 模型微调训练适配（lora微调）。 模型在线推理适配：适配模型在线推理代码、模板开发及验证。 模型极致调优：从训练框架、数据前后处理，算子亲和性等方面提升模型的MFU、TPS、训练精度等关键指标。 训练平台侧功能支持：训练平台侧运行脚本、log日志功能支持。 模型适配交付物提供：提供模型适配的开发代码、镜像、模型及技术文档。 客户交付过程中故障排查以及技术支持 基础环境运行故障定位、问题排查及支撑解决。 训练框架运行故障定位、问题排查及支撑解决。 模型训练中断问题定位、排查及支撑解决。 模型训练精度问题及支撑解决。 模型训练效率问题及支撑解决。 模型在线推理问题及支撑解决。 训练数据处理问题及支撑解决。 平台侧训练问题及支撑解决。 模型训练性能极致调优服务支撑：模型训练效率如MFU、TPS等指标的深度分析及极致优化。 模型训练算法效果服务支撑。 模型运行版本、训练配置差异化验证服务支撑。

接口功能介绍 导入pkcs12格式证书 接口约束 请保证账户余额大于0 URI POST /manageCertificate/importCertifiicateByPKCS12 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 hmac 是 String kms鉴权值 B1uAGreROOnfuQkNp9I5bE4aXsGwBcL5daW3W0nL0Mw requestDate 是 String 时间戳 Wed, 29 Aug 2023 17:05:01 CST accessKey 是 String ctapi鉴权ak ae2cc5cc5e8211ea978a186590d96509 userId 是 String 用户id 562b89493b1a40e1b97ea05e50dd8170 regionId 是 Integer 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 passPhrase 是 String 导入证书密码 12345 pkcs12Blob 是 String pkcs12格式证书 MIIKCQIBAzCCCc8GCSqGSIb3DQEHAaCCCcAEggm8MIIJuDCCBG8GCSqGSIb3DQEHBqCCBGAwggRcAgEAMIIEVQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIA5ZZNcJVpBYCAggAgIIEKMpBWtpSNLTskOL8WTgv8Cs2DV7vDKD1 epId 否 String 企业项目id default

步骤二：设置通知策略 新建或编辑通知策略，选择通知对象 为通用Webhook，然后选择对应的Webhook集成。具体操作，请参见【通知策略】。

步骤二：设置通知策略 新建或编辑通知策略，选择通知对象 为通用Webhook，然后选择对应的Webhook集成。具体操作，请参见【通知策略】。

本文主要介绍弹性伸缩使用的使用限制。 功能限制 在应用系统中添加弹性伸缩后，使用时有以下功能限制： 弹性伸缩的云主机中运行的应用需要是无状态、可横向扩展的。 说明 无状态：关于应用的既往事务，没有任何记录和参考，每项事务处理均是从头开始。无状态应用运行的实例不会在本地存储需要持久化的数据。例如：可以将无状态事务看作一台自动售货机：一个请求对应一个响应。 有状态：是可以周而复始、反复发生的应用和流程，操作是在之前的事务背景下执行的，当前事务可能会受到之前事务的影响。有状态应用运行的实例会在本地存储需要持久化的数据。例如：可以将有状态事务看作网上银行或电子邮件，有上下文记录。 弹性伸缩会自动释放云主机，所以弹性伸缩组内的云主机不可以保存应用的状态信息（例如session）和相关数据（如数据库、日志等）。如果应用中需要云主机保存状态或日志信息，可以考虑把相关信息保存到独立的服务器中。 弹性伸缩无法纵向扩展，即弹性伸缩无法自动升降ECS实例的vCPU和内存等配置。 配额限制 弹性伸缩对用户的资源数量或容量做的配额限制如下表所示。 类别 描述 默认值 ::: 弹性伸缩组 用户可以创建的最多伸缩组个数。 10 弹性伸缩配置 用户可以创建的最多伸缩配置个数。 100 弹性伸缩策略 某个弹性伸缩组下可以创建的最多伸缩策略个数。 10 弹性伸缩实例 某个弹性伸缩组下可以创建的最多实例个数。 200

本节主要介绍LevelDB到GeminiDB Redis的迁移方案。 LevelDB是一个开源的持久化KV单机数据库引擎，具有很高的随机写，顺序读/写性能，适合应用在写多读少的场景。其内部没有设计成C/S网络结构，使用时必须和服务部署在同一台服务器，对于服务的部署、使用有较大的限制。相比于在LevelDB基础上开发的RocksDB, LevelDB存在较多缺点，如无法很好的使用多核服务器的计算性能，无法支撑TB级数据存储，不支持从HDFS读取数据等。 GeminiDB Redis采用RocksDB作为存储引擎，兼容Redis协议，具有丰富的数据类型，可以满足LevelDB的使用需求。同时GeminiDB Redis对RocksDB进行深度定制，实现秒级分裂弹性扩容，扩缩容无需搬迁数据，快速而平滑，为LevelDB业务转到Redis生态提供了便利。 迁移原理 使用自研迁移工具leveldbport，和LevelDB部署在相同机器上，准备好配置文件，启动迁移即可自动完成全量与增量的迁移。 全量迁移对LevelDB数据进行快照，然后扫描整个数据库，将数据打包成GeminiDB Redis识别的格式，发送到GeminiDB Redis ，具有很高的迁移效率。 增量迁移解析LevelDB的wal文件，将LevelDB的操作解析出来，然后对其中的key进行分片，多线程进行发送。 使用须知 迁移工具需要部署在源端，对性能有一定消耗，可通过修改配置文件进行一定的控制。 迁移过程读取LevelDB的源数据文件，只读操作，理论上不会有数据受损风险。 迁移过程不需要停服。 若迁移过程出现故障，需要清理GeminiDB Redis实例，重新启动迁移。

本页介绍了通过利用数据分片来提升性能。 在文档数据库服务中，通过数据分片（Sharding）可以显著提升性能和扩展数据库的处理能力。数据分片是将数据库水平拆分成多个片（Shard），将数据均匀地分布在这些片上，使每个片都只处理部分数据，从而分担负载和提高性能。以下是通过数据分片来提升性能的步骤和优势： 操作步骤 1. 准备Shard节点： 在数据分片前，需要准备多个Shard节点。Shard节点是MongoDB集群中存储数据片的实例。每个Shard节点可以是一个独立的MongoDB副本集，用于保证数据的高可用性。 2. 配置Config服务器： Config服务器存储了整个集群的分片信息和配置信息。需要至少三个Config服务器来提供冗余和可用性。 3. 启用Sharding： 在文档数据库的路由节点上（mongos进程），使用 sh.enableSharding()命令来启用Sharding。 4. 选择分片键： 在启用Sharding前，需要选择一个分片键（Shard Key）。分片键是用来划分数据的字段，数据会根据该字段的值进行分片和路由到对应的Shard上。合理选择分片键很重要，它会直接影响到数据的均衡分布和查询性能。单调递增分片键： 选择单调递增的分片键（如ObjectId或时间戳），可以保证数据在插入时分布在不同的分片上，减少数据迁移。 5. 创建分片集合： 使用 sh.shardCollection()命令来创建需要分片的集合，并指定分片键。 6. 插入数据： 开始插入数据到分片集合中。文档数据库会根据分片键的值，将数据分布到不同的Shard上。

本页介绍天翼云TeleDB数据库备份概念。 全量备份 ：通过在备份服务端调用pgBackRest命令，将PG实例的数据并行拷贝到备机指定的数据目录。 增量备份 ：通过在备份服务端调用pgBackRest命令，将PG实例的数据并行拷贝到备机指定的数据目录。与全量备份区别在于：全量备份用于备份所有文件，增量备份用于备份自动上一次备份后的全部改动和新文件。 备份压缩： 通过gzip工具实现全量备份以及wal日志的压缩。 手动备份： 提供手动创建备份和复制已有全量备份的功能。 恢复备份 ：通过在实例客户端调用pgBackRest命令。将匹配的基础备份数据发送目标PG实例，并通过配置恢复文件，重放wal日志到达一致性点，完成目标实例的恢复。 全量恢复 ：支持基于选定全量备份进行恢复。 基于时间点恢复 ：支持基于选定时间点进行恢复，前提是开启了增量日志备份。 注意 基于时间点恢复原理是先找到离时间点最近的全量备份为基础，再重新以基础备份的Checkpoint点为起点，顺序加载WAL日志直到达到指定时间点，所以如果想使用基于时间点恢复需要开启定时备份全量数据以及WAL日志文件。 恢复指定实例 ：支持恢复到指定实例，推荐恢复到全新的实例，避免造成wal日志覆盖。 自动备份维护 ：支持在线配置备份策略，自动删除过期的WAL备份文件。 本地集中存储 ：支持单个备份机本地存储多个PG实例的备份数据的功能。 wal日志归档 ：通过设置PG实例archivecommand命令，在发生日志切换时自动推送wal日志到备机指定的数据目录。

本页介绍天翼云TeleDB数据库备份相关概念。 全量备份 ：通过在备份服务端调用pgBackRest命令，将PG实例的数据并行拷贝到备机指定的数据目录。 增量备份 ：通过在备份服务端调用pgBackRest命令，将PG实例的数据并行拷贝到备机指定的数据目录。与全量备份区别在于：全量备份用于备份所有文件，增量备份用于备份自动上一次备份后的全部改动和新文件。 备份压缩： 通过gzip工具实现全量备份以及wal日志的压缩。 手动备份： 提供手动创建备份和复制已有全量备份的功能。 恢复备份 ：通过在实例客户端调用pgBackRest命令。将匹配的基础备份数据发送目标PG实例，并通过配置恢复文件，重放wal日志到达一致性点，完成目标实例的恢复。 全量恢复 ：支持基于选定全量备份进行恢复。 基于时间点恢复 ：支持基于选定时间点进行恢复，前提是开启了增量日志备份。 注意 基于时间点恢复原理是先找到离时间点最近的全量备份为基础，再重新以基础备份的Checkpoint点为起点，顺序加载WAL日志直到达到指定时间点，所以如果想使用基于时间点恢复需要开启定时备份全量数据以及WAL日志文件。 恢复指定实例 ：支持恢复到指定实例，推荐恢复到全新的实例，避免造成wal日志覆盖。 自动备份维护 ：支持在线配置备份策略，自动删除过期的WAL备份文件。 本地集中存储 ：支持单个备份机本地存储多个PG实例的备份数据的功能。 wal日志归档 ：通过设置PG实例archivecommand命令，在发生日志切换时自动推送wal日志到备机指定的数据目录。

本章节主要介绍集群扩容。 扩容集群 用户需要更多的计算资源或存储资源以满足业务需要时，可以在管理控制台对已有集群，通过增加节点进行扩容操作。 说明 如果当前集群是包年/包月计费模式，那么新增节点也是按照包年包月模式进行计费。 标准数仓集群扩容时使用与当前集群相同的存储规格。 如果子网IP数量不足，允许执行跨子网扩容操作。 如果您是因集群存储容量不足而扩容集群，建议您在扩容前先执行VACUUM清理和回收存储空间，DWS 数据仓库中保存的数据在删除后，可能没有释放占用的磁盘空间形成脏数据，导致磁盘浪费。如果执行VACUUM后，已使用存储容量仍然占用过高，您再进行扩容。VACUUM的语法请参见《数据仓库服务SQL语法参考》中的“VACUUM”章节。 扩容对系统的影响 扩容前，需退出创建了临时表的客户端连接，因为在扩容过程中及扩容成功之前创建的临时表将会失效，操作临时表也会失败。但是扩容后创建的临时表不受影响。 在执行“扩容”操作后，集群会进行一次自动快照，快照创建成功后进行集群扩容。 正在扩容的集群将禁用重启集群、扩容集群、创建快照、重置数据库管理员密码和删除集群的功能。 离线扩容过程中，集群会自动重启，因此集群会有一段时间变为“不可用”状态，重启成功后集群变回“可用”状态。然后在扩容结束阶段，系统会将集群中用户数据在全部节点重新动态分布。

接口功能介绍 查询策略地址组，访问控制采用黑、白名单方式实现，此接口为查询黑、白名单的地址组。 接口约束 无 URI GET /v4/elb/listaccesscontrol 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 区域ID 81f7728662dd11ec810800155d307d5b IDs 否 String 访问控制ID列表 ["xxxx"] name 否 String 访问控制名称,只能由数字，字母，组成不能以数字和开头，最大长度32 test 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 message String statusCode为900时的错误信息; statusCode为800时为success, 英文 success description String statusCode为900时的错误信息; statusCode为800时为成功, 中文 成功 errorCode String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS SUCCESS returnObj Array of Objects 返回结果 见下表 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 azName String 可用区名称 az1 projectID String 项目ID 0 ID String 访问控制ID xxx name String 访问控制名称 test description String 描述 desc sourceIps Array of Strings IP地址的集合或者CIDR [] createTime String 创建时间，为UTC格式 20221003T09: 44: 22Z

接口功能介绍 创建策略地址组，策略地址组为被访问控制的黑白名单调用的地址组。 接口约束 无 URI POST /v4/elb/createaccesscontrol 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 clientToken 是 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 区域ID 81f7728662dd11ec810800155d307d5b name 是 String 唯一。支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 32 test description 否 String 支持拉丁字母、中文、数字, 特殊字符：~!@ $%^&()+ <>?:,.,/;'[]·！@ ￥%……&（） ——+{} acl sourceIps 是 Array of Strings IP地址的集合或者CIDR [1.0.0.0 8] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 message String statusCode为900时的错误信息; statusCode为800时为success, 英文 success description String statusCode为900时的错误信息; statusCode为800时为成功, 中文 成功 errorCode String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS SUCCESS returnObj Object 返回结果 见下表 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ID String 访问控制ID xxxx

接口功能介绍 非对称密钥验签接口 接口约束 请保证账户余额大于0 URI POST /v1/asymmetric/asymmetricVerify 路径参数 无 Query参数 无 请求参数 请求头header参数 请参见请求消息头 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId 是 String 密钥版本id db4e73dedef547029dbb6387f05ae0d8 algorithm 是 String 验签算法，取值范围： RSAPSSSHA256 SM2 RSAPSSSHA256 digest 是 String 消息摘要，使用algorithm对应的哈希算法，对原始消息生成摘要 说明：需进行Base64编码 ZOyIygCyaOW6GjVnihtTFtIS9PNmskdyMlNKiuyjfzw value 是 String 待验证的签名值 说明：需进行Base64编码 ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwi 响应参数 参数 参数类型 说明 示例 下级对象 code String 返回码，取值范围： 200：成功 400：参数缺失或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 200 errorCode String 错误码 KMS.0514 msg String 调用结果信息 验签成功 data Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 value Boolean 验签结果 true

接口功能介绍 非对称密钥解密接口 接口约束 请保证账户余额大于0 URI POST /v1/asymmetric/asymmetricDecrypt 路径参数 无 Query参数 无 请求参数 请求头header参数 请参见请求消息头 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId 是 String 密钥版本id db4e73dedef547029dbb6387f05ae0d8 algorithm 是 String 解密算法，取值范围： RSAESOAEPSHA256 RSAESOAEPSHA1 RSAESPKCS1V15 SM2 RSAESOAEPSHA256 ciphertextBlob 是 String 待解密密文 说明：需进行Base64编码 ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwi 响应参数 参数 参数类型 说明 示例 下级对象 code String 返回码，取值范围： 200：成功 400：参数缺失或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 200 errorCode String 错误码 KMS.0514 msg String 调用结果信息 解密成功 data Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 plaintext String 解密后明文经过Base64编码后的值 itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba

步骤5：通过云主机创建镜像 通过云主机创建正常状态的私有镜像，请参考通过云主机创建Linux系统盘镜像。 清理环境（可选） 以上步骤中，未初始化的镜像文件以及创建的云主机会额外占用存储和计算资源空间，因此建议您在完成镜像注册后清理环境。 删除在步骤2：注册镜像中注册的未初始化镜像。 删除在步骤3：创建云主机中创建的云主机。 删除OBS个人桶中的镜像文件。

模块 说明 今日数据 展示实时上/下行带宽、今日上/下行流量、各状态设备数/设备总数信息。 今日用量统计 展示设备接入、上/下行带宽、上/下行流量、视频/视图存储和AI服务的今日用量统计。 AI分析路数 展示当前绑定了AI应用的分析路数，以算法类型为维度进行统计。 今日AI告警 实时告警展示最新的AI告警图片，告警统计展示今日AI告警次数的统计图。 资源包 展示用户已购买的资源包数量。

本页介绍天翼云TeleDB数据库的列设计规范。 1. 建议能用数值类型的，就不用字符类型。 2. 建议能用varchar(N) 就不用char(N)、text。 3. 建议使用default NULL，而不用default ''。 4. 如果有国际业务，建议使用timestamp with time zone而不是timestamp without time zone，避免时间函数在对于不同时区的时间点返回值不同。 5. 建议使用NUMERIC(precision, scale)来存储货币金额和其它要求精确计算的数值, 而不使用real,double precision。

本节介绍了文档数据库服务的数据库引擎和版本说明。 文档数据库服务目前支持4.4、4.2、4.0和3.4版本，需要使用兼容MongoDB 3.0以上版本的Driver来访问。您可以根据业务需求在创建实例时选择合适的引擎和版本。 表 DDS支持的引擎和版本 支持的版本 CPU类型 实例类型 存储引擎 4.4 x86 集群 副本集 RocksDB 4.2 x86 集群 副本集 RocksDB 4.0 x86 鲲鹏 集群 副本集 WiredTiger 3.4 x86 鲲鹏 集群 副本集 WiredTiger

参数 说明 <DBHOST> 数据库地址。 <DBPORT> 数据库端口号。 <DBUSER> 数据库用户名。 <AUTHDB> 存储<DBUSER> 信息的数据库，一般为admin。 < FILEPATH > 存放根证书的路径。 < DBNAME > 需要迁移的数据库名称。 < DBCOLLECTION > 需要迁移的数据库中的集合。

本小节介绍DDoS基础防护最佳实践。 DDoS基础防护产品最佳实践 为保障公网业务持续稳定运行，避免因 DDoS 攻击导致 IP 封堵、业务中断，建议您按照以下最佳实践流程，使用天翼云 DDoS 基础防护并做好安全防护规划。 1.业务平稳运行阶段 在业务上线初期，若未遭受 DDoS 攻击，或攻击流量规模低于 DDoS 基础防护阈值，IP 不会触发封堵机制，业务网络可正常对外提供服务。 2.攻击触发封堵场景 随着业务规模扩大、行业竞争加剧，若业务遭遇针对性 DDoS 攻击，且攻击流量峰值超出基础防护阈值、挤占资源池带宽并影响网络稳定时，系统将自动对该 IP 执行 DDoS 封堵，暂时阻断公网流量以保障平台整体稳定。 3.接收封堵通知 IP 被封堵后，您将通过账号联系人及安全消息配置联系人的短信、邮箱、站内信同步收到封堵通知，通知中包含受影响 IP、攻击流量峰值、封堵时长等关键信息，便于您快速掌握异常情况。 4.方案查阅 参考官方产品文档与常见问题说明，了解封堵原因及对应的防护解决方案。针对开放DDoS基础防护控制台的资源池EIP，您可登录天翼云控制台，进入 DDoS 基础防护页面，复核流量封堵情况。 5.部署高防防护与 IP 优化 根据官方防护建议，选购并配置天翼云 DDoS 高防 IP、DDoS 高防（边缘云版）或第三方合规 DDoS 高防产品；同时同步更换业务 IP，并限制仅高防 IP 可访问业务 IP，实现业务 IP 隐藏与专业 DDoS 清洗防护，从根源避免再次触发DDoS封堵，保障业务长期稳定运行。

CSRF防护的方式 验证码 CSRF攻击的过程，往往是在用户不知情的情况下构造了网络请求，验证码则强制用户必须与应用进行交互才能完成最终请求。但基于使用体验，网站不会给所有的操作都加上验证码。 验证HTTP Referrer字段 根据 HTTP 协议，HTTP 头部中Referrer字段记录了该 HTTP 请求的来源地址。 比如一个论坛发帖的操作，在正常境况下需要先访问有发帖功能的页面，在提交发帖的表单时，Referrer值必然是发帖表单所在的页面。如果Referrer的值不是这个页面，甚至不是发帖网站的域，则极有可能是CSRF攻击。 请求中添加token并验证 在请求中放入黑客所不能伪造的信息，并且该信息不存在于Cookie 之中。可以在HTTP 请求中以参数的形式加入一个随机产生的token，并在服务器端建立一个拦截器来验证这个token，如果请求中没有token 或者token 内容不正确，则认为可能是CSRF 攻击而拒绝该请求。 前提条件 已经订购边缘安全加速平台安全与加速服务，若未订购，请参见服务开通。 在控制台新增域名，请参见添加服务域名。 开通套餐为高级版及以上版本，支持CSRF防护功能。 操作步骤 1. 登录边缘安全加速平台控制台。 2. 在左侧导航栏中选择【安全能力】，进入【Web应用防火墙】菜单，并在左侧域名列表选择您要防护的域名。 3. 进入防护能力高级安全防护【CSRF防护】详细设置页。

批量版本管理主要包含批量创建应用实例和批量创建应用实例版本。此功能当前只适用于K8s应用实例。 概述 批量版本管理主要包含批量创建应用实例和批量创建应用实例版本。此功能当前只适用于K8s应用实例。 前提条件 目标环境已创建，若没有，请先创建环境。 批量创建应用实例 该功能支持基于基准应用实例的跨环境快速复制能力，用户可将经过验证的稳定版本（基线版本）作为模板，批量生成具有相同配置和版本内容的新应用实例至目标环境，适用于多环境部署、灾备实例创建等场景，有效保障环境间应用版本的一致性和部署效率。 注意 选择的目标环境下若存在目标实例，则必须要选择，且系统会对目标应用实例做覆盖操作。 批量创建应用实例版 本功能提供应用实例版本跨环境批量创建能力，支持在多集群/多区域场景中快速完成应用版本升级。系统通过复用已验证的基准版本全量配置（包含镜像版本、环境变量及附属资源），自动生成符合目标环境要求的应用实例版本，显著减少人工核对和配置迁移时间。 注意 批量创建应用实例版本功能只针对K8s镜像部署的应用实例。 通过查看详情可以对目标应用实例版本做修改。 注意 如果应用实例所在资源池跟当前资源池不相同，需先切换资源池信息。

本节主要介绍升级微服务引擎 创建微服务引擎时，使用的是当前最新的引擎版本。当后续再发布新版本的引擎时，用户可以选择升级引擎版本。 注意 1. 仅微服务引擎专享版支持升级引擎版本。升级后，不支持版本回退。 2. 仅支持版本内升级，不支持跨版本升级。 注意事项 升级过程中，高可用和非高可用对外表现不同： 高可用版本：支持两个实例滚动升级，服务不中断。但是可能存在两个接入地址中一个不可用的情况，从而导致该实例不可用，需要支持快速切换到另外一个可用实例。当前，ServiceComb SDK、Go Chassis和Mesher都支持快速切换实例。如果是调用服务注册中心、配置中心接口来进行注册发现的，需要实现实例快速切换。 非高可用版本：非高可用引擎只有一个服务实例，升级过程中服务会中断，导致不能进行服务注册、服务发现和配置变更。需要评估会不会对业务产生影响。ServiceComb SDK、Go Chassis和Mesher都做了可靠性增强，断服过程中，客户端会有缓存。如果查到了空实例，会继续使用本地缓存。如果是调用服务注册中心、配置中心接口来进行注册发现的，需要使用缓存降级。 操作步骤 1、进入微服务引擎页面，单击左侧菜单栏的“引擎列表”。 2、选择待升级的微服务引擎，单击 ，选择“升级”。 3、选择“升级后版本”，查看版本说明，根据需要决定是否升级。 4、单击“确定”，进行升级。 如果升级失败，可单击“重试”，再次进行升级。

本章主要介绍API控制策略常见问题。 API流量控制 是否支持对请求并发次数做自定义控制？ 不支持。流控策略只控制单位时间内调用次数，无请求并发次数控制。 每个子域名每天最多可以访问1000次，如果帐号为企业帐号，是否还有这个限制？ 每个子域名每天最多可以访问1000次的限制同样适用于企业帐号。 API调用是否存在带宽限制 专享版API网关存在带宽限制，在创建实例时可以选择公网入口以及出口带宽。 流量控制策略不生效怎么办？ 若流控策略的API流量限制或源IP流量限制不生效，检查API是否绑定流控策略。 若流控策略的用户流量限制不生效，检查API的安全认证方式是否为IAM认证。 若流控策略的应用流量限制不生效，检查API的安全认证方式是否为APP认证。 API访问控制 怎样给指定的用户开放API 可以采用以下两种方式： 注册API时可选取APP认证方式，APP key和APP Secret分享给指定的用户。 使用访问控制策略，按照IP地址或者帐号名，只允许符合允许策略的用户调用API。 配置了身份认证的API，如何在特殊场景下（如指定IP地址）允许不校验身份？ 认证方式不能基于某个特殊场景进行选择性认证。 方案1：创建API时选择无认证方式，然后利用“访问控制策略”功能进行IP白名单过滤，使得所有调用都不需要校验身份。 方案2：考虑拆分成2个API，其中一个使用身份认证（IAM认证或APP认证），另一个使用“无认证”并设置访问控制策略，以确保安全。

本文主要介绍查询类目详情内容。 接口描述 查询当前租户下的类目详情 请求方法 GET 接口要求 无 URI /openapi/v1/categorys/detail 请求参数 请求头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（非必须），请求时间，终端节点域名（非必须）以及请求体内容。 请求代码示例 plaintext Curl X GET " H "ContentType: application/json" H "ctyuneoprequestid:33dfa732b27b464fb15a21ed6845afd5" H "tenantId:XXX" H "EopAuthorization:XXX" H "eopdate:20211109T104641Z" H "host:kqaglobal.ctapi.ctyun.cn" 返回值说明 1.请求成功返回响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回状态，返回200表示成功 200 message String 返回Success Success returnObj Object 接口返回结果 returnObj表 returnObj表 参数 参数类型 说明 示例 下级对象 id Int 类目ID 299 name String 类目名称 默认类别 createTime String 创建时间 20230508T15:14:00Z updateTime String 更新时间 20230508T15:14:00Z 2.请求失败返回响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 错误码，放置API对应的错误码 40001 message String 失败信息 缺少鉴权信息 error String 返回对应的错误码 KQA40001 返回值示例 1.请求成功返回值示例 plaintext { "statusCode": "200", "error": null, "message": "Success", "returnObj": { "id": 124, "name": "通用文档库", "createTime": "20250916T17:09:34+08:00", "updateTime": "20250916T17:09:34+08:00" } } 2.请求失败返回值示例 plaintext { "statusCode": "40004", "error": "KQA40004", "message": "接口执行异常" } 状态码 http状态码 描述 200 表示请求成功 错误码说明 错误码 错误信息 错误描述 40007 类目不存在 用户不存在可用类目 40014 类目不唯一 用户类目不唯一，属于异常情况，联系技术支持