华为云用户手册

  • 响应参数 表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__ CS T": 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”)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 终止(即取消)分段上传任务 功能描述 分段上传任务可以被取消,当一个分段上传任务被取消后,就不能再使用其“uploadId”做任何操作,已经上传段也会被删除。 采用分段上传方式上传文件过程中或上传文件失败后会在桶内产生段,这些段会占用存储空间,可以通过取消该分段上传任务来清理掉不需要的段,节约存储空间。 URI POST AstroZero域名/u-route/baas/sys/v1.1/connectors/{connector_type}/{connector_name}/abortupload?object=X&uploadId=Y 表9 路径参数 参数 是否必选 参数类型 描述 connector_type 是 String 参数解释: 连接器的类型。 约束限制: 不涉及。 取值范围: obs:与OBS对接的连接器。 minio:与MINIO对接的连接器。 objectstorageproxy:对象存储代理类型。 默认取值: 不涉及。 connector_name 是 String 参数解释: 连接器实例的名称,即创建连接器时命名的连接器实例名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 object 是 String 参数解释: 上传文件到桶里的全路径,包含文件名、文件类型、上传到桶里的路径。不携带路径时,表示上传到桶的根目录下。 示例:取值为“a/b/c/test.mp4”,表示将文件“test.mp4”上传到桶的“a/b/c”路径下。如果桶中不存在该路径,会创建该路径。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 uploadId 是 String 参数解释: 整个分段上传任务的标识,请从初始化分段上传任务的返回结果中获取该值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 请求参数 无 响应参数 表10 响应参数说明 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。 请求示例 已创建好OBS类型连接器,连接器实例名称为“命名空间__TestOBS”,需要向该OBS桶的“a/b/c”路径下上传大文件。已有初始化分段上传任务和分段上传任务,标识“uploadId”为“0000017B76500F0662CABA7128913936”,调用如下请求,取消该分段上传任务。 POST https://AstroZero域名/u-route/baas/sys/v1.1/connectors/obs/命名空间__TestOBS/abortupload?object=a/b/c/test3.mp4&uploadId=0000017B76500F0662CABA7128913936 响应示例 { "resCode": "0", "resMsg": "成功" }
  • 上传分段 功能介绍 初始化分段上传任务之后,可以根据指定的对象文件名和“uploadId”来分段上传数据。每一个上传的段都有一个标识它的号码,即分段号(partNumber,范围是1~10000)。对于同一个分段上传任务(即uploadId相同),分段号“partNumber”不但唯一标识这一段数据,也标识了这段数据在整个对象文件内的相对位置。如果使用同一个分段号上传了新的数据,那么存储服务端上已有的这个段号的数据将被覆盖。除了最后一个分段以外,其他分段大小必须大于5MB,最大值对于OBS、MINIO本身来说没有限制,通过AstroZero平台该接口调用时,所有分段最大值不超过100MB。每个分段不需要按顺序上传,甚至可以在不同进程、不同机器上上传,存储服务端会按照分段号排序组成最终对象。 URI POST AstroZero域名/u-route/baas/sys/v1.1/connectors/{connector_type}/{connector_name}/uploadpart?object=X&uploadId=Y&partNumber=Z 表4 路径参数 参数 是否必选 参数类型 描述 connector_type 是 String 参数解释: 连接器的类型。 约束限制: 不涉及。 取值范围: obs:与OBS对接的连接器。 minio:与MINIO对接的连接器。 objectstorageproxy:对象存储代理类型。 默认取值: 不涉及。 connector_name 是 String 参数解释: 连接器实例的名称,即创建连接器时命名的连接器实例名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 object 是 String 参数解释: 上传文件到桶里的全路径,包含文件名、文件类型、上传到桶里的路径。不携带路径时,表示上传到桶的根目录下 示例:取值为“a/b/c/test.mp4”,表示将文件“test.mp4”上传到桶的“a/b/c”路径下。如果桶中不存在该路径,会创建该路径。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 uploadId 是 String 参数解释: 整个分段上传任务的标识,从初始化分段上传任务的返回结果中获取该值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 partNumber 是 Number 参数解释: 分段号。 对于同一个分段上传任务(即uploadId相同),分段号“partNumber”不但唯一标识这一段数据,也标识了这段数据在整个对象文件内的相对位置。 约束限制: 不涉及。 取值范围: 1~10000。 默认取值: 不涉及。 请求参数 请求中的body类型,按照“application/octet-stream”格式上传文件分段内容。 响应参数 表5 响应参数说明 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。 result Object 参数解释: 返回分段任务对象,包含如下字段: ETag:文件分段的标识, 用于后续完成上传时使用。 partNumber:分段号,用于后续完成上传时使用。 请求示例 已创建好OBS类型连接器,连接器实例名称为“命名空间__TestOBS”,需要向该OBS桶的“a/b/c”路径下上传大文件。已有初始化分段上传任务,标识“uploadId”为“0000017B761F112966C45D8FF0F75F13”,调用如下请求,创建分段上传任务,上传test.mp4,分段号为“1”。 POST https://AstroZero域名/u-route/baas/sys/v1.1/connectors/obs/命名空间__TestOBS/uploadpart?object=a/b/c/test.mp4&uploadId=0000017B761F112966C45D8FF0F75F13&partNumber=1 在请求Body中设置“application/octet-stream”格式的object,即要上传的文件数据。 响应示例 { "resCode": "0", "resMsg": "成功", "result": { "ETag": "\"d41d8cd98f00b204e9800998ecf8427e\"", "partNumber": 1 } } 请记录下“ETag”和“partNumber”的值,后续完成上传时需要使用。
  • 完成上传合并段 功能介绍 所有分段上传完成后,需要调用完成上传接口,在存储服务端(如OBS)合并段生成最终对象文件。在执行完成上传操作时,需要提供所有有效的分段列表(包括分段号和分段ETag值)。AstroZero收到提交的分段列表后,会逐一验证每个段的有效性。当所有段验证通过后,将把这些分段组合成最终的对象。合并的分段任务可以是不连续的分段号。 完成上传任务后,“uploadId”就失效了,不能再用于终止(即取消)分段上传任务。 URI POST AstroZero域名/u-route/baas/sys/v1.1/connectors/{connector_type}/{connector_name}/completeupload?object=X&uploadId=Y 表6 路径参数 参数 是否必选 参数类型 描述 connector_type 是 String 参数解释: 连接器的类型。 约束限制: 不涉及。 取值范围: obs:与OBS对接的连接器。 minio:与MINIO对接的连接器。 objectstorageproxy:对象存储代理类型。 默认取值: 不涉及。 connector_name 是 String 参数解释: 连接器实例的名称,即创建连接器时命名的连接器实例名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 object 是 String 参数解释: 上传文件到桶里的全路径,包含文件名、文件类型、上传到桶里的路径。不携带路径时,表示上传到桶的根目录下 示例:取值为“a/b/c/test.mp4”,表示将文件“test.mp4”上传到桶的“a/b/c”路径下。如果桶中不存在该路径,会创建该路径。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 uploadId 是 String 参数解释: 整个分段上传任务的标识,从初始化分段上传任务的返回结果中获取该值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 请求参数 数组类型,每个元素中包含如表7所示字段。 表7 请求参数说明 参数 是否必选 参数类型 描述 ETag 是 String 参数解释: 文件分段的标识,请从上传分段的返回结果中获取该值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 partNumber 是 String 参数解释: 分段号。 对于同一个分段上传任务(即uploadId相同),分段号“partNumber”不但唯一标识这一段数据,也标识了这段数据在整个对象文件内的相对位置,从上传分段的返回结果中获取该值。 约束限制: 不涉及。 取值范围: 1~10000。 默认取值: 不涉及。 响应参数 表8 响应参数说明 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。 请求示例 已创建好OBS类型连接器,连接器实例名称为“命名空间__TestOBS”,需要向该OBS桶的“a/b/c”路径下上传大文件。已有初始化分段上传任务和两个分段上传任务,标识“uploadId”为“0000017B761F112966C45D8FF0F75F13”,调用如下请求,完成分段上传任务,合并所有分段生成最终对象文件。 POST https://AstroZero域名/u-route/baas/sys/v1.1/connectors/obs/命名空间__TestOBS/completeupload?object=a/b/c/test.mp4&uploadId=0000017B761F112966C45D8FF0F75F13 [{ "ETag": "\"d41d8cd98f00b204e9800998ecf8427e\"", "partNumber": 1 }, { "ETag": "\"7dcad0c8a7398333ff25418bad511581\"", "partNumber": 2 }] 响应示例 { "resCode": "0", "resMsg": "成功" }
  • 请求参数 表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:传入的对象名称。 默认取值: 不涉及。
  • URI POST AstroZero域名/u-route/baas/bulk/v1.0/template/xlsx?template={template}&filename={filename} 表1 路径参数 参数 是否必选 参数类型 描述 template 是 String 参数解释: 数据导入模板的名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 filename 是 String 参数解释: 上传的文件名称。 约束限制: 支持“xls”和“xlsx”格式的文件。 取值范围: 不涉及。 默认取值: 不涉及。
共100000条