华为云用户手册

超高I/O型aI7 概述 aI7型弹性云服务器搭载新一代可扩展处理器，配备大容量高性能NVMe SSD本地盘，提供高存储IOPS以及低读写时延。 使用须知 请参考使用须知。 适用场景 超高I/O型实例适用于高性能关系型数据库 NoSQL数据库(Cassandra、MongoDB等)以及ElasticSearch搜索等场景 规格 表4 aI7型弹性云服务器的规格 规格名称 vCPU 内存 （GiB） 最大带宽/基准带宽 （Gbps） 最大收发包能力 （万PPS） 网卡多队列数 网卡个数上限 辅助网卡个数上限 本地盘 （GiB） 虚拟化类型 ai7.2xlarge.8 8 64 4/2.5 100 8 8 64 1 × 1600GiB NVMe KVM ai7.4xlarge.8 16 128 8/5 200 16 8 128 2 × 1600GiB NVMe KVM ai7.8xlarge.8 32 256 15/8 300 16 8 256 4 × 1600GiB NVMe KVM ai7.12xlarge.8 48 384 22/12 400 16 8 256 6 × 1600GiB NVMe KVM ai7.16xlarge.8 64 512 28/16 550 24 12 256 8 × 1600GiB NVMe KVM ai7.24xlarge.8 96 768 40/25 800 24 12 256 12 × 1600GiB NVMe KVM

超高I/O型实例类型总览 超高I/O型弹性云服务器使用高性能NVMe SSD本地磁盘，提供高存储IOPS以及低读写时延，您可以通过管理控制台创建挂载有高性能NVMe SSD盘的弹性云服务器。 在售：Ir3、I3、Ir7、I7、aI7、Ir7n、I7n 表1 超高I/O型实例特点 规格名称 计算 磁盘类型 网络 超高I/O型Ir7 CPU/内存配比：1:4 vCPU数量范围：2-64 处理器：第三代英特尔® 至强® 铂金® 可扩展处理器 基频/睿频：3.0GHz/3.5GHz 支持开启/关闭超线程功能，详细内容请参见开启/关闭超线程 高IO 通用型SSD 超高IO 极速型SSD 通用型SSD V2 支持IPv6 超高网络收发包能力 实例网络性能与计算规格对应，规格越高网络性能越强 最大网络收发包：600万PPS 最大内网带宽：40Gbps 超高I/O型I7 CPU/内存配比：1:4 vCPU数量范围：8-96 处理器：第三代英特尔® 至强® 铂金® 可扩展处理器 基频/睿频：3.0GHz/3.5GHz 支持开启/关闭超线程功能，详细内容请参见开启/关闭超线程 高IO 通用型SSD 超高IO 极速型SSD 通用型SSD V2 支持IPv6 超高网络收发包能力 实例网络性能与计算规格对应，规格越高网络性能越强 最大网络收发包：800万PPS 最大内网带宽：40Gbps 超高I/O型aI7 CPU/内存配比：1:8 vCPU数量范围：8-96 基频/睿频：2.45GHz/3.5GHz 支持开启/关闭超线程功能，详细内容请参见开启/关闭超线程 高IO 通用型SSD 超高IO 极速型SSD 通用型SSD V2 支持IPv6 超高网络收发包能力 实例网络性能与计算规格对应，规格越高网络性能越强 最大网络收发包：800万PPS 最大内网带宽：40Gbps 超高I/O型Ir7n CPU/内存配比：1:4 vCPU数量范围：2-64 处理器：第三代英特尔® 至强® 可扩展处理器 基频/睿频：2.6GHz/3.5GHz 高IO 通用型SSD 超高IO 极速型SSD 支持IPv6 超高网络收发包能力 实例网络性能与计算规格对应，规格越高网络性能越强 最大网络收发包：600万PPS 最大内网带宽：40Gbps 超高I/O型I7n CPU/内存配比：1:4 vCPU数量范围：8-96 处理器：第三代英特尔® 至强® 可扩展处理器 基频/睿频：2.6GHz/3.5GHz 高IO 通用型SSD 超高IO 极速型SSD 通用型SSD V2 支持IPv6 超高网络收发包能力 实例网络性能与计算规格对应，规格越高网络性能越强 最大网络收发包：800万PPS 最大内网带宽：40Gbps 超高I/O型Ir3 CPU/内存配比：1:4 vCPU数量范围：2-32 处理器：第二代英特尔® 至强® 可扩展处理器 基频/睿频：2.6GHz/3.5GHz 高IO 通用型SSD 超高IO 极速型SSD 通用型SSD V2 超高网络收发包能力 实例网络性能与计算规格对应，规格越高网络性能越强 最大网络收发包：450万PPS 最大内网带宽：30Gbps 超高I/O型I3 CPU/内存配比：1:8 vCPU数量范围：8-64 处理器：英特尔® 至强® 可扩展处理器 基频/睿频：3.0GHz/3.4GHz 高IO 通用型SSD 超高IO 极速型SSD 通用型SSD V2 超高网络收发包能力 实例网络性能与计算规格对应，规格越高网络性能越强 最大网络收发包：500万PPS 最大内网带宽：25Gbps

超高I/O型Ir7 概述 Ir7型弹性云服务器搭载第三代英特尔® 至强® 可扩展处理器，配备2块容量较小的高性能NVMe SSD本地盘，提供高存储IOPS以及低读写时延。 使用须知 请参考使用须知。 适用场景 适用于高性能关系型数据库。 NoSQL数据库(Cassandra、MongoDB等)。 ElasticSearch搜索等场景。 规格 表2 Ir7型弹性云服务器的规格 规格名称 vCPU 内存 （GiB） 最大带宽/基准带宽 （Gbps） 最大收发包能力 （万PPS） 网卡多队列数 网卡个数上限 本地盘 （GiB） 虚拟化类型 ir7.large.4 2 8 3/0.8 40 2 3 2 × 50 KVM ir7.xlarge.4 4 16 6/1.5 80 2 3 2 × 100 KVM ir7.2xlarge.4 8 32 15/3.1 150 4 4 2 × 200 KVM ir7.4xlarge.4 16 64 20/6.2 300 4 6 2 × 400 KVM ir7.8xlarge.4 32 128 30/12 400 8 8 2 × 800 KVM ir7.16xlarge.4 64 256 40/25 600 16 8 2 × 1600 KVM

功能 FPGA开发套件 FPGA云服务提供硬件开发套件 (HDK）。HDK包括加速器示例、编码环境、仿真平台、自动化编译工具、代码加密和调试工具包等必备工具。您可以参照应用示例和用户开发指导手册，迅速开发和测试您的FPGA硬件加速器。 应用开发套件 FPGA云服务提供应用开发套件 (SDK）。SDK包括应用示例、硬件抽象接口、加速器抽象接口、加速器驱动和runtime、版本管理工具等必备工具。通过加速器抽象接口实现硬件加速器和驱动的透明化，您的应用即可像调用软件函数库一样调用硬件加速器，让您方便快捷的开发基于硬件加速器的高性能应用。 FPGA硬件配置 每个FPGA云服务器最大提供8片FPGA，每片FPGA包含约250万逻辑单元。支持PCIe 3.0 x16接口，吞吐量高达100Gbps；FPGA之间提供高达300Gbps的Mesh光互连网络；每片提供64GiB的DDR4，接口速率高达2133MHz。让您的应用不再受限硬件配置。 硬件加速器资源池 FPGA云服务的硬件加速资源以池化的形式呈现，像分配CPU资源一样，按照您的需求分配最合适、最经济的FPGA资源。通过FPGA虚拟化技术、隔离技术和分布式技术，可以实现节点内FPGA资源的共享，而这一切对您的业务都是透明的，从而最大化满足您业务的硬件加速需求。

使用场景 应用： 视频处理、机器学习、基因组学研究、金融风险分析 场景特点： 适合密集计算、高并发、高带宽场景。 适用场景： 视频处理：图片自动分类识别、图片搜索、视频转码、实时渲染、互联网直播和AR/VR等视频应用，需要大量的实时计算能力，普通的云服务器难以满足性能需求，FPGA云服务器可以提供高性价比的视频解决方案，是视频类场景的理想选择。 机器学习：机器学习中多层神经网络需要大量计算资源，其中训练过程需要处理海量的数据，推理过程则希望极低的时延。同时机器学习算法还在不断优化中， FPGA以其高并行计算、硬件可编程、低功耗、和低时延等优势，可针对不同算法动态编程设计最匹配的硬件电路，满足机器学习中海量计算和极低时延的要求。因此，FPGA在满足机器学习的硬件需求上提供极具吸引力的替代方案。 基因组学研究：通过基因测序和分析、生物和医疗信息等海量数据的快速分析，可实现精准医疗；同时在药物研发、分子育种等领域都有海量数据的处理，该领域需要硬件加速来解决生物计算量的性能瓶颈。FPGA云服务器提供的强大的可编程的硬件计算能力可以很好满足海量生物数据快速计算的需求。 金融风险分析：金融行业对计算能力、基于超低时延和高吞吐能力的及时响应有很高的要求，比如基于 定价 树模型的金融计算、高频金融交易、基金/证券交易算法、金融风险分析和决策、交易安全保证等，FPGA云服务通过可编程的硬件加速技术，可以针对各种场景的提供硬件加速解决方案，部分场景可以提供相比纯软件百倍的性能改善。

规格 表1 高性能架构弹性云服务器的规格 规格名称 vCPU 内存 （GiB） 最大带宽/基准带宽 （Gbps） 最大收发包能力 （万PPS） 网卡多队列数 FPGA 虚拟化类型 fp1.2xlarge.11 8 88GiB 5/1.3 20 2 1×VU9P KVM fp1.8xlarge.11 32 352GiB 10/5 60 8 4×VU9P KVM fp1.16xlarge.11 64 704GiB 10/10 100 8 8×VU9P KVM fp1.8xlarge.8 32 224GiB 10/5 60 8 1×VU9P KVM fp1.16xlarge.8 64 448GiB 10/10 100 8 2×VU9P KVM 网络类型：10GbE 表2 通用型架构弹性云服务器的规格 规格名称 vCPU 内存 （GiB） 最大带宽/基准带宽 （Gbps） 最大收发包能力 （万PPS） 网卡多队列数 FPGA 虚拟化类型 fp1c.2xlarge.11 8 88GiB 5/1.3 20 2 1×VU9P KVM fp1c.8xlarge.11 32 352GiB 10/5 60 8 4×VU9P KVM fp1c.16xlarge.11 64 704GiB 10/10 100 8 8×VU9P KVM fp1c.8xlarge.8 32 224GiB 10/5 60 8 1×VU9P KVM fp1c.16xlarge.8 64 448GiB 10/10 100 8 2×VU9P KVM 网络类型：10GbE

概述 FPGA加速云服务器（FPGA Accelerated Cloud Server，FA CS ）提供FPGA开发和使用的工具及环境，让用户方便地开发FPGA加速器和部署基于FPGA加速的业务，为您提供易用、经济、敏捷和安全的FPGA云服务。 FPGA加速云服务器包括两类： 高性能架构 基于DPDK的高性能交互框架，支持流计算模型，支持数据流并发，主要用于RTL开发场景，满足用户高带宽低时延的要求。 通用型架构 基于SDAccel的通用型交互框架，支持块计算模块，支持Xilinx SGDMA数据传输框架，主要用于高级语言开发或已有算法移植，满足用户快速上线的需求。

云服务器备份与云硬盘备份 目前弹性云服务器备份可以通过“云服务器备份”和“云硬盘备份”功能实现： 云服务器备份（推荐）：如果是对弹性云服务器中的所有云硬盘（系统盘和数据盘）进行备份，推荐使用云服务器备份功能，同时对所有云硬盘进行备份，避免因备份创建时间差带来的数据不一致问题。 云硬盘备份：如果对指定的单个或多个云硬盘（系统盘或数据盘）进行备份，推荐使用云硬盘备份功能，在保证数据安全的同时降低备份成本。 表1 云服务器备份与云硬盘备份 对比维度 云服务器备份 云硬盘备份 备份/恢复对象 服务器中的所有云硬盘（系统盘和数据盘）。 指定的单个或多个磁盘（系统盘或数据盘）。 推荐场景 需要对整个云服务器进行保护。 系统盘没有个人数据，因而只需要对部分的数据盘进行备份。 优势 备份的同一个服务器下的所有磁盘数据具有一致性，即同时对所有云硬盘进行备份，不存在因备份创建时间差带来的数据不一致问题。 保证数据安全的同时降低备份成本。

创建巡检计划 步骤1：巡检路线添加，点击运维管理、巡检管理、配置管理、巡检路线，点击详情可查看该路线巡检点位、说明等。可修改或删除该巡检路线。点击添加维修工单。 步骤2：填写巡检路线名称，点击巡检路线设定分级点开，将要巡检的点位依次打钩、点击提交。 注：左侧打钩，右侧也需打钩。顺序是按照打钩顺序依次向下排。 步骤3：创建工单，点击运维管理，点击工单管理，右上角创建保修，输入工单标题，选择工单等级，选择故障时间，选择故障位置，选择审核部门，选择关联资产，填写报修描述，提交即可 步骤4：创建巡检计划，点击运维管理，点击计划管理，点击巡检管理，点击巡检计划，右上角添加工单。输入巡检名称，选择巡检等级，选择任务开始时间、结束时间。选择负责人（巡检人），检查人以巡检内容，点击确定即可。 注：需提前3天创建，如当日创建完成，第三天会推送到工单。 步骤6：添加巡检点，点击运维管理，点击巡检管理，点击配置管理，点击巡检点，右上角添加巡检点。填写巡检点名称，选择巡检区域，描述及关联图形。点击提交即可。 父主题： 运维管理功能

修订记录 遵从公有云租户侧文档修订记录写作要求。 格式：使用附录节点新建修订记录。 内容： 产品的变更导致的文档变化 针对产品变更导致的功能变化、特性变化、产品规格变更等，导致解决方案实践刷新，需要简要说明变更内容，并根据需要提供相应的1个或多个超链接。 文档本身的变化 对于章节变化和调整、批量处理（如样例刷新）等用户感知明显的内容，需要在变更记录中明确描述变化，且描述易于理解。 对于错别字修改等低级问题的修改，不需要呈现。对于客户提的低级问题，通过客服团队等方式进行答复，不需要呈现。 【样例】 发布日期 修订记录 2022-04-20 第二次正式发布。 在XXX章节中，增加XXX说明。 在XXX章节中，修改XXX参数。 2022-03-01 第一次正式发布。

背景信息 低碳智慧园区可视化运营管理平台解决方案是一种全面的能源管理解决方案，旨在为园区提供实时、准确、完整的能耗数据支持，并帮助实现节能降本增效。该方案集成了数据采集、实时监控、能耗分析、安全告警、运维管理等多种功能，为园区的低碳化、智能化运营提供全方位的支持。 方案能够满足园区用户的如下需求： 数据采集：通过智能化的数据采集系统，实时监测园区内的能源使用情况，包括电力、燃气、水等，确保数据的实时性和准确性。 实时监控：通过物联网技术，对园区内的能源设备进行实时监控，及时发现异常情况，并采取相应的处理措施，确保能源设备的正常运行。 能耗分析：对采集到的能源数据进行深入分析，提供能耗报表和趋势分析，帮助园区管理者了解能源使用情况，为节能降本增效提供数据支持。 安全告警：设定安全阈值，对超出阈值的能源使用情况进行告警，及时发现并处理能源安全问题，避免能源浪费和事故发生。 运维管理：提供完善的运维管理功能，包括设备维护、巡检、维修等，确保能源设备的稳定运行和延长使用寿命。 大数据看板：通过大数据技术，将采集到的能源数据以可视化的方式呈现给管理者，帮助其全面了解园区的能源使用情况。 智能设备：接入智能电表、水表、断路器、空调等各类设备，支持自动抄表、远程控制，降低人工抄表和运维管理难题。 用能统计：用电、用水等每月用能报表分析，自动输出费用账单，帮助管理员进行用能对账结算。 智能预警：实时监控能源设备的运行状态和能耗情况，发现异常或潜在问题时及时发出预警通知，确保园区能源系统的稳定运行。 跨部门、跨行业综合协调和管理：实现园区内各部门和行业之间的信息共享和协同工作，提高园区的综合管理和服务水平。 总之，该方案通过智能化的管理和技术创新为园区的低碳化、智能化运营提供了全面的解决方案，帮助园区实现节能降本增效和可持续发展。 低碳智慧园区可视化运营管理平台解决方案创造的价值体现主要体现在以下几个方面： 提高能源利用效率：通过智能化的数据采集和监控系统，可以实时了解园区的能源使用情况，对能源浪费进行及时干预和调整，有效提高能源利用效率。 降低运营成本：通过对能源数据的分析和优化，可以合理调配和管理能源资源，减少能源浪费和成本支出，从而降低园区的运营成本。 促进绿色低碳发展：该方案强调低碳、环保的理念，通过智能化的能源管理，减少碳排放和环境污染，推动园区的绿色低碳发展。 提高管理效率：通过自动化的数据采集和分析，可以减少人工干预和巡检工作量，提高管理效率和管理精度。 增强安全性：实时监控能源设备的运行状态和能耗情况，及时发现异常和潜在问题，避免能源安全事故的发生，保障园区的安全稳定运行。 优化资源配置：通过对能源数据的分析和预测，可以对园区的能源需求进行精准预测和管理，优化资源配置，提高园区的资源利用效率。 推动数字化转型：该方案强调数字化、智能化的发展趋势，通过智能化的能源管理，推动园区的数字化转型和管理升级。 提升企业形象：实现低碳、环保的能源管理，有助于提升企业的社会形象和品牌价值。 创造经济价值：通过节能降本增效和优化资源配置等措施，可以为园区创造更多的经济价值和发展机会。 实现可持续发展：该方案强调可持续发展理念，通过智能化的能源管理和技术创新，推动园区的可持续发展和长期竞争力提升。 综上所述，低碳智慧园区可视化运营管理平台方案创造的价值体现是多方面的，既包括经济效益的提升，也包括社会效益和环境效益的改善，对于推动园区的数字化转型和可持续发展具有重要意义。 父主题： 附录

常见问题 低碳智慧园区可视化运营管理平台的常见问题包括以下几个方面： 数据集成问题：在低碳智慧园区运营管理平台的建设中，数据的集成是一个常见问题。由于园区内各个系统和设备的数据格式、通信协议等可能存在差异，如何实现数据的统一采集、处理和分析是一个需要解决的难题。 技术应用难题：低碳智慧园区运营管理平台涉及的技术领域广泛，包括物联网、大数据、人工智能等。在应用这些先进技术时，可能会遇到技术门槛高、实施难度大等问题，需要专业的技术团队进行支持和指导。 信息安全风险：智慧园区运营管理平台涉及大量的数据交换和信息处理，如何确保数据的安全性和隐私保护是一个重要问题。必须采取有效的安全防护措施，防止数据泄露和信息安全事件的发生。 用户体验优化：低碳智慧园区运营管理平台的使用者包括园区管理者、企业员工等各方利益相关者。如何提供友好的用户界面和便捷的操作体验，以满足不同用户的需求，是一个需要关注的问题。 运维与升级问题：低碳智慧园区运营管理平台的运维和升级是确保平台稳定运行和持续优化的关键环节。在运行过程中，可能会遇到设备故障、系统漏洞等问题，需要有完善的运维体系和升级机制来保障平台的正常运行。 法规与政策支持：低碳智慧园区的建设和管理涉及到相关法规和政策的支持。需要密切关注政策动态，确保方案的实施符合法规要求，并充分利用政策优惠和扶持措施。 针对这些问题，可以通过加强技术研发、建立完善的数据安全体系、优化用户体验设计、制定科学的运维与升级计划以及加强与政府部门的沟通合作等措施来解决。通过不断完善和改进低碳智慧园区运营管理平台方案，可以推动园区的可持续发展和创新能力提升。 父主题： 附录

响应示例 状态码： 200 OK [ { "publisher_unique_id" : "b9fc8fb6d9194536ac66dd74c2212126", "user_id" : "847a5317086c41798469d0868535943a", "tenant_id" : "ce8df55870164338a72d7e828a966a2a", "description" : "这里是描述", "logo_url" : "/api/v1/ce8df55870164338a72d7e828a966a2a/common/get-plugin-icon?object_key=default-cfb6036d13404631a04a5e7f3a5899b2-kubernetes.png-ce8df55870164338a72d7e828a966a2a&icon_type=publish", "website" : "https://tinydesign.cloudbu.huawei.com/rp/team/ptnixbayoz", "support_url" : "5555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555", "source_url" : "", "en_name" : "kejiyouxiangongsi", "name" : "杭州XXX科技有限公司", "auth_status" : "accept", "is_delete" : 0, "last_update_user_name" : "devcloud_devcloud_h00485561_01", "last_update_user_id" : "847a5317086c41798469d0868535943a", "last_update_time" : "2023-02-21T09:22:34.528" } ]

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of PublisherVO objects OK 表4 PublisherVO 参数 参数类型 描述 publisher_unique_id String 发布商ID user_id String 用户ID tenant_id String 租户ID description String 描述 logo_url String 图标URL website String 网页地址 support_url String 地址 source_url String 地址 en_name String 英文名 name String 名称 auth_status String 授权状态 is_delete Integer 是否删除 last_update_user_name String 最后更新人 last_update_user_id String 最后更新人ID last_update_time String 最后更新时间 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 group_id 是 String 分组ID pipelines 是 Array of pipelines objects 流水线集合 表4 pipelines 参数 是否必选 参数类型 描述 pipeline_id 是 String 流水线ID pipeline_name 是 String 流水线名

响应示例 状态码： 200 OK [ { "code" : "success", "pipeline_id" : "1ae88404911a4513bcdf8158ab6a0416", "pipeline_name" : "sdfgsdfgdfsg345345" }, { "code" : "success", "pipeline_id" : "b99de7c698264251ac1fc3c053dc2b34", "pipeline_name" : "32131233131025122241" } ]

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 [数组元素] Array of PipelineMoveToGroupResponseVo objects OK 表6 PipelineMoveToGroupResponseVo 参数 参数类型 描述 code String 响应码 ["failed", "success"] pipeline_id String 流水线ID pipeline_name String 流水线名 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码

请求示例 POST https://{endpoint}/v5/d80a8a6530324b7bac972cbb8a9f28ec/api/pipeline-group/pipeline/move { "group_id" : "2ca78947b25847a9ab68a07d8ef1347b", "pipelines" : [ { "pipeline_id" : "1ae88404911a4513bcdf8158ab6a0416", "pipeline_name" : "sdfgsdfgdfsg345345" }, { "pipeline_id" : "b99de7c698264251ac1fc3c053dc2b34", "pipeline_name" : "32131233131025122241" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 模板名称 description 否 String 模板描述 language 是 String 模板语言 variables 否 CustomVariable object 自定义参数 definition 是 String 模板编排json，包含stages is_system 是 Boolean 是否系统模板 domain_id 是 String 所属租户ID is_show_source 是 Boolean 是否显示流水线源 表4 CustomVariable 参数 是否必选 参数类型 描述 pipeline_id 否 String 流水线ID name 否 String 自定义参数名称 sequence 否 Integer 自定义参数顺序 type 否 String 自定义参数类型 value 否 String 自定义参数默认值 is_secret 否 Boolean 是否私密参数 description 否 String 自定义参数描述 is_runtime 否 Boolean 是否运行时设置 limits 否 Array of objects 限制 is_reset 否 Boolean 是否重置 latest_value 否 String 最近一次参数值 runtime_value 否 String 运行时传入值

请求示例 POST https://{endpoint}/v5/ce8df55870164338a72d7e828a966a2a/api/pipeline-templates { "name" : "新建流水线模板-20231023215133", "description" : "", "language" : "none", "is_show_source" : true, "variables" : [ ], "definition" : "{\"stages\":[{\"name\":\"阶段_1\",\"sequence\":\"0\",\"jobs\":[{\"stage_id\":1698069093677,\"identifier\":\"16980691185419778b0f5-02cd-4bd3-a8cc-da825644add1\",\"name\":\"CodeCheck中文名称\",\"depends_on\":[],\"timeout\":\"\",\"timeout_unit\":\"\",\"steps\":[{\"name\":\"CodeCheck中文名称\",\"task\":\"official_devcloud_codeCheck_template\",\"sequence\":0,\"inputs\":[{\"key\":\"language\",\"value\":\"Java\"},{\"key\":\"module_or_template_id\",\"value\":\"d7dffaefb6d94c63a09cf141668356c7\"}],\"business_type\":\"Gate\",\"runtime_attribution\":\"agent\",\"identifier\":\"16980691136015f94b249-102d-44f2-abb5-02fa3ad9fae0\",\"multi_step_editable\":0,\"official_task_version\":\"0.0.1\"}],\"resource\":\"{\\\"type\\\":\\\"system\\\",\\\"arch\\\":\\\"x86\\\"}\",\"condition\":\"completed()\",\"exec_type\":\"OCTOPUS_JOB\",\"sequence\":0}],\"identifier\":\"16980690936778259e2a5-a97e-4c66-af8d-1908988c1c21\",\"pre\":[{\"task\":\"official_devcloud_autoTrigger\",\"sequence\":0}],\"post\":null,\"depends_on\":[],\"run_always\":false}]}", "domain_id" : "ce8df55870164338a72d7e828a966a2a", "is_system" : false }

URI GET /v2/{project_id}/rule-sets/query 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0 limit 是 Integer 每页显示的条目数量 include_tenant_rule_set 是 Boolean 是否包含租户级规则 name 否 String 策略名称，用于模糊查询 is_valid 否 Boolean 是否有效 type 否 String 规则集类型

响应示例 状态码： 200 OK { "data" : [ { "id" : "98183e0e70634f4d99da7dc549496652", "name" : "创建策略-20230915203425", "level" : "project", "is_valid" : true, "version" : "82ed35e3ecd041ebace8d62347042368", "operator" : "devcloud_xxx", "is_public" : false, "operate_time" : 1694781278000 }, { "id" : "becbd00aa13147c6a226283a4bad57e0", "name" : "创建策略-20230817183223", "level" : "project", "is_valid" : true, "version" : "e3cc0a3df511486ea36bdcb46df724f8", "operator" : "devcloud_xxx", "is_public" : false, "operate_time" : 1693900336000 }, { "id" : "52b24f9add844832a2af11f2e760c730", "name" : "codecheck-copy", "level" : "project", "is_valid" : true, "version" : "a2e50e1972f348e0838679eabe0b4467", "operator" : "devcloud_xxx", "is_public" : false, "operate_time" : 1693900325000 }, { "id" : "d899845c2eff4fa18860fa4b31c5ee31", "name" : "codecheck", "level" : "project", "is_valid" : true, "version" : "20f79c6ff8844f5391882d7b3497761b", "operator" : "devcloud_xxx", "is_public" : false, "operate_time" : 1693300726000 } ], "total" : 4 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of RuleSet objects 规则实例列表 total Long 总数 表5 RuleSet 参数 参数类型 描述 id String 规则模版实例ID name String 规则模版实例名称 type String 类型 version String 版本 operator String 最近操作人 operate_time Long 最近操作时间 is_valid Boolean 是否生效 level String 租户级、项目级 is_public Boolean 是否系统级 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表4 请求Body参数 参数 是否必选 参数类型 描述 use_condition 否 String 用于区分插件为流水线可使用/模板可使用 input_repo_type 否 String 用于区分源的代码仓类型codehub/gitlab/github等 input_source_type 否 String 用于区分单源/多源的情况 business_type 否 String 业务类型 regex_name 否 String 名称

请求示例 POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/relation/plugins?limit=4&offset=0 { "input_repo_type" : "codehub", "input_source_type" : "single", "use_condition" : "pipeline", "business_type" : "", "regex_name" : "" }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 offset Integer 偏移 limit Integer 大小 total Integer 总数 data Array of data objects 结果集 表6 data 参数 参数类型 描述 business_type String 业务类型 display_name String 展示名 unique_id String 唯一ID editable Boolean 可编辑 removable Boolean 可移除 cloneable Boolean 可复制 disabled Boolean 禁用 conditions Array of strings 条件 plugins_list Array of plugins_list objects 插件列表 表7 plugins_list 参数 参数类型 描述 unique_id String 唯一ID display_name String 展示名 plugin_name String 插件名 disabled Boolean 禁用 group_name String 组名 group_type String 组类型 plugin_attribution String 属性 plugin_composition_type String 组合插件 runtime_attribution String 运行属性 all_steps Array of all_steps objects 基础插件列表 description String 描述 version_attribution String 版本属性 icon_url String 图标URL multi_step_editable Integer 可编辑 location String 地址 publisher_unique_id String 发布商ID manifest_version String 版本 表8 all_steps 参数 参数类型 描述 plugin_name String 插件名 display_name String 展示名 version String 版本 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 error_code String 错误码

响应示例 状态码： 200 OK { "offset" : 0, "limit" : 4, "total" : 246, "data" : { "plugins_list" : [ { "unique_id" : "1bfe2cd6b6f44fe3a918768e0391144f", "display_name" : "1030测试", "plugin_name" : "132132132231", "disabled" : false, "group_name" : null, "group_type" : null, "plugin_attribution" : "custom", "plugin_composition_type" : "single", "runtime_attribution" : "agent", "all_steps" : null, "description" : "", "version_attribution" : "formal", "icon_url" : "", "multi_step_editable" : 1, "location" : "pipeline,service", "publisher_unique_id" : null, "manifest_version" : "3" }, { "unique_id" : "84b6d96b240644b8a9c529981759a6d2", "display_name" : "插件发布", "plugin_name" : "create_test_2", "disabled" : false, "group_name" : null, "group_type" : null, "plugin_attribution" : "custom", "plugin_composition_type" : "multi", "runtime_attribution" : "agent", "all_steps" : null, "description" : "test", "version_attribution" : "formal", "icon_url" : "", "multi_step_editable" : 1, "location" : "pipeline,service", "publisher_unique_id" : null, "manifest_version" : "3" }, { "unique_id" : "816c527f9ba34904b84823718633ecdf", "display_name" : "插件创建测试", "plugin_name" : "create_test.plugin_draft", "disabled" : false, "group_name" : null, "group_type" : null, "plugin_attribution" : "custom", "plugin_composition_type" : "multi", "runtime_attribution" : "agent", "all_steps" : null, "description" : "test", "version_attribution" : "draft", "icon_url" : "", "multi_step_editable" : 1, "location" : "pipeline,service", "publisher_unique_id" : null, "manifest_version" : "3" }, { "unique_id" : "6e7a5fe5e7214ce6858087357a4bf79b", "display_name" : "插件版本描述测试", "plugin_name" : "plugin_version_test", "disabled" : false, "group_name" : null, "group_type" : null, "plugin_attribution" : "custom", "plugin_composition_type" : "single", "runtime_attribution" : "agent", "all_steps" : null, "description" : "插件版本描述测试", "version_attribution" : "formal", "icon_url" : "", "multi_step_editable" : 1, "location" : "pipeline,service", "publisher_unique_id" : null, "manifest_version" : "3" } ], "display_name" : "代码检查", "business_type" : "Gate", "unique_id" : "032ad7e2-5e19-4e90-8517-0958deb89e12", "conditions" : null, "editable" : false, "removable" : false, "cloneable" : false, "disabled" : false } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 type 是 String 类型：Build,Gate,Deploy,Test,Normal name 是 String 规则名称 layout_content 是 String 布局内容 plugin_id 否 String 插件ID plugin_name 否 String 插件名称 plugin_version 否 String 插件版本号 content 是 Array of RuleContent objects 规则属性分组列表 表4 RuleContent 参数 是否必选 参数类型 描述 group_name 是 String 分组名称 can_modify_when_inherit 否 Boolean 继承后的子策略是否可以修改阈值 properties 是 Array of RuleProperty objects 规则属性列表 表5 RuleProperty 参数 是否必选 参数类型 描述 key 是 String 属性键 type 是 String 类型 name 是 String 展示名称 operator 否 String 比较运算符 value 是 String 属性值 value_type 是 String 数据类型

请求示例 POST https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/rules/create { "name" : "新建规则-20231020170337", "type" : "Build", "plugin_id" : "official_devcloud_cloudBuild", "plugin_name" : "official_devcloud_cloudBuild", "plugin_version" : "0.0.15", "layout_content" : "layout_content", "content" : [ { "group_name" : "MavenUnitTest", "properties" : [ { "key" : "build.PassRatio", "name" : "PassRatio", "type" : "judge", "operator" : "=", "value_type" : "float", "value" : "0.1" }, { "key" : "build.TotalCases", "name" : "TotalCases", "type" : "judge", "operator" : "=", "value_type" : "float", "value" : "0.1" }, { "key" : "build.CoverageRatio", "name" : "CoverageRatio", "type" : "judge", "operator" : "=", "value_type" : "float", "value" : "0.1" } ] } ] }

请求示例 POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/publisher/create { "name" : "aaa", "en_name" : "aaa", "website" : "", "support_url" : "aaa@aa.com", "source_url" : "", "description" : "", "logo_url" : "" }