华为云用户手册

响应参数 表2 响应参数 参数 参数类型 描述 resCode String 参数解释： 返回码。 取值范围： 如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 参数解释： 返回消息。 取值范围： 如果成功状态，通常会返回“Success”，其他情况会返回具体的错误信息。 result result object 参数解释： 在成功请求时，会有内容返回。 表3 响应参数result 参数 参数类型 描述 value 任意类型 参数解释： 执行脚本的返回值。 log String 参数解释： debug日志。 取值范围： 不涉及。

响应示例 { "resCode": "0", "resMsg": "成功", "result": [ { "id": "cglE000000aMFjB9ipAu" }, { "id": "cglE000000aMFjB9ipAv" }, { "id": "cglE000000aMFjB9ipAw" } ] }

请求示例 向对象“TestProject__testForObject1__ CS T”中插入三条数据，body体中含有要插入的records参数。 POST https://AstroZero 域名 /u-route/baas/data/v1.0/upsert/TestProject__testForObject1__CST { "records":[ { "name":"zhang", "TestProject__length__CST":"17" }, { "name":"li", "TestProject__length__CST":"30" }, { "name":"wang", "TestProject__length__CST":"20" } ] }

请求示例 更新一个记录，例如更新“TestProject__testForObject__CST”对象，记录ID为“cfw0000000aKin6AQgfQ”的数据。 PUT https://AstroZero域名/u-route/baas/data/v1.0/bobject/TestProject__testForObject__CST/cfw0000000aKin6AQgfQ { "setValue": { "name": "newName" } }

响应参数 表3 响应参数 参数 参数类型 描述 resCode String 参数解释： 返回码。 取值范围： 如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 参数解释： 返回消息。 取值范围： 如果成功状态，通常会返回“Success”，其他情况会返回具体的错误信息。 result Number 参数解释： 更新记录的个数，成功时携带。 取值范围： 数字，一般更新成功为“1”。

请求示例 创建Picklist对象实例。 POST https://AstroZero域名/u-route/baas/metadata/v1.0/Picklist { "name": "CNAME1__testName", "picklistValues": [ { "label": "A", "value": "A" }, { "label": "B", "value": "B" }, { "label": "C", "value": "C" } ], "masterLabel": "Label for pick list ABC" }

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 参数解释： 选项列表值集名称。 约束限制： 如环境中设置了命名空间，请在名称中加上前缀“命名空间__”。 取值范围： 必须以英文字母开头，只能由英文字母，数字和单下划线组成，没有连续的下划线，不能以单下划线结尾，且长度不能超过64个字符。 默认取值： 不涉及。 masterLabel 是 String 参数解释： 选项列表值集的标签。 约束限制： 不涉及。 取值范围： 1~64个字符。 默认取值： 不涉及。 description 否 String 参数解释： 选项列表值集的描述。 约束限制： 不涉及。 取值范围： 1~255个字符。 默认取值： 不涉及。 useFirstAsDefault 否 String 参数解释： 是否使用第一个值作为默认值。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 picklistValues 否 Array 参数解释： 添加一个或多个选项列表值，取值中禁止出现分号“;”。 约束限制： 不涉及。

响应参数 表1 响应参数 参数 参数类型 描述 resCode String 参数解释： 返回码。 取值范围： 如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 参数解释： 返回消息。 取值范围： 如果成功状态，通常会返回“Success”，其他情况会返回具体的错误信息。 result Array 参数解释： 成功返回会返回该账号下所有应用，以一个列表展示，每个值是一个应用。 表2 其中result内每个对象的主要属性 参数 参数类型 描述 id String 参数解释： 应用ID。 取值范围： 不涉及。 label String 参数解释： 应用的标签名。 取值范围： 不涉及。 name String 参数解释： 应用的名称。 取值范围： 不涉及。 description String 参数解释： 应用的描述信息。 取值范围： 不涉及。 type String 参数解释： 应用的类型。 取值范围： 不涉及。 logo String 参数解释： 应用的图标，可填图片地址（其前缀是受限的）。 取值范围： 不涉及。 properties String 参数解释： 应用的属性。 取值范围： 不涉及。

响应示例 { "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 } ] }

请求示例 根据object_id新增trigger。 POST https://AstroZero域名/u-route/baas/metadata/v1.0/Object/cust000000aKtFZpERvc/Trigger { "name": "Trigger_01", "label": "Trigger 01", "description": null, "script": "string", "jscode": "Hello, world;rn", "active": true, "event": "BeforeInsert" }

响应参数 表3 响应参数 参数 参数类型 描述 resCode String 参数解释： 返回码。 取值范围： 如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 参数解释： 返回消息。 取值范围： 如果成功状态，通常会返回“Success”，其他情况会返回具体的错误信息。 result string 参数解释： 成功返回会返回Object的一个ID值。 取值范围： 不涉及。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 参数解释： 新增触发器的名称。 约束限制： 不涉及。 取值范围： 必须以英文字母开头，只能由英文字母，数字和单下划线组成，没有连续的下划线，不能以单下划线结尾，且长度不能超过64个字符。 默认取值： 不涉及。 label 否 String 参数解释： 新增触发器的标签。 约束限制： 不涉及。 取值范围： 1~64个字符。 默认取值： 不涉及。 description 否 String 参数解释： 触发器的描述信息。 约束限制： 不涉及。 取值范围： 1~255个字符。 默认取值： 不涉及。 script 是 String 参数解释： 脚本名，即基于哪个脚本实现触发器的功能。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 jscode 否 string 参数解释： 触发器中的JavaScript代码。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 active 否 String 参数解释： 是否激活触发器。 约束限制： 不涉及。 取值范围： true：表示激活。 false：表示不激活。 默认取值： false event 否 String 参数解释： 满足什么条件时启动触发器。 约束限制： 不涉及。 取值范围： 可选择BeforeInsert、AfterInsert、BeforeUpdate，AfterUpdate、BeforeDelete或AfterDelete。 默认取值： 不涉及。

响应示例 { "resCode": "0", "resMsg": "成功", "result": [ { "TestProject__address__CST": null, "createdBy": "10gd000000SDzgxNSckK", "createdBy.__objectType": "User", "createdBy.name": "test0xx", "createdDate": "2020-05-28 14:34:40", "currencyIsoCode": "", "id": "cfw0000000aKin6AQgfQ", "installedPackage": null, "lastModifiedBy": "10gd000000SDzgxNSckK", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test0xx", "lastModifiedDate": "2020-05-28 14:34:40", "name": "testd", "owner": "10gd000000SDzgxNSckK", "owner.__objectType": "User", "owner.name": "test0xx" } ] }

响应参数 表2 响应参数说明 参数 参数类型 描述 resCode String 参数解释： 返回码。 取值范围： 如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 参数解释： 返回消息。 取值范围： 如果成功状态，通常会返回“Success”，其他情况会返回具体的错误信息。 result Array 参数解释： 如果请求成功，数组中只有一个对象，对象中包含记录中的数据。

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

响应参数 表3 响应参数 参数 参数类型 描述 resCode String 参数解释： 返回码。 取值范围： 如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 参数解释： 返回消息。 取值范围： 如果成功状态，通常会返回“Success”，其他情况会返回具体的错误信息。 result Number 参数解释： 删除记录的个数，成功时携带。 取值范围： 0~100。

URL POST、GET、PUT、DELETE AstroZero域名/u-route/baas/metadata/v1.0/{object_name}/{object_id} 表1 路径参数 参数 是否必选 参数类型 描述 object_name 是 String 参数解释： 对象的名称。 约束限制： 不涉及。 取值范围： 1~80个字符。 默认取值： 不涉及。 object_id 是 String 参数解释： 所填对象对应的实例ID，可通过调用查询所有自定义对象接口查看（响应消息中的“id”）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 示例1 如下请求创建了一个仅执行一次的数据导出任务，执行时间为2020-05-31 00:00:00，导出的文件格式为csv，编码格式为utf-8，需要导出的对象通过名为“myTemplate”的模板指定，未指定任何导出筛选条件。 POST https://AstroZero域名/u-route/baas/bulk/v1.0/export/data?flag=template&file_type=csv { "scheduleMode": 1, "firstScheduleDate": "2020-05-31 00:00:00", "encodeType": "utf-8", "templateName": "myTemplate" } 示例2 如下请求创建了周期性执行的数据导出任务，首次执行时间为2020-06-01 00:00:00，往后每隔一个月执行一次，导出的文件格式为txt，编码格式为GBK，需要导出的对象以数组的形式列在objects中，同时设定筛选条件，仅导出创建者id（createBy）为“1234567890xyz”的数据。 POST https://AstroZero域名/u-route/baas/bulk/v1.0/export/data?flag=template&file_type=txt { "scheduleMode": 2, "firstScheduleDate": "2020-06-01 00:00:00", "scheduleInterval": 1, "intervalUnit": "Month", "templateName": "template01", "encodeType": "gbk", "objects": [ "Flow", "Page" ], "cond": { "conjunction": "AND", "conditions": [ { "field": "createdBy", "operator": "eq", "value": "1234567890xyz" } ] } }

响应参数 表5 响应参数 参数 参数类型 描述 resCode String 参数解释： 返回码。 取值范围： 如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 参数解释： 返回消息。 取值范围： 如果成功状态，通常会返回“Success”，其他情况会返回具体的错误信息。 result String 参数解释： 创建成功的记录ID，成功时返回。 取值范围： 不涉及。

请求参数 表2 请求参数 参数 是否必选 参数类型 描述 cond 否 cond objects 参数解释： 导出筛选条件，为一个结构体，包含conditions和conjunction两个字段。 约束限制： 不涉及。 encode-type 是 String 参数解释： 导出文件的编码格式。 约束限制： 不涉及。 取值范围： 支持“UTF-8”和“GBK”两种类型。 默认取值： 不涉及。 firstScheduleDate 否 String 参数解释： 首次导出时间，格式为“yyyy-MM-dd HH:mm:ss” 约束限制： scheduleMode=2时，必选。 scheduleMode=1时，与isImmediate互斥。 取值范围： 不涉及。 默认取值： 不涉及。 objects 否 Array of Strings 参数解释： 需要导出的对象，为一字符串数组，数组中每个字符串为一个对象名，可同时导出多个对象数据，也可通过templateName参数指定模板选择导出的数据。 约束限制： 不涉及。 scheduleMode 是 Number 参数解释： 导出任务的执行次数。 约束限制： 不涉及。 取值范围： 1：仅执行一次。 2：按设定的频率执行多次。 默认取值： 不涉及。 scheduleInterval 否 Number 参数解释： 导出任务的执行间隔。 约束限制： “scheduleMode=2”时必选。 取值范围： 不涉及。 默认取值： 不涉及。 intervalUnit 否 Number 参数解释： 导出任务执行间隔对应的单位。 约束限制： “scheduleMode=2”时必选。 取值范围： Hour：小时。 Day：天。 Month：月。 默认取值： 不涉及。 isImmediate 否 Boolean 参数解释： 是否立即导出。 约束限制： “scheduleMode=1”时可选，“scheduleMode=1”时与firstScheduleDate互斥。 取值范围： 不涉及。 默认取值： 不涉及。 templateName 否 String 参数解释： 数据导出使用的模板名称，也可通过objects参数直接指定希望导出的对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 cond参数说明 参数 参数类型 描述 conditions Array of condition objects 参数解释： 条件数组，数组中每项作为一个条件。 约束限制： 不涉及。 conjunction String 参数解释： conditions数组中各个条件的组合方式。 约束限制： 不涉及。 取值范围： AND：与。 OR：或。 默认取值： 不涉及。 表4 条件参数condition说明 参数 是否必选 描述 field 是 参数解释： 筛选条件字段。 约束限制： 不涉及。 取值范围： createDate：创建时间。 createBy：创建者id。 lastModifiedDate：最后编辑时间。 lastModifiedBy：最后编辑者id。 默认取值： 不涉及。 operator 是 参数解释： 筛选运算操作。 约束限制： 只有时间类型的筛选字段支持所有操作，其他类型的字段仅支持eq/ne（等于或不等于）。 取值范围： gt：大于。 ge：大于等于。 eq：等于。 ne：不等于。 lt：小于。 le：小于等于。 timeFunc：时间函数。 默认取值： 不涉及。 value 是 参数解释： 进行比较的具体值。 约束限制： 不涉及。 取值范围： 当“operator”为“timeFunc”时，支持以下函数： today：今天。 yesterday：昨天。 last week：上周。 last month：上月。 last year：去年。 this week：本周。 this month：本月。 this year：今年。 若比较的字段为时间类型，则此处使用的时间字符串应为“yyyy-MM-dd HH:mm:ss”格式。 默认取值： 不涉及。

URI POST AstroZero域名/u-route/baas/bulk/v1.0/export/data?flag=template&file_type=csv 表1 路径参数 参数 是否必选 参数类型 描述 file_type 是 String 参数解释： 导出文件的格式，支持csv格式和txt格式。 约束限制： 不涉及。 取值范围： csv：数据以csv格式导出。 txt：数据以txt格式导出。 默认取值： 不涉及。

请求参数 表2 请求参数 参数 是否必选 参数类型 描述 condition 是 Object 参数解释： 表示删除的条件。 约束限制： 其中包含以下三个元素，为空则表示删除所有对象数据。 conjunction：表示需要满足的条件个数。 AND：表示条件都要满足。 OR：表示至少要满足一个条件。 conditions：筛选条件的数组。如果参数为空，代表查询所有对象数据，若不为空，其中的每一个元素对象都包含如下三个字段。 field：类型string，字段名称。 operator：类型string，操作符。 value:类型string，对比值。 relation：数组中包含parents（向上查询）和children（向下查询）两个元素，两者分别对应相应的数组。 其中，parents包含condition数组和relatedField（关联字段名称）。children包含condition数组和relationName（关联字段名称）。 condition数组包含： conjunction：取值为AND或OR。 conditions：同上conditions参数。 relation：同上relation参数。

请求示例 删除“TestProject__testForObject1__CST”对象中，name为“test”的记录数。 POST https://AstroZero域名/u-route/baas/data/v1.0/delete/TestProject__testForObject1__CST { "condition": { "conjunction": "AND", "conditions": [ { "field": "NAME", "operator": "eq", "value": "test" } ] } }

请求示例 创建服务编排对象实例，服务编排对象的标签为 "das"，名称为"t__das"。 POST https://AstroZero域名/u-route/baas/metadata/v1.0/Flow { "label": "das", "name": "t__das", "processType": "Autolaunched Flow", "localUrl": "/run/t__das", "startElement": "", "event": "", "eventCriteria": "", "interviewLabel": "das {!$Flow.CurrentDateTime}" }

响应示例 { "resCode": "0", "resMsg": "成功", "result": { "errors": [ "Flow(t__das) 的startElement为必选属性, 必须输入" ], "id": "000y000000aM8XixTN0S", "warnings": [] } }

请求参数 表1 请求参数 参数 是否必选 参数类型 描述 name 是 String 参数解释： 服务编排的名称。 约束限制： 不涉及。 取值范围： 必须以英文字母开头，只能由英文字母，数字和单下划线组成，没有连续的下划线，不能以单下划线结尾，且长度不能超过64个字符。 默认取值： 不涉及。 label 是 String 参数解释： 服务编排的标签。 约束限制： 不涉及。 取值范围： 1~64个字符。 默认取值： 不涉及。 processType 是 String 参数解释： 服务编排的类型。 约束限制： 不涉及。 取值范围： Autolaunched Flow：自启动Flow，在接口调用后会立即执行服务编排模型定义的逻辑。 Event Trigger：事件触发的服务编排，在事件触发时才会开始执行服务编排模型定义的逻辑。当选择该类型时，您需要配置具体的事件以及条件规则。 默认取值： Autolaunched Flow。 startElement 否 String 参数解释： 服务编排的起始元素。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 interviewLabel 否 String 参数解释： 服务编排实例的标签。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 localUrl 是 String 参数解释： 本地url。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 event 否 String 参数解释： 服务编排涉及的事件。 约束限制： 当processType为“ Event Trigger”时，必填。 取值范围： 不涉及。 默认取值： 不涉及。 variables 否 Array 参数解释： 绑定的具体事件信息。 约束限制： 当服务编排类型是“Event Trigger”，则可以填写绑定具体事件。

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

请求参数 表2 请求参数 参数 是否必选 参数类型 描述 condition 是 Object 参数解释： 表示查询的条件。 约束限制： 包含以下三个元素，若为空则表示查询所有对象数据。 conjunction：表示需要满足的条件个数。 AND：表示条件都要满足。 OR：表示至少要满足一个条件。 conditions：筛选条件的数组。如果参数为空，代表查询所有对象数据，若不为空，其中的每一个元素对象都包含三个字段： field：字段名称。 operator：操作符。例如，操作符“eq”表示等于，“ne”表示不等于，“gt”表示大于，“lt”表示小于，“ge”表示大于等于，“le”表示小于等于。 value：对比值。 relation：数组中包含parents（向上查询）和children（向下查询）两个元素，两者分别对应相应的数组。 其中，parents包含condition数组和relatedField（关联字段名称）。children包含condition数组和relationName（关联字段名称）。

请求示例 查询“TestProject__testForObject1__CST”对象中，name为“lisi”的记录数。 POST https://AstroZero域名/u-route/baas/data/v1.0/count/TestProject__testForObject1__CST { "condition": { "conjunction": "AND", "conditions": [ { "field": "NAME", "operator": "eq", "value": "lisi" } ] } }

URI POST AstroZero域名/u-route/baas/data/v1.0/count/{objectName}?base=X 表1 路径参数 参数 是否必选 参数类型 描述 objectName 是 String 参数解释： 数据对象的名称。 约束限制： 不涉及。 取值范围： 1~80个字符。 默认取值： 不涉及。 base 否 String 参数解释： 查询参数，用于区分objectName传入数据样式。 约束限制： 不涉及。 取值范围： 支持如下选项： I：对应对象的ID。 N：传入的对象名称。 默认取值： 不涉及。