本文主要介绍并行文件服务 HPFS 的产品概述和产品架构。 并行文件服务（HPFS，High Performance File Storage）是由天翼云提供的高性能并行文件存储，支持全 NVMe 闪存、RDMA 技术，最高提供千万 IOPS 和 TBps 吞吐，同时保证亚毫秒级时延。具有高性能，高可靠性，高可扩展性的特点，充分满足影视渲染、气象分析、石油勘探、EDA 仿真、基因分析、AI 训练、自动驾驶等数据密集型场景的需求。

参数 类型 是否必填 说明 type string 是 提取器类型，正则提取为regexp mode string 否 名字冲突的结果取值策略，详情参考 pattern Regexp 是 正则表达式 field Field 是 需要提取信息的原字段名称。 输入数据中要包含该字段，类型为varchar，且其值为非null。否则，不执行提取操作。 output Field 否 用于存储提取结果的字段名称

本章节为您介绍如数据加密网关的相关内容。 数据加密网关是一种专门为保护数据库数据存储安全而设计的高性能密码设备。它基于数据加密技术，能够在数据进入数据库之前对其进行加密处理，从而确保数据的机密性和完整性。这款创新设备在当今数据安全需求日益增长的环境下，扮演着至关重要的角色。 注意 在正式接入生产环境前，强烈建议您使用测试环境配合数据加密网关进行充分调试验证，确保通过后再切换至生产环境。 若因未遵循此操作流程导致的系统故障或数据风险，相关责任需由接入方自行承担。 核心功能与优势 数据加密：数据库加密网关采用先进的加密算法，对数据进行实时加密。无论是静态数据还是传输中的数据，都能得到有效保护，防止未经授权的访问和数据泄露。 高性能处理：作为一款高性能密码网关设备，它具备出色的处理能力，能够在保证数据安全的同时，不降低数据库的读写性能。这使得它在处理大量数据时依然能够保持高效稳定。 密钥管理：内置完善的密钥管理系统，能够安全地生成、存储和管理加密密钥。密钥的严密管理是数据安全的重要保障，防止密钥泄露导致的数据风险。 透明加密：提供透明的加密服务，应用程序无需改动即可享受数据加密保护。数据库加密网关在后台自动完成加密和解密操作，简化了数据安全管理。 兼容性强：支持多种数据库系统和应用程序，无需对现有系统进行大规模改造即可部署。这使得它能够快速融入企业现有的IT架构，提供即时的数据安全防护。

DRDS支持通过隐式序列功能（创建表时添加AUTOINCREMENT关键字，启用隐式序列功能）为列设置自增属性，能够自动为列填充全局唯一值。 背景信息 什么是隐式序列 在传统的单库环境中，AUTOINCREMENT是用于生成主键自增值的常用机制，能够保证主键在单实例数据库中的唯一性。然而，在分布式数据库DRDS中，数据被分片存储在多个存储节点中，原有的自增机制将无法保证全局唯一性，因此DRDS引入了基于全局序列的隐式序列机制，用于替代传统的AUTOINCREMENT功能。 隐式序列与AUTOINCREMENT的关系 在DRDS中，虽然通过添加AUTOINCREMENT关键字实现自增，但实际不是调用数据库原生的自增逻辑，而是通过隐式的全局序列实现唯一值生成。 注意 隐式序列由系统自动维护，无需用户手动干预。 隐式序列的生命周期 隐式序列由系统在建表时自动创建，并在DROP表时自动删除。 注意 不推荐用户手动创建或删除隐式序列，可能会造成ID冲突或数据一致性问题。 HINT路由下的行为差异 当使用HINT路由 + INSERT语句时，DBProxy无法改写SQL，因此不会自动填充自增ID： 注意 不推荐在需要使用AUTOINCREMENT功能的表中使用HINT路由。 以/+TDDL:node('group1')/ INSERT INTO test(value) VALUES(1); 为例，该命令将直接透传到物理库。若该表中的自增列未显式给值，数据库可能会使用默认值（例如0），若该值不唯一，则会报错（例如Duplicate entry）。

全局索引是一组非分片键和分片键的映射关系，通过非分片键查询到分片键，直接计算出数据所在的分片节点，从而提升非分片键查询（select语句）时的效率，避免广播查询。本文对分布式关系数据库DRDS全局索引功能进行说明。 核心特性 全局索引的核心特性说明如下： 增量索引追加 解析binlog数据，提取非分片键和分片键的映射关系。 支持全量索引重建 通过JDBC从数据库中获取全量数据。 以单索引单分片为最小任务单元分配重建任务。 索引存储 索引数据以keyvalue方式存储在分布式缓存中。 索引配置 索引项相关的配置与DRDS实例共用，配置修改实时同步。 库表信息变更自动同步更新。 索引延时 正常情况下，索引与数据库延时在秒级以内。 注意事项 DRDS实例版本不同全局索引的管理入口可能存在差异，具体版本说明如下，请以控制台实际情况为准： V5.1.20.0.13及以后版本：Giserver与DBProxy合并部署，不再区分DBProxy和Giserver两种实例，即购买DRDS实例时，将自动为该实例部署Giserver与DBProxy，且两者之间底层服务与进程互相隔离、故障互相隔离，更具安全性和性价比。 说明 您可以在控制台的左侧导航栏选择DRDS > 实例管理 ，进入实例列表页面，再单击目标DRDS实例操作 列的管理 ，进入实例基本信息 页面，然后单击目录树的全局索引，管理您的GiServer。 V5.1.20.0.13以前的版本：存在DBProxy和Giserver两种实例，存量GiServer实例不影响使用。 说明 您可以在控制台的左侧导航栏选择DRDS > 全局索引，进入全局索引管理页面，管理您的GiSever实例。

本文主要介绍Helm v2 Release转换成Helm v3 Release。 背景介绍 当前CCE已全面支持Helm v3版本，用户可通过本指南将已创建的v2 release转换成v3 release，从而更好地使用v3的特性。因Helm v3底层相对于Helm v2来说，一些功能已被弃用或重构，因此转换会有一定风险，需转换前进行模拟转换。 该指南参考社区文档： 注意事项： Helm v2 release信息存储在configmap中，Helm v3 release信息存储在secrets中。 若用户通过前端console操作，在获取实例、更新实例等操作中CCE会自动尝试转换v2模板实例到v3模板实例。若用户仅在后台操作实例，需通过该指南进行转换操作。 转换流程（不使用Helm v3客户端） 步骤 1 在CCE节点上下载helm 2to3 转换插件。 wget 2to30.10.2linuxamd64.tar.gz 步骤 2 解压插件包。 tar xzvf helm2to30.10.2linuxamd64.tar.gz 步骤 3 模拟转换。 以testconvert实例为例，执行以下命令进行转换的模拟。若出现以下提示，说明模拟转换成功。 ./2to3 convert dryrun tilleroutcluster s configmaps testconvert NOTE: This is in dryrun mode, the following actions will not be executed. Run without dryrun to take the actions described below: Release "testconvert" will be converted from Helm v2 to Helm v3. [Helm 3] Release "testconvert" will be created. [Helm 3] ReleaseVersion "testconvert.v1" will be created. 步骤 4 执行正式转换。若出现以下提示，说明转换成功。

Linux块迁移，为什么实际迁移速率显示很低？ Linux块迁移时，实际迁移速率显示很低，远小于宽带的速率。 出现这种现象的原因，一般但不限于以下场景： 磁盘中数据占有率较低。 磁盘中存储了大量的稀疏文件。 Linux块迁移，在执行迁移的过程中会对数据进行压缩，当需要迁移的磁盘块本身存储数据较少，或者是空的磁盘块，会导致数据压缩率很高（如：100M压缩为5M），而迁移执行过程中传输的数据为压缩后的数据，所以在传输这些数据较小的磁盘块时，显示的传输速率很低。实际上，在这种场景下迁移还在正常快速的执行，网络连接、带宽等都是正常的。 迁移中源端有新增的数据如何处理？ 启动目的端后，若源端有新增的数据，单击此服务器所在行的操作列的“同步”，开始下一次复制（增量数据），当迁移状态为“持续同步”时，单击“启动目的端”，迁移实时状态为“已完成”时，说明新增数据已同步到目的端。 “迁移模块异常中止，无法同步”怎么处理？ 问题描述 持续同步过程中出现“SMS.1414 迁移模块异常中止，无法同步”。 问题原因 迁移模块异常终止可能是因为用户手动重启过Agent或者源端服务器被重启过。 源端有一个监控磁盘变化的进程，用于将源端变化的部分同步到目的端。重启之后该进程被终止，会导致无法正确的将源端服务器的变化同步到目的端。 解决方案 该场景下无法继续完成迁移任务，请删除该任务后，重新迁移。请注意迁移过程中不要重启源端服务器或Agent。

本文列举了多活容灾服务常用的术语及解释。 命名空间 命名空间是一个逻辑租户的概念，实现对MDR管控配置和数据的逻辑隔离，承载整个多活项目的资源集合，包括了流量入口，多活分区，数据同步，数据监控等内容。用户可以创建多个命名空间，用于逻辑隔离不同的资源。一般推荐按照企业的系统划分，比如OA系统，支付系统等可以各建一个命名空间。 容灾管理中心 容灾管理中心是一个独立的资源管理空间，以虚拟实例的形式独立运行，所有的操作都是在实例内进行，不同实例间的资源相互隔离。用户可以根据业务需要使用一个或若干个容灾管理中心。 容灾演练 为构建高效灾难应对机制，需定期开展基于预案演练体系的全真模拟演练。通过实战化场景复现关键业务系统的灾备恢复流程，重点验证应急响应时效性与数据保全能力，确保在突发灾难时实现业务连续性管理目标，最大限度降低运营中断风险和数据资产损失。 应急切换 当生产中心可用区内的云主机、数据库、存储等生产资源发生重大故障时，为快速恢复业务而进行的一系列的切换或恢复任务，涉及的任务来源于相应的预案流程。 同城主备 同城主备容灾是一种在同城或相近区域内（通常距离小于或等于200KM）建立的容灾策略。包括一个主数据中心，负责日常生产运行和实时数据存储，以及一个备用的数据中心，作为灾难备份中心。当主数据中心因各种原因（如火灾、建筑物破坏、供电故障、计算机系统及人为破坏等）发生故障时，备份数据中心能够快速接管业务，继续提供服务。

本章介绍如何新增备份目录。 场景说明 完成安装客户端后，云服务备份系统会自动识别已安装成功的客户端，并显示在“云服务备份 > 文件备份 > 文件备份”客户端列表中。需要手动将已安装客户端资源中需要备份的文件路径添加至云服务备份中。 约束与限制 单个备份资源最多支持添加8个文件目录。 单个目录下文件数不超过50万个，建议执行文件备份的主机配备4GB以上可用内存。 每个目录支持的数据量不超过500GB。 文件路径只能为绝对路径，如以/、C:、D:开头的文件路径。 操作步骤 1. 登录云服务备份控制台。 1. 登录管理控制台。 2. 单击管理控制台左上角的，选择区域。 3. 单击“”，选择“存储 > 云服务备份 > 文件备份”。 2. 单击目标服务器名称。进入服务器基本信息。 3. 单击“新增备份目录”。 4. 将需要备份的文件路径粘贴至“备份文件路径”中。单击“确定”。 5. 添加成功后，待备份的文件路径将会出现在下方。 移除目录 如果不再需要备份目录，或者已超出目录上限需要删除，可以进行移除目录操作。 1. 登录弹性云主机控制台。 1. 登录管理控制台。 2. 单击管理控制台左上角的，选择区域。 3. 选择“存储 > 云服务备份 > 文件备份”。 2. 单击目标服务器名称。进入服务器基本信息。 3. 单击目标目录的“移除目录”。移除目录后，将无法对该文件进行备份操作。已产生的备份将不会被删除，可用于恢复数据。未产生备份的目录路径将会被彻底移除，请谨慎操作。 4. 单击“确定”，完成目录移除。

本节介绍了本地盘的简介、创建本地盘、删除本地盘等。 简介 本地盘是虚拟机实例、容器实例或函数服务所在物理机上的本地硬盘设备。本地硬盘能够为实例提供本地存储访问能力，具有低时延、高随机IOPS、高吞吐量和高性价比的优势。 本地盘是将一个或多个硬盘的分区在逻辑上集合，相当于一个大硬盘来使用，当硬盘的空间不够使用的时候，可以继续将其它的硬盘的分区加入其中，这样可以实现磁盘空间的动态管理，相对于普通的磁盘分区有很大的灵活性。同样具备较高的IO性能，同时支持RAID方式提供更高系统可靠性。用户可以按需选择容量规格购买使用本地盘。本地盘目前提供SATA HDD、SATA SSD、NVMe SSD三种类型的介质。本地盘支持提供给虚拟机实例作为系统盘或数据盘，作为系统盘时，开放购买的规格支持为20GB～2048GB，作为数据盘时，开放购买的规格支持为10GB～6144GB。 注意 本地盘不支持快照，云硬盘支持快照，高可用方面也不如云盘。 由于本地盘是随着单台物理机，一旦物理机故障将有丢失数据风险，数据可靠性较低，因此，重要数据建议使用云硬盘。 创建本地硬盘 1. 登录ECX控制台。 2. 单击左侧导航栏【边缘存储>本地盘】进入本地盘列表，单击【购买本地盘】。 3. 【基础配置>计费模式】选择【包年包月】或者【按需计费】。 4. 选择【地域】跟【可用区】，本地盘需要与虚拟机在同一个可用区。 5. 点击【增加一块数据盘】，选择本地盘的类型、大小以及驱动，一次最多可以选择3块磁盘。 6. 本地盘只能选择立即挂载，点击下拉列表【请选择挂载虚机】，列表中显示当前集群运行中和已关机的虚机，点击【选择】需要挂载的虚机。 7. 单击【下单购买】完成支付，即创建成功。 注意 实际可购买的地域和可用区以库存展示为准

接口功能介绍 非对称密钥加密接口 接口约束 请保证账户余额大于0 URI POST /v1/asymmetric/asymmetricEncrypt 路径参数 无 Query参数 无 请求参数 请求头header参数 请参见请求消息头 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId 是 String 密钥版本id db4e73dedef547029dbb6387f05ae0d8 algorithm 是 String 加密算法，取值范围： RSAESOAEPSHA256 RSAESOAEPSHA1 RSAESPKCS1V15 SM2 RSAESOAEPSHA256 plaintext 是 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 ciphertextBlob String 密文数据，且经过Base64编码 itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba

接口功能介绍 查看指定id的密钥详情 接口约束 请保证账户余额大于0 URI POST /v1/keyManage/describeKey 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 获取密钥详情成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 deleteDate String 密钥删除时间 Tue Oct 25 15:06:52 CST 2022 rotationInterval String 轮转周期 7d nextRotationDate String 下次轮转时间 Tue Oct 25 15:06:52 CST 2022 creationDate String 密钥创建时间 Tue Oct 25 15:06:52 CST 2022 description String 密钥描述 密钥描述，长度小于8129 Tue Oct 25 15:06:52 CST 2022 cmkUuid String 密钥唯一标识 474e569e8814474a948bdbcf6d853eff status String 密钥状态 1 keyUsage String 密钥类型1加密解密 2签名验签 1 lastRotationDate String 上一次轮转时间 Tue Oct 25 15:06:52 CST 2022 creator String 密钥所属用户id 562b89493b1a40e1b97ea05e50dd8170 protectionLevel String 密钥保护级别 保护等级，0为硬件，1为软件 origin String 密钥来源 1KMS 2外部密钥 1 automaticRotation String 是否开启轮转取值0，1，2 1 materialExpireTime String 密钥材料过期时间 Tue Oct 25 15:06:52 CST 2022 keySpec String 密钥类型 AES256 isDefault Integer 是否为默认密钥 1 primaryKeyVersion String 密钥版本 f2ffbff9940a41a4ba9afe1fd8f22792 deleted String 密钥是否删除取值（0未删除，1已删除） 0 epId String 企业项目id 53e50630604f42eba9d4fd9e0d8458bf requestId String 请求id a2a7ca1d86d6436486bf51599de3b542

接口功能介绍 查看指定id的密钥详情 接口约束 请保证账户余额大于0 URI POST /v1/keyManage/describeKey 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 获取密钥详情成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 deleteDate String 密钥删除时间 Tue Oct 25 15:06:52 CST 2022 rotationInterval String 轮转周期 7d nextRotationDate String 下次轮转时间 Tue Oct 25 15:06:52 CST 2022 creationDate String 密钥创建时间 Tue Oct 25 15:06:52 CST 2022 description String 密钥描述 密钥描述，长度小于8129 Tue Oct 25 15:06:52 CST 2022 cmkUuid String 密钥唯一标识 474e569e8814474a948bdbcf6d853eff status String 密钥状态 1 keyUsage String 密钥类型1加密解密 2签名验签 1 lastRotationDate String 上一次轮转时间 Tue Oct 25 15:06:52 CST 2022 creator String 密钥所属用户id 562b89493b1a40e1b97ea05e50dd8170 protectionLevel String 密钥保护级别 保护等级，0为硬件，1为软件 origin String 密钥来源 1KMS 2外部密钥 1 automaticRotation String 是否开启轮转取值0，1，2 1 materialExpireTime String 密钥材料过期时间 Tue Oct 25 15:06:52 CST 2022 keySpec String 密钥类型 AES256 isDefault Integer 是否为默认密钥 1 primaryKeyVersion String 密钥版本 f2ffbff9940a41a4ba9afe1fd8f22792 deleted String 密钥是否删除取值（0未删除，1已删除） 0 epId String 企业项目id 53e50630604f42eba9d4fd9e0d8458bf requestId String 请求id a2a7ca1d86d6436486bf51599de3b542

接口功能介绍 本接口用于查询目录列表。 接口约束 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI GET /v2/dirs 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 ParentDirId 否 String 根据上级目录ID查询，不传该参数则按照根目录ID查询。 561297207819108352 DirName 否 String 根据目录名称查询。 openapidir SortBy 否 String 选择按一个字段排序，默认为CreatedTime，按照创建时间排序。取值：DirName：目录名称；CreatedTime：目录创建时间；UpdatedTime：目录更新时间。 CreatedTime SortDirection 否 String 排序方式，默认升序。取值：Asc(升序)，Desc(降序)。 Asc PageNum 否 Integer 第几个分页，默认为1。 1 PageSize 否 Integer 分页大小，默认为20。取值范围为1～1000。 20 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 Dirs Array of Objects 目录列表。 Dir PageNum Integer 第几个分页。 1 PageSize Integer 分页大小。 10 TotalPage Integer 分页总数。 1 TotalNum Integer 目录总数。 10 RequestId String 请求ID。 ba41650f6da84a20bc386c87285cebe6 表 Dir 参数 参数类型 说明 示例 下级对象 ParentDirId String 上级目录ID。 1 DirId String 目录ID。 693323900457467904 DirName String 目录名称。 openapidir DirType String 目录类别。取值：common(普通)，virual(虚拟)。 common DirCode Integer 目录编码。 0087 Description String 目录描述。 描述 TotalSize Integer 设备总数。 1 OnlineSize Integer 在线设备数。 1 OrderSequence Integer 序列号。 1680514055943 CreatedTime String 目录创建时间。 1679641940225 UpdatedTime String 目录更新时间。 1680513927459

本文介绍如何根据需求自定义设置告警规则。 操作场景 您可以在云监控产品控制台为VPN连接产品设置告警规则，当资源的监控指标达到告警条件，云监控将向您发送告警消息，报告异常监控数据，帮助您及时掌握异常状态并处理，保障业务顺畅运行。 前提条件 您在该区域下有正常状态的VPN资源；如果资源状态异常，可能会没有监控数据，无法触发告警。 操作步骤 1. 登录控制中心。 2. 选择“管理与部署”下的“云监控”产品。 3. 选择“告警服务 ”下的“告警规则”，进入告警规则页面。 4. 在告警规则页面，单击右上角的“创建告警规则”按钮，进入创建告警规则页面。 5. 在“选择监控对象”部分，规则类型选择“指标监控”，云服务选择“VPN”，维度可选“VPN网关、IPsec连接、SSL客户端、SSL网关”，监控对象类型选择“具体实例”，监控对象可以从弹出对话框列表中按需选择。如果您是通过点击具体监控指标操作列中的“创建告警规则”按钮跳转到创建告警规则页面的，则此部分内容会自动填充为关联监控对象，无法调整。 6. 在“选择监控指标”部分，选择类型为“自定义创建”，针对于不同的监控指标，可以配置不同的监控策略，如监控入方向流量速率的最大值、监控出方向数据包速率的最小值、监控SSL客户端连接数的原始值等，配置策略、聚合周期和出现次数之后，即可产生告警，在“告警服务”下的“告警记录”中可以查看告警记录。如果开启发送通知还需要配置告警联系组等选项，用于将告警以邮件或短信方式通知告警联系人。 7. 在“规则信息”部分，需要填入告警规则名称，选择企业项目，可选填写描述信息。 8. 最后，点击“确定”完成告警规则的创建。

接口功能介绍 本接口用于查询单个回调模板的信息。 接口约束 查询模板前确保存在该回调模板。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI GET /v2/callbackTemplate/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 TemplateId 是 String 模板ID。 739943519892963328 Query参数 无 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 TemplateId String 模板ID。 739943519892963328 TemplateName String 模板名称。 test Description String 模板描述。 描述 CallbackKey String 回调Key。 xxx DeviceStatusNotifyUrl String 设备状态回调URL。 < StreamStatusNotifyUrl String 流状态回调URL。 < RecordNotifyUrl String 录制回调URL。 < AiEventNotifyUrl String AI回调URL。 < CreateTime String 创建时间。 1691992586 UpdateTime String 修改时间。 1691992586 RequestId String 请求ID。 362d4e78556b47129182d0881fade86b

接口描述：调用本接口查询IP可用状态 请求方式：get 请求路径：/ip/queryipstatus 使用说明： 单个用户一分钟限制调用10000次，并发不超过100 请求参数说明： 参数 是否必填 参数类型 说明 示例 下级对象 vips 是 string vip列表，最多支持10个ip查询，多IP使用逗号分隔。若超过限制，则只返回最前面的10个。 1.1.1.1 返回参数说明： 参数 是否必填 参数类型 说明 示例 下级对象 code 是 int 状态码 成功100000 message 是 string 信息描述 成功返回success，其他返回异常信息描述 result 否 list 节点IP地址状态列表 resultsingle 表resultsingle 参数 是否必填 参数类型 说明 示例 下级对象 ip 否 string 节点ip地址 1.1.1.1 status 否 string ip状态，normal（正常），abnormal（非正常），noctyun（非天翼云ip） normal 示例： 请求路径： 示例1： 请求： 返回结果： json { "result": [ { "ip": "1.1.1.1", "status": "noctyun" }, { "ip": "2.2.2.2", "status": "noctyun" } ], "code": 100000, "message": "success" } 错误码请参考：参数code和message含义

费用计算 包年包月的资源实例，升级需要支付截至到期时间的差价，订单升级标准费用 （新规格按天单价 原规格按天单价）x（原规格订单总天数 已使用天数），按天单价 包月价格 x 12 / 365，具体价格以支付界面展示为准。 按需计费的实例，升级后，将按新的产品规格使用时长计费。 计费方式变更 ECX支持有限制的边缘虚拟机、边缘存储资源实例进行计费方式转换，包括包年包月转为按需计费、按需计费转为包年包月，请联系客户经理咨询。 以下场景不支持计费方式转换： 试用资源、冻结中或无效的资源不支持转换。 公网IP、共享带宽、裸金属带宽等包含带宽的实例，不支持计费方式转换。 与公网IP、共享带宽、裸金属带宽同一订单购买的边缘虚拟机、边缘存储，不支持计费方式转换。 边缘裸金属不支持计费方式转换。

响应参数 参数 参数类型 说明 示例 下级对象 code String 返回码，取值范围： 200：成功 400：参数缺失或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 200 errorCode String 错误码 KMS.0514 msg String 调用结果信息 生成并导出数据密钥成功 data Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 exportedDataKey String 导出的数据密钥密文 AK0Fq+zuxUitFTmOpyJkJb8VsjR7t8RLFGMSLxsiuK6s6/8dyQmlI5lxCxBFDfuRT9bpLqLAlKNm7DM+NzYNNwshq1GsX7+ujaTfHIt5a4QOW5mLdnPEpdpbUfOHzXlV3pvToDC24wPJjw7KcIQMqchfOzuixXWtreEVf8LK4J1hMiVp1VuiDO2HR1dUjk+RZVsQKlZy0xf55qN4uffknp1c7bwv5Fd1mPIVzBjvjdz9h+8gTG2VVygN1uHo0tCCljQRKFGLo67y/E8Dn8qyWANWKhPl0dkjNrOtRvwm1kNK7cunPIECkpYm1lHnBPO3QPkzIC7t5dQJzu3T0iMAAg cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 ciphertextBlob String 数据密钥密文 itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba

接口功能介绍 删除证书 接口约束 无 URI POST /v4/elb/deletecertificate 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 clientToken 是 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 资源池ID ID 否 String 证书ID, 该字段后续废弃 certificateID 否 String 证书ID, 推荐使用该字段, 当同时使用 ID 和 certificateID 时，优先使用 certificateID 响应参数 参数 参数类型 说明 示例 下级对象 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 error String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS 表 returnObj 参数 参数类型 说明 示例 下级对象 ID String 证书ID cert4xvz5g2y5h

接口功能介绍 停止监听器 接口约束 无 URI POST /v4/elb/stoplistener 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 clientToken 否 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 区域ID ID 否 String 监听器ID, 该字段后续废弃 listenerID 是 String 监听器ID, 推荐使用该字段, 当同时使用 ID 和 listenerID 时，优先使用 listenerID 响应参数 参数 参数类型 说明 示例 下级对象 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 error String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS 表 returnObj 参数 参数类型 说明 示例 下级对象 ID String 监听器 ID xxxx

接口功能介绍 更新系统账号 接口约束 无 URI POST /v2/updateSystemAccount 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String 类型 application/json regionId 是 String 资源池编码（资源池ID，您可以查看容器镜像服务资源池获取） bb9fdb42056f11eda1610242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 systemAccountId 是 String 系统账号ID cf9f5ca532e4e8195cbaa6ba94cfa4f2 description 否 String 描述信息，最大255个字符 更新后的描述信息 expirable 否 Boolean 是否设置过期时间 true expirationTime 否 String 过期时间，格式：yyyyMMdd HH:mm:ss 20251231 23:59:59 scope 否 String 权限范围。可选值：all（全部命名空间）、namespace（指定命名空间） all auth 否 String 权限类型。当scope为all时必填，可选值：push（推送权限）、pull（拉取权限） push auths 否 Array of Objects 权限列表。当scope为namespace时必填 auths enabled 否 Boolean 是否启用 true 表 auths 参数 是否必填 参数类型 说明 示例 下级对象 namespaceId 是 String 命名空间ID f5b49578426e6da458fb9aba36d8cfdb auth 是 String 权限类型。可选值：push（推送权限）、pull（拉取权限） push

接口功能介绍 非对称密钥签名接口 接口约束 请保证账户余额大于0 URI POST /v1/asymmetric/asymmetricSign 路径参数 无 Query参数 无 请求参数 请求头header参数 请参见请求消息头 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId 是 String 密钥版本id db4e73dedef547029dbb6387f05ae0d8 algorithm 是 String 签名算法，取值范围： RSAPSSSHA256 SM2 RSAPSSSHA256 digest 是 String 消息摘要，使用algorithm中对应的哈希算法，对原始消息生成摘要 说明：需进行Base64编码 mkmscsninfnenfck 响应参数 参数 参数类型 说明 示例 下级对象 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 String 签名值，且经过Base64编码 itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba

接口功能介绍 导出证书私钥 接口约束 请保证账户余额大于0 URI POST /v1/manageCertificate/exportCertifiicatePrivatkey 路径参数 无 Query参数 无 请求参数 请求头header参数 请参见请求消息头 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff passPhrase 是 String 导出证书密码 12345 exportFormat 是 String 证书算法类型:PKCS12 PKCS12 响应参数 参数 参数类型 说明 示例 下级对象 code String 返回码，取值范围： 200：成功 400：参数缺失或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 200 errorCode String 错误码 KMS.0514 msg String 调用结果信息 导出证书成功 data Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 certificateId String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff pkcs12Blob String 证书导出格式私钥 f2ffbff9940a41a4ba9afe1fd8f22792 privateKey String 证书私钥 itIb4kN84JKrbv8P5ZTZJyn3cbu0SLvblB5/csedLEchgF5ijFx9nEc5Y0DpzWba certificate String 证书 BEGIN CERTIFICATE (X.509 Certificate PEM Content) END CERTIFICATE certificateChain String 证书链 BEGIN CERTIFICATE (Sub CA Certificate PEM Content) END CERTIFICATE BEGIN CERTIFICATE (Sub CA Certificate PEM Content) END CERTIFICATE BEGIN CERTIFICATE (Root CA Certificate PEM Content) END CERTIFICATE

本节介绍混合集群如何打通云上云下网络。 混合集群概述 本地自建 Kubernetes 集群通过分布式容器云平台注册集群接入，可以为自建Kubernetes集群扩容云上 ECS 节点，同时管理云上、云下计算资源，形成混合集群。 搭建混合集群的网络关键在于打通云上云下网络连通，包括： 1. 云上VPC网络与云下网络互通，即计算节点之间互连互通； 2. 云上容器网络与云下容器网络互通，即容器Pod之间互连互通； 混合集群网络模式 节点网络互通 具体操作步骤如下： 1. 将云下网络通过内网接入天翼云，请参考天翼云提供的专线方案 云上云下网络专线接通方案。 2. 测试云上云下连通性，验证云下节点与云上节点是否互通。 3. 如需要云下网络需要通过内网访问云产品，云下网络需配置云产品的域名解析（.ctyun.cn域名解析转发到云上DNS VPCE IP），云产品包括：CRS镜像仓库、对象存储、日志、监控等。 容器网络互通 在确保云上云下节点网络互通之后，才可配置云下节点上运行的容器网络和云上节点运行的容器网络互通。 场景一：云下Kubernetes集群容器网络模式为Underlay模式，Pod IP集群外可访问 平面网络模式，一般用于集群规模较大(或规划较大)且对网络性能要求较高的场景。常见的开源Underlay模式组件包括： Flannel HostGW模式 Calico 路由反射模式 Cilium BCP路由模式 若云下Kubernetes的容器网络模式是Underlay模式，那么云上节点需要使用Cubecni网络插件。在此模式下，需要满足以下条件： 在混合集群中，用户需要确保满足以下条件： 云下网络插件只运行在云下计算节点。 云上的Cubecni网络插件只运行在云上计算节点，不会被调度到云下计算节点。 1. 配置网络插件 a.分布式容器云平台三方集群节点扩容的云上ECS节点会自动添加节点标签k8s.node.ctyun.cn/cloudtrue，默认云上Cubecni网络插件会根据云上节点标签自动调度到云上ECS节点。 b.请根据节点标签为云下网络插件设置NodeAffinity，或设置相关污点来确保云下网络插件只运行在云下。例如，针对云下Calico网络插件，使用nodeAffinity设置其不会被调度到标签为k8s.node.ctyun.cn/cloudtrue的节点上。其它运行于云下且不被希望调度到云上的网络插件也可以用这种方式设置： shell cat calicods.patch spec: template: spec: affinity: nodeAffinity: requiredDuringSchedulingIgnoredDuringExecution: nodeSelectorTerms: matchExpressions: key: k8s.node.ctyun.cn/cloud operator: NotIn values: "true" EOF kubectl n kubesystem patch ds caliconode p "$(cat calicods.patch)" 2. 安装Cubecni插件 a.登录分布式容器云平台控制台，在左侧导航栏选择集群资源 > 集群管理。 b.在集群列表页面，单击目标集群，进入集群页面，在左侧导航栏选择插件 > 插件市场。 c.在插件市场页面，搜索cubecni插件或者cubecnistandalone插件，单击右下方安装。 d.在左侧导航栏选择 工作负载 > 守护进程，查看kubesystem命名空间下cubecni组件的守护进程，在三方集群扩容云上节点前，cubecni不会被调度到任何一个云下节点上。

源端类型 说明 参数配置 OBS 支持以CSV、JSON或二进制格式抽取数据，其中二进制方式不解析文件内容，性能快，适合文件迁移。 参见 MRS HDFs FusionInsight HDFS Apache HDFS 支持以CSV、Parquet或二进制格式抽取HDFS数据，支持多种压缩格式。 参见 MRS HBase FusionInsight HBase Apache HBase CloudTable 支持从MRS、FusionInsight HD、开源Apache Hadoop的HBase，或CloudTable服务导出数据，用户需要知道HBase表的所有列族和字段名。 参见 MRS Hive FusionInsight Hive Apache Hive 支持从Hive导出数据，使用JDBC接口抽取数据。 Hive作为数据源，CDM自动使用Hive数据分片文件进行数据分区。 参见 DLI 支持从DLI导出数据。 参见 FTP SFTP 支持以CSV、JSON或二进制格式抽取FTP/SFTP的数据。 参见 HTTP 用于读取一个公网HTTP/HTTPS URL的文件，包括第三方对象存储的公共读取场景和网盘场景。 当前只支持从HTTP URL导出数据，不支持导入。 参见 数据仓库DWS 云数据库MySQL 云数据库SQL Server 云数据库PostgreSQL 支持从云端的数据库服务导出数据。 从这些数据源导出数据时，CDM使用JDBC接口抽取数据，源端作业参数相同，详细请 参见 FusionInsight LibrA 支持从FusionInsight LibrA导出数据。 从这些数据源导出数据时，CDM使用JDBC接口抽取数据，源端作业参数相同，详细请 参见 MySQL PostgreSQL Oracle Microsoft SQL Server SAP HANA MYCAT 分库 这些非云服务的数据库，既可以是用户在本地数据中心自建的数据库，也可以是用户在ECS上部署的，还可以是第三方云上的数据库服务。 从这些数据源导出数据时，CDM使用JDBC接口抽取数据，源端作业参数相同，详细请 参见 MongoDB 文档数据库服务（DDS） 支持从MongoDB或DDS导出数据。 参见 Redis 支持从开源Redis导出数据。 参见 Apache Kafka DMS Kafka MRS Kafka 仅支持导出数据到云搜索服务。 参见 。 云搜索服务 Elasticsearch 支持从云搜索服务或Elasticsearch导出数据。 参见

参数 描述 名称 设置层的名称，支持自定义。 描述 设置层的描述信息，便于区分各层。 兼容运行时 选择与该层兼容的运行时环境。 层上传方式 层依赖的上传方式提供以下四种标准化方案： · 通过 ZIP 包上传层 选择或直接上传已构建的层的ZIP文件。上传的ZIP文件默认不能超过 500 MB。 · 通过文件夹上传层 选择或直接上传包含待构建层的依赖文件的文件夹。上传的文件夹压缩为zip包后，大小默认不能超过500MB。 · 通过ZOS上传层 若已构建的层的zip包已经上传到您的对象存储系统（ZOS），可以选择上传待构建层zip包所在的ZOS Bucket名称 及 文件名称 。选择的ZOS中的文件默认不能超过500MB。 · 在线构建依赖层 若您的函数应用是基于 Python 或 Node.js 语言开发的或者您需要安装部分轻量级系统依赖库，可以选择在线构建依赖层，并在下方输入框内，输入构建层的依赖文件 requirements.txt 或 package.json 的内容。提交创建层后，系统将会自动安装这些语言级别的依赖包和系统库，简化层依赖的管理过程。 构建环境 当您选择在线构建依赖层时，需要设置此参数选择构建依赖层所使用的运行环境。 需要注意的是，目前仅Python和Node.js运行时支持在线构建依赖层。

响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 PageInfo 表 PageInfo 参数 参数类型 说明 示例 下级对象 endRow Long 当前页面最后一个元素在数据库中的行号 hasNextPage Boolean 是否有下一页 hasPreviousPage Boolean 是否有前一页 isFirstPage Boolean 是否为首页 isLastPage Boolean 是否为末页 list Array of Objects 资产列表 ListEntity navigateFirstPage Integer 导航条上的第一页 1 navigateLastPage Integer 导航条上的最后一页 1 navigatePages Integer 导航页码数 1 navigatepageNums Array of Integers 所有导航页号 1 nextPage Integer 下一页 1 pageNum Integer 当前页的页码 1 pageSize Integer 每页的数量 1 pages Integer 总页数 1 prePage Integer 前一页 1 size Integer 当前页的数量 1 startRow Long 当前页面第一个元素在数据库中的行号 total Long 总记录数 表 ListEntity 参数 参数类型 说明 示例 下级对象 attachedId String 绑定设备ID aab10b211ec040108b16d76993b49d9b attachedName String 绑定设备名称 asconfigb17cqes8 attachedPrivateIp String 绑定设备ip 172.31.0.150 attachedType String 绑定设备类型 VM云主机 BM物理机 VIP虚拟ip LB是负载均衡，BM;LB;NAT;VIP;VM; VM bindStatus String 绑定状态，bind;unbind; bind eip String eip 182.43.62.56 eipId String eipId eipp0weypef75 eipName String eip名称 eip1cc7 eipNum String eip数字形式表现 firewallEdition String 防火墙版本号 firewallId String 防火墙ID ipType String IP类型，ipv4;ipv6; ipv4 protectStatus Boolean 防护状态 regionId String 资源池ID a6449feab4db11e9a6b40242ac110007 subnetCidr String 子网cidr subnetId String 子网id subnetName String 子网名称 tip String 提示 normal正常 tipOpenFirewall提示开通防火墙 tipConfig提示更改配置 uid String 租户ID 6ee4c9fa71c3403eab8af44e29c3e4c1 userId String 用户id 6ee4c9fa71c3403eab8af44e29c3e4c1 vpcId String vpc id vpccc91 vpcIp String vpc ip 192.168.0.0/16 vpcName String vpc名称 vpccc91 endpoint Object 终端节点 GwlbeInfoVo 表 GwlbeInfoVo 参数 参数类型 说明 示例 下级对象 endpointName String 终端节点名称 endpointId String 终端节点id vpcName String Vpc名称 subnetName String 子网名称 description String 描述

接口描述 主动停止对话，用于快速中断与模型侧的链接。 请求方法 POST 接口要求 无 URI /openapi/v1/context/stop 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 tenantId 是 String 租户ID abcb82293b1a40e1b97ea05e50dd8170 ctyuneoprequestid 是 String 用户请求 id，由用户构造，用户可以通过 uuid 等方法自行生成唯一字符串，用于日志请求追踪。 abcfa732b27b464fb15a21ed6845afd5 eopdate 是 String 请求时间，由用户构造，形如 yyyymmddTHHMMSSZ。 20211221T163014Z host 是 String 终端节点域名，固定字段 koaglobal.ctapi.ctyun.cn EopAuthorization 是 String 由天翼云官网 accessKey 和 securityKey 经签名后生成，参与签名生成的字段包括天翼云官网 accessKey 、securityKey、用户请求id（非必须），请求时间，终端节点域名（非必须）以及请求体内容。 请求Body参数 参数 是否必填 参数类型 说明 示例 下级对象 contextId 是 String 对话ID b682065ba12345c79c4e35aec01e5398 请求代码示例 plaintext Curl X GET " " H "ctyuneoprequestid:33dfa732b27b464fb15a21ed6845afd5" H "tenantId:XXX" H "EopAuthorization:XXX" H "eopdate:20211109T104641Z" H "host:kqaglobal.ctapi.ctyun.cn" dataraw '{ "contextId": "b682065ba12345c79c4e35aec01e5398" }' 返回值说明 1.请求成功返回响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 200表示成功 200 message String 固定为Success Success returnObj Boolean 是否执行成功 true 2.请求失败返回响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 错误码，放置API对应的错误码 40001 message String 失败信息 缺少鉴权信息 error String 返回对应的错误码 KQA40001 返回值示例 1.请求成功返回值示例 plaintext { "statusCode": 200, "error": null, "message": "Success", "returnObj": true } 2.请求失败返回值示例 plaintext { "statusCode": "40004", "error": "KQA40004", "message": "接口执行异常" } 状态码 http状态码 描述 200 表示请求成功 错误码说明 见6.1.3通用错误码

接口功能介绍 更新监听器 接口约束 无 URI POST /v4/elb/updatelistener 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 clientToken 否 String 客户端存根，用于保证订单幂等性, 长度 1 64 79fa97e3c48bxxxx9f466a13d8163678 regionID 是 String 区域ID 81f7728662dd11ec810800155d307d5b ID 否 String 监听器ID, 该字段后续废弃 xxx listenerID 是 String 监听器ID, 推荐使用该字段, 当同时使用 ID 和 listenerID 时，优先使用 listenerID xxx name 否 String 唯一。支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 32 test description 否 String 支持拉丁字母、中文、数字, 特殊字符：~!@ $%^&()+ <>?:{},./;'[]·！@ ￥%……&（） —— +{} 《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 128 desc certificateID 否 String 证书ID certxxx caEnabled 否 Boolean 是否开启双向认证。false（不开启）、true（开启） true clientCertificateID 否 String 双向认证的证书ID，如果caEnabled为true,此项必填 xxx defaultAction 否 Object 默认规则动作 defaultAction accessControlID 否 String 访问控制ID,如果accessControlType有值，此项必填 xxx accessControlType 否 String 访问控制类型。Close（未启用）、White（白名单）、Black（黑名单） Close forwardedForEnabled 否 Boolean x forward for功能。false（未开启）、true（开） true 表 defaultAction 参数 是否必填 参数类型 说明 示例 下级对象 type 是 String 默认规则动作类型。取值范围： forward、redirect、deny(目前暂不支持配置为deny) forward forwardConfig 否 Object 转发配置，当type为forward时，此字段必填 forwardConfig redirectListenerID 否 String 重定向监听器ID，当type为redirect时，此字段必填 xxx 表 forwardConfig 参数 是否必填 参数类型 说明 示例 下级对象 targetGroups 否 Array of Objects 后端服务组 targetGroup 表 targetGroup 参数 是否必填 参数类型 说明 示例 下级对象 targetGroupID 是 String 后端服务组ID tgxxx weight 否 Integer 权重，取值范围：1256。默认为100 100

接口功能介绍 调用此接口可查询站点监控任务。 接口约束 资源池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

本文介绍知识库问答内容。 接口描述 依据知识库与大模型进行对话问答 请求方法 POST 接口要求 无 URI /openapi/v1/rag/talk 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String json格式 application/json Accept 否 String 设置开启接收ServerSent Events (SSE) 格式的流式响应 text/eventstream 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参数 参数 是否必填 参数类型 说明 示例 下级对象 text 是 String 问题的文本内容 infobaseIds 否 Array[String] 通用知识库ID列表 customBaseIds 否 Array[String] 自定义知识库ID列表 modelId 是 String 模型ID contextId 否 String 上一轮会话的ID，需要多轮对话时使用 searchEnable 否 Boolean 是否开启联网搜索 index 否 Boolean 是否输出文档索引引用标签 prompt 否 String 用户自定义输入的prompt thinkSchema 否 String 思考模式，枚举范围：{"THINK":思考,"NOTHINK"：不思考，快速问答}，默认开启思考 "THINK" 请求代码示例 plaintext Curl X POST " H "ContentType: application/json" H "Accept: text/eventstream" H "ctyuneoprequestid:33dfa732b27b464fb15a21ed6845afd5" H "tenantId:XXX" H "EopAuthorization:XXX" H "eopdate:20211109T104641Z" H "host:kqaglobal.ctapi.ctyun.cn" data '{ "text": "总结下文档内容", "infobaseIds": [123456789, 987654321], "modelId": "d5f09a41d4584715a5d94a4892411c0f", "searchEnable": false, "index": true, "prompt": "请依据文档内容进行回答，不得使用超出文档内容的知识；n 确保您的回答既精确又实用且忠实于原文，同时覆盖所有相关的要点，以满足用户的查询需求；n 要求语句通顺，条理清晰，易于阅读；n 请不要随意发散，尽量以原文档内容输出；n 对于包含多个子问题的问题，请回答每一个子问题，不要遗漏问题； n下面是文档信息：n{chunks}n问题为：{question}n开始回答：n" }' 返回值说明 1.请求成功返回响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回状态，返回200表示成功 200 message String 返回Success Success returnObj Object 接口返回结果 returnObj表 returnObj表 参数 参数类型 说明 示例 下级对象 code Int 0表示成功 0 message String 返回success success result Object 对话结果 result表 result表 参数 参数类型 说明 示例 下级对象 input String 对话输入文本 介绍下定积分 output String 对话输出文本 定积分是一种.... contextId String 此轮对话的ID finishState String 会话状态 状态取值：start（开始）/continued（生成中）/stop（正常结束）/interrupt（中断） stop inferSource Array[Object] 拼入模型prompt的参考文档信息。请求体参数index为false时生效 inferSource对象 indexInfo Array[Object] 模型回复的参考引用片段。请求体参数index为true时生效 indexInfo对象 indexInfo表 参数 参数类型 说明 示例 下级对象 indexId int 引用下标 1 subTitle String 子标题 docTitlec String 文档标题 文档.doc docTitle String 来源 Knowledge content String 引用片段内容 fileName String 引用文档名称 文档.doc fileId String 引用文档id 133 inferSource表 参数 参数类型 说明 示例 下级对象 fileName String 检索到的参考文档名称 文档.doc fileId String 检索到的参考文档id 133 fileType String 文档类型 doc contentText String 参考文档的内容 score Float 参考文档和用户输入的相关性分数，取值[01] 0.33 2.请求失败返回响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 错误码，放置API对应的错误码 40001 message String 失败信息 缺少鉴权信息 error String 返回对应的错误码 KQA40001 返回值示例 该接口为SSE接口，返回值为流式返回，返回时ContentType为text/eventstream。 1.请求成功返回值示例（关闭引用开关indexfalse） plaintext data:{ 'statusCode': 200, "error": null, "message": "Success", "returnObj": { "code": 0, "message": "success", "result": { "input": "水泥的国标", "output": " n好的，我现在需要处理用户的问题：“水泥的国标”。首先。。。", "finishState": "stop", "contextId": "2f963a77e58b467ead9223ddf2e4015b", "inferSource": [ { "fileName": "筑府办函xx号附件.wps", "fileId": 32432, "fileType": "doc", "contentText": "xxx", "score": 0.37754068 } ], "indexInfo": [] }, "details": null } } 2.请求成功返回值示例（开启引用开关indextrue） plaintext data:{ "statusCode": 200, "error": null, "message": "Success", "returnObj": { "code": 0, "message": "success", "result": { "input": "水泥的国标", "output": "根据提供的文档内容，水泥的参考标准为GB 16780[[1]]。。。", "finishState": "stop", "contextId": "bcca2bb95b454d41b9b878a24659b3d5", "inferSource": [], "indexInfo": [ { "indexId": 1, "subTitle": "", "docTitle": "筑府办函xx号附件.wps", "from": "Knowledge", "content": "xxx", "fileName": "筑府办函xx号附件.wps", "fileId": 32432 } ] }, "details": null } } 3.请求失败返回值示例 plaintext data:{ "statusCode": "40004", "error": "KQA40004", "message": "接口执行异常" } 状态码 http状态码 描述 200 表示请求成功 错误码说明 错误码 错误信息 错误描述 40013 对话出现异常 无法进行正常交互