更新时间:2025-10-11 GMT+08:00

API概览

数据模块

数据模块接口,包括按记录ID查询、删除和更新数据等接口。通过这些接口,您可以查询对象中的数据,为对象新增数据等。

表1 数据模块接口

API

说明

按记录ID查询数据 - QueryDatabyRecordID

按记录ID查询数据。

按记录ID删除数据 - DeleteDatabyRecordID

按记录ID删除数据。

按记录ID更新数据 - UpdateDatabyRecordID

按记录ID更新数据。

按记录ID列表查询数据 - QueryDatabyRecordIDList

按记录ID列表查询数据。

新增对象数据 - AddData

新增对象数据。

按记录ID列表删除数据 - DeleteData

按记录ID列表删除数据。

按条件更新数据 - UpdateData

按条件更新数据。

按条件查询对象数据 - QueryData

按条件查询对象数据。

按条件删除对象数据 - DeleteDatabyCondition

按条件删除对象数据。

按条件查询对象记录数 - QueryObjectRecordNumber

按条件查询对象记录数。

批量插入对象数据 - AddObjectData

批量插入或修改对象数据,若数据包含id进行更新,若数据不含id进行插入。

元数据

元数据接口,包括创建对象、服务编排和工作流等接口。通过这些接口,您可以新建对象、新建服务编排对象和新建工作流对象等。

表2 元数据接口

API

说明

创建自定义对象 - CreateCustomObject

添加一个Object对象。

查询所有自定义对象 - QueryCustomObject

查询所有Object对象。

按照对象ID查询自定义对象 - QueryCustomObjectbyID

按照ID查询Object。

根据对象ID添加字段 - AddField

为object添加自定义字段。

根据对象ID新增触发器 - AddTrigger

根据object_id新增trigger。

根据对象ID新增校验规则 - AddValidationRule

根据object_id新增校验validator。

根据对象ID新增布局 - AddLayout

按object_id新增layout。

根据字段ID查询字段 - QueryField

按照field_id查询Field。

根据对象ID查询对象布局 - QueryObjectLayout

按照object_id查询layout。

根据布局ID查询对象布局 - QueryObjectLayoutbyID

按照layout_id查询Layout。

根据对象ID查询按钮 - QueryButton

按照object_id查询button。

根据按钮ID查询按钮 - QueryButtonbyID

按照button_id查询Button。

根据对象ID查询触发器 - QueryTrigger

按照object_id查询trigger。

根据触发器ID查询触发器 - QueryTriggerbyID

按照trigger_id查询Trigger。

根据对象ID查询对象验证规则 - QueryVerificationRule

按照object_id查询validator。

根据验证规则ID查询对象验证规则 - QueryVerificationRulebyID

按照validator_id查询validator。

创建Picklist对象 - CreatePicklistInstance

创建一个Picklist对象。

查询选项列表值集 - QueryPicklistValue

查询选项列表值集。

增加选项列表值集的值 - AddPicklistValue

按picklist_id增加选项列表值集的值。

查询选项列表值集 - QueryPicklistValue

根据ID查询选项列表值集或引用该选项列表值集的对象字段列表。

修改选项列表值集 - ModifyPicklistValue

根据id修改Picklist对象。

删除选项列表值集 - DeletePicklistValue

根据ID删除选项列表值集或选项列表值集的值。

列出所有应用 - ListApplication

查询当前账号下所有应用。

根据ID查询应用 - QueryApplication

根据应用ID查询应用详细信息。

查询标准页面列表 - QueryStandardPageList

查询标准页面的列表,仅包含基础信息,如果需要获取标准页面的内容,需要根据 ID 进行查询。

根据ID查询标准页面 - QueryStandardPage

按view_id查询标准页面。

查询Tab列表 - QueryTab

查询应用页签的列表。

服务编排

服务编排接口,包括编排Flow和查看服务编排运行实例两个接口。

表3 服务编排接口

API

说明

创建服务编排 - CreateFlow

添加一个flow对象。

查询服务编排 - QueryFlow

获取匹配查询条件的flow列表。

查看服务编排运行实例 - QueryFlowInstance

查询服务编排信息。

编排服务编排 - OrchestrateFlow

编排某个服务编排。

查询服务编排的入参出参信息 - QueryFlowParameter

按flow_id查询Flow/查询flow_id的入参出参信息。

修改服务编排 - ModifyFlow

根据id修改flow对象。

删除服务编排 - DeleteFlow

按flow_id删除Flow。

脚本

脚本接口,包括运行、调试和获取脚本签名信息等接口。通过这些接口,您可以运行脚本、对脚本进行调试等。

表4 脚本接口

API

说明

运行脚本 - RunScript

运行脚本。

调试脚本 - DebugScript

调试脚本。

获取脚本签名信息 - ObtainSignatureInformation

获取脚本签名信息。

获取脚本内置库的声明 - ObtainDeclaration

获取脚本内置库的声明。

获取Flow公式信息 - ObtainFormula

获取服务编排的公式。

工作流

工作流接口,包括启动、查询和删除工作流等接口。通过这些接口,您可以启动工作流实例、删除工作流实例和挂起/恢复/终止工作流实例等。

表5 工作流接口

API

说明

创建工作流 - CreateBPM

创建一个工作流。

启动工作流实例 - StartBPMInstance

创建并启动一个工作流实例。

查询工作流实例 - QueryBPMInstance

获取当前账号所有的工作流实例信息。

挂起工作流实例 - SuspendBPMInstance

挂起/恢复/终止一个工作流实例。工作流实例被挂起后,不会在用户的待办任务列表中出现,流程SLA定时器停止,也不会进行任何跟催。恢复后,可继续进行操作。终止操作则强行结束一个工作流实例,可在历史任务中查看。

删除工作流实例 - DeleteBPMInstance

删除一个工作流实例。彻底删除一个工作流实例,仅当管理员清除过期数据时可以删除,其他情况不建议删除工作流实例数据。

按照ID删除工作流 - DeleteBPM

按bpm_id删除工作流。

配置工作流实例中变量的值 - SetVariableValue

设置或修改工作流实例中变量的值,一次可以修改一个、多个或者所有变量的值。不存在的变量或者只读变量会被忽略。

按条件查询工作流 - QueryBPMbyCondition

获取匹配查询条件的工作流列表。

按ID查询工作流 - QueryBPMbyID

按bpm_id查询工作流对象。

根据ID修改工作流 - ModifyBPM

根据id修改工作流对象。

导入导出

对象数据导入导出接口,包括导入数据、导出数据和导入导出元数据等接口。通过这些接口,您可以导入导出对象数据或元数据,实现数据的迁移。

表6 导入导出接口

API

说明

导出数据 - ExportData

导出数据表中的具体数据。华为云Astro轻应用中创建的对象,其内部的数据是支持导出的,该接口支持将对象中的数据按照设定的周期频率、筛选条件进行导出。

导入数据 - ImportData

导入数据。导入的数据源为zip包,包中的数据文件应为txt或csv格式,每个文件第一行为数据所属对象信息,第二行为字段名,第三行开始每一行为一条数据记录。

导出元数据 - ExportMetadata

导出数据表的元数据,即将数据表的各个字段信息导出,但不包含具体的数据记录。

导入元数据 - ImportMetadata

导入数据表的元数据。若已有数据表的元数据,可使用该功能快速根据元数据创建对象表。

使用模板导入数据 - ImportDataUseTemplate

按照所使用的模板格式,导入数据。使用该功能前,需要创建好可使用的数据导入模板,在模板中定义数据的映射规则,调用接口时需指定模板名称,在该模板中,需要指定对应的操作脚本。

连接器

预置连接器接口,包括上传、下载、删除文件和目录等接口。通过这些接口,您可以实现文件的上传、下载和列举目录下文件等。

表7 连接器接口

API

说明

上传文件 - UploadFile

将本地文件上传到存储中。使用该API上传文件,默认只会上传到连接器下配置的第一个桶中。

下载文件 - DownloadFile

从存储中下载文件。

删除文件 - DeleteFile

从存储中删除无用的文件。

删除目录 - DeleteDirectory

从存储中删除某目录。如果目录下不为空,删除目录的同时也会删除该目录下文件。

列举目录下文件 - ListFile

列举存储中某目录下文件。

分段上传 - UploadMultipart

对于较大文件上传,可以切分成段上传。用户可以在如下的应用场景内(但不仅限于此),使用分段上传的模式:

  • 上传超过100MB大小的文件。
  • 网络条件较差,和OBS等存储服务端之间的连接经常断开。
  • 上传前无法确定将要上传文件的大小。

获取endpoint - ObtainEndpoint

endpoint为文件存储地址的前缀,该前缀加上传对象的路径,是实际访问对象的全路径。上传文件 - UploadFile中,返回的是上传文件在桶上的路径。通过调用本节接口,返回endpoint,组装起来才是文件完整的访问地址。

分享Token - ShareToken

通过调用获取分享Token,可以获取临时Token,用户只要使用该临时Token即可访问文件,不用再使用“access-token”进行鉴权。