# API概览 #### 数据模块 数据模块接口，包括按记录ID查询、删除和更新数据等接口。通过这些接口，您可以查询对象中的数据，为对象新增数据等。 表1数据模块接口 | API | 说明 | |:---|:---| | [按记录ID查询数据 - QueryDatabyRecordID](https://support.huaweicloud.com/api-astrozero/astrozero_api_0017.html) | 按记录ID查询数据。 | | [按记录ID删除数据 - DeleteDatabyRecordID](https://support.huaweicloud.com/api-astrozero/astrozero_api_0018.html) | 按记录ID删除数据。 | | [按记录ID更新数据 - UpdateDatabyRecordID](https://support.huaweicloud.com/api-astrozero/astrozero_api_0019.html) | 按记录ID更新数据。 | | [按记录ID列表查询数据 - QueryDatabyRecordIDList](https://support.huaweicloud.com/api-astrozero/astrozero_api_0020.html) | 按记录ID列表查询数据。 | | [新增对象数据 - AddData](https://support.huaweicloud.com/api-astrozero/astrozero_api_0021.html) | 新增对象数据。 | | [按记录ID列表删除数据 - DeleteData](https://support.huaweicloud.com/api-astrozero/astrozero_api_0022.html) | 按记录ID列表删除数据。 | | [按条件更新数据 - UpdateData](https://support.huaweicloud.com/api-astrozero/astrozero_api_0023.html) | 按条件更新数据。 | | [按条件查询对象数据 - QueryData](https://support.huaweicloud.com/api-astrozero/astrozero_api_0024.html) | 按条件查询对象数据。 | | [按条件删除对象数据 - DeleteDatabyCondition](https://support.huaweicloud.com/api-astrozero/astrozero_api_0025.html) | 按条件删除对象数据。 | | [按条件查询对象记录数 - QueryObjectRecordNumber](https://support.huaweicloud.com/api-astrozero/astrozero_api_0026.html) | 按条件查询对象记录数。 | | [批量插入对象数据 - AddObjectData](https://support.huaweicloud.com/api-astrozero/astrozero_api_0027.html) | 批量插入或修改对象数据，若数据包含id进行更新，若数据不含id进行插入。 | #### 元数据 元数据接口，包括创建对象、服务编排和工作流等接口。通过这些接口，您可以新建对象、新建服务编排对象和新建工作流对象等。 表2元数据接口 | API | 说明 | |:---|:---| | [创建自定义对象 - CreateCustomObject](https://support.huaweicloud.com/api-astrozero/astrozero_api_0032.html) | 添加一个Object对象。 | | [查询所有自定义对象 - QueryCustomObject](https://support.huaweicloud.com/api-astrozero/astrozero_api_0033.html) | 查询所有Object对象。 | | [按照对象ID查询自定义对象 - QueryCustomObjectbyID](https://support.huaweicloud.com/api-astrozero/astrozero_api_0034.html) | 按照ID查询Object。 | | [根据对象ID添加字段 - AddField](https://support.huaweicloud.com/api-astrozero/astrozero_api_0035.html) | 为object添加自定义字段。 | | [根据对象ID新增触发器 - AddTrigger](https://support.huaweicloud.com/api-astrozero/astrozero_api_0036.html) | 根据object_id新增trigger。 | | [根据对象ID新增校验规则 - AddValidationRule](https://support.huaweicloud.com/api-astrozero/astrozero_api_0037.html) | 根据object_id新增校验validator。 | | [根据对象ID新增布局 - AddLayout](https://support.huaweicloud.com/api-astrozero/astrozero_api_0038.html) | 按object_id新增layout。 | | [根据字段ID查询字段 - QueryField](https://support.huaweicloud.com/api-astrozero/astrozero_api_00106.html) | 按照field_id查询Field。 | | [根据对象ID查询对象布局 - QueryObjectLayout](https://support.huaweicloud.com/api-astrozero/astrozero_api_00107.html) | 按照object_id查询layout。 | | [根据布局ID查询对象布局 - QueryObjectLayoutbyID](https://support.huaweicloud.com/api-astrozero/astrozero_api_00108.html) | 按照layout_id查询Layout。 | | [根据对象ID查询按钮 - QueryButton](https://support.huaweicloud.com/api-astrozero/astrozero_api_00109.html) | 按照object_id查询button。 | | [根据按钮ID查询按钮 - QueryButtonbyID](https://support.huaweicloud.com/api-astrozero/astrozero_api_00110.html) | 按照button_id查询Button。 | | [根据对象ID查询触发器 - QueryTrigger](https://support.huaweicloud.com/api-astrozero/astrozero_api_00112.html) | 按照object_id查询trigger。 | | [根据触发器ID查询触发器 - QueryTriggerbyID](https://support.huaweicloud.com/api-astrozero/astrozero_api_00111.html) | 按照trigger_id查询Trigger。 | | [根据对象ID查询对象验证规则 - QueryVerificationRule](https://support.huaweicloud.com/api-astrozero/astrozero_api_00113.html) | 按照object_id查询validator。 | | [根据验证规则ID查询对象验证规则 - QueryVerificationRulebyID](https://support.huaweicloud.com/api-astrozero/astrozero_api_00114.html) | 按照validator_id查询validator。 | | [创建Picklist对象 - CreatePicklistInstance](https://support.huaweicloud.com/api-astrozero/astrozero_api_0052.html) | 创建一个Picklist对象。 | | [查询选项列表值集 - QueryPicklistValue](https://support.huaweicloud.com/api-astrozero/astrozero_api_0053.html) | 查询选项列表值集。 | | [增加选项列表值集的值 - AddPicklistValue](https://support.huaweicloud.com/api-astrozero/astrozero_api_0054.html) | 按picklist_id增加选项列表值集的值。 | | [查询选项列表值集 - QueryPicklistValue](https://support.huaweicloud.com/api-astrozero/astrozero_api_0055.html) | 根据ID查询选项列表值集或引用该选项列表值集的对象字段列表。 | | [修改选项列表值集 - ModifyPicklistValue](https://support.huaweicloud.com/api-astrozero/astrozero_api_0056.html) | 根据id修改Picklist对象。 | | [删除选项列表值集 - DeletePicklistValue](https://support.huaweicloud.com/api-astrozero/astrozero_api_0057.html) | 根据ID删除选项列表值集或选项列表值集的值。 | | [列出所有应用 - ListApplication](https://support.huaweicloud.com/api-astrozero/astrozero_api_00104.html) | 查询当前账号下所有应用。 | | [根据ID查询应用 - QueryApplication](https://support.huaweicloud.com/api-astrozero/astrozero_api_0080.html) | 根据应用ID查询应用详细信息。 | | [查询标准页面列表 - QueryStandardPageList](https://support.huaweicloud.com/api-astrozero/astrozero_api_0005.html) | 查询标准页面的列表，仅包含基础信息，如果需要获取标准页面的内容，需要根据 ID 进行查询。 | | [根据ID查询标准页面 - QueryStandardPage](https://support.huaweicloud.com/api-astrozero/astrozero_api_0006.html) | 按view_id查询标准页面。 | | [查询Tab列表 - QueryTab](https://support.huaweicloud.com/api-astrozero/astrozero_api_0003.html) | 查询应用页签的列表。 | #### 服务编排 服务编排接口，包括编排Flow和查看服务编排运行实例两个接口。 表3服务编排接口 | API | 说明 | |:---|:---| | [创建服务编排 - CreateFlow](https://support.huaweicloud.com/api-astrozero/astrozero_api_0040.html) | 添加一个flow对象。 | | [查询服务编排 - QueryFlow](https://support.huaweicloud.com/api-astrozero/astrozero_api_0041.html) | 获取匹配查询条件的flow列表。 | | [查看服务编排运行实例 - QueryFlowInstance](https://support.huaweicloud.com/api-astrozero/astrozero_api_0060.html) | 查询服务编排信息。 | | [编排服务编排 - OrchestrateFlow](https://support.huaweicloud.com/api-astrozero/astrozero_api_0059.html) | 编排某个服务编排。 | | [查询服务编排的入参出参信息 - QueryFlowParameter](https://support.huaweicloud.com/api-astrozero/astrozero_api_0042.html) | 按flow_id查询Flow/查询flow_id的入参出参信息。 | | [修改服务编排 - ModifyFlow](https://support.huaweicloud.com/api-astrozero/astrozero_api_0043.html) | 根据id修改flow对象。 | | [删除服务编排 - DeleteFlow](https://support.huaweicloud.com/api-astrozero/astrozero_api_0044.html) | 按flow_id删除Flow。 | #### 脚本 脚本接口，包括运行、调试和获取脚本签名信息等接口。通过这些接口，您可以运行脚本、对脚本进行调试等。 表4脚本接口 | API | 说明 | |:---|:---| | [运行脚本 - RunScript](https://support.huaweicloud.com/api-astrozero/astrozero_api_0062.html) | 运行脚本。 | | [调试脚本 - DebugScript](https://support.huaweicloud.com/api-astrozero/astrozero_api_0063.html) | 调试脚本。 | | [获取脚本签名信息 - ObtainSignatureInformation](https://support.huaweicloud.com/api-astrozero/astrozero_api_0065.html) | 获取脚本签名信息。 | | [获取脚本内置库的声明 - ObtainDeclaration](https://support.huaweicloud.com/api-astrozero/astrozero_api_0066.html) | 获取脚本内置库的声明。 | | [获取Flow公式信息 - ObtainFormula](https://support.huaweicloud.com/api-astrozero/astrozero_api_0067.html) | 获取服务编排的公式。 | #### 工作流 工作流接口，包括启动、查询和删除工作流等接口。通过这些接口，您可以启动工作流实例、删除工作流实例和挂起/恢复/终止工作流实例等。 表5工作流接口 | API | 说明 | |:---|:---| | [创建工作流 - CreateBPM](https://support.huaweicloud.com/api-astrozero/astrozero_api_0046.html) | 创建一个工作流。 | | [启动工作流实例 - StartBPMInstance](https://support.huaweicloud.com/api-astrozero/astrozero_api_0069.html) | 创建并启动一个工作流实例。 | | [查询工作流实例 - QueryBPMInstance](https://support.huaweicloud.com/api-astrozero/astrozero_api_0070.html) | 获取当前账号所有的工作流实例信息。 | | [挂起工作流实例 - SuspendBPMInstance](https://support.huaweicloud.com/api-astrozero/astrozero_api_0071.html) | 挂起/恢复/终止一个工作流实例。工作流实例被挂起后，不会在用户的待办任务列表中出现，流程SLA定时器停止，也不会进行任何跟催。恢复后，可继续进行操作。终止操作则强行结束一个工作流实例，可在历史任务中查看。 | | [删除工作流实例 - DeleteBPMInstance](https://support.huaweicloud.com/api-astrozero/astrozero_api_0072.html) | 删除一个工作流实例。彻底删除一个工作流实例，仅当管理员清除过期数据时可以删除，其他情况不建议删除工作流实例数据。 | | [按照ID删除工作流 - DeleteBPM](https://support.huaweicloud.com/api-astrozero/astrozero_api_0050.html) | 按bpm_id删除工作流。 | | [配置工作流实例中变量的值 - SetVariableValue](https://support.huaweicloud.com/api-astrozero/astrozero_api_0073.html) | 设置或修改工作流实例中变量的值，一次可以修改一个、多个或者所有变量的值。不存在的变量或者只读变量会被忽略。 | | [按条件查询工作流 - QueryBPMbyCondition](https://support.huaweicloud.com/api-astrozero/astrozero_api_0047.html) | 获取匹配查询条件的工作流列表。 | | [按ID查询工作流 - QueryBPMbyID](https://support.huaweicloud.com/api-astrozero/astrozero_api_0048.html) | 按bpm_id查询工作流对象。 | | [根据ID修改工作流 - ModifyBPM](https://support.huaweicloud.com/api-astrozero/astrozero_api_0049.html) | 根据id修改工作流对象。 | #### 导入导出 对象数据导入导出接口，包括导入数据、导出数据和导入导出元数据等接口。通过这些接口，您可以导入导出对象数据或元数据，实现数据的迁移。 表6导入导出接口 | API | 说明 | |:---|:---| | [导出数据 - ExportData](https://support.huaweicloud.com/api-astrozero/astrozero_api_0075.html) | 导出数据表中的具体数据。华为云Astro轻应用中创建的对象，其内部的数据是支持导出的，该接口支持将对象中的数据按照设定的周期频率、筛选条件进行导出。 | | [导入数据 - ImportData](https://support.huaweicloud.com/api-astrozero/astrozero_api_0076.html) | 导入数据。导入的数据源为zip包，包中的数据文件应为txt或csv格式，每个文件第一行为数据所属对象信息，第二行为字段名，第三行开始每一行为一条数据记录。 | | [导出元数据 - ExportMetadata](https://support.huaweicloud.com/api-astrozero/astrozero_api_0077.html) | 导出数据表的元数据，即将数据表的各个字段信息导出，但不包含具体的数据记录。 | | [导入元数据 - ImportMetadata](https://support.huaweicloud.com/api-astrozero/astrozero_api_0078.html) | 导入数据表的元数据。若已有数据表的元数据，可使用该功能快速根据元数据创建对象表。 | | [使用模板导入数据 - ImportDataUseTemplate](https://support.huaweicloud.com/api-astrozero/astrozero_api_0079.html) | 按照所使用的模板格式，导入数据。使用该功能前，需要创建好可使用的数据导入模板，在模板中定义数据的映射规则，调用接口时需指定模板名称，在该模板中，需要指定对应的操作脚本。 | #### 连接器 预置连接器接口，包括上传、下载、删除文件和目录等接口。通过这些接口，您可以实现文件的上传、下载和列举目录下文件等。 表7连接器接口 | API | 说明 | |:---|:---| | [上传文件 - UploadFile](https://support.huaweicloud.com/api-astrozero/astrozero_api_0085.html) | 将本地文件上传到存储中。使用该API上传文件，默认只会上传到连接器下配置的第一个桶中。 | | [下载文件 - DownloadFile](https://support.huaweicloud.com/api-astrozero/astrozero_api_0086.html) | 从存储中下载文件。 | | [删除文件 - DeleteFile](https://support.huaweicloud.com/api-astrozero/astrozero_api_0087.html) | 从存储中删除无用的文件。 | | [删除目录 - DeleteDirectory](https://support.huaweicloud.com/api-astrozero/astrozero_api_0088.html) | 从存储中删除某目录。如果目录下不为空，删除目录的同时也会删除该目录下文件。 | | [列举目录下文件 - ListFile](https://support.huaweicloud.com/api-astrozero/astrozero_api_0089.html) | 列举存储中某目录下文件。 | | [分段上传 - UploadMultipart](https://support.huaweicloud.com/api-astrozero/astrozero_api_0090.html) | 对于较大文件上传，可以切分成段上传。用户可以在如下的应用场景内（但不仅限于此），使用分段上传的模式： - 上传超过100MB大小的文件。 - 网络条件较差，和OBS等存储服务端之间的连接经常断开。 - 上传前无法确定将要上传文件的大小。 | | [获取endpoint - ObtainEndpoint](https://support.huaweicloud.com/api-astrozero/astrozero_api_0091.html) | endpoint为文件存储地址的前缀，该前缀加上传对象的路径，是实际访问对象的全路径。[上传文件 - UploadFile](https://support.huaweicloud.com/api-astrozero/astrozero_api_0085.html)中，返回的是上传文件在桶上的路径。通过调用本节接口，返回endpoint，组装起来才是文件完整的访问地址。 | | [分享Token - ShareToken](https://support.huaweicloud.com/api-astrozero/astrozero_api_0092.html) | 通过调用[获取分享Token](https://support.huaweicloud.com/api-astrozero/astrozero_api_0092.html#astrozero_api_0092__section1338511411177)，可以获取临时Token，用户只要使用该临时Token即可访问文件，不用再使用"access-token"进行鉴权。 |