检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API接口 如何开放API接口 如何进行接口鉴权 如何自定义错误码 如何控制接口访问权限 父主题: 经典版开发指导
base=X&fields=f1,f2 表1 路径参数 参数 是否必选 参数类型 描述 objectName 是 String 参数解释: 数据对象的名称,请参考登录应用设计器中操作,进入应用设计器,在“数据 > 对象”列表中查看。 约束限制: 不涉及。 取值范围: 1~80个字符。 默认取值: 不涉及。
processType 是 String 参数解释: 服务编排的类型。 约束限制: 不涉及。 取值范围: Autolaunched Flow:自启动Flow,在接口调用后会立即执行服务编排模型定义的逻辑。 Event Trigger:事件触发的服务编排,在事件触发时才会开始执行服务编排模型定义的逻辑。
服务下接口定义yaml文件。 单击,发布API。 发布后如果需要修改API,需要单击,取消发布后进行修改,修改后再保存并发布。 已发布的API可能在服务编排中已经使用,如果修改API导致不兼容,请同步修改引用该API的服务编排。 在经典版环境配置中,查看API 发布API后,可在
按记录ID删除数据 功能介绍 按记录ID删除数据,该接口为同步接口(同步接口是指调用后,会等待函数执行结束后,才返回结果)。 在此之前需要先创建对象以及待删除的数据记录。 URI DELETE AstroZero域名/u-route/baas/data/v1.0/bobject/
0/count/{objectName}?base=X 表1 路径参数 参数 是否必选 参数类型 描述 objectName 是 String 参数解释: 数据对象的名称,请参考登录应用设计器中操作,进入应用设计器,在“数据 > 对象”列表中查看。 约束限制: 不涉及。 取值范围: 1~80个字符。 默认取值: 不涉及。
的快速应用开发和构建。 您可以使用本文提供的API,在AstroZero上对数据、元数据、访问控制、脚本、服务编排等进行相关操作,如运行服务编排、终止(删除)服务编排实例等,支持的全部操作可参见API概览。 在调用Astro轻应用API前,请确保已充分了解Astro轻应用的相关概念,详细信息请参见产品介绍。
按记录ID列表删除数据 功能介绍 按记录ID列表删除数据,该接口为同步接口(同步接口是指调用后,会等待函数执行结束后,才返回结果)。 在此之前需要先创建对象以及待删除的数据记录。 URI DELETE AstroZero域名/u-route/baas/data/v1.0/bobject/{objectName}
如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。 result Array 参数解释: 插入或者更新成功,返回相应记录id组成的数组。 请求示例 向对象“Test
响应参数 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。
响应参数 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。
响应参数 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。
表1 路径参数 参数 是否必选 参数类型 描述 bpm_id 是 String 参数解释: BPM的实例ID,可通过调用按条件查询BPM对象接口查看(响应消息中的“id”)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 请求参数 无 响应消息 表2 响应参数 参数
如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。 result Object 参数解释: 成功返回应用的详细信息,具体返回的信息可参考表3。 表3 result内每个对象的主要属性
processType 否 String 参数解释: 服务编排的类型。 约束限制: 不涉及。 取值范围: Autolaunched Flow:自启动Flow,在接口调用后会立即执行服务编排模型定义的逻辑。 Event Trigger:事件触发的服务编排,在事件触发时才会开始执行服务编排模型定义的逻辑。
状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。
按记录ID列表查询数据 功能介绍 按记录ID列表查询数据,该接口为同步接口(同步接口是指调用后,会等待函数执行结束后,才返回结果)。 在此之前需要先创建对象以及待查询的数据记录。 URI GET AstroZero域名/u-route/baas/data/v1.0/bobject/{objectName}
取值范围: 不涉及。 默认取值: 不涉及。 private 否 String 参数解释: 是否私有。私有的服务编排不能通过Rest API或者自定义API(公共接口)进行调用。 约束限制: 不涉及。 取值范围: true:私有。 false:公开。 默认取值: 不涉及。 响应参数 响应参数如表3所示。
响应参数说明 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。当调用出错时,HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便尽快帮您解决问题。