# 数据工坊 DWR

> 开放的近数据处理服务

## 产品介绍

- [图解数据工坊服务](https://support.huaweicloud.com/productdesc-dwr/dwr_01_10001.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [什么是数据工坊](https://support.huaweicloud.com/productdesc-dwr/dwr_01_0001.md): 数据工坊（Data Workroom，DWR）是一款近数据处理服务，通过易用的数据处理工作流编排和开放生态的数据处理算子，能够在云上实现图像、视频、文档、图片等数据处理业务。如图1所示，DWR主要对外提供开放的算子库和数据处理引擎。算子库包含由DWR提供的华为自有算子和第三方开发者提供的第三方算子。华为自有算子的能力源是华为云数据处理相关
- [产品优势](https://support.huaweicloud.com/productdesc-dwr/dwr_01_0002.md): 传统线下处理方式：硬件为用户自建IDC，软件为自研或集成商的数据处理软件，通过数据处理软件完成数据处理。传统云上处理方式：使用云上存储服务和数据处理服务，数据写入存储服务后，再调用数据处理服务接口实现数据处理。云上近数据处理方式：使用云上存储服务和DWR的近数据处理能力，数据写入存储服务后，自动触发DWR编排的工作流完成数据处理。高效：数
- [应用场景](https://support.huaweicloud.com/productdesc-dwr/dwr_01_0003.md): 未来几年时间，数据量将会呈数倍增长趋势，海量数据的快速处理是企业数据变现的核心诉求。DWR提供的高效、开放、易用的近数据处理能力，让视频处理、图片审核、文档压缩、灾难防治、数据搜索和推荐、办公协同、基因测序等场景的海量数据快速产生价值。DWR的应用场景包括但不限于以下典型场景。
- [产品功能](https://support.huaweicloud.com/productdesc-dwr/dwr_01_0205.md): 本页面介绍了DWR支持的常用功能特性。关于各功能支持的地域（Region）信息，可通过控制台查询详情。算子市场即DWR提供的算子库，提供方包括华为和第三方。华为算子的能力源是华为云数据处理相关的云服务，如媒体处理MPC、图像识别Image等，DWR将云服务提供的各种数据处理能力通过函数生成算子并在算子市场发布。第三方算子是基于DWR的算子
- [使用限制](https://support.huaweicloud.com/productdesc-dwr/dwr_01_0004.md): 当前支持使用的区域有：华北-北京四、华东-上海一、华南-广州、亚太-新加坡。当前仅支持OBS对象桶，不支持并行文件系统。当前仅支持创建串行的工作流。一个事件触发器仅支持关联一个工作流，一个工作流可同时被多个事件触发器关联。当前暂不支持创建重名工作流，即使工作流被删除后，也不能再创建与之重名的工作流。同一桶内的触发器名称不允许重复。工作流及
- [计费说明](https://support.huaweicloud.com/productdesc-dwr/dwr_01_0005.md): 算子费用主要由三部分组成：OBS API调用费、FunctionGraph函数及函数工作流费、算子费。
- [知识检索计费](https://support.huaweicloud.com/productdesc-dwr/lms_02_0700.md): 在使用知识湖存储中的知识检索功能时，需要先创建知识仓实例，使用知识仓实例，会收取一定的费用。以下示例中出现的费用价格仅供参考，实际价格请以控制台显示为准。假设某用户于2025年6月3日11:36:00创建了一个知识仓实例，该知识仓实例的CU规格为2xlarge，CU数量为3个，假设2xlarge的单价为0.3元/个/小时，那么截止2025
- [权限管理](https://support.huaweicloud.com/productdesc-dwr/dwr_01_0006.md): 如果您需要对华为云上购买的DWR资源，为企业中的员工设置不同的访问权限，以达到不同员工之间的权限隔离，您可以使用统一身份认证服务（Identity and Access Management，简称IAM）进行精细的权限管理。该服务提供用户身份认证、权限分配、访问控制等功能，可以帮助您安全的控制华为云资源的访问。通过IAM，您可以在华为云账
- [与其他服务的关系](https://support.huaweicloud.com/productdesc-dwr/dwr_01_0007.md): DWR数据处理的数据源是华为云存储服务，DWR提供的华为云自有算子是通过函数生成，且能力源是华为云数据处理相关的云服务。因此，DWR与其他服务的关系如表1所示。
- [基本概念](https://support.huaweicloud.com/productdesc-dwr/dwr_01_0008.md): 工作流是DWR运行单位，其中可以包含一个或多个算子，客户可通过加入不同算子到工作流中实现高度自由化的数据处理功能。算子是DWR中的执行单位，是一个具有输入输出的完成功能模块。算子既有华为云提供的内置官方算子，也有经过华为云审核后的第三方算子。用户可以根据自己的需求挑选算子加入工作流中，从而快速构建特有的数据处理功能。每个工作流需要绑定一个
- [什么是知识湖存储](https://support.huaweicloud.com/productdesc-lms/lms_01_0100.md): 知识湖存储（Long-term Memory Service，LMS），是一款用于存储、检索、分析多维向量数据和标量数据的云原生服务。知识湖存储服务支持多种索引类型和相似度计算方法，支持千亿向量规模和毫秒级查询时延。知识湖存储不仅能为大模型提供外部知识库，提高大模型回答的准确性，还可广泛应用于推荐系统，自然语言处理，智能客服等AI领域。提
- [产品优势](https://support.huaweicloud.com/productdesc-lms/lms_01_0200.md): 知识湖存储作为一种存储和检索向量数据的服务提供给用户，在高性能、高可用、大规模、简单易用、安全可信等方面体现出显著优势。高性能：知识湖存储支持千亿级向量数据规模及毫秒级查询延迟。高可用：知识湖存储提供多副本高可用特性，其多可用区和分布式多节点的架构，可用性可达99.99%，显著提高系统的可靠性和容错性，确保知识湖存储服务在面临节点故障和负
- [应用场景](https://support.huaweicloud.com/productdesc-lms/lms_01_0300.md): 知识湖存储可进行高性能向量存储和检索，主要适用于以下应用场景：文本/图像检索：向量数据库对输入的图像和文本信息进行向量存储与检索，会找到最匹配输入信息的文本或图像结果。大规模知识库：企业的私域数据存储在向量数据库中可构建外部知识库，帮助企业更好地管理和利用自己的数据资源。问答系统：向量数据库会基于问题信息进行向量存储与检索，并返回最相关的
- [产品功能](https://support.huaweicloud.com/productdesc-lms/lms_01_0400.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [计费说明](https://support.huaweicloud.com/productdesc-lms/lms_01_0500.md): 在使用知识湖存储中的知识检索功能时，需要先创建向量桶，使用向量桶，会收取一定的费用。以下示例中出现的费用价格仅供参考，实际价格请以控制台显示为准。假设某用户于2025年5月27日14:00:00创建了一个向量桶，该向量桶的CU规格为2xlarge，CU数量为3个，假设2xlarge的单价为0.3元/个/小时，那么截止2025年5月27日1

## 快速入门

- [准备工作](https://support.huaweicloud.com/qs-dwr/dwr_02_0001.md): 如果您已有一个华为账号，请跳到下一个任务。如果您还没有华为账号，请参考以下步骤创建。根据提示信息完成注册。注册成功后，系统会自动跳转至您的个人信息界面。注册成功后，系统会自动跳转至您的个人信息界面。关于注册华为账号并开通华为云，请参见注册华为账号并开通华为云。请参考实名认证完成个人或企业账号实名认证。您需要确保账户有足够金额。关于DWR收
- [入门流程](https://support.huaweicloud.com/qs-dwr/dwr_02_0003.md): 当需要使用DWR服务对OBS内存储的数据自动进行多项复杂任务（如解析、转码、截图等）处理时，建议参考表1逐步操作。
- [示例：图片质量变换](https://support.huaweicloud.com/qs-dwr/dwr_02_0004.md): 对于需要对大量图片文件进行压缩，快速发布上线的场景，可以使用DWR可视化的质量变换工作流来完成任务，帮助用户提升图片处理效率，节省内容发布时间。该实例通过创建触发器的方式异步启动工作流，实现流程为：在OBS服务中创建桶在DWR服务中创建工作流在DWR服务中创建事件触发器在OBS服务中上传文件触发工作流执行当前支持使用的区域有：华北-北京四
- [发布算子](https://support.huaweicloud.com/qs-dwr/dwr_02_0005.md): 所有开发者均可以创建用于数据处理的算子，审核通过后发布至DWR算子市场，开放给所有华为云用户使用。当算子被华为云用户使用之后，算子发布者将会获得相应的收益，详情参见计费说明。算子从API上线、开发、到发布的整个流程如图1所示，本节主要介绍如何使用DWR发布已开发好的算子到算子市场。算子开发完成后，您可以参考抽帧截图（自定义算子）来验证算子

## 用户指南

- [创建用户并授权使用DWR](https://support.huaweicloud.com/usermanual-dwr/dwr_03_0110.md): 如果您需要对您所拥有的DWR服务进行精细的权限管理，您可以使用统一身份认证服务（Identity and Access Management，简称IAM），通过IAM，您可以：根据企业的业务组织，在您的华为云账号中，给企业中不同职能部门的员工创建IAM用户，让员工拥有唯一安全凭证，并使用DWR资源。根据企业用户的职能，设置不同的访问权限，
- [DWR自定义策略](https://support.huaweicloud.com/usermanual-dwr/dwr_03_0111.md): 如果系统预置的DWR权限，不满足您的授权要求，可以创建自定义策略。目前华为云支持以下两种方式创建自定义策略：可视化视图创建自定义策略：无需了解策略语法，按可视化视图导航栏选择云服务、操作、资源、条件等策略内容，可自动生成策略。JSON视图创建自定义策略：可以在选择策略模板后，根据具体需求编辑策略内容；也可以直接在编辑框内编写JSON格式的
- [算子市场介绍](https://support.huaweicloud.com/usermanual-dwr/dwr_03_0001.md): 算子市场即为DWR提供的算子库，提供方包括华为和第三方。华为云自有算子的能力源是华为云数据处理相关的云服务，如媒体处理MPC、图像识别Image等，DWR将云服务提供的各种数据处理能力通过函数生成算子并在算子市场发布。第三方算子是基于DWR的算子注册能力，由第三方开发者创建，专业人员审核发布的公共算子，您也可以将自己创建的算子发布为第三方
- [发布算子](https://support.huaweicloud.com/usermanual-dwr/dwr_03_0003.md): 所有开发者均可以创建用于数据处理的算子，审核通过后发布至DWR算子市场，开放给所有华为云用户使用。当算子被华为云用户使用之后，算子发布者将会获得相应的收益，详情参见计费说明。算子从API上线、开发、到发布的整个流程如图1所示，本节主要介绍如何使用DWR发布已开发好的算子到算子市场。算子开发完成后，您可以参考抽帧截图（自定义算子）来验证算子
- [官方算子一览](https://support.huaweicloud.com/usermanual-dwr/dwr_03_0004.md): 本小节介绍华为云自有服务提供的各类算子的参数配置说明。不同区域支持的算子可能不同，请以控制台实际为准。模板作用：人脸比对是将两个人脸进行比对，来判断是否为同一个人，返回比对置信度。如果传入的图片中包含多个人脸，选取最大的人脸进行比对。该模板实际调用的是FRS服务的人脸比对接口。模板作用：对输入图片进行人脸检测和分析，输出人脸在图像中的位置
- [数据处理介绍](https://support.huaweicloud.com/usermanual-dwr/dwr_03_0005.md): DWR提供的近数据处理能力，可以对OBS内存储的数据，按照用户编排的工作流进行自动化处理（如解析、转码、截图等）。DWR基于函数工作流FunctionGraph的函数能力，将复杂的业务处理逻辑编排为工作流，通过事件触发器或API驱动，自动化完成多项复杂的数据处理任务。DWR提供图形化界面，方便用户直观便捷的构建数据处理流程，同时提供了预置
- [创建工作流](https://support.huaweicloud.com/usermanual-dwr/dwr_03_0006.md): 工作流主要是对算子进行编排，这样DWR就可以按照用户编排的工作流对OBS中的数据进行自动化处理（如视频解析、图片转码、视频截图等）。各预置模板及自定义函数的参数配置说明，请参见官方算子一览。使用视频解析、抽帧截图、媒资转码等模板需要先在MPC中开启桶授权，详情请参见权限说明。使用视频解析、抽帧截图、媒资转码等模板需要先在MPC中开启桶授权
- [通过事件触发器异步启动工作流](https://support.huaweicloud.com/usermanual-dwr/dwr_03_0007.md): 创建工作流之后，可以通过创建事件触发器来为工作流设置执行条件，指定桶内什么数据在执行某类操作后开始执行工作流。已完成工作流创建。一个桶支持绑定10个事件触发器。当事件触发器规则的条件满足时，将自动执行关联工作流定义的任务。
- [通过API启动工作流](https://support.huaweicloud.com/usermanual-dwr/dwr_03_0010.md): DWR支持通过API异步启动已有工作流，详情参见API异步启动工作流。DWR支持通过API同步启动已有工作流。请求示例GET /objectkey?x-workflow-graph-name=gramname/p1_v1,p2_v2 HTTP/1.1 Host: bucket.obs.cn-north-4.myhuaweicloud.co
- [自定义函数开发规范](https://support.huaweicloud.com/usermanual-dwr/dwr_03_0008.md): 用户在自行开发自定义函数时，函数的输入参数和输出参数需要遵守本节的开发规范。自定义函数的编译方式请参考FunctionGraph的《开发指南》。工作流执行自定义函数时，函数输入参数的JSON格式的结构体和环境变量的定义如下：函数输入的JSON格式体名称是否必选参数类型说明execution_name是String工作流实例名称。graph
- [申请公测](https://support.huaweicloud.com/usermanual-lms/lms_02_0000.md): 知识湖存储服务 LMS目前正在公测中，支持用户申请使用。公测申请提交后，5个工作日内审核结果将发送到您的邮箱和手机。
- [向量桶介绍](https://support.huaweicloud.com/usermanual-lms/lms_03_0100.md): 向量桶是LMS中用来组织、存储和管理数据的单位。LMS自顶向下按照向量桶、索引、向量的结构存储数据。向量桶中包含至少1个或多个索引表，索引表中包含至少1个或多个向量，索引表中也可以包含标量。索引表中的向量用于相似性查询。
- [管理向量桶](https://support.huaweicloud.com/usermanual-lms/lms_03_0200.md): 单个账号支持创建的向量桶数量不超过16个。或在向量桶列表上方的搜索框中直接输入关键字，按Enter键。搜索到的向量桶“向量桶名称”、“类型”、“区域”、“状态”、“规格”、“副本数量”、“节点数量”、“创建时间”中包含关键字的所有向量桶会展示在列表中。
- [VPCEP终端节点对接LMS向量桶](https://support.huaweicloud.com/usermanual-lms/lms_04_0000.md): 华为云租户通过API、SDK方式访问LMS服务时，需要通过VPC终端节点对接LMS。本章节指导用户如何通过VPC终端节点（下文简称：VPCEP）对接LMS向量桶。VPCEP对接LMS主要分为以下三大步骤：购买连接“接口”型终端节点服务的终端节点创建内网域名添加A类型记录集用户购买VPC终端节点，创建内网域名，内网域名即用户使用API、SD
- [支持的监控指标](https://support.huaweicloud.com/usermanual-lms/lms_05_0001.md): 本节定义了LMS上报云监控服务的监控指标的命名空间，监控指标列表和维度定义，用户可以通过云监控服务提供管理控制台或API接口来检索LMS产生的监控指标和告警信息。SYS.LMS

## 最佳实践

- [案例概述](https://support.huaweicloud.com/bestpractice-dwr/dwr_04_0003.md): DWR平台除了提供面向使用者的平台功能，同时也支持合作伙伴将自有功能包装成算子发布到DWR平台上，帮助伙伴快速搭建用户的数据处理工厂。部署服务：算子提供方需要将自身服务部署在华为云，同时对外提供API，方便用户进行调用。API上线云商店：云商店提供API调用权限的购买入口，算子提供方将1中开放的API注册到云商店中即可获取便捷的收费管理，
- [开发算子代码](https://support.huaweicloud.com/bestpractice-dwr/dwr_04_0004.md): DWR算子开发运行依赖于FunctionGraph平台，本节将使用python开发一个下载OBS对象的算子，python使用详情参见Python函数开发指南。通过对该示例算子开发方式的说明，能够帮助算子开发者快速适应开发流程。通过本节将学到以下内容：算子代码的入口结构如何在算子中获得AK/SK如何通过算子访问OBS算子代码的入口结构如何在
- [测试算子功能](https://support.huaweicloud.com/bestpractice-dwr/dwr_04_0005.md): 当算子功能代码开发完毕后，可以在DWR工作流中使用或进行上线前的测试。本节主要介绍如何使用DWR的自定义工作流来测试算子的功能。将左侧自定义算子拖拽至编排区域。鼠标单击各流程图标下方的小圆圈并长按拖拽，将工作流完整串联起来。在函数唯一标识中搜索上文中创建的测试算子。上文算子测试时我们通过dynamic_source获取了两个参数值buck
- [发布算子](https://support.huaweicloud.com/bestpractice-dwr/dwr_04_0006.md): 当完成算子开发、算子在工作流中的测试后，即可在DWR上将算子发布到算子市场。Inputs参数:动态参数（dynamic_source）:权限1.1版本:审核通过后，算子将发布至算子市场。您可以过滤第三方的算子提供方，查看您发布的算子。
- [创建视频转码工作流](https://support.huaweicloud.com/bestpractice-dwr/dwr_04_0001.md): 针对使用DWR做视频转码的场景，如果需要每个对象转码任务的参数不同，可通过给对象增加对象元数据（例如：x-obs-meta-transcode-commands: base64(commands)），再使用DWR集成自定义函数的方式来实现视频转码。具体的工作流视图如图1所示。在FunctionGraph创建函数，选择“Python 2.7
- [抽帧截图（官方算子）](https://support.huaweicloud.com/bestpractice-dwr/dwr_07_0001.md): 需要对视频抽帧截图时，在不编写额外代码的情况下使用抽帧截图算子对视频进行指定时间点截帧。用户使用对象域名向OBS发送请求。DWR收到请求，同步执行位于FunctionGraph的视频截图抽帧算子实例，调用MPC服务。MPC服务完成抽帧截图，将结果写回租户桶。DWR读取租户桶并将结果返回给用户。无需额外代码编写，快速构建视频抽帧截图应用。该
- [抽帧截图（自定义算子）](https://support.huaweicloud.com/bestpractice-dwr/dwr_07_0006.md): 需要对视频抽帧截图时，在不编写额外代码的情况下使用抽帧截图算子对视频进行指定时间点截帧。用户自定义算子，无需依赖额外服务，功能更灵活。该抽帧截图算子目前暂不支持中文对象。您首先需要在FunctionGraph导入自定义算子需要的函数依赖包。然后需要在FunctionGraph创建自定义抽帧截图函数。之后需要在DWR工作流编排界面完成配置动
- [视频解析](https://support.huaweicloud.com/bestpractice-dwr/dwr_07_0011.md): 解析视频的元数据信息，包括：视频时长、视频格式、码率等。用于视频播放时获取时长，分辨率展示 等等。在OBS服务控制台创建两个桶，一个用于上传待处理的数据对象，一个用于存储处理后的数据对象。桶的详细介绍参见创建桶。数据输入桶：“piccomp”数据处理后输出桶：“piccomp-output”这里创建两个桶是为了防止无限循环。因为处理后的数
- [媒资转码](https://support.huaweicloud.com/bestpractice-dwr/dwr_07_0012.md): 执行MPC服务的预置转码模板“DASH_H.265_4K_低码_1入9出”，将片源转为4K、2K、1080等码率的视频。该模板实际调用的是MPC服务的新建转码任务接口。媒资转码算子不支持同步返回，如您配置了同步工作流执行媒资转码算子，则会采用异步方式执行，且返回值会格式异常。在OBS服务控制台创建两个桶，一个用于上传待处理的数据对象，一个

## 常见问题

- [“无限循环”触发工作流如何处理？](https://support.huaweicloud.com/dwr_faq/dwr_05_0001.md): 由于DWR只能按触发器前缀、后缀、事件源类型等条件触发工作流，所以可能存在出现“无限循环”的场景。如果出现“无限循环”，只能先删除桶的事件触发器。主要有以下两个场景：案例1：使用DWR内置函数触发“无限循环”用户创建一条工作流workflowA，在工作流中使用了内置的“媒资转码”函数，且配置“媒资转码”函数的转码输出桶为桶A。然后，在桶A
- [如何测试算子](https://support.huaweicloud.com/dwr_faq/dwr_05_0002.md): 当算子功能代码开发完毕后，可以在DWR工作流中使用自定义工作流进行测试。请参考测试算子功能。
- [一个事件触发器可以设置多个前缀或者后缀吗？](https://support.huaweicloud.com/dwr_faq/dwr_05_0003.md): 如果您需要使用一个工作流处理多种后缀的文件，可以为该工作流创建多条事件触发器来实现支持多个前缀或者后缀。当前一个事件触发器支持设置一个前缀或者后缀，一个桶支持绑定10个触发器。例如：对于媒资转码工作流，用户需要对后缀mp4和mov两种格式的视频进行数据处理。用户需要为该给工作流创建两个触发器，一个用于触发mp4格式的数据处理，一个用于触发

## API参考

- [使用前必读](https://support.huaweicloud.com/api-dwr/dwr_07_0001.md): 数据工坊服务（Data Work Room，DWR）是一款近数据处理服务，通过易用的数据处理工作流编排和开放生态的数据处理算子，能够在云上实现各种灵活的数据处理业务。您可以使用本文档提供的API对DWR进行相关操作，如创建、修改、删除算子与工作流，配置触发器等操作。支持的全部操作请参见API概览。在调用DWR API之前，请确保已经充分了
- [API概览](https://support.huaweicloud.com/api-dwr/dwr_07_0006.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [构造请求](https://support.huaweicloud.com/api-dwr/dwr_07_0008.md): 本节介绍REST API请求的组成，并以调用IAM服务的管理员创建IAM用户接口说明如何调用API。您还可以通过这个视频教程了解如何构造请求调用API：https://bbs.huaweicloud.com/videos/102987。请求URI由如下部分组成：{URI-scheme}://{Endpoint}/{resource-pat
- [认证鉴权](https://support.huaweicloud.com/api-dwr/dwr_07_0010.md): 调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。Token认证：通过Token认证调用请求。AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key）加密调用请求。推荐使用AK/SK认证，其安全性比Token认证要高。Token认证：通过Token认证调用请求。AK/SK认证：通过AK（
- [返回结果](https://support.huaweicloud.com/api-dwr/dwr_07_0011.md): 请求发送以后，您会收到响应，其中包含状态码、响应消息头和消息体。状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。对于管理员创建IAM用户接口，如果调用后返回状态码为201，则表示请求成功。对应请求消息头，响应同样也有消息头，如Content-type。对于管理员创建IAM用户接口，返回如图
- [创建工作流-CreateWorkflow](https://support.huaweicloud.com/api-dwr/dwr_04_0122.md): 本接口用于直接创建Data+工作流。账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。POST /v3/{project_id}/workflows/{graph_name}该请求使用公共消息头，具体参见表3。该请求的
- [查询工作流详情-GetWorkflow](https://support.huaweicloud.com/api-dwr/dwr_04_0123.md): 本接口用于根据工作流名称查询工作流详细信息。账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。GET /v3/{project_id}/workflows/{graph_name}该请求使用公共消息头，具体参见表3。该
- [删除工作流-DeleteWorkflow](https://support.huaweicloud.com/api-dwr/dwr_04_0124.md): 本接口用于标记删除工作流。账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。DELETE /v3/{project_id}/workflows/{graph_name}该请求使用公共消息头，具体参见表3。该请求消息中不
- [更新工作流-UpdateWorkflow](https://support.huaweicloud.com/api-dwr/dwr_04_0125.md): 本接口用于更新工作流参数值。账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。PUT /v3/{project_id}/workflows/{graph_name}该请求使用公共消息头，具体参见表3。该请求的响应消息使
- [查询工作流列表-ListWorkflow](https://support.huaweicloud.com/api-dwr/dwr_04_0126.md): 本接口用于查询工作流列表。账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。GET /v3/{project_id}/workflows该请求使用公共消息头，具体参见表3。该请求消息中不使用消息参数。该请求的响应消息使
- [API异步启动工作流-AsyncInvokeApiStartWorkflow](https://support.huaweicloud.com/api-dwr/dwr_04_0127.md): 本接口用于API方式异步启动已有工作流，产生工作流实例。账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。POST /v3/{project_id}/workflows/{graph_name}/execute该请求使
- [查询工作流实例列表-ListWorkflowExecution](https://support.huaweicloud.com/api-dwr/dwr_04_0128.md): 本接口用于查询用户工作流的实例列表。账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。GET /v3/{project_id}/workflowexecutions该请求使用公共消息头，具体参见表3。该请求消息中不使用
- [查询工作流实例-GetWorkflowExecution](https://support.huaweicloud.com/api-dwr/dwr_04_0129.md): 本接口用于查询指定工作流实例详细。账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。GET /v3/{project_id}/workflows/{graph_name}/workflowexecution/{exec
- [恢复失败状态的工作流实例-RestoreFailedWorkflowExecution](https://support.huaweicloud.com/api-dwr/dwr_04_0130.md): 本接口用于恢复一个执行失败状态的工作流实例。恢复后，工作流实例将从上次失败的状态处继续执行，而工作流步骤中已经执行成功的状态不会再执行。账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。POST /v3/{projec
- [开通授权-OpenWorkflowAuthentication](https://support.huaweicloud.com/api-dwr/dwr_04_0131.md): 本接口用于开通授权，由OBS服务自动帮助用户创建工作流运行时需要的函数服务权限，以及函数服务运行时的权限。该函数具有幂等性。账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。POST /v3/{project_id}/
- [查询授权-ListWorkflowAuthentication](https://support.huaweicloud.com/api-dwr/dwr_04_0132.md): 本接口用于查询授权，查询由OBS服务自动帮助用户创建工作流运行时需要的函数服务权限，以及函数服务运行时的权限。该函数具有幂等性。账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。GET /v3/{project_id}
- [查询华为云算子模板详情-GetActionTemplate](https://support.huaweicloud.com/api-dwr/dwr_04_0133.md): 本接口用于按名称查询Action模板。账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。GET /v3/{project_id}/actiontemplate/{template_name}该请求使用公共消息头，具体参
- [查询华为云算子模板列表-ListActionTemplate](https://support.huaweicloud.com/api-dwr/dwr_04_0134.md): 本接口用于查询已有预置Action模板列表。账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。GET /v3/{project_id}/actiontemplates该请求使用公共消息头，具体参见表3。该请求消息中不使
- [配置桶触发器-CreateWorkflowTrigger](https://support.huaweicloud.com/api-dwr/dwr_04_0135.md): 本接口用于在桶上绑定工作流触发器。账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。该请求消息中不使用消息参数。该请求使用公共消息头，具体参见表3。该请求的响应消息使用公共消息头，具体请参考响应消息头。该响应消息中不包
- [查询桶触发器-GetWorkflowTrigger](https://support.huaweicloud.com/api-dwr/dwr_04_0136.md): 本接口用于查询桶上绑定工作流触发器。账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。该请求消息中不使用消息参数。该请求使用公共消息头，具体参见表3。该请求消息中不使用消息元素。该请求的响应消息使用公共消息头，具体请参
- [删除桶触发器-DeleteWorkflowTrigger](https://support.huaweicloud.com/api-dwr/dwr_04_0137.md): 本接口用于删除在桶上绑定工作流触发器。账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。该请求消息中不使用消息参数。该请求使用公共消息头，具体参见表3。该请求消息中不使用消息元数。该请求的响应消息使用公共消息头，具体请
- [权限及授权项说明](https://support.huaweicloud.com/api-dwr/dwr_07_0050.md): 如果您需要对您所拥有的DWR进行精细的权限管理，您可以使用统一身份认证服务（Identity and Access Management，简称IAM），如果华为云账号已经能满足您的要求，不需要创建独立的IAM用户，您可以跳过本章节，不影响您使用DWR服务的其它功能。默认情况下，新建的IAM用户没有任何权限，您需要将其加入用户组，并给用户
- [状态码](https://support.huaweicloud.com/api-dwr/dwr_07_0053.md): 服务器向用户返回的状态码和提示信息如表1所示：
- [错误码](https://support.huaweicloud.com/api-dwr/ErrorCode_0.md): 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。
- [获取项目ID](https://support.huaweicloud.com/api-dwr/dwr_07_0055.md): 在调用接口的时候，部分URL中需要填入项目ID，所以需要获取到项目ID。有如下两种获取方式：调用API获取项目ID从控制台获取项目ID项目ID可以通过调用查询指定条件下的项目列表API获取。获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和
- [使用前必读](https://support.huaweicloud.com/api-dwr/lms_01_0000.md): 欢迎使用向量存储（OBS Vectors）。向量存储是作为OBS特性，专门用于高效地存储、管理和检索千亿级向量数据，主要适用于将对象存储中数据转换成向量，并检索对象存储中的数据和向量场景。不仅能为大模型提供外部知识库，提高大模型回答的准确性，还可广泛应用于推荐系统、自然语言处理等 AI 领域。您可以使用本文档提供API对向量存储进行相关操
- [API概览](https://support.huaweicloud.com/api-dwr/lms_02_0000.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [构造请求](https://support.huaweicloud.com/api-dwr/lms_03_0100.md): 本节介绍REST API请求的组成，并以调用OBS Vectors服务的创建集合接口说明如何调用API。请求URI由如下部分组成（方括号部分可选）：{URI-scheme} ://[{instance-name}.]{Endpoint} / {resource-path} ? [{query-string}]尽管请求URI包含在请求消息头
- [认证鉴权](https://support.huaweicloud.com/api-dwr/lms_03_0200.md): LMS现在仅支持AK/SK认证鉴权。AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key)加密调用请求。AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。AK/SK既可以使用永久访问密钥中的AK/SK，也可以使用临时访问密钥中的AK/SK，但使用临时访问
- [返回结果](https://support.huaweicloud.com/api-dwr/lms_03_0300.md): 请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。对于创建集合接口，如果调用后返回状态码为“200”，则表示请求成功。【样例】对应请求消息头，响应同样也有消息头，如“Content-type”。对于创建集合接口，返回如图1所示的消息
- [创建知识仓实例 - CreateStore](https://support.huaweicloud.com/api-dwr/CreateStore.md): 创建知识仓实例。知识仓实例名称region内唯一。POST /v1/stores/create状态码：200状态码：400状态码：200创建知识仓实例请求成功状态码：400Bad Request请参见错误码。
- [删除知识仓实例 - DeleteStore](https://support.huaweicloud.com/api-dwr/DeleteStore.md): 删除指定的知识仓实例。POST /v1/stores/delete状态码：200状态码：400状态码：200删除知识仓实例请求成功状态码：400删除store失败请参见错误码。
- [列举知识仓实例 - ListStores](https://support.huaweicloud.com/api-dwr/ListStores.md): 列举租户所有的知识仓实例。POST /v1/stores/list无状态码：200状态码：200返回消息的参数 stores中以数组的形式，列出所有的stores名请参见错误码。
- [查询知识仓实例 - DescribeStore](https://support.huaweicloud.com/api-dwr/DescribeStore.md): 查询指定知识仓实例的详细信息。POST /v1/stores/describe状态码：200状态码：200执行成功，返回指定store信息请参见错误码。
- [变更知识仓实例 - ScaleStore](https://support.huaweicloud.com/api-dwr/ScaleStore.md): 对指定的知识仓实例进行扩容或缩容。POST /v1/stores/scale状态码：200状态码：200执行成功，返回扩容或缩容相关信息。请参见错误码。
- [创建collection - CreateCollection](https://support.huaweicloud.com/api-dwr/CreateCollection.md): 在知识仓实例下创建collection。POST /v1/collections/create状态码：200状态码：400状态码：200创建collection成功状态码：400Bad Request请参见错误码。
- [删除collection - DeleteCollection](https://support.huaweicloud.com/api-dwr/DeleteCollection.md): 在知识仓实例下删除指定的collection。POST /v1/collections/delete状态码：200状态码：400状态码：200删除collection成功状态码：400Bad Request请参见错误码。
- [列举collection - ListCollections](https://support.huaweicloud.com/api-dwr/ListCollections.md): 列举指定知识仓实例中所有的collections。POST /v1/collections/list状态码：200状态码：400状态码：200执行成功返回指定store中所有的collection的名字请参见错误码。
- [查询collection - DescribeCollection](https://support.huaweicloud.com/api-dwr/DescribeCollection.md): 在知识仓实例下查询指定的collection的信息。POST /v1/collections/describe状态码：200状态码：400状态码：200执行成功，返回指定store中指定collection信息状态码：400集合查询失败请参见错误码。
- [加载collection - LoadCollection](https://support.huaweicloud.com/api-dwr/LoadCollection.md): 加载指定collection的数据。加载成功后，才能执行查询操作。POST /v1/collections/load状态码：200状态码：400状态码：200执行成功，load collection success状态码：400集合加载失败请参见错误码。
- [卸载collection - ReleaseCollection](https://support.huaweicloud.com/api-dwr/ReleaseCollection.md): 卸载已加载collection的数据。POST /v1/collections/release状态码：200状态码：400状态码：200执行成功，release collection success状态码：400集合卸载失败请参见错误码。
- [插入向量 - InsertEntities](https://support.huaweicloud.com/api-dwr/InsertEntities.md): 在指定的collection中插入一个或多个Entity。POST /v1/entities/insert状态码：200状态码：400状态码：200更新entity成功状态码：400entity插入失败请参见错误码。
- [删除向量 - DeleteEntities](https://support.huaweicloud.com/api-dwr/DeleteEntities.md): 在指定的collection中删除一个或多个Entity。POST /v1/entities/delete状态码：200状态码：400状态码：200删除entity成功状态码：400Entity删除失败请参见错误码。
- [更新向量 - UpsertEntities](https://support.huaweicloud.com/api-dwr/UpsertEntities.md): 在指定collection中更新Entity。如果pk列中值存在，则更新Entity，如果不存在，则插入Entity。POST /v1/entities/upsert状态码：200状态码：400状态码：200更新entity成功状态码：400entity更新失败请参见错误码。
- [向量查询 - SearchEntities](https://support.huaweicloud.com/api-dwr/SearchEntities.md): 基于相似度匹配的查询方式，用于查找与给定查询向量相似的向量。返回指定的 Top K 个最相似的 Entity。POST /v1/entities/search状态码：200状态码：400状态码：200搜索成功状态码：400搜索失败请参见错误码。
- [混合搜索 - HybridSearch](https://support.huaweicloud.com/api-dwr/HybridSearch.md): 基于相似度匹配的查询方式，用于查找与给定多个向量进行相似性搜索，支持密集向量，稀疏向量等多路召回，并对结果进行重排处理，最终返回指定的 Top K 个最相似的 Entity。POST /v1/entities/hybrid-search状态码：200状态码：400状态码：200搜索成功状态码：400搜索失败请参见错误码。
- [标量查询 - QueryEntities](https://support.huaweicloud.com/api-dwr/QueryEntities.md): 接口用于精确查找与查询条件完全匹配的向量，此操作使用指定的布尔表达式对标量字段进行筛选。POST /v1/entities/query状态码：200状态码：400状态码：200搜索成功状态码：400搜索失败请参见错误码。
- [创建索引 - CreateIndex](https://support.huaweicloud.com/api-dwr/CreateIndex.md): 在指定的collection中，按照参数创建索引。POST /v1/indexes/create状态码：200状态码：400向量索引示例{ "store_name" : "test-storename", "collection_name" : "test-collection", "index_param" : { 
- [删除索引 - DeleteIndex](https://support.huaweicloud.com/api-dwr/DeleteIndex.md): 删除指定索引。POST /v1/indexes/delete状态码：200状态码：400状态码：200删除索引成功状态码：400Bad Request请参见错误码。
- [查询索引 - DescribeIndex](https://support.huaweicloud.com/api-dwr/DescribeIndex.md): 查询指定索引的详细信息。POST /v1/indexes/describe状态码：200状态码：400状态码：200查询索引成功状态码：400Bad Request请参见错误码。
- [查询索引构建进度 - GetProgress](https://support.huaweicloud.com/api-dwr/GetProgress.md): 查询指定索引的构建进度。POST /v1/indexes/get-progress状态码：200状态码：400状态码：200查询索引构建进度成功状态码：400Bad Request请参见错误码。
- [获取指定ID任务信息 - DescribeJob](https://support.huaweicloud.com/api-dwr/DescribeJob.md): 根据指定的jobid查询任务信息。用于在创建和删除知识仓实例操作执行成功后，通过响应中返回的job_id，来查询创建和删除知识仓实例执行的具体结果。POST /v1/jobs/describe状态码：200状态码：200执行成功，返回指定job的信息请参见错误码。
- [查询任务列表 - ListJobs](https://support.huaweicloud.com/api-dwr/ListJobs.md): 根据指定条件查询列举任务的详情。POST /v1/jobs/list无状态码：200状态码：200列举jobs信息请参见错误码。
- [状态码](https://support.huaweicloud.com/api-dwr/lms_05_0100.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [错误码](https://support.huaweicloud.com/api-dwr/ErrorCode.md): 调用接口出错后，将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时，HTTP 请求返回一个 4xx 或 5xx 的 HTTP 状态码。返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时，可以联系华为云客服，并提供错误码，以便我们尽快帮您解决问题。当接口调用出错时，会返回错误码及错误信息说明，

## LMS SDK参考

- [SDK概述](https://support.huaweicloud.com/sdkreference-lms/lms_01_0000.md): 本文介绍了LMS服务提供的SDK语言版本，列举了最新版本SDK的获取地址。API Explorer能根据需要动态生成SDK代码功能，降低您使用SDK的难度，推荐使用。表1提供了LMS服务支持的SDK列表，您可以在GitHub仓库查看SDK更新历史、获取安装包以及查看指导文档。用户购买VPC终端节点，创建内网域名，内网域名即用户使用SDK访