华为云用户手册

请求示例 删除两个记录，例如删除“TestProject__testForObject__ CS T”对象，记录ID为“cfw0000000aKmGskAsDo”和“cfw0000000aKmGskAsDp”的数据。 DELETE https://华为云Astro轻应用 域名 /u-route/baas/data/v1.0/bobject/TestProject__testForObject__CST?records=cfw0000000aKmGskAsDo,cfw0000000aKmGskAsDp

响应参数 表1 响应参数 参数 参数类型 描述 resCode String 参数解释： 返回码。 取值范围： 如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 参数解释： 返回消息。 取值范围： 成功返回“成功”，其他情况会返回具体的错误信息。 result result object 参数解释： 在成功请求时会有内容返回。 表2 result参数说明 参数 参数类型 描述 name String 参数解释： 服务编排的公式名称。 取值范围： 不涉及。 category String 参数解释： 服务编排公式的类别。 取值范围： 不涉及。 format String 参数解释： 服务编排公式的调用格式。 取值范围： 不涉及。 description String 参数解释： 服务编排公式的描述信息。 取值范围： 不涉及。

响应示例 { "resCode": "0", "resMsg": "成功", "result": { "active": false, "application": null, "belongTo": "000f000001DHIByJ3nKC", "belongTo.__objectType": "Application", "belongTo.name": "", "createdBy": "10gd000001DHHEwmE1NQ", "createdBy.__objectType": "User", "createdBy.name": "test00xx", "createdDate": "2024-05-22 16:02:55", "custom": true, "customStyle": null, "description": null, "events": [{ "action": "[{\"type\":\"$core.execJSCode\",\"options\":{\"content\":\"// Current Component\\r\\nlet _component = context.getCurrentComponent()\\r\\n\\r\\n// Current Form\\r\\nlet _form = _component.getForm()\\r\\n\\r\\n_form.formSave()\\r\\n\"}}]", "belongTo": null, "createdBy": "10gd000001DHHEwmE1NQ", "createdBy.__objectType": "User", "createdBy.name": "test00xx", "createdDate": "2024-05-22 16:02:55", "custom": true, "id": "003h000001DHkGa8bjhA", "installedPackage": null, "lastModifiedBy": "10gd000001DHHEwmE1NQ", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test00xx", "lastModifiedDate": "2024-05-22 16:02:55", "name": "button_0_click", "owner": "10gd000001DHHEwmE1NQ", "owner.__objectType": "User", "owner.name": "test00xx", "protectMode": 0, "view": "003g000001DHkGa4LkkC", "view.__objectType": "View", "view.name": "__layout__Test__ApprovedResource__CST__detail", "visibility": 0 }, { "action": "[{\"type\":\"$core.execJSCode\",\"options\":{\"content\":\"// Current Component\\r\\nlet _component = context.getCurrentComponent()\\r\\n\\r\\n// Current Form\\r\\nlet _form = _component.getForm()\\r\\n\\r\\n_form.resetFields()\\r\\n\"}}]", "belongTo": null, "createdBy": "10gd000001DHHEwmE1NQ", "createdBy.__objectType": "User", "createdBy.name": "test00xx", "createdDate": "2024-05-22 16:02:55", "custom": true, "id": "003h000001DHkGa8tKpE", "installedPackage": null, "lastModifiedBy": "10gd000001DHHEwmE1NQ", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test00xx", "lastModifiedDate": "2024-05-22 16:02:55", "name": "button_1_click", "owner": "10gd000001DHHEwmE1NQ", "owner.__objectType": "User", "owner.name": "test00xx", "protectMode": 0, "view": "003g000001DHkGa4LkkC", "view.__objectType": "View", "view.name": "__layout__Test__ApprovedResource__CST__detail", "visibility": 0 } ], "id": "003g000001DHkGa4LkkC", "installedPackage": null, "label": "Test__ApprovedResource__CST Detail", "lastModifiedBy": "10gd000001DHHEwmE1NQ", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test00xx", "lastModifiedDate": "2024-05-22 16:02:55", "layer": "null", "libraries": "[]", "lockTime": "", "lockUser": "", "logo": null, "name": "__layout__Test__ApprovedResource__CST__detail", "overridable": true, "owner": "10gd000001DHHEwmE1NQ", "owner.__objectType": "User", "owner.name": "test00xx", "pageType": null, "protectMode": 0, "referencePageId": null, "type": "Page", "version": "1.0.1", "viewData": "{\"key\":1,\"type\":\"DesignerPage\",\"props\":{\"name\":\"DesignerPage_1\"},\"elements\":[{\"key\":1538107283948000,\"type\":\"form\",\"props\":{\"labelPosition\":\"top\",\"labelWidth\":120,\"name\":\"form_0\",\"dataSource\":\"Test__ApprovedResource__CST\",\"dataSourceType\":\"Entity\",\"layout\":{\"key\":\"one_one_one\",\"value\":[8,8,8]},\"dataSourceId\":\"Test__ApprovedResource__CST\"},\"attrs\":{},\"on\":{},\"elements\":[{\"key\":1535715199303019,\"type\":\"title\",\"props\":{\"text\":\"ApprovedResource\",\"value\":\"ApprovedResource\",\"class\":\"form-title-container\",\"name\":\"title_1\"},\"attrs\":{},\"on\":{},\"elements\":[]},{\"key\":1535715199303039,\"type\":\"container\",\"props\":{\"name\":\"container_1\"},\"attrs\":{},\"on\":{},\"elements\":[{\"key\":1535715199303036,\"type\":\"layoutgrid\",\"props\":{\"name\":\"layoutgrid_1\"},\"attrs\":{},\"on\":{},\"elements\":[{\"key\":1888001472428500,\"type\":\"row\",\"props\":{\"layout\":{\"pc\":{\"key\":\"one_one_one\",\"value\":[8,8,8]},\"pad\":{\"key\":\"pad1\",\"value\":[24]},\"phone\":{\"key\":\"phone1\",\"value\":[24]}},\"name\":\"row_0\"},\"attrs\":{},\"on\":{},\"elements\":[{\"key\":1888001472428501,\"type\":\"col\",\"props\":{\"align\":\"left\",\"lg\":8,\"md\":8,\"sm\":24,\"xs\":24,\"name\":\"col_3\"},\"attrs\":{},\"on\":{},\"elements\":[{\"key\":1888001472428502,\"dataBinding\":{\"default\":{\"model\":[\"form_0\",\"name\"]}},\"type\":\"input\",\"props\":{\"type\":\"text\",\"dataField\":\"name\",\"dataFieldType\":\"xs_string\",\"label\":\"{\\\"en_US\\\":\\\"Name\\\",\\\"zh_CN\\\":\\\"名称\\\"}\",\"name\":\"input_1716364974936\",\"readonly\":false}}]}]}]},{\"key\":1535946611880038,\"type\":\"container\",\"props\":{\"align\":\"center\",\"class\":\"form-buttons-container\",\"name\":\"container_1\"},\"attrs\":{},\"on\":{},\"elements\":[{\"key\":1535946611880036,\"type\":\"button\",\"props\":{\"text\":\"{\\\"en_US\\\":\\\"Save\\\",\\\"fr_FR\\\":\\\"\\\",\\\"ja_JP\\\":\\\"\\\",\\\"zh_CN\\\":\\\"保存\\\"}\",\"style\":\"margin-right:20px;\",\"type\":\"primary\",\"name\":\"button_0\"},\"attrs\":{},\"on\":{\"click\":{\"actions\":[{\"type\":\"$core.execJSCode\",\"options\":{\"content\":\"// Current Component\\r\\nlet _component = context.getCurrentComponent()\\r\\n\\r\\n// Current Form\\r\\nlet _form = _component.getForm()\\r\\n\\r\\n_form.formSave()\\r\\n\"}}],\"graph\":\"\",\"serviceList\":[]}},\"elements\":[]},{\"key\":1535946611880037,\"type\":\"button\",\"props\":{\"text\":\"{\\\"en_US\\\":\\\"Reset\\\",\\\"fr_FR\\\":\\\"\\\",\\\"ja_JP\\\":\\\"\\\",\\\"zh_CN\\\":\\\"重置\\\"}\",\"style\":\"\",\"name\":\"button_1\"},\"attrs\":{},\"on\":{\"click\":{\"actions\":[{\"type\":\"$core.execJSCode\",\"options\":{\"content\":\"// Current Component\\r\\nlet _component = context.getCurrentComponent()\\r\\n\\r\\n// Current Form\\r\\nlet _form = _component.getForm()\\r\\n\\r\\n_form.resetFields()\\r\\n\"}}],\"graph\":\"\",\"serviceList\":[]}},\"elements\":[]}]}]}],\"dataBinding\":{\"default\":{\"model\":[\"form_0\"]}}}],\"dependencies\":[{\"names\":{\"extendNames\":[],\"pageMasterNames\":[],\"cardNames\":[]}}],\"version\":\"1.0.2\"}", "viewModel": "{\"form_0\":{\"mapping\":[{\"bindType\":\"object\",\"bindName\":\"Test__ApprovedResource__CST\",\"include\":\"ALL\",\"exclude\":\"\"}],\"fields\":[{\"name\":\"form_0\",\"label\":\"form_0\",\"type\":\"object\",\"isRequired\":false,\"defaultValue\":{},\"expand\":false,\"orign\":[{\"type\":\"Test__ApprovedResource__CST\",\"name\":\"Test__ApprovedResource__CST\",\"mappingField\":\"Test__ApprovedResource__CST\"}],\"rootInstanceId\":\"form_0\",\"_uid\":0},{\"name\":\"name\",\"label\":\"{\\\"en_US\\\":\\\"Name\\\",\\\"zh_CN\\\":\\\"名称\\\"}\",\"type\":\"xs_string\",\"orign\":[{\"type\":\"object\",\"name\":\"Test__ApprovedResource__CST\",\"mappingField\":\"name\"}],\"parentId\":\"form_0\",\"expand\":false,\"rootInstanceId\":\"form_0\",\"_uid\":1}],\"actions\":[{\"name\":\"query\",\"type\":\"object\",\"method\":\"query\",\"uri\":\"Test__ApprovedResource__CST\",\"input\":[],\"output\":[{\"fieldName\":\"name\",\"mappingField\":\"name\"}]},{\"name\":\"save\",\"type\":\"object\",\"method\":\"save\",\"uri\":\"Test__ApprovedResource__CST\",\"output\":[],\"input\":[{\"fieldName\":\"name\",\"mappingField\":\"name\"}]},{\"name\":\"delete\",\"type\":\"object\",\"method\":\"delete\",\"uri\":\"Test__ApprovedResource__CST\",\"output\":[],\"input\":[{\"fieldName\":\"name\",\"mappingField\":\"name\"}]},{\"name\":\"count\",\"type\":\"object\",\"method\":\"count\",\"uri\":\"Test__ApprovedResource__CST\",\"input\":[],\"output\":[]}]}}", "visibility": 0 } }

请求参数 表2 请求参数 参数 是否必选 参数类型 描述 fields 否 String 参数解释： 指明要查询的BPM实例信息的字段，多个字段名之间以英文逗号分隔。如果不指明字段，则返回缺省的字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 orderField 否 String 参数解释： 用于排序的字段名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 orderType 否 String 参数解释： 排序类型。 约束限制： 不涉及。 取值范围： asc：升序。 desc：降序。 默认取值： 不涉及。

URI GET 华为云Astro轻应用域名/u-route/baas/bp/v2.0/runtime/instances?states={X} 表1 路径参数 参数 是否必选 参数类型 描述 states 是 String 参数解释： BPM实例状态。 约束限制： 不涉及。 取值范围： New Running Waiting for user interaction Waiting for page event Completed OK Paused Broken Suspended User Terminated Terminated Dispatched CompletedOkWait 默认取值： 不涉及。

响应示例 { "resCode":"0", "resMsg":"Success", "result":[ { "bpStage":"Stage 1", "bpStatus":"begin", "bpStep":"Transfer 1", "businessKey":"BK001", "createdBy":"10gd0000003T2E10UTfk", "createdBy.__objectType":"User", "createdBy.name":"ecommerce", "createdDate":"2018-08-13 16:21:17", "curElement":"", "description":"Transfer 1", "endTime":"2018-08-17 14:40:09", "id":"002N000000IpNGFfNvm4", "label":"TestFSM2 2018-08-13 16:21:17", "lastHandler":null, "lastModifiedBy":"10gd0000003T2E10UTfk", "lastModifiedBy.__objectType":"User", "lastModifiedBy.name":"ecommerce", "lastModifiedDate":"2018-08-17 14:40:09", "name":"TestFSM2", "owner":"10gd0000003T2E10UTfk", "owner.__objectType":"User", "owner.name":"ecommerce", "startTime":"2018-08-13 16:21:17", "state":"Completed OK", "suspended":false, "title":"Hello, this is a title", "type":"BP", "urgency":0, "version":"0.0.1" } ] }

URI POST 华为云Astro轻应用域名/u-route/baas/bulk/v1.0/import/data?filename={filename}&flag={hasid}&comment=X 表1 路径参数 参数 是否必选 参数类型 描述 filename 是 String 参数解释： 上传的文件名称。 约束限制： 文件名对应的文件数据上传时，会转为二进制流的形式传输。 取值范围： 不涉及。 默认取值： 不涉及。 flag 是 String 参数解释： 当前支持的flag。 约束限制： 不涉及。 取值范围： hasid：导入的源数据中，已存在ID值。 noid：导入的源数据中，没有ID值。 默认取值： 不涉及。 comment 是 Boolean 参数解释： 是否对zip文件进行完整性校验。 约束限制： 不涉及。 取值范围： true：校验文件的完整性。 false：不校验文件的完整性。 默认取值： 不涉及。

URI GET 华为云Astro轻应用域名/u-route/baas/metadata/v1.0/object/{object_id}/Validator/{validator_id} 表1 路径参数 参数 是否必选 参数类型 描述 object_Id 是 String 参数解释： 对象的ID值，可通过调用查询所有自定义对象接口查看（响应消息中的“id”）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 validator_id 是 String 参数解释： 对象验证规则的ID值，可通过调用根据object_id查询对象验证规则接口查看（响应消息中的“id”）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 更新“TestProject__testForObject__CST”对象中，满足name字段值为“newName”的记录，更新name字段值为“name3”。 PUT https://华为云Astro轻应用域名/u-route/baas/data/v1.0/bobject/TestProject__testForObject__CST { "setValue": { "name": "name3" }, "condition": { "conjunction": "AND", "conditions": [ { "field": "name", "operator": "eq", "value": "newName" } ] } }

连接器 预置连接器接口，包括上传、下载、删除文件和目录等接口。通过这些接口，您可以实现文件的上传、下载和列举目录下文件等。 表7 连接器接口 API 说明 上传文件 将本地文件上传到存储中。使用该API上传文件，默认只会上传到连接器下配置的第一个桶中。 下载文件 从存储中下载文件。 删除文件 从存储中删除无用的文件。 删除目录 从存储中删除某目录。如果目录下不为空，删除目录的同时也会删除该目录下文件。 列举目录下文件 列举存储中某目录下文件。 分段上传 对于较大文件上传，可以切分成段上传。用户可以在如下的应用场景内（但不仅限于此），使用分段上传的模式： 上传超过100MB大小的文件。 网络条件较差，和OBS等存储服务端之间的连接经常断开。 上传前无法确定将要上传文件的大小。 获取endpoint endpoint为文件存储地址的前缀，该前缀加上传对象的路径，是实际访问对象的全路径。上传文件中，返回的是上传文件在桶上的路径。通过调用本节接口，返回endpoint，组装起来才是文件完整的访问地址。 分享Token 通过调用获取分享Token，可以获取临时Token，用户只要使用该临时Token即可访问文件，不用再使用“access-token”进行鉴权。

BPM 工作流接口，包括启动、查询和删除工作流等接口。通过这些接口，您可以启动工作流实例、删除工作流实例和挂起/恢复/终止工作流实例等。 表5 BPM接口 API 说明 启动BPM实例 创建并启动一个BPM实例。 查询BPM实例 获取当前账号所有的BPM实例信息。 挂起/恢复/终止BPM实例 挂起/恢复/终止一个BPM实例。BPM实例被挂起后，不会在用户的待办任务列表中出现，流程SLA定时器停止，也不会进行任何跟催。恢复后，可继续进行操作。终止操作则强行结束一个BPM实例，可在历史任务中查看。 删除BPM实例 删除一个BPM实例。彻底删除一个BPM实例，仅当管理员清除过期数据时可以删除，其他情况不建议删除BPM实例数据。 配置或修改BPM实例中变量的值 设置或修改BPM实例中变量的值，一次可以修改一个、多个或者所有变量的值。不存在的变量或者只读变量会被忽略。

导入导出 对象数据导入导出接口，包括导入数据、导出数据和导入导出元数据等接口。通过这些接口，您可以导入导出对象数据或元数据，实现数据的迁移。 表6 导入导出接口 API 说明 导出数据 导出数据表中的具体数据。华为云Astro轻应用中创建的对象，其内部的数据是支持导出的，该接口支持将对象中的数据按照设定的周期频率、筛选条件进行导出。 导入数据 导入数据。导入的数据源为zip包，包中的数据文件应为txt或csv格式，每个文件第一行为数据所属对象信息，第二行为字段名，第三行开始每一行为一条数据记录。 导出元数据 导出数据表的元数据，即将数据表的各个字段信息导出，但不包含具体的数据记录。 导入元数据 导入数据表的元数据。若已有数据表的元数据，可使用该功能快速根据元数据创建对象表。 使用模板导入数据 按照所使用的模板格式，导入数据。使用该功能前，需要创建好可使用的数据导入模板，在模板中定义数据的映射规则，调用接口时需指定模板名称，在该模板中，需要指定对应的操作脚本。

元数据 元数据接口，包括创建对象、服务编排和工作流等接口。通过这些接口，您可以新建对象、新建服务编排对象和新建工作流对象等。 表2 元数据接口 API 说明 创建自定义对象 添加一个Object对象。 查询所有自定义对象 查询所有Object对象。 按照object_id查询自定义对象 按照ID查询Object。 根据object_id添加字段 为object添加自定义字段。 根据object_id新增触发器 根据object_id新增trigger。 根据object_id新增校验规则 根据object_id新增校验validator。 根据object_id新增布局 按object_id新增layout。 根据field_id查询字段 按照field_id查询Field。 根据object_id查询对象布局 按照object_id查询layout。 根据layout_id查询对象布局 按照layout_id查询Layout。 根据object_id查询button 按照object_id查询button。 根据button_id查询button 按照button_id查询Button。 根据object_id查询触发器 按照object_id查询trigger。 根据trigger_id查询触发器 按照trigger_id查询Trigger。 根据object_id查询对象验证规则 按照object_id查询validator。 根据validator_id查询validator 按照validator_id查询validator。 创建Flow对象 添加一个flow对象。 查询Flow对象 获取匹配查询条件的flow列表。 按照flow_id查询服务编排或服务编排的入参出参信息 按flow_id查询Flow/查询flow_id的入参出参信息。 根据flow_id修改Flow对象 根据id修改flow对象。 按照flow_id删除flow 按flow_id删除Flow。 创建BPM对象 创建一个BPM对象。 按条件查询BPM对象 获取匹配查询条件的BPM列表。 按ID查询BPM对象 按bpm_id查询BPM对象。 根据ID修改BPM对象 根据id修改BPM对象。 按照ID删除BPM 按bpm_id删除BPM。 创建Picklist对象 创建一个Picklist对象。 查询选项列表值集 查询选项列表值集。 按ID增加选项列表值集的值 按picklist_id增加选项列表值集的值。 根据ID查询选项列表值集或引用该选项列表值集的对象字段列表 根据ID查询选项列表值集或引用该选项列表值集的对象字段列表。 根据ID修改选项列表值集的基本信息 根据id修改Picklist对象。 根据ID删除选项列表值集或选项列表值集的值 根据ID删除选项列表值集或选项列表值集的值。 列出所有应用 查询当前账号下所有应用。 根据ID查询应用 根据应用ID查询应用详细信息。 查询标准页面列表 查询标准页面的列表，仅包含基础信息，如果需要获取标准页面的内容，需要根据 ID 进行查询。 根据ID查询标准页面 按view_id查询标准页面。 查询Tab列表 查询应用页签的列表。

数据模块 数据模块接口，包括按记录ID查询、删除和更新数据等接口。通过这些接口，您可以查询对象中的数据，为对象新增数据等。 表1 数据模块接口 API 说明 按记录ID查询数据 按记录ID查询数据。 按记录ID删除数据 按记录ID删除数据。 按记录ID更新数据 按记录ID更新数据。 按记录ID列表查询数据 按记录ID列表查询数据。 新增对象数据 新增对象数据。 按记录ID列表删除数据 按记录ID列表删除数据。 按条件更新数据 按条件更新数据。 按条件查询对象数据 按条件查询对象数据。 按条件删除对象数据 按条件删除对象数据。 按条件查询对象记录数 按条件查询对象记录数。 批量插入或修改对象数据 批量插入或修改对象数据，若数据包含id进行更新，若数据不含id进行插入。

URI DELETE 华为云Astro轻应用域名/u-route/baas/sys/v1.1/connectors/{connector_type}/{connector_name}/deldir?dir=path 表1 路径参数 参数 是否必选 参数类型 描述 connector_type 是 String 参数解释： 连接器的类型。 约束限制： 不涉及。 取值范围： obs：与OBS对接的连接器。 minio：与MINIO对接的连接器。 objectstorageproxy：对象存储代理类型。 默认取值： 不涉及。 connector_name 是 String 参数解释： 连接器实例的名称，即创建连接器时设置的连接器实例名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 dir 是 String 参数解释： 要删除的目录，如果目录为空或者“/ ”，则代表删除根目录。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

组件 在开发自定义组件时，需要定义“组件名.js”文件，该文件为组件逻辑文件，是整个组件的渲染核心JS，在组件编辑状态和页面最终的发布运行态都会被加载执行。主要包含的预置API说明，请参见表1。 表1 组件名.js中预置API说明 分类 API及说明 组件实例预置API init方法：主要包含组件渲染需要初始化数据的入口函数。 render方法：负责整个组件渲染的业务逻辑方法。 getConnectorProperties：获取桥接器属性的配置值。 getConnectorInstanceByName：通过桥接器的变量名称获取桥接器实例，其中“APIConnector”类型为String，表示桥接器的变量名称。 ConnectorIns.process(renderCbk, errCbk)：通过桥接器实例调用process函数，主要作用为发起调用服务的请求和处理返回结果信息。 在通过process函数发起请求前，需设置桥接器实例的requestParams属性为请求的参数，例如：ConnectorIns.requestParams = param; 参数renderCbk，类型为Function，当返回结果信息后调用该函数，用于处理返回信息。 参数errCbk，类型为Function，调用该函数来处理错误。 ConnectorIns.query(param)：通过桥接器实例调用query函数，主要作用为发起调用服务的请求和处理返回结果信息，参数说明如下： param：请求参数。 其返回结果为Promise对象。 getProperties：用于返回该组件的自定义属性值。 开发Widget时，可以给组件自定义属性，在开发界面可对这些属性进行配置，通过getProperties方法可返回自定义属性值。例如，var properties = thisObj.getProperties()。 getContainer：用于返回渲染该组件的容器dom节点。 代码示例：var elem = thisObj.getContainer ()，然后通过jquery去查询组件中某个dom节点时，可通过$("#id", elem)的方式来获取。 getWidgetBasePath：用于返回该组件静态资源的根路径。 例如，某个组件的静态资源路径为“https://10.10.10.1:12900/default/0000000000NABzEjpNIH/assets/bundle/widget/172a6056501-a6f8ce1f-2ed9-4a9a-b883-251aaac14e0a/v1591923270914/test0609.js”，执行thisObj.getWidgetBasePath()返回“https://10.10.10.1:12900/default/0000000000NABzEjpNIH/assets/bundle/widget/172a6056501-a6f8ce1f-2ed9-4a9a-b883-251aaac14e0a/v1591923270914” 。 getMessages：返回该组件国际化配置文件中定义的国际化文件内容，需要配置vue和vueI18n使用。 例如，开发组件时定义了messages-en.json和messages-zh.json国际化文件。thisObj.getMessages()返回的就是这两个文件中定义的国际化内容。 hideWidget：隐藏该组件的dom结构，预览时调用该方法可以隐藏Widget。 例如，执行thisObj.hideWidget()方法，隐藏该组件的dom结构。 showWidget：显示该组件的dom结构，预览时调用该方法可以展示Widget。 例如，执行thisObj.showWidget()方法，显示该组件的dom结构。 SITE_ROOT_PATH：为华为云Astro轻应用预置的参数，用于获取当前站点URL地址的根路径。站点和应用是一对一的关系，当创建应用时，系统默认会创建并分配一个站点。 假如，某个页面的URL地址为“https://10.10.10.1:12900/magno/render/cool__app_0000000000NABzEjpNIH/page1”，则使用SITE_ROOT_PATH获取的根路径为“/magno/render/cool__app_0000000000NABzEjpNIH”。 triggerEvent：用于触发事件，参数说明如下： eventName：指定触发的事件名称。 {}：为事件触发时传递的参数赋值，例如{param: value}。 Studio对象预置API Studio.registerWidget：用来定义组件。 Studio.registerConnector：用来定义桥接器。 Studio.registerEvents：用于注册事件，只有通过此API注册后的事件才会在组件的事件列表中展现。 thisObj：当前组件实例对象，指为该组件注册事件。 "eventName"：事件名称，应该与触发事件API中的第一个参数保持一致。 "Event Label"：事件标签名，在事件列表中展示的事件标题。 []：定义该事件触发时传递的参数模型，例如[{"name": "param"}] 。 Studio.registerAction：用来注册动作。只有通过此API注册后的事件，才会在组件的动作列表中展现。 thisObj：当前组件实例对象，指为该组件注册动作。 actionName：动作名称。 Action Label：动作标签名，在动作列表中展示的动作标题。 []：事件触发时传入的参数。 $.proxy(this.receiveActionCbk, this)：该动作的回调函数，在回调函数中定义该动作的执行逻辑。 []：此参数在开发过程中置为空数组即可。 Studio.registerRouter：用来定义路由。 Studio.inReader：判断当前页面状态是开发态或预览态。其中，“true”表示在预览态（即运行态），“false”表示在开发态。 StudioToolkit.getCatalogProperties()：用于获取当前站点的元数据。 magno对象预置API savePropertiesForWidget(props)：用于在开发态中保存当前组件的高级设置属性信息，参数为要设置的相关属性集对象。 参数props示例： { "prop1": "value1", "prop2": ""value2" } HttpUtils工具类预置API 华为云Astro轻应用平台内置了HttpUtils工具类，预置API如下： HttpUtils.getCookie：用于获取某个cookie的值。 代码示例：HttpUtils.getCookie() HttpUtils.setCookie：用于设置cookie的值。 代码示例：HttpUtils.setCookie("key","value") HttpUtils.getI18n：返回一个Vue18n的实例，配合Vue和VueI18n使用。该Vue18n实例可以在new一个Vue实例时赋值为i18n参数。 代码示例：HttpUtils.getI18n({locale: HttpUtils.getLocale(), messages: thisObj.getMessages()}) HttpUtils.getCsrfToken：通过ajax的方式去调用平台的接口时使用。如果使用平台桥接器的方式，平台会自动在请求header中，添加csrf-token头。 HttpUtils.getCsrfToken(function(csrfToken) { $.ajax({ …. headers: { CSRF-Token: csrfToken }, }) }) HttpUtils.refreshToken：用于手动刷新页面的accesstoken，通常用在执行退出逻辑时，执行该方法刷新页面的access token。 HttpUtils.getUrlParam：用于获取查询字符串中的参数。 例如，某个页面的URL为“https://10.10.10.1:12900/magno/render/cool__app_0000000000NABzEjpNIH/page1?param=1”, 通过执行HttpUtils.getUrlParam("param")返回该参数的值“1”。 HttpUtils.getLocalStorage：用于获取某个localStorage的值。 代码示例：HttpUtils.getLocalStorage("key") HttpUtils.setLocalStorage：用于设置某个localStorage的值。 代码示例：HttpUtils.setLocalStorage("key","value")

响应示例 { "resCode":"0", "resMsg":"Success", "result":{ "name":"bpName1", "version":"1.0.1", "id":"002N000000Sy2NphoRbU", "processDefID":"001L000000S8Yi3xG9Gi", "interviewLabel":"BP Label 1", "nextElem":"subProcess", "isTest":true, "state":"Dispatched", "bpStatus":"New", "urgency":0, "taskOutcome":"", "businessKey":"002N000000Sy2NphoRbU", "startTime":"2019-08-27 10:53:04", "endTime":"", "Ext1":"", "Ext2":"", "Ext3":"", "Ext4":"", "Ext5":"", "Ext6":"", "Ext7":0, "Ext8":0, "suspended":false, "isClosed":false } }

请求示例 创建并启动一个BPM实例，例如创建并启动了一个BPM，BPM名称为“createCloudOK_NEW”，版本号为“1.0.1”，带有4个启动参数。 POST https://华为云Astro轻应用域名/u-route/baas/bp/v2.0/runtime/instances { "name":"createCloudOK_NEW", "version":"1.0.1", "variables":{ "name":"sun", "memorySize":"15", "storageSize":"15", "expiryDate":"2018-12-12" } }

URI DELETE 华为云Astro轻应用域名/u-route/baas/bp/v2.0/runtime/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 参数解释： 对应一个具体BPM实例的标识，可通过调用查询BPM实例接口查看（响应消息中的“id”）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

URI GET 华为云Astro轻应用域名/u-route/baas/sys/v1.1/connectors/{connector_type}/{connector_name}/getendpoint 表1 路径参数 参数 是否必选 参数类型 描述 connector_type 是 String 参数解释： 连接器的类型。 约束限制： 不涉及。 取值范围： obs：与OBS对接的连接器。 minio：与MINIO对接的连接器。 objectstorageproxy：对象存储代理类型。 默认取值： 不涉及。 connector_name 是 String 参数解释： 连接器实例的名称，即创建连接器时设置的连接器实例名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应参数 表2 响应参数说明 参数 参数类型 描述 resCode String 参数解释： 返回码。 取值范围： 如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 参数解释： 返回消息。 取值范围： 成功返回“成功”，其他情况会返回具体的错误信息。 result Object 参数解释： 如果请求成功，返回“endpoint”，即文件存储地址的前缀。“endpoint”和上传文件返回的上传文件，在桶上的路径组装起来才是文件完整的访问地址。

响应示例 { "resCode": "0", "resMsg": "成功", "result": [ { "id": "testListId", "name": "testName", "isSorted": false, "isRestricted": false, "controlField": "", "masterLabel": "testLabel", "description": "", "isGlobal": true, "isBaseline": false, "picklistValues": [ { "id": "testValueId", "value": "A", "isDefault": false, "isActive": true, "label": "A", "sequenceNo": 0, "color": "", "controlFieldValue": "", "description": "", "isBaseline": false, "createdBy": "testUserId", "createdBy.name": "test0xx", "createdDate": "2019-08-05 20:38:24", "lastModifiedBy": "testUserId", "lastModifiedBy.name": "test0xx", "lastModifiedDate": "2019-08-05 20:38:24", "owner": "testUserId", "owner.name": "test0xx", "custom": true } ], "createdBy": "testUserId", "createdBy.name": "test0xx", "createdDate": "2019-08-05 20:38:24", "lastModifiedBy": "testUserId", "lastModifiedBy.name": "test0xx", "lastModifiedDate": "2019-08-05 20:38:24", "owner": "testUserId", "owner.name": "test0xx", "custom": true } ] }

URI GET 华为云Astro轻应用域名/u-route/baas/metadata/v1.0/Picklist/{Picklist_id} 表1 路径参数 参数 是否必选 参数类型 描述 Picklist _id 是 String 参数解释： Picklist实例的ID，可通过调用查询选项列表值集接口查看（响应消息中的“id”）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应示例 { "resCode": "0", "resMsg": "成功", "result": [{ "active": true, "belongTo": null, "category": null, "coreVersion": null, "createdBy": "10gd000000bZHUAq7Pea", "createdBy.__objectType": "User", "createdBy.name": "test", "createdDate": "2019-02-10 22:14:41", "custom": true, "defaultTabId": "001g0000000000000000", "defaultTabId.__objectType": "Tab", "defaultTabId.name": "Home", "description": "应用1", "id": "000f000000NhIiwso4p6", "installedPackage": "003L000000mR6pf2uFqi", "installedPackage.__objectType": "PackageInstall", "installedPackage.name": "FacilityManagement", "introductionPageID": null, "isIncremental": false, "label": "Facility Management", "lastModifiedBy": "10gd000000bZHUAq7Pea", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test", "lastModifiedDate": "2020-01-10 15:21:18", "logo": null, "name": "SmartCampus__FacilityManagement", "owner": "10gd000000bZHUAq7Pea", "owner.__objectType": "User", "owner.name": "test", "properties": "{\"version\":\"0.0.0\",\"packageId\":\"testPackageId\"}", "protectMode": 1, "runtimeProperties": null, "supportBO20": false, "theme": null, "type": "Custom Application", "type.name": "Custom Application", "visibility": null, "visibleScope": null }, { "active": true, "belongTo": null, "category": "", "coreVersion": "1.3.3", "createdBy": "10gd000000bZHUAq7Pea", "createdBy.__objectType": "User", "createdBy.name": "test", "createdDate": "2020-09-28 20:30:35", "custom": true, "defaultTabId": "001g0000000000000000", "defaultTabId.__objectType": "Tab", "defaultTabId.name": "Home", "description": "演示流程场景可配置案例。", "id": "000f000000ddHP8z87N2", "installedPackage": "003L000000llRwGwwuDg", "installedPackage.__objectType": "PackageInstall", "installedPackage.name": "$caseDemo_a", "introductionPageID": null, "isIncremental": false, "label": "故障单流程", "lastModifiedBy": "10gd000000bZHUAq7Pea", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test", "lastModifiedDate": "2021-08-02 10:20:56", "logo": "/img/03.cd9e2a5.jpg", "name": "caseDemo", "owner": "10gd000000bZHUAq7Pea", "owner.__objectType": "User", "owner.name": "test", "properties": "{\"version\":\"0.0.0\",\"packageId\":\"003G000000ddHP8QV3VA\"}", "protectMode": 0, "runtimeProperties": "{\"version\":\"180828\",\"packageId\":\"003G000000ddHP8QV3VA\"}", "supportBO20": false, "theme": null, "type": "Custom Application", "type.name": "Custom Application", "visibility": null, "visibleScope": null } ] }

响应参数 表1 响应参数 参数 参数类型 描述 resCode String 参数解释： 返回码。 取值范围： 如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 参数解释： 返回消息。 取值范围： 成功返回“成功”，其他情况会返回具体的错误信息。 result Array 参数解释： 成功返回会返回该账号下所有应用，以一个列表展示，每个值是一个应用。 表2 其中result内每个对象的主要属性 参数 参数类型 描述 id String 参数解释： 应用ID。 取值范围： 不涉及。 label String 参数解释： 应用的标签名称。 取值范围： 不涉及。 name String 参数解释： 应用的名称。 取值范围： 不涉及。 description String 参数解释： 应用的描述信息。 取值范围： 不涉及。 type String 参数解释： 应用的类型。 取值范围： 不涉及。 logo String 参数解释： 应用的图标，可填图片地址（其前缀是受限的）。 取值范围： 前缀的取值范围为： "/u-route/baas/file/v1.0/media", "/besBaas/baas/studio/img", "/img", "/besBaas/images", "nc-icon", "/nocode/service/file/v1.0/media", "menuicon", "/lowcode/home/img" properties String 参数解释： 应用的属性，主要包括应用包ID、版本号等。 取值范围： 不涉及。

响应示例 { "resCode": "0", "resMsg": "成功", "result": [ { "boID": null, "catalogue": "Out", "createdBy": "testUserId", "createdBy.__objectType": "User", "createdBy.name": "test0xx", "createdDate": "2019-08-04 16:21:58", "custom": true, "description": "Updated Description", "id": "000y000000aM8XixTN0S", "installedPackage": null, "lastModifiedBy": "testUserId", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test0xx", "lastModifiedDate": "2019-08-04 16:22:58", "name": "testName", "namespace": "testSpace", "owner": "testUserId", "owner.__objectType": "User", "owner.name": "test0xx", "protectMode": 0, "structMembers": [ { "createdBy": "testUserId", "createdBy.__objectType": "User", "createdBy.name": "test0xx", "createdDate": "2019-08-04 16:21:58", "currencyFactor": 1, "custom": true, "dataType": "text", "defaultValue": null, "defaultValueType": null, "description": null, "id": "000y000000bM2XixVA0P", "ignoreNull": true, "installedPackage": null, "isCollection": true, "isNested": false, "lastModifiedBy": "testUserId", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test0xx", "lastModifiedDate": "2019-08-04 16:21:58", "name": "testName", "namespace": null, "owner": "testUserId", "owner.__objectType": "User", "owner.name": "test0xx", "parent": "testId", "parent.__objectType": "ExtStruct", "parent.name": "TestName", "picklistValues": null, "protectMode": 0, "required": true, "structType": null } ] } ] }

请求参数 表2 请求消息头参数说明 消息头名称 是否必选 参数类型 描述 Range 否 String 参数解释： 查看文件内容的范围，格式为bytes=numA-numB，numA为起始的字节位置，numB为结束的字节位置。 示例：取值“bytes=0-”，表示返回全部字节文件内容。 约束限制： numA、numB的取值均需大于0且numB大于numA。 取值范围： 不涉及。 默认取值： 不填写，表示返回全部文件内容。

URI GET 华为云Astro轻应用域名/u-route/baas/sys/v1.1/connectors/{connector_type}/{connector_name}/viewobject?object=X&x-image-process=Y 表1 路径参数 参数 是否必选 参数类型 描述 connector_type 是 String 参数解释： 连接器的类型。 约束限制： 不涉及。 取值范围： obs：与OBS对接的连接器。 minio：与MINIO对接的连接器。 objectstorageproxy：对象存储代理类型。 默认取值： 不涉及。 connector_name 是 String 参数解释： 连接器实例的名称，即创建连接器时设置的连接器实例名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 object 是 String 参数解释： 文件所在桶里的全路径，包含文件名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 x-image-process 否 String 参数解释： 在OBS中定义，表示图片处理服务。 示例： 命令方式：x-image-process=image/commands 样式方式：x-image-process=style/stylename 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应示例 { "resCode": "0", "resMsg": "成功", "result": { "createdBy": "10gd000000QwWjXspAOW", "createdBy.__objectType": "User", "createdBy.name": "bingo", "createdDate": "2021-05-19 11:41:30", "curElement": "isMasterAccountByIdentityId", "description": "", "endTime": "", "id": "002N000000jrOCerKZBQ", "label": "isMasterAccount 2021-05-19 11:41:30", "lastHandler": null, "lastModifiedBy": "10gd000000QwWjXspAOW", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "bingo", "lastModifiedDate": "2021-05-19 11:41:30", "name": "CP_DS__isMasterAccountForOperator", "owner": "10gd000000QwWjXspAOW", "owner.__objectType": "User", "owner.name": "bingo", "rootID": "", "runMode": 2, "startTime": "2021-05-19 11:41:30", "state": "Broken", "suspended": false, "type": "Flow", "type.name": "Flow", "version": "1.0.1" } }

响应参数 表2 响应参数 参数 参数类型 描述 resCode String 参数解释： 返回码。 取值范围： 如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 参数解释： 返回消息。 取值范围： 成功返回“成功”，其他情况会返回具体的错误信息。 result Object 参数解释： 成功请求时会有内容返回，内容包含请求中传入的fields中的字段或默认字段。