华为云用户手册

新旧版本差异 自2021年12月30日起，API网关控制台界面更新，新旧版本差异点如下表所示。您也可以在控制台的“总览”页面，单击“新界面指南”查看。 API网关控制台旧版专享版界面于2024年01月30日下线，详情请参考服务公告。 新版仅提供专享版，共享版已下线，建议用户使用新版（专享版）。存量用户进入共享版，在“总览”页面单击“进入共享版控制台”即可。 表1 新旧版差异 差异点 旧版 新版 体验demo 有 无 API的安全配置支持双重认证 无 有 HTTP&HTTPS后端服务类型支持定义重试次数 无 有 导入API 导入API 创建API分组时，支持导入Swagger文件；API列表页支持导入API API调试可自定义body体 无 有 API详情页布局 API详情页信息集成度一般 API运行页信息集成度高 API详情页：单击流程图切换信息 有 无 可视化查看API已绑定的所有策略 无 有 策略创建和编辑可切换脚本模式 无 有 插件类型 跨域资源共享、HTTP响应头管理、流量控制 跨域资源共享、HTTP响应头管理、流量控制2.0、Kafka日志推送、断路器，与传统策略（流量控制、访问控制、签名密钥）合并于策略管理 SSL证书管理 无 有 负载通道支持创建服务器分组 无（负载通道即VPC通道） 有 负载通道提供健康检查开关 无（负载通道即VPC通道） 有 负载通道展示备用节点和启停状态 无（负载通道即VPC通道） 有 应用管理 应用管理 更名凭据管理 凭据配额策略 无 有 访问控制策略 无 有 监控管理 监控管理 更名API监控 子域名 子域名 更名调试域名 变量管理 变量管理 更名环境变量 左侧导航栏上方支持快速切换实例下拉框 无 有 铂金版扩容规格 无 有 带宽监控 无 有 导入云容器引擎CCE工作负载 无 有 导入CSE微服务 无 有 实例标签 无 有 微服务类型负载通道 无 有 访问控制支持账号ID类型 无 有 克隆API 无 有 custom_log 无 有 第三方认证策略 无 有 gzip压缩 无 有 GRPC协议 无 有

前提条件 给用户组授权之前，请您了解用户组可以添加的表1，并结合实际需求进行选择。如果您需要对除API网关服务之外的其它服务授权，IAM支持服务的所有策略请参见服务列表“其他”中的“系统权限”。 表1 API网关的系统角色或策略 系统角色/策略名称 描述 类别 依赖关系 APIG Administrator API网关服务的管理员权限。拥有该权限的用户可以使用专享版和共享版API网关服务的所有功能。 系统角色 无。 APIG FullAccess API网关服务所有权限。拥有该权限的用户可以使用专享版API网关服务的所有功能。 系统策略 无。 APIG ReadOnlyAccess API网关服务的只读访问权限。拥有该权限的用户只能查看专享版API网关服务的各类信息。 系统策略 无。

操作步骤 登录新版ROMA Connect控制台。 在“工作台”页单击“智能助手”，弹出“智能助手”窗口。 在输入框输入想创建的组合应用描述内容，或者单击输入框下面的行为描述语句。 单击带下划线的连接器或处理器，可以在下拉框中替换所需的其它连接器或处理器。 单击键盘的“Enter”键生成组合应用，再单击“应用结果”，生成组合应用。 继续在编辑组合应用画布页面，进行流任务的配置和编排。 可以进行交互式输入，进行组件配置。 完成后单击右上角的“保存”。 单击左上角组合应用名称旁的编辑按钮，在编辑组合应用弹窗中填写组合应用的名称和描述，然后单击“确定”，完成组合应用的创建。

配置参数 表1 机器人发送链接消息 参数 说明 群聊ID 从钉钉的创建企业内部群或创建场景群接口获取。对于已存在的群，可以用钉钉的根据corpid选择会话JSAPI获取。 消息标题 消息通知标题。 消息内容 消息内容。 图片链接 消息预览图链接。 跳转链接 消息单击后跳转链接。 表2 机器人发送Markdown消息 参数 说明 群聊ID 从钉钉的创建企业内部群或创建场景群接口获取。对于已存在的群，可以用钉钉的根据corpid选择会话JSAPI获取。 消息标题 消息通知标题。 消息内容 消息内容。 表3 机器人发送图片消息 参数 说明 群聊ID 从钉钉的创建企业内部群或创建场景群接口获取。对于已存在的群，可以用钉钉的根据corpid选择会话JSAPI获取。 图片链接 消息预览图链接。 表4 机器人发送文件消息 参数 说明 群聊ID 从钉钉的创建企业内部群或创建场景群接口获取。对于已存在的群，可以用钉钉的根据corpid选择会话JSAPI获取。 媒体文件ID 通过上传媒体文件接口，获取media_id参数值。 文件名称 发送的文件名称。 文件类型 支持xlsx、pdf、zip、rar、doc、docx文件。 表5 机器人发送ActionCard消息 参数 说明 群聊ID 从钉钉的创建企业内部群或创建场景群接口获取。对于已存在的群，可以用钉钉的根据corpid选择会话JSAPI获取。 消息标题 消息通知标题。 消息内容 消息内容。 跳转按钮文本 跳转按钮显示内容。 跳转链接 消息单击后跳转链接。 表6 机器人发送文本消息 参数 说明 群聊ID 从钉钉的创建企业内部群或创建场景群接口获取。对于已存在的群，可以用钉钉的根据corpid选择会话JSAPI获取。 消息内容 消息内容。

前置条件和约束 使用工作流在线调试功能，您需要具备ROMA Connect实例作为调试运行环境。您可购买独立的ROMA Connect实例，也可以使用共享体验版实例。 工作流在线调试功能可能会对运行在所选实例上的其它工作流产生影响，推荐您使用独立的实例进行调试。 使用工作流在线调试功能，调试环境如果选择共享体验版实例，您可同时调试的最大工作流数量为1条；如果选择购买独立的ROMA Connect实例，可同时调试的最大工作流数量为5条。 使用工作流在线调试功能，工作流的触发器节点不会真实运行，如Open API节点不会发布为API，您需要手动配置触发器节点进行触发。 使用工作流在线调试功能，在单个节点的最大停留时间为60s，超时后会自动向后运行。

调试步骤 登录新版ROMA Connect控制台。 在左侧导航栏选择“组合应用”，在组合应用页面单击需要调试的组合应用。 单击右上角的“编辑”进入组合应用设计页面。 单击页面上方“调试”按钮，进入调试模式。 图1 设计页面 选择调试环境。选择“区域”、“项目”和“实例”，作为在线调试使用的环境。 图2 配置调试环境 配置触发器节点。根据触发器节点类型，配置对应的触发参数，如Open API节点您可能需要配置API请求参数和请求Body等。 图3 配置Open API节点参数 单击“保存”，开启工作流调试。 执行调试操作，对工作流进行调试。 图4 调试工作流 添加断点：单击工作流中的节点，即可添加断点，工作流在调试过程中可能会停在当前断点。再次单击该节点，可移除断点。 触发器节点、并行处理节点和分支判断节点等不可添加断点。 调试运行：单击“调试运行”，工作流开始执行调试。如果工作流中存在断点，工作流会停留在该断点，并展示进入当前断点的数据，包括“属性”和“载荷”数据；如果工作流中不存在断点，工作流会自动运行至结束，或者在运行出错的节点停止，并展示错误信息。 单步运行：当工作流处于调试状态，停留在某一节点时，单击“单步运行”，工作流可自动运行至下一个节点。 运行到下一断点：当工作流处于调试状态，停留在某一节点时，单击“运行到下一断点”，工作流可自动运行至下一个断点。如果后续不存在断点，工作流会自动运行至结束，或者在运行出错的节点停止，并展示错误信息。 运行到结束：当工作流处于调试状态，停留在某一节点时，单击“运行到结束”，工作流会自动运行至结束，或者在运行出错的节点停止，并展示错误信息。 停止运行：当工作流处于调试状态，单击“停止运行”，工作流会终止本次调试过程。 调试完成后，单击页面右上方“退出调试”，退出调试模式，返回组合应用设计页面。

创建企业微信连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“企业微信”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 连接类型 选择连接类型。 机器人：若需要使用机器人推送消息功能，选择机器人； 应用：其他功能选择应用。 企业ID 仅当“连接类型”选择“应用”时需要配置。 每个企业都拥有唯一的corpid，详情见企业微信《企业内部开发服务端API文档》“基本概念介绍”章节。 应用凭证密钥 仅当“连接类型”选择“应用”时需要配置。 每一个应用都有一个独立的访问密钥，详情见企业微信《企业内部开发服务端API文档》“基本概念介绍”章节。 机器人Key 仅当“连接类型”选择“机器人”时需要配置。 机器人webhook中的请求参数key的值。 描述 填写连接器的描述信息，用于识别不同的连接器。

支持的动作 获取部门ID列表 创建部门 更新部门 删除部门 获取成员ID列表 创建成员 更新成员 删除成员 获取群聊会话 创建群聊会话 修改群聊会话 推送文本消息 推送markdown消息 推送文件消息 推送图片消息 推送图文消息 推送文本卡片消息 撤回应用消息 推送文本消息到群聊 推送markdown消息到群聊 推送文件消息到群聊 推送图片消息到群聊 推送图文消息到群聊 推送文本卡片消息到群聊 机器人推送文本消息 机器人推送markdown消息 机器人推送文件消息 机器人推送图片消息 机器人推送图文消息

配置参数 表1 删除资产授权 参数 说明 bucket_id 桶ID。 project_id 项目ID。 region_id 区域ID。 表2 添加资产授权 参数 说明 project_id 项目ID。 region_id 区域ID。 type 资产类型。 buckets OBS桶列表。 asset_name 资产名称。 location 桶位置。 bucket_name 桶名称。 bucket_policy 桶策略。 表3 查看资产列表 参数 说明 project_id 项目ID。 region_id 区域ID。 added 是否已授权。 true false offset 页码。 limit 分页大小。 表4 编辑资产名称 参数 说明 asset_id 资产ID。 project_id 项目ID。 region_id 区域ID。 name 资产名称。 表5 开启/停止脱敏任务 参数 说明 project_id 项目ID。 template_id 模板ID。 region_id 区域ID。 status 脱敏任务状态。 表6 查询脱敏任务执行列表 参数 说明 project_id 项目ID。 template_id 模板ID。 region_id 区域ID。 workspace_id 工作区ID。 offset 页码。 limit 分页大小。 表7 提取图片中的图片暗水印（文件地址版本） 参数 说明 project_id 项目ID region_id 区域ID。 region_id 项目所在region的ID，如：xx-xx-1。 src_file 待提取图片暗水印的图片地址，当前只支持OBS对象，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://hwbucket/hwinfo/hw.png，其中obs://表示OBS存储，hwbucket为桶名，hwinfo/hw.png为对象全路径名。 image_watermark 提取出来的水印图片存放地址，格式要求同src_file。 表8 提取图片中的文字暗水印（文件地址版本） 参数 说明 project_id 项目ID region_id 区域ID。 region_id 项目所在region的ID，如：xx-xx-1。 src_file 待提取文字暗水印的图片地址，当前只支持OBS，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://hwbucket/hwinfo/hw.png，其中obs://表示OBS存储，hwbucket为桶名，hwinfo/hw.png为对象全路径名。 mark_len 指定待提取水印的长度，最小0，最大32。设置后可以提升水印提取性能。 表9 图片嵌入暗水印（文件地址版本） 参数 说明 project_id 项目ID region_id 区域ID。 region_id 项目所在region的ID，如：xx-xx-1。 src_file 待加暗水印的图片地址，当前只支持OBS文件，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://hwbucket/hwinfo/hw.png，其中obs://表示OBS存储，hwbucket为桶名，hwinfo/hw.png为对象全路径名。 blind_watermark 待嵌入的文字暗水印内容，长度不超过32个字符。当前仅支持数字及英文大小写。与图片暗水印image_watermark二选一。 image_watermark 待嵌入的图片暗水印地址，格式要求同src_file字段，与文字暗水印 blind_watermark 二选一，都填写时，生效image_watermark。 dst_file 添加水印后的图片存放的地址，格式要求同src_file字段，不设置时，默认取src_file的值，即添加水印后覆盖原文件。 表10 文档提取暗水印（文档地址版本） 参数 说明 project_id 项目ID region_id 区域ID。 region_id 项目所在region的ID，如：xx-xx-1。 doc_type 待提取水印的文档类型 枚举值： WORD EXCEL PDF PPT src_file 待提取文字暗水印的文档的地址，当前只支持OBS对象，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://hwbucket/hwinfo/hw.doc，其中obs://表示OBS存储，hwbucket为桶名，hwinfo/hw.doc为对象全路径名。 file_password 解密文件的密码， 最大支持长度256。如果Office文档有读密码或域控的权限密码，请输入读密码，或者有读权限的域控密码。 表11 文档嵌入水印（文件地址版本） 参数 说明 project_id 项目ID region_id 区域ID。 region_id 项目所在region的ID，如：xx-xx-1。 src_file 待添加水印的文档地址，当前只支持OBS对象，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://hwbucket/hwinfo/hw.png，其中obs://表示OBS存储，hwbucket为桶名，hwinfo/hw.png为对象全路径名。 doc_type 待嵌入水印的文档类型。 枚举值： WORD EXCEL PDF PPT dst_file 添加水印后的文档存放地址，格式和要求同src_file字段，不设置时，默认取src_file的值，即添加水印后覆盖原文件。 blind_watermark 暗文字水印内容，与“visible_watermark”字段至少有一个不为空。 visible_watermark 明文字水印内容，与暗水印“blind_watermark”字段至少有一个不为空。 image_mark 待嵌入的图形明水印文件的地址, 字段格式要求同src_file字段，图形文件的格式必须为“png”或“jpg”，否则返回参数错误；图像文件大小不超过1MB。 visible_type 该字段控制明水印嵌入文字还是图片。默认为TEXT类型，需填写visible_watermark字段设置明文字水印； 当该字段为IMAGE时，需填写image_watermark字段设置水印图片地址此时 ，“visible_watermark”，“font_size”，“rotation”和“opacity”字段无效。 枚举值： TEXT IMAGE file_password 待加水印文件有密码时，读取文件的密码， 最大支持长度256。如果Office文档有读密码或域控的权限密码，请输入读密码，或者有读权限的域控密码。 marked_file_password 添加水印后给文件设置密码， 最大支持长度256。默认不加文档密码。 readonly_password 添加水印后给文件设置只读密码， 最大支持长度256。默认不加只读密码。 front 明水印字体大小，取值为[1,100]，默认值50。 rotation 明水印旋转角度，逆时针方向，取值为[0,90]，默认值45。 opacity 明水印的透明度，取值[0,1]，默认值为0.3。 表12 对数据进行脱敏 参数 说明 project_id 项目ID region_id 区域ID。 mask_strategies 脱敏策略列表，每一个策略对应一个字段，脱敏策略数最多100个。 name 需要脱敏的字段名称，最大支持长度256。 algorithm 脱敏算法名称。 枚举值： SHA256 SHA512 AES PRESNM MASKNM PRESXY MASKXY SYMBOL KEYWORD NUMERIC parameters 脱敏算法参数。 data 数据列表。 表13 提取数据水印 参数 说明 project_id 项目ID。 region_id 区域ID。 watermark_key 水印密钥。 columns 字段类型列表，最大长度100。使用时，要包含嵌入时所有“primary_key”为true的字段，和至少一个为false的字段用来提取水印。 name 数据的字段名称，最大支持长度256。 type 数据的字段类型。 枚举值： INTEGER STRING DOUBLE primary_key 标记该字段是否为主键。true为主键，表示用来定位水印位置；false为非主键，将在该列嵌入/提取水印内容。字段类型列表中可同时包含多个为true或为false的字段。 data 水印数据，数据条数不超过30,000条。 表14 嵌入数据水印 参数 说明 project_id 项目ID。 region_id 区域ID。 watermark_content 添加水印的内容。 watermark_key 水印密钥。 columns 字段类型列表，最大长度100。使用时，至少包含两个字段，一个“primary_key”为true表示主键，一个为false用来嵌入水印。 name 数据的字段名称，最大支持长度256。 type 数据的字段类型。 枚举值： INTEGER STRING DOUBLE primary_key 标记该字段是否为主键。true为主键，表示用来定位水印位置；false为非主键，将在该列嵌入/提取水印内容。字段类型列表中可同时包含多个为true或为false的字段。 data 数据字段的内容，最大支持长度2000。

创建数据安全中心连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“数据安全中心”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。 描述 填写连接器的描述信息，用于识别不同的连接器。

配置参数 参数 说明 主题 需要监听的topic。 GroupId 用来唯一标识consumer进程所在组的字符串，如果设置同样的group id，表示这些processes都是属于同一个consumer group。 KeyDeserializer 键的反序列化方式，默认为:org.apache.kafka.common.serialization.StringDeserializer。 ValueDeserializer 值的反序列化方式，默认为:org.apache.kafka.common.serialization.StringDeserializer。 AutoOffsetReset 设置当没有初始的偏移量或者偏移量超出范围时，从哪里开始消费。 latest：从最近的偏移量开始消费； earliest：从最早的偏移量开始消费； none：抛出异常。

创建Kafka连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“Kafka”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 Brokers地址 填写Kafka的Brokers地址。 认证方式 选择Kafka的认证方式。 SSL认证 无认证 SASL鉴权方式 仅当“认证方式”选择“SSL认证”时需要配置。 选择SASL鉴权方式。 PLAIN SCRAM-SHA-512 SSL用户名 仅当“认证方式”选择“SSL认证”时需要配置。 填写SSL用户名/应用Key。 SSL密码 仅当“认证方式”选择“SSL认证”时需要配置。 填写SSL密码。 SSL证书格式 仅当“认证方式”选择“SSL认证”时需要配置。 选择SSL证书格式。 PEM JKS SSL证书 仅当“认证方式”选择“SSL认证”时需要配置。 填写经过base64编码的证书内容。 SSL证书密码 仅当“认证方式”选择“SSL认证”时需要配置。 填写SSL证书密码。 描述 填写连接器的描述信息，用于识别不同的连接器。

配置参数 表1 获取软件需求列表 参数 说明 项目ID 填写需求的项目ID。 表2 修改软件需求状态 参数 说明 项目ID 填写需求的项目ID。 需求ID 填写需求ID。 需求状态 选择需求状态。 Draft Reviewed Approved Rejected 原因 选择拒绝原因。 Obsolete Duplicate Invalid Later 表3 获取测试用例列表 参数 说明 项目ID 填写需求的项目ID。 表4 获取软件测试用例列表 参数 说明 项目ID 填写需求的项目ID。 表5 获取测试用例与需求关联关系 参数 说明 项目ID 填写需求的项目ID。 测试用例ID 填写测试用例ID。 表6 添加软件测试报告 参数 说明 项目ID 填写需求的项目ID。 空间ID 填写空间ID。 标题 填写报告标题 名称（ID） 填写名称（ID）。 类型 请选择工作项类型。 Software Test Case est Case 链接角色 请选择连接角色。 has parent duplicates relates to 内容类型 请选择内容类型。 text/html text/plain 内容 填写报告内容。 表7 修改软件测试报告 参数 说明 项目ID 填写需求的项目ID。 空间ID 填写空间ID。 标题 填写报告标题 名称（ID） 填写名称（ID）。 类型 请选择工作项类型。 Software Test Case est Case 内容类型 请选择内容类型。 text/html text/plain 内容 填写报告内容。 表8 获取Issue列表 参数 说明 项目ID 填写需求的项目ID。

创建Polarion连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“Polarion”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 连接地址 填写连接地址，连接地址示例: http://endpoint:port/polarion。 API Token 填写API Token。 描述 填写连接器的描述信息，用于识别不同的连接器。

创建CodeArts PerfTest连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“CodeArts PerfTest”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 描述 填写连接器的描述信息，用于识别不同的连接器。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

创建IBM MQ连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“IBM MQ”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 主机IP地址 填写IBM MQ主机的IP地址。 端口 填写IBM MQ主机的端口。 队列管理器 提供队列服务和API及用于管理队列的管理功能的系统管理程序。 字符集标识 对消息中的字符串进行编码时要使用的字符集。 通道名称 通道是MQ系统中队列管理器之间传递消息的管道。 用户名 连接IBM MQ的用户名。 密码 连接IBM MQ的用户密码。 是否开启SSL认证 连接IBM MQ时是否使用SSL认证。 是 否 密钥算法套件 仅当“是否开启SSL认证”选择“是”时需要配置。 填写密钥算法套件。 公钥库文件 仅当“是否开启SSL认证”选择“是”时需要配置。 填写经过base64编码的公钥库文件内容。 公钥库密码 仅当“是否开启SSL认证”选择“是”时需要配置。 填写公钥库密码。 描述 填写连接器的描述信息，用于识别不同的连接器。

创建IBM MQ连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“IBM MQ”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 主机IP地址 填写IBM MQ主机的IP地址。 端口 填写IBM MQ主机的端口。 队列管理器 提供队列服务和API及用于管理队列的管理功能的系统管理程序。 字符集标识 对消息中的字符串进行编码时要使用的字符集。 通道名称 通道是MQ系统中队列管理器之间传递消息的管道。 用户名 连接IBM MQ的用户名。 密码 连接IBM MQ的用户密码。 是否开启SSL认证 连接IBM MQ时是否使用SSL认证。 是 否 密钥算法套件 仅当“是否开启SSL认证”选择“是”时需要配置。 填写密钥算法套件。 公钥库文件 仅当“是否开启SSL认证”选择“是”时需要配置。 填写经过base64编码的公钥库文件内容。 公钥库密码 仅当“是否开启SSL认证”选择“是”时需要配置。 填写公钥库密码。 描述 填写连接器的描述信息，用于识别不同的连接器。

配置参数 表1 发送消息 参数 说明 主题 填写需要监听的topic。 Partition 消息将被写入的分区。 Key 消息Key值。 Message 消息内容。 Acks 发送确认参数。 all -1 0 1 KeySerializer 键的序列化方式，默认为org.apache.kafka.common.serialization.StringSerializer。 ValueSerializer 值的序列化方式，默认为org.apache.kafka.common.serialization.StringSerializer。 BufferMemorySize producer可以用来缓存数据的内存大小，默认为33554432。 Retries 重试次数。

创建Kafka连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“Kafka”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 Brokers地址 填写Kafka的Brokers地址。 认证方式 选择Kafka的认证方式。 SSL认证 无认证 SASL鉴权方式 仅当“认证方式”选择“SSL认证”时需要配置。 选择SASL鉴权方式。 PLAIN SCRAM-SHA-512 SSL用户名 仅当“认证方式”选择“SSL认证”时需要配置。 填写SSL用户名/应用Key。 SSL密码 仅当“认证方式”选择“SSL认证”时需要配置。 填写SSL密码。 SSL证书格式 仅当“认证方式”选择“SSL认证”时需要配置。 选择SSL证书格式。 PEM JKS SSL证书 仅当“认证方式”选择“SSL认证”时需要配置。 填写经过base64编码的证书内容。 SSL证书密码 仅当“认证方式”选择“SSL认证”时需要配置。 填写SSL证书密码。 描述 填写连接器的描述信息，用于识别不同的连接器。

创建CodeArts IDE Online连接 登录新版ROMA Connect控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“CodeArts IDE Online”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 描述 填写连接器的描述信息，用于识别不同的连接器。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

配置参数 表1 查询IDE实例列表 参数 说明 region_id 区域ID。 limit 每页显示的条目数量，最大值为100，最小值为1。 offset 偏移量，表示从此偏移量开始查询。 is_temporary 是否页面显示（以标签配置为准）。 label 标签。 search 关键字查询(根据实例名，描述模糊查询)。 sort_dir 排序方式 asc/desc。 sort_key 排序字段。 display_name 实例名、status状态、pvc_quantity 存储容量、created_time 创建时间、stack_id 技术栈。 表2 创建IDE实例 参数 说明 org_id 租户ID（对应华为云账号的domainId）。 region_id 区域ID。 agent_id 代理商ID，教程活动场景下使用。 arch cpu架构，x86或arm。 cpu_memory cpu规格。arm架构支持4U8G，x86架构支持1U1G、2U4G、2U8G，与技术栈配置的规格对应，可通过技术栈管理ListStacks接口获取。如果标签不为空，以标签配置的技术栈规格为准。 quantum技术栈，x86架构cpu规格为2U8G；其他技术栈，x86架构cpu规格为1U1G、2U4G。 description 描述。 display_name 实例名。 可以输入中文、数字、字母、下划线、点、破折号。长度介于3-100之间。 is_temporary 实例标签（不同的第三方需要和CodeArtsIDEOnline服务共同设定标签），不传默认为default。 label_tag 排序方式asc/desc。 plugin_enable_list 预装插件列表。 plugin_vars 预装插件参数，请注意敏感信息保护，若涉及敏感信息，请自行加密。 port_id 云服务器对应的portId，小网连接ecs的场景下使用。 private_ip 云服务器ip，小网连接ecs的场景下使用。 pvc_quantity PVC规格，如5GB|10GB|20GB。 refresh_interval 自动休眠时长。arm架构，自动休眠时长只能设置成30或60。x86架构可取值为30、60、240、1440和-1。除-1外，其它值的单位为“分钟”。实例无操作超过自动休眠时长后，将会被暂停（已保存的数据不会被删除）。-1表示实例不会自动停止。 repository_id 解放号的仓库ID，解放号场景下使用。 stack_id 技术栈ID，通过技术栈管理ListStacks接口获取。 task_type 任务类型，教程活动场景下使用。 token 解放号的token，解放号场景下使用。 vpc_id 云服务器对应的vpcId，小网连接ecs的场景下使用。 instance_domain_id 实例授权用户租户ID。 instance_user_id 实例授权用户ID。 表3 查询某个租户下的IDE实例列表 参数 说明 org_id 租户ID（对应华为云账号的domainId）。 region_id 区域ID。 is_temporary 实例标签（不同的第三方需要和CodeArtsIDEOnline服务共同设定标签），不传默认为default。 limit 每页显示的条目数量，10/15/30。 offset 偏移量，表示从此偏移量开始查询。 search 关键字查询(根据实例名，描述模糊查询)。 表4 停止IDE实例 参数 说明 instance_id 实例ID。 region_id 区域ID。 表5 启动IDE实例 参数 说明 instance_id 实例ID。 region_id 区域ID。 plugin_enable_list 插件列表。 plugin_vars 插件参数，请注意敏感信息保护，若涉及敏感信息，请自行加密。 表6 删除IDE实例 参数 说明 instance_id 实例ID。 region_id 区域ID。 表7 修改IDE实例 参数 说明 instance_id 实例ID。 region_id 区域ID。 description 描述。 display_name 实例名。 可以输入中文、数字、字母、下划线、点、破折号。长度介于3-100之间。 refresh_interval 自动休眠时长。arm架构，自动休眠时长只能设置成30或60。x86架构可取值为30、60、240、1440和-1。除-1外，其它值的单位为“分钟”。实例无操作超过自动休眠时长后，将会被暂停（已保存的数据不会被删除）。-1表示实例不会自动停止。 表8 查询某个IDE实例 参数 说明 instance_id 实例ID。 region_id 区域ID。 表9 查询IDE实例名是否重复 参数 说明 region_id 区域ID。 display_name 实例名。 可以输入中文、数字、字母、下划线、点、破折号。长度介于3-100之间。

状态码 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。 HTTP状态码 错误码 描述 400 CBC.0100 参数错误。 400 CBC.99000049 转售子客户无账户余额。 403 CBC.0151 访问拒绝。 500 CBC.0999 其他错误。

迁移流程 音视频文件迁移的总体流程，如图1所示。 图1 迁移流程图 评估迁移能力：音视频文件迁移之前，需要明确现有业务平台使用了哪些视频点播能力，然后参考华为云点播功能特性介绍，确认能力是否匹配。 对接业务：对接华为云视频点播服务时，需要重点关注测试验证各种异常场景，避免在使用过程中出现问题，影响体验。 迁移存量文件：需要根据迁移的存量文件大小选择适合的迁移方式进行存量文件的搬迁。 保障上线工作：在设计迁移上线方案时，建议从上线前检查、监控告警、上线前数据备份、上线灰度策略和上线支持回退等多个维度设计上线方案，以确保迁移成功。

步骤一：评估服务能力是否满足迁移 迁移之前，需要您明确现有业务平台使用了哪些视频点播能力，然后参考华为云点播功能特性介绍，确认能力是否匹配。您可以参考以下维度进行服务的能力评估。 接口使用方式：如音视频上传、转码、水印等，各云平台接口或SDK等使用方式都有差异，核心功能大致相同。接口调用方式、传参可以根据接口描述或APIE调试，评估点播接口功能是否满足业务场景要求。 音视频处理能力：如转码格式、转码模板使用方式、水印模板使用、转码时间要求、封面生成要求、编辑能力、格式等方面，考虑能力、效率是否匹配您的业务场景。如点播业务部分功能（转码等）是异步处理，可能无法满足实时要求。 音视频分发能力：如防盗链、HLS加密、音视频统计分析等。 存量搬迁：需评估搬迁时间要求，涉及文件的格式，是否涉及转码，预热，对转码预热的时间评估等。

步骤四：保障上线工作 在设计迁移上线方案时，建议您参考以下维度设计上线方案，以确保迁移成功。其他注意事项请结合实际业务场景补充。 表1 上线方案说明 注意事项 说明 上线前检查 针对业务量进行评估、对业务的监控影响、可能影响的客户，以及配置检查。 监控告警 需提前配置监控告警，在业务波动时能及时分析并处理。 上线前数据备份 上线前相关配置或文件需要先备份，以便上线后进行数据对比或数据恢复。 上线灰度策略 上线方案设计中务必要支持灰度，逐量切换风险低。 上线支持回退 上线方案需支持回退，如出现异常时能及时恢复业务。

操作步骤 在项目主页，选择“原始需求”。 单击“新建RR”，进入“新建RR”页面。 填写需求的基本信息。 参数名 参数说明 标题 原始需求的名称。 描述 根据实际情况填写原始需求的背景、价值和详情信息。 支持使用文字、图片、链接等形式。 附件 单个原始需求的附件数量最多为100个，附件总容量为50MB。 提出项目 默认是原始需求所在项目，不可修改。 提出人 默认是原始需求的创建者，支持多选。 归属项目 原始需求的归属项目。 选择本项目时，表示该需求归属内部。 选择其他项目时，表示该需求提给外部。 默认为本项目。 承接人 承接原始需求的责任人。 项目成员信息可在成员中增加。承接人选择多个时，会根据承接人处理的速度去同步数据。 期望完成时间 期望原始需求完成的时间。 优先级 原始需求的优先级，包含低、中、高三个等级。 默认为“中”。 抄送人 项目组内其他成员。 项目成员信息可在成员中增加。 单击“提交”，系统会自动跳转到原始需求主页，并在主页右上角给出“提交需求成功”的提示。 单击“保存”，返回原始需求列表页面，该需求状态显示为“提交”。 单击“取消”，可取消该原始需求的创建。 在原始需求列表可查看到新建的需求，该需求状态显示为“分析”。如果“归属项目”选择为其他项目，则需在“提给外部”中查看新建的原始需求。 原始需求新建成功后，默认提出人、承接人和抄送人会收到邮件通知和站内信通知，如未收到或需修改配置内容可参见通知设置。

概述 每一个迭代结束时，会召开一个迭代回顾会议，对已结束的迭代进行全员的总结，回顾做得好的和做得不好的，寻找改进措施，并在下个迭代进行改进。 迭代回顾可以使用如下功能： 使用仪表盘、统计报表，了解迭代的质量、进度、工作量的情况，基于真实数据进行改进。 使用Wiki内置的“迭代回顾会议”模板创建迭代回顾会议模板，引导和记录会议要点。 使用知识库服务，上传迭代的总结文件，便于项目成员在线浏览和下载，沉淀项目的知识和总结。 父主题： 迭代回顾

操作步骤 在项目主页，选择“原始需求”。 单击“新建RR”，进入“新建RR”页面。 填写需求的基本信息。 参数名 参数说明 标题 原始需求的名称。 描述 根据实际情况填写原始需求的背景、价值和详情信息。 支持使用文字、图片、链接等形式。 附件 单个原始需求的附件数量最多为100个，附件总容量为50MB。 提出项目 默认是原始需求所在项目，不可修改。 提出人 默认是原始需求的创建者，支持多选。 归属项目 原始需求的归属项目。 选择本项目时，表示该需求归属内部。 选择其他项目时，表示该需求提给外部。 默认为本项目。 承接人 承接原始需求的责任人。 项目成员信息可在成员中增加。承接人选择多个时，会根据承接人处理的速度去同步数据。 期望完成时间 期望原始需求完成的时间。 优先级 原始需求的优先级，包含低、中、高三个等级。 默认为“中”。 抄送人 项目组内其他成员。 项目成员信息可在成员中增加。 单击“提交”，系统会自动跳转到原始需求主页，并在主页右上角给出“提交需求成功”的提示。 单击“保存”，返回原始需求列表页面，该需求状态显示为“提交”。 单击“取消”，可取消该原始需求的创建。 在原始需求列表可查看到新建的需求，该需求状态显示为“分析”。如果“归属项目”选择为其他项目，则需在“提给外部”中查看新建的原始需求。 原始需求新建成功后，默认提出人、承接人和抄送人会收到邮件通知和站内信通知，如未收到或需修改配置内容可参见通知设置。

操作步骤 在项目主页，选择“原始需求”。 单击“新建RR”，进入“新建RR”页面。 填写需求的基本信息。 参数名 参数说明 标题 原始需求的名称。 描述 根据实际情况填写原始需求的背景、价值和详情信息。 支持使用文字、图片、链接等形式。 附件 单个原始需求的附件数量最多为100个，附件总容量为50MB。 提出项目 默认是原始需求所在项目，不可修改。 提出人 默认是原始需求的创建者，支持多选。 归属项目 原始需求的归属项目。 选择本项目时，表示该需求归属内部。 选择其他项目时，表示该需求提给外部。 默认为本项目。 承接人 承接原始需求的责任人。 项目成员信息可在成员中增加。承接人选择多个时，会根据承接人处理的速度去同步数据。 期望完成时间 期望原始需求完成的时间。 优先级 原始需求的优先级，包含低、中、高三个等级。 默认为“中”。 抄送人 项目组内其他成员。 项目成员信息可在成员中增加。 单击“提交”，系统会自动跳转到原始需求主页，并在主页右上角给出“提交需求成功”的提示。 单击“保存”，返回原始需求列表页面，该需求状态显示为“提交”。 单击“取消”，可取消该原始需求的创建。 在原始需求列表可查看到新建的需求，该需求状态显示为“分析”。如果“归属项目”选择为其他项目，则需在“提给外部”中查看新建的原始需求。 原始需求新建成功后，默认提出人、承接人和抄送人会收到邮件通知和站内信通知，如未收到或需修改配置内容可参见通知设置。

字段模版 字段模版默认展示系统中所有的字段信息，包括字段的名称、添加/创建人、添加/创建时间、字段类型、新建页显示、是否必填、字段选项、默认值、操作。当系统中的字段不能满足要求时，您可以根据项目实际情况新建自定义的字段。 字段隐藏设置 单击右上角的“字段隐藏设置”，弹出“字段隐藏设置”窗口。 将“字段列表”下的字段拖拽到“隐藏字段”中，即可隐藏字段。 隐藏的字段不会显示在“字段模板”列表中。 在工作项中增加字段 工作项包括原始需求、特性、史诗、用户故事、任务和缺陷。选择需要增加字段的工作项，再执行如下操作： 在“字段模板”页面中单击“添加字段”，弹出“添加字段”窗口。 单击“字段名称”下拉框，显示字段名称取值信息。 在公共字段中新增的取值会显示在该参数取值中。如果没有符合要求的取值，可以执行后面的步骤自定义字段信息。 单击“新建字段”，弹出“新建字段”窗口。 填写字段信息。 表1 新建字段参数说明 参数名 参数说明 字段名称 自定义字段名称。 字段类型 字段的类型。 取值包含：单选列表、多选列表、单行文本、多行文本、日期、日期时间、整数、小数、单选用户、多选用户、层级字段。 选项 仅当“字段类型”为“单选列表”、“多选列表”或“层级字段”时，显示该参数。 单击“增加选项”，可一次新增一个选项。需要同时新增多个选项时，可单击“多项录入”，一次新增多个选项，使用回车键分行。 当有多个选项时，使用鼠标拖动图标，可以调整选项的位置。 单击，可删除选项。默认有一个选项，不能删除。 当“字段类型”为“层级字段”时，需要先单击“编辑选项”，再增加选项，最多可增加到4级。 默认值 仅当“字段类型”为“单行文本”、“多行文本”、“日期”、“日期时间”、“整数”、“小数”或“层级字段”时，显示该参数。 请根据项目时间情况配置。 新建页显示 默认为开启。如果关闭，则新建的字段在创建工作项时不显示。 是否必填 仅当“新建页显示”开启时，显示该参数。 默认为关闭。该参数开启时，表示新建的字段为必填参数，包括工作项新建和工作项流转中的必填。 是否基线锁定 仅特性、研发需求（IR、SR、AR）支持是否基线锁定。 仅当“新建页显示”开启时，显示该参数。 默认为关闭。该参数开启时，表示在工作项（如特性、研发需求）被基线后，新建的字段会被锁定，不支持修改。如果必须修改，会发起变更流程。 单击“确定”，新建字段成功。 在字段模板列表中最下方会显示新建的字段信息，且新建的字段信息还会显示在“公共字段”中。 （可选）编辑或删除字段。 系统中自带的字段不支持编辑和删除。 单击需要编辑的字段所在行的，可以修改字段信息。 单击需要编辑的字段所在行的，可以根据提示删除字段信息。 租户级字段在字段模版中删除后，在租户字段页面不被删除。 自定义字段被删除后，在公共字段页面不被删除。 使用鼠标拖动字段前的图标，可以调整字段的位置。 在“公共字段”中增加字段 单击左侧导航的“公共字段”，显示“字段管理”页面。 字段管理列表中会显示在工作项中增加的字段信息。 单击“新建字段”，弹出“添加字段”窗口。 填写字段信息。 “字段名称”不能跟系统中已有的重复。 “字段类型”的取值请参见表1。 单击“确定”，新建字段成功。 在字段管理列表中会显示新建的字段信息。 当新建的字段被工作项使用后，“使用情况”下会显示具体的工作项。 （可选）编辑或删除字段。 单击需要编辑的字段所在行的，可以修改字段信息。 单击需要编辑的字段所在行的，可以根据提示删除字段信息。 在“公共状态”中增加状态 单击左侧导航的“公共状态”，显示“状态管理”页面。 单击“添加状态”，弹出“添加状态”窗口。 单击“状态名称”下拉框，显示状态名称取值信息。 单击“新建状态”，弹出“新建状态”窗口。 填写状态信息。 “状态名称”不能跟系统中已有的重复。 “状态属性”包含“开始态”、“进行态”和“结束态”。 单击“确定”，新建状态成功。 在状态管理列表中会显示新建的状态信息。 当新建的状态被工作项使用后，“使用情况”下会显示具体的工作项。 （可选）编辑或删除状态。 系统中自带的状态不支持删除。编辑时，只能编辑“描述”信息。 单击需要编辑的状态所在行的，可以修改状态信息。 单击需要编辑的状态所在行的，可以根据提示删除状态信息。