华为云用户手册

MQTTConnect简介 该系统关键字支持对MQTT协议的全流程测试，用以连接MQTT服务器，如果需要使用该系统关键字，需要用户将MQTT服务器开放公网访问并且将对应端口的安全组策略开启放行。 参数 是否必选 参数类型 默认值 描述 MQTT服务器协议 是 String - 枚举值（tcp://和ssl://），缺省为tcp://。当前支持TCP(tcp://)和SSL(ssl://)两种协议，其余协议待扩充。 MQTT服务器IP 是 String - MQTT服务器地址，支持写固定IP或 域名 。 MQTT服务器端口 是 Integer - MQTT服务器端口，用来访问MQTT服务。 MQTT版本 是 String 3.1.1 MQTT版本：目前支持3.1.1和3.1。 用户名 是 String - MQTT服务器用户名。 密码 是 String - MQTT服务器密码。 连接保活时长 是 String 300 MQTT协议组件与服务器在该时间段内会发送心跳。超过该连接保活时长后，客户端不再发送PINGREQ报文，不影响后续发布消息、订阅消息和关闭连接流程。 客户端ID 是 String apitest_ MQTT客户端ID，用来区分客户端，一般为UUID。 添加随机后缀 是 Boolean true 支持添加随机后缀，当clientID为空时，默认打开，用户指定后缀，请关闭随机后缀。 清空会话 是 Boolean false 每次消息接收之后是否清空会话。

MQTT协议简介 MQTT（Message Queuing Telemetry Transport，消息队列遥测传输协议），是一种基于发布/订阅（Publish/Subscribe）模式的轻量级通讯协议，MQTT 最大的优点在于以极少的代码和有限的带宽，为远程设备提供实时可靠的消息服务。作为一种低开销、低带宽占用的即时通讯协议， MQTT 在物联网、小型设备、移动应用等方面有广泛的应用。 接口测试对于MQTT协议提供全流程测试，系统关键字包括：MQTTConnect，MQTTDisconnect，MQTTPublish，MQ TTS ubscribe。 由于MQTT协议测试需要采用双容器方案，安全风险较高，目前只对白名单用户开放，如果需要使用MQTT相关测试请联系客服。

测试生命周期管理 随着产品的规模和复杂度增加，测试活动的开展也需要有章可循，形成科学的流程和规范。以华为公司为例，为保障产品测试活动有序开展，华为在IPD流程中定义了从需求分析阶段到版本发布阶段之间的详细测试活动和流程，并通过标准化的规范，持续保障测试验证的高质量。 华为云CodeArts TestPlan内置IPD测试流程与规范，从测试策略、测试设计、测试管理、测试执行到测试评估，全流程融入IPD高质量实践精髓，伴随着华为产品发展而持续优化演进，广泛应用于华为各业务线的产品测试中。 华为云CodeArts TestPlan通过其测试设计、测试管理、测试执行、测试评估能力，提供完整覆盖IPD-PTM的测试生命周期，将测试流程融入作业活动。 表1 术语表 缩略语 全称 含义 补充说明 IPD Integrated Product Development 集成产品开发流程 IPD是并行工程方法的应用和扩展，是一种集成了系统工程方法的结构化产品开发和管理框架，它要求产品开发一开始就考虑产品生命周期中的各种因素，建立集成跨功能部门的产品开发团队，以客户为中心进行开发。 PTM Product Test Management 产品测试管理 通过统一的测试业务与产品缺陷修复流程，使产品测试及缺陷修复活动达到有序化、模板化、可视化，加强各项活动的继承性和可重复性，从而促进研发成本的降低。 Charter Charter 任务书 指项目的计划书，主要描述项目的时间、目标、范围和主要交付，以及一些初步的投资回报分析。 CDCP Concept Decision Checkpoint 概念决策评审点 在该决策评审点上，商业计划体现了足够的业务潜力，有望形成可行的产品包。 PDCP Plan Decision Checkpoint 计划决策评审点 - ADCP Availability Decision Checkpoint 一般可获得性决策评审点 在该点上，产品包已经做好正式发布和发货的准备。 GA General Availability 一般可获得性 软件版本周期是指计算机软件的发展及发布过程，从Pre-alpha（准预览版本）发展到Alpha（预览版本）、Beta（测试版本）、Released candidate （最终测试版本）至最后的Gold（完成版）。GA点在IPD过程里意味着产品可以批量交付给客户。 TR Technical Review 技术评审 又称产品技术成熟度评估，由PDT组织检查评估本流程实施到一定阶段以后产品成熟度，并检查关键点上的准备情况，用以发现遗留的问题，评估存在的产品风险，并形成对策和操作建议。 IPD中有7个TR：TR1（需求）、TR2（设计规格）、TR3（概要设计）、TR4（详细设计和单元测试）、TR4A（系统设计验证）、TR5（系统测试）、TR6（β测试）。 SDV System Design Verification 系统设计验证 针对产品原型机的测试，验证系统的功能规格是否实现。 SIT System Integrated Test 系统集成验证 针对初试产品的测试，它包括系统功能、性能/指标、可靠性、可用性、容限/容错、组网、安全等系统属性的测试。 SVT System Verification Test 系统验证测试 目的是验证制造流程，一方面保证大批量生产时的可制造性，另一方面通过批量builds来保证设计完整性；该测试必须在产线正式生产出的硬件上执行。 父主题： IPD测试流程与实践

动态变量说明 测试套件中的多个用例间可能存在上下文关系，后执行的用例依赖先执行用例中接口的返回结果。例如所有的接口都需要鉴权信息，且鉴权信息有时效性，如果在每个用例里都去获取鉴权信息，用例的测试步骤会显得冗余，不易维护。 使用动态全局变量即可避免上述问题，在第一个执行的用例中获取鉴权信息后赋值给动态全局变量，后面执行的用例直接使用动态全局变量即可，无需重复获取鉴权信息。 设置动态变量。 在“接口自动化测试用例列表”页面，单击页面右侧“更多”，选择“环境参数”。 选中动态变量列的复选框，单击“保存”，将全局参数设置为动态参数。 赋值动态变量。 在接口自动化用例中，选择URL请求的“响应提取”标签下，单击匹配列的“添加”按钮。 在“赋值给环境动态参数”下拉列表中希望赋值的全局动态参数。 使用动态变量。 在测试用例中使用动态变量。 在需要使用全局动态变量的用例中，引用动态全局变量，引用方式请参见环境参数引用形式。 在测试套件中使用动态全局变量。 将2和3中的用例按顺序添加到测试套件中，选择“串行执行”，即可让使用动态变量的用例执行时使用到动态全局变量被赋值的最新值。 并行执行时动态变量的赋值和使用顺序不能保证，因此不推荐在并行执行时使用动态全局变量。

环境参数值使用内置函数的设置说明 环境参数不支持内置函数嵌套，如果有嵌套则原样输出。 环境参数支持的内置函数如表1。 表1 环境参数支持的内置函数表 序号 函数 描述 1 $random_string(intA) 生成指定长度随机字符串 2 $random_int(intA, intB) 生成指定范围随机数 3 $timestamp() 获取当前时间戳 4 $timestamp_format(String A, String B) 时间戳转日期 5 $uuid() 生成UUID 6 $encode_base64(StringA) 生成Base64编码 7 $md5(StringA) 生成MD5哈希值 8 $sha512(StringA) 生成SHA512编码 环境参数支持内置函数使用举例如下。 正常场景：引用$random_string(intA)，输出$random_string(intA)。 正常场景：函数前后拼接字符，按照字符串解析，原样输出。例如引用aa$random_string(10)或者$random_string(10)aa，则输出aa$random_string(10)或者$random_string(10)aa。 异常场景：传参所需一个参数，实际传两个参数，例如$random_string(1,1) ，执行时抛出异常。 传参类型和实际函数所需参数类型不匹配，例如$random_string(fff)或$random_string() ，执行时抛出异常 。

环境参数引用形式 环境参数的引用形式为“$${参数名}”。例如：参数名为“hostname”，则可以使用“$${hostname}”来引用该参数。 根据需要可以对环境参数进行分组配置管理，例如：参数hostname在类生产环境中的值为“stage.example.com”，在生产环境中的值为“prod.example.com”，测试脚本使用“$${hostname}”引用该参数，执行测试时选择不同环境执行，实现一套接口自动化用例在所有环境复用。

环境参数设置方法 进入接口自动化用例编辑的“脚本”页签，单击图标。 单击“新建变量”，输入参数信息，单击“确定”。 配置项 说明 参数名 参数的名称。 类型 参数的类型。支持文本、随机字符串、随机整数、时间戳等多种类型。 值 参数的值。 描述 对参数的描述。 敏感参数 勾选为敏感数据后，对参数值加密存储，在测试结果日志中使用星号覆盖处理。敏感数据类型适用并不限于个人信息、鉴权信息，例如姓名、地址、用户名等。 动态参数 动态参数设置，动态参数的值可以在用例执行过程中被赋值。动态参数初始值可为空，被赋值之后，此处显示的是最新值。 在用例测试步骤“响应提取”的“赋值给环境动态参数”列中设置后，在测试执行时，响应提取的内容将被赋值给动态参数。详细介绍请参见动态变量说明。 页面中会有一个默认环境。 如果需要设置其它环境为默认环境，单击该环境卡片右上角图标，在下拉列表中选择“设为默认环境”。

使用场景 传统的接口测试中，对于安全性要求不高的场景，使用公共资源池（八爪鱼提供）来执行接口自动化用例，要求用户服务与公共资源池所在网络相互打通，且接口向接口自动化执行机开放。 但是，在网络结构冲突、安全性要求较高等场景下，用户接口无法向接口自动化执行机开放，此时需要采用自定义执行机方案，让执行机下沉到被测接口的VPC中，以保证执行机对用户被测接口的网络连接是畅通的。 支持自定义资源池能够解决跨VPC小网测试的问题。

操作步骤 登录CAE控制台。 在左侧导航栏中选择“组件监控”。 您可以通过页面上方的三个下拉框切换组件、实例以及选择监控指标，查看组件监控信息。 CAE支持同时显示多个组件的状态情况，您可以在组件下拉框中选择多个组件，选了多个组件之后，不支持按实例、自定义指标查看。 图1 查看多组件监控 组件监控主要提供上行Bps、下行Bps、上行Pps、下行Pps、CPU使用量率、内存使用率及自定义监控指标等。具体参数请参考表1。 表1 组件监控信息 参数 参数说明 上行Bps 该指标用于统计测试对象的出方向网络流速。 下行Bps 该指标用于统计测试对象的入方向网络流速。 上行Pps 每秒网卡发送的数据包个数。 下行Pps 每秒网卡接收的数据包个数。 CPU使用率 该指标用于统计实例的CPU使用率。 内存使用率 该指标用于统计实例的内存使用率。 文件系统读取速率 单位时间内读取文件系统的字节数。 文件系统写入速率 单位时间内写入文件系统的字节数。 自定义监控指标 用户在组件中自定义，并在“自定义监控指标”处配置的监控维度，具体请参考配置自定义监控指标。 默认显示上行Bps、下行Bps、CPU使用量率、内存使用率，如需变更请在下拉框中根据需求自行勾选。 图2 选择展示监控指标 图3 查看组件监控

其他相关操作 组件创建或部署完成后，在“组件列表”页可查看环境ID、应用ID、组件ID、组件名称，代码源、状态、实例个数、创建时间等信息。 在组件列表界面，您可以对已创建或部署的组件进行其他相关操作，具体的操作有： 表1 相关操作 操作 说明 查看环境ID 当鼠标悬停在“环境”时，显示环境名称和环境ID。 查看应用ID 当鼠标悬停在“应用”时，显示应用名称和应用ID。 查看组件ID 当鼠标悬停在“组件”时，显示组件名称、组件版本和组件ID。 搜索组件 在组件列表上方的搜索框，可以通过组件名称来模糊搜索对应组件。 刷新组件列表 单击组件列表右上角的按钮，可刷新组件列表信息。 自定义列表项 单击组件列表右上角的按钮，可对组件的列项设置显示或隐藏。 过滤组件 在组件列表的表头，单击“代码源”或“状态”列的，可按特定类型过滤组件。 切换组件的排序 在组件列表的表头，单击“名称/版本/ID”、“最近一次变更状态/时间”或“创建时间”列的可切换组件的排序。为默认排序，为正序排序，为倒序排序。 组件配置 单击组件右侧的，跳转到组件配置界面，对组件进行相关配置，详情请参考组件配置。 查看组件监控 单击组件右侧的，跳转到组件监控界面查看组件指标，详情请参考查看组件监控。 查看组件日志 单击组件右侧的，跳转到组件日志界面查看详细日志，详情请参考查看组件日志。 查看组件事件 单击组件右侧的，跳转到组件事件界面查看组件的活动，详情请参考查看组件事件。 查看变更详情 单击组件“最近一次变更状态/时间”列的，可以查看组件的变更记录。 父主题： 管理组件

删除端口配置 登录CAE控制台。 在左侧导航栏中选择“组件配置”。 在“组件配置”页面上方的下拉框中选择需要操作的组件。 单击“访问方式”模块中的“编辑”。 在“环境内其他组件访问本组件”中，选择待操作端口配置，单击操作列“删除”。 在弹框中单击“是”，完成端口配置删除。 图5 删除端口配置 单击“确定”，完成访问方式配置确认。 使配置生效。 如已完成组件部署，单击页面上方“生效配置”。在右侧弹框中确认配置信息，并单击“确定”，使配置生效。 如未完成组件部署，单击页面上方“配置并部署组件”，在右侧弹框中单击“确定”待部署执行完成后，配置生效。

添加端口配置 登录CAE控制台。 在左侧导航栏中选择“组件配置”。 在“组件配置”页面上方的下拉框中选择需要操作的组件。 图1 选择组件 单击“访问方式”模块中的“编辑”。 在“环境内其他组件访问本组件”中，单击“添加配置”，参考表1进行参数配置。 表1 内网访问配置 参数 参数说明 协议 支持TCP、UDP协议。 监听端口 组件中程序的监听端口，一般从用户的程序代码中获取。 取值范围[1，65535]。 访问端口 组件提供给外部访问的端口，一般由用户自行设定，端口号唯一，避免冲突。 取值范围[1，65535]。 以TCP协议为例，监听端口为80，访问端口为35475，配置生效后，登录集群节点使用curl命令访问组件。 图2 配置内网访问参数 （可选）如需添加多条端口配置，单击“添加端口配置”，参考表1进行参数配置。 单击“确定”完成配置。 使配置生效。 如已完成组件部署，单击页面上方“生效配置”。在右侧弹框中确认配置信息，并单击“确定”，使配置生效。 如未完成组件部署，单击页面上方“配置并部署组件”，在右侧弹框中单击“确定”待部署执行完成后，配置生效。 图3 内网访问

修改端口配置 登录CAE控制台。 在左侧导航栏中选择“组件配置”。 在“组件配置”页面上方的下拉框中选择需要操作的组件。 图4 选择组件 单击“访问方式”模块中的“编辑”。 在“环境内其他组件访问本组件”中，参考表2更新参数配置。 表2 内网访问配置 参数 参数说明 协议 支持TCP、UDP协议。 监听端口 组件中程序的监听端口，一般从用户的程序代码中获取。 取值范围[1，65535]。 访问端口 组件提供给外部访问的端口，一般由用户自行设定，端口号唯一，避免冲突。 取值范围[1，65535]。 单击“确定”完成配置。 使配置生效。 如已完成组件部署，单击页面上方“生效配置”。在右侧弹框中确认配置信息，并单击“确定”，使配置生效。 如未完成组件部署，单击页面上方“配置并部署组件”，在右侧弹框中单击“确定”待部署执行完成后，配置生效。

添加负载均衡配置 登录CAE控制台。 在左侧导航栏中选择“组件配置”。 在“组件配置”页面上方的下拉框中选择需要操作的组件。 单击“访问方式”模块中的“编辑”。 “从环境外部访问本组件”页面，选择“负载均衡配置”，并单击“添加负载均衡配置”。 在“新增负载均衡配置”页面，参考表1进行参数配置。 表1 负载均衡外网访问配置 参数 参数说明 负载均衡器 支持“独享型”和“内置负载均衡器”。 选择“内置负载均衡器”，只支持基于EIP公网访问。 选择“独享型”时，在下拉框中选择对应负载均衡器。 说明： 如需选择“独享型”负载均衡器，请先添加VPC访问CAE环境配置。 只支持选择环境所属VPC下的负载均衡实例。 可通过将负载均衡器配置弹性公网IP实现外网访问CAE组件。 如果没有可选的负载均衡器，可单击“创建负载均衡器”，跳转至ELB控制台进行创建，具体操作请参考创建独享型负载均衡器。 健康检查 此处健康检查是设置负载均衡的健康检查配置。 不启动：关闭负载均衡健康检查。 启动：启动负载均衡健康检查。默认为“启动”。 协议 健康检查请求的协议类型。 支持TCP和HTTP协议。默认值为TCP。 说明： 不支持直接切换协议，如需切换，请更新为不启用后再选择其他协议。 检查路径 当健康检查的“协议”选择“HTTP”时，需要配置。 指定健康检查的URL地址。检查路径必须以/开头，长度范围为1-80个字符。 支持使用英文字母、数字和字符‘-’、‘/’、‘.’、‘%’、‘?’、‘&’、‘_’。 检查周期（秒） 发送健康检查请求的时间间隔。 取值范围[1-50]。默认值5秒。 超时时间（秒） 每次健康检查响应的最大超时时间。 取值范围[1-50]。默认值10秒。 最大重试次数 健康检查最大的重试次数。 取值范围[1-10]。默认值3次。 访问控制 主要用来控制访问组件的IP地址，您可以创建访问控制策略，允许/禁止某个IP地址对组件进行访问。支持IP和IP网段。 允许所有IP访问。 白名单。 只允许白名单中放通的IP访问组件。 黑名单。 禁止黑名单中的IP访问组件。 端口配置 协议：支持TCP、UDP协议。 监听端口：组件中程序的监听端口，一般从用户的程序代码中获取。 取值范围[1，65535]。 访问端口：组件提供给外部访问的端口，一般由用户自行设定，端口号唯一，避免冲突。 取值范围[1，65535]。 图1 配置负载均衡参数 图2 配置健康检查 单击“确定”，完成负载均衡配置添加。 （可选）如需添加多条负载均衡配置，请重复执行5~7。 单击“确定”，完成负载均衡配置。 使配置生效。 如已完成组件部署，单击页面上方“生效配置”。在右侧弹框中确认配置信息，并单击“确定”，使配置生效。 如未完成组件部署，单击页面上方“配置并部署组件”，在右侧弹框中单击“确定”待部署执行完成后，配置生效。 以Nginx组件为例，协议选择TCP，监听端口为80，访问端口为8089，则部署成功后。在左侧导航栏中选择“组件列表”，进入“组件列表”页面，单击Nginx组件“访问地址”列的公网访问地址，可查看Nginx静态WEB页面。 如果您配置了访问控制白名单或黑名单，则只有在白名单内或在黑名单外的ip能够访问组件。 图3 外网访问 也可以通过域名访问，例如：http://test-test-7.com:8089。前提是已在系统设置中添加域名，并成功绑定，具体操作可参考常见问题:自定义域名如何绑定CAE。 图4 域名配置 图5 通过域名访问 图6 不在白名单内的ip访问

修改负载均衡配置 登录CAE控制台。 在左侧导航栏中选择“组件配置”。 在“组件配置”页面上方的下拉框中选择需要操作的组件。 单击“访问方式”模块中的“编辑”。 “从环境外部访问本组件”页面，选择“负载均衡配置”。 在负载均衡配置列表中选择待操作配置项，单击操作列“编辑”。 图7 修改负载均衡配置 参考表1更新参数配置。 单击“确定”，完成负载均衡配置修改。 单击“确定”，完成访问方式配置确认。 使配置生效。 如已完成组件部署，单击页面上方“生效配置”。在右侧弹框中确认配置信息，并单击“确定”，使配置生效。 如未完成组件部署，单击页面上方“配置并部署组件”，在右侧弹框中单击“确定”待部署执行完成后，配置生效。

删除负载均衡配置 登录CAE控制台。 在左侧导航栏中选择“组件配置”。 在“组件配置”页面上方的下拉框中选择需要操作的组件。 单击“访问方式”模块中的“编辑”。 “从环境外部访问本组件”页面，选择“负载均衡配置”。 在负载均衡配置列表中选择待操作配置项，单击操作列“删除”。 在弹框中单击“是”，完成负载均衡配置删除。 图8 删除负载均衡配置 单击“确定”，完成访问方式配置确认。 使配置生效。 如已完成组件部署，单击页面上方“生效配置”。在右侧弹框中确认配置信息，并单击“确定”，使配置生效。 如未完成组件部署，单击页面上方“配置并部署组件”，在右侧弹框中单击“确定”待部署执行完成后，配置生效。

监控项 在“组件设置”页签下单击“监控项”，即可在列表中查看监控项、监控项名称、采集间隔等信息，并可根据需要执行以下操作，具体请参见表3。 表3 相关操作 操作 说明 启停监控项 单击列表中“监控项启停”列下的按钮，即可停用监控项。“监控项启停”按钮默认打开。 编辑监控项 单击列表中“操作”列下“编辑”，即可修改采集器的监控配置。 刷新监控项 在监控项列表右上角单击，可实时获取所有监控项的最新信息。

自定义设置 自定义设置页签包括关联日志服务设置、组件与基础设施关联分析设置、Profiler性能剖析配置。 关联日志服务设置 应用性能管理 （ APM ）与 云日志 服务（LTS）关联，您可以在 LTS中关联调用链的 TraceID 信息，当应用出现故障时，可以通过调用链的 TraceID 快速关联到业务日志，及时定位分析并解决问题。 关联业务日志与TraceId开关，开启后业务日志中会自动生成调用链的TraceId。如果关闭关联业务日志与TraceId开关，则关联日志服务设置不生效。 关联业务日志支持Log4j/Log4j2/Logback日志组件。 关联日志服务设置只支持java类型。 在“关联日志服务设置”表单中填写相关信息。 图3 关联日志服务设置 表1 关联日志服务设置参数说明 参数 说明 项目 在下拉菜单中选择项目。 日志组 日志组（LogGroup）是云日志服务进行日志管理的基本单位，可以创建日志流以及设置日志存储时间，每个账号下可以创建100个日志组。创建日志组详细操作参见日志组。 日志流 日志流（LogStream）是日志读写的基本单位，日志组中可以创建日志流，将不同类型的日志分类存储，方便对日志进一步分类管理。详细操作参见日志流。 单击“保存”，弹出“关联日志服务”提示框。 单击“确认”，关联成功。 单击“复用到其他组件”，弹出“复用到其他组件”选择框。 图4 复用到其他组件 选择一个或多个组件，单击“复用到其他组件”，则当前“关联日志服务”的配置，成功的复制到被选择的组件中。 组件与基础设施关联分析设置 在“组件与基础设施关联分析设置”表单中选择场景并选择需要存储的的普罗实例。 图5 组件与基础设施关联分析设置 针对容器场景，容器资源、容器中间件等指标存储在Prometheus for CCE类型的实例中。 如果需要关联分析，需要先在 AOM 中创建Prometheus for CCE实例并在Prometheus实例中一键接入容器监控。 针对虚机场景，虚机、虚机上的自建中间件等资源指标存储在Proomthous for E CS 类型的实例中。 如果需要关联分析，需要先在AOM中创建Prometheus for CCE实例并在AOM的采集管理,安装node-exporter或自建中间件。 单击“保存”，即可关联。 单击“复用到其他组件”，弹出“复用到其他组件”选择框。 图6 复用到其他组件 选择一个或多个组件，单击“复用到其他组件”，则当前“组件与基础设施关联分析设置”的配置，成功的复制到被选择的组件中。 Profiler性能剖析配置 在“Profiler性能剖析配置”表单中填写相关信息。 图7 Profiler性能剖析配置 表2 Profiler性能剖析配置说明 参数 说明 Profiler启停 打开后将低开销的对您应用进行持续诊断，解决Java程序中因为CPU、内存和时延导致的瓶颈问题。 开关默认为关闭，开关置灰。总开关关闭时，所有子开关都处于关闭状态。 CPU 开启后将采集应用运行过程中CPU火焰图信息。 开关默认为关闭，开关置灰。 内存 开启后将采集应用运行过程中堆内存火焰图信息。 开关默认为关闭，开关置灰。 时延 开启后将采集应用运行过程中时延火焰图信息。 开关默认为关闭，开关置灰。 生效范围 组件：组件级范围生效。该组件下关联的所有实例生成Profiler。 实例：实例级范围生效。仅所选实例生成Profiler，实例开启或离线后不会在新的实例生成profiler。开关默认为关闭，开关置灰。 单击“实例”。 单击“选择实例”，选择所需要的实例。 图8 选择实例 选择1个或多个实例后，单击“确定”，设置成功。 图9 选择需要的实例 注意： 如果选择了实例级范围生效，则不能复制到其他组件/环境。 “组件”和“实例”只能选择其中一项，不支持同时选择。 单击“保存”，提示保存成功。 单击“复用到其他组件”，弹出“复用到其他组件”选择框。 图10 复用到其他组件 选择一个或多个环境，单击“复用到其他环境”，则当前“Profiler性能剖析配置”信息，成功的复制到被选择的环境中。

VPN网关 权限 对应API接口 授权项（Action） 依赖的授权项 IAM 项目 (Project) 企业项目 (Enterprise Project) 创建VPN网关 POST /v5/{project_id}/vpn-gateways vpn:vpnGateways:create er:instances:list er:instances:get vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:list vpc:subnets:create vpc:subnets:delete vpc:subNetworkInterfaces:update vpc:publicIps:create vpc:publicIps:delete vpc:publicIps:update vpc:publicIps:get vpc:publicIps:list vpc:ports:create vpc:bandwidths:list vpc:ports:get vpc:routeTables:update vpc:routeTables:get √ √ 查询VPN网关 GET /v5/{project_id}/vpn-gateways/{vgw_id} vpn:vpnGateways:get vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list er:instances:list er:instances:get vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:list √ √ 查询VPN网关列表 GET /v5/{project_id}/vpn-gateways vpn:vpnGateways:list vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list er:instances:list er:instances:get vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:list √ × 更新VPN网关 PUT /v5/{project_id}/vpn-gateways/{vgw_id} vpn:vpnGateways:update er:instances:list er:instances:get vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:list vpc:subnets:delete vpc:subNetworkInterfaces:update vpc:publicIps:delete vpc:publicIps:update vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list vpc:ports:get vpc:routeTables:update vpc:routeTables:get √ √ 删除VPN网关 DELETE /v5/{project_id}/vpn-gateways/{vgw_id} vpn:vpnGateways:delete er:instances:list er:instances:get vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:subnets:delete vpc:subNetworkInterfaces:update vpc:publicIps:delete vpc:publicIps:update vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list vpc:ports:get vpc:routeTables:update vpc:routeTables:get √ √ 查询VPN网关可用区 GET /v5/{project_id}/vpn-gateways/availability-zones vpn:vpnGatewayAvailabilityZone - √ √ 导入VPN网关证书 POST /v5/{project_id}/vpn-gateways/{vgw_id}/certificate vpn:vpnGateways:importCertificate - √ √ 查询VPN网关证书 GET /v5/{project_id}/vpn-gateways/{vgw_id}/certificate vpn:vpnGateways:getCertificate - √ √ 更新VPN网关证书 PUT /v5/{project_id}/vpn-gateways/{vgw_id}/certificate/{certificate_id} vpn:vpnGateways:updateCertificate - √ √ 父主题： 站点入云VPN授权项列表

VPN网关 权限 对应API接口 授权项（Action） 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 订购包周期终端入云VPN网关 POST /v5/{project_id}/p2c-vpn-gateways/subscribe/{order_id} vpn:p2cVpnGateway:subscribe vpn:p2cVpnGateway:listAvailabilityZones vpc:vpcs:list vpc:subnets:get vpc:bandwidths:list vpc:publicIps:create vpc:publicIps:delete vpc:publicIps:update vpc:publicIps:list √ × 变更包周期 VPN网关规格 PUT /v5/{project_id}/p2c-vpn-gateways/update-specification/{order_id} vpn:p2cVpnGateway:updateSpecification - √ × 更新终端入云VPN网关 PUT /v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id} vpn:p2cVpnGateway:update vpc:publicIps:create vpc:publicIps:delete vpc:publicIps:update vpc:publicIps:get vpc:publicIps:list vpc:bandwidths:list √ × 查询终端入云VPN网关详情 GET /v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id} vpn:p2cVpnGateway:get vpc:publicIps:get √ × 查询终端入云VPN网关列表 GET /v5/{project_id}/p2c-vpn-gateways vpn:p2cVpnGateway:list vpc:publicIps:get √ × 查询终端入云VPN连接列表 GET /v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}/connections vpn:p2cVpnGateway:listConnections vpc:publicIps:get √ × 父主题： 终端入云VPN授权项列表

URI GET /v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}/connections 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID，可以通过获取项目ID获取项目ID p2c_vgw_id String 是 P2C VPN网关实例ID 表2 请求Query参数列表 名称 类型 是否必选 描述 limit Integer 否 分页查询时每页返回的记录数量 offset Integer 否 分页查询的偏移量

请求消息 请求参数 无。 请求样例 1.不分页查询连接列表。 GET https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}/connections 2.分页查询连接列表。 GET https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}/connections?limit=10&offset=0

URI DELETE /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/access-policies/{policy_id} 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID，可以通过获取项目ID获取项目ID。 vpn_server_id String 是 VPN服务端ID policy_id String 是 访问策略ID

URI POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id}/add-users 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID，可以通过获取项目ID获取项目ID vpn_server_id String 是 VPN服务端ID group_id String 是 VPN用户组ID

请求消息 请求参数 表2 请求参数 名称 类型 是否必选 描述 users Array of OpVpnUser objects 是 VPN用户列表 表3 OpVpnUser 名称 类型 是否必选 描述 id String 是 功能描述：VPN用户ID 格式：36位UUID 请求样例 POST https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id}/add-users { "users": [ { "id": "41ad472e-d3e4-482b-8f00-7b2c1bfc4b7d" }, { "id": "a609eecb-3fa6-4d6d-a8c3-256a12d02b6c" } ] }

响应消息 响应参数 返回状态码为 200: 查询成功。 表2 响应Body参数列表 名称 类型 描述 vpn_servers Array of ShowServerResponse objects 服务端列表 request_id String 请求id 表3 ShowServerResponse 名称 类型 描述 id String 功能说明：VPN服务端 ID 格式：36位UUID p2c_vgw_id String 功能说明：P2C VPN网关ID 格式：36位UUID client_cidr String 功能说明：客户端网段。客户端建立连接时，会从该网段分配一个虚拟IP地址 格式："点分十进制/掩码"格式，例如192.168.1.0/24 local_subnets Array of strings 功能说明：本端网段列表 格式："点分十进制/掩码"格式，例如10.10.1.0/24 client_auth_type String 功能说明：客户端认证类型 取值范围： CERT：证书认证 LOCAL_PASSWORD：口令认证（本地） tunnel_protocol String 功能说明：隧道协议类型。 取值范围 SSL：SSL协议 server_certificate server_certificate object 服务端证书 client_ca_certificates Array of QueryClientCaCertificateBody objects 客户端CA证书列表，用于对客户端证书进行认证 ssl_options ssl_options object SSL隧道协议的可选配置项 status String 功能说明：服务端状态 取值范围： PENDING_CREATE：创建中 PENDING_UPDATE：更新中 ACTIVE：正常 FAULT：异常 FROZEN：冻结 created_at String 功能说明：创建时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ updated_at String 功能说明：最后更新时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ 表4 server_certificate 名称 类型 描述 id String 证书ID，为CCM( 云证书管理服务 )中已上传证书的证书ID。若证书在CCM中被删除后，该ID为空 name String 证书名，为CCM( 云证书管理 服务)中已上传证书的证书名 issuer String 功能说明：证书颁发者。 取值范围：1-256个字符。 subject String 功能说明：证书使用者。 取值范围：1-256个字符。 serial_number String 功能说明：证书序列号。 取值范围：1-64个字符。 expiration_time String 功能说明：到期时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ signature_algorithm String 功能说明：证书签名算法。 取值范围：1-64个字符。 表5 QueryClientCaCertificateBody 名称 类型 描述 id String 功能说明：证书ID 格式：36位UUID name String 功能说明：证书名称。 取值范围：1-64个字符、支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线) issuer String 功能说明：证书颁发者。 取值范围：1-256个字符。 subject String 功能说明：证书使用者。 取值范围：1-256个字符。 serial_number String 功能说明：CA证书序列号。 取值范围：1-64个字符。 expiration_time String 功能说明：证书到期时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ signature_algorithm String 功能说明：证书签名算法。 取值范围：1-64个字符。 created_at String 功能说明：创建时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ updated_at String 功能说明：最后更新时间 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ 表6 ssl_options 名称 类型 描述 protocol string 功能说明：协议 取值范围： TCP port integer 功能说明：端口 取值范围： 443 1194 encryption_algorithm string 功能说明：加密算法 取值范围： AES-128-GCM AES-256-GCM authentication_algorithm string 功能说明：认证算法 取值范围： SHA256 SHA384 is_compressed boolean 功能说明：是否压缩，默认否 取值范围： true false 响应样例 { "vpn_servers": [ { "id": "2407a20d-0bf7-4530-ba9a-7ffa0cedfa3b", "p2c_vgw_id": "3b5b64e4-2927-4062-acf6-05b0b842bbfe", "client_cidr": "1.1.0.0/16", "local_subnets": [ "192.168.12.0/24", "192.168.1.0/24" ], "client_auth_type": "LOCAL_PASSWORD", "tunnel_protocol": "SSL", "server_certificate": { "id": "scs1716171403922", "name": "lsh-newcert", "issuer": "C=CN,ST=beijing,L=haidian,O=lesaas,OU=root,CN=www.***.com", "subject": "C=CN,ST=beijing,L=haidian,O=server,OU=server,CN=www.***.com", "serial_number": "310325804134830162280305057622726926320418980636", "expiration_time": "2024-06-19T02:15:26Z", "signature_algorithm": "SHA256WITHRSA" }, "client_ca_certificates": [], "ssl_options": { "protocol": "TCP", "port": 443, "encryption_algorithm": "AES-128-GCM", "authentication_algorithm": "SHA256", "is_compressed": false }, "status": "ACTIVE", "created_at": "2024-06-14T01:14:56.802Z", "updated_at": "2024-06-14T08:53:22.855Z" } ], "request_id": "3378c265585ffb8aac68ec39a2db67a1" }

VPN标签 权限 对应API接口 授权项（Action） 依赖的授权项 IAM项目（Project） 企业项目（Enterprise Project） 创建资源标签 POST /v5/{project_id}/{resource_type}/{resource_id}/tags/create vpn:resourceInstanceTags:create - √ x 删除资源标签 POST /v5/{project_id}/{resource_type}/{resource_id}/tags/delete vpn:resourceInstanceTags:delete - √ x 查询资源类型标签列表 GET /v5/{project_id}/{resource_type}/tags vpn:resourceTypeTags:list - √ x 查询资源实例列表 POST /v5/{project_id}/{resource_type}/resource-instances/filter vpn:resourceInstances:list - √ x 查询资源标签列表 GET /v5/{project_id}/{resource_type}/{resource_id}/tags vpn:resourceInstanceTags:list - √ x 查询资源实例数量 POST /v5/{project_id}/{resource_type}/resource-instances/count vpn:resourceInstances:count - √ x 父主题： 服务公共接口授权项列表

VPN连接监控 权限 对应API接口 授权项（Action） 依赖的授权项 IAM项目（Project） 企业项目（Enterprise Project） 创建连接监控 POST /v5/{project_id}/connection-monitors vpn:connectionMonitors:create - √ x 查询连接监控列表 GET /v5/{project_id}/connection-monitors vpn:connectionMonitors:list - √ x 删除连接监控 DELETE /v5/{project_id}/connection-monitors/{connection_monitor_id} vpn:connectionMonitors:delete - √ x 查询连接监控 GET /v5/{project_id}/connection-monitors/{connection_monitor_id} vpn:connectionMonitors:get - √ x 父主题： 站点入云VPN授权项列表

访问策略 权限 对应API接口 授权项（Action） 依赖的授权项 IAM项目（Project） 企业项目（Enterprise Project） 创建VPN访问策略 POST /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/access-policies vpn:p2cVpnGateway:createAccessPolicy - √ x 查询VPN访问策略列表 GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/access-policies vpn:p2cVpnGateway:listAccessPolicies - √ x 修改VPN访问策略 PUT /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/access-policies/{policy_id} vpn:p2cVpnGateway:updateAccessPolicy - √ x 查询VPN访问策略 GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/access-policies/{policy_id} vpn:p2cVpnGateway:getAccessPolicy - √ x 删除VPN访问策略 DELETE /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/access-policies/{policy_id} vpn:p2cVpnGateway:deleteAccessPolicy - √ x 父主题： 终端入云VPN授权项列表

URI DELETE /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/client-ca-certificates/{client_ca_certificate_id} 表1 参数说明 名称 类型 是否必选 描述 project_id String 是 项目ID，可以通过获取项目ID获取项目ID。 vpn_server_id String 是 VPN服务端ID client_ca_certificate_id String 是 客户端CA证书ID