检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API接口 如何开放API接口 如何进行接口鉴权 如何自定义错误码 如何控制接口访问权限 父主题: 经典版开发指导
源。 在接口列表中,单击接口后的,可查看定义的API信息。 单击“测试一下”,可模拟API接口调用。 图5 API接口请求参数信息 图6 API接口返回参数信息 API接口的请求参数和返回消息体,为绑定的资源(如脚本,服务编排等)所配置的入参和出参。 父主题: API接口
客户端收到授权码code,根据鉴权ID、鉴权密钥和授权码code在后端调用接口“ https://域名/baas/auth/v1.0/oauth2/token”获取access_token。后续第三方需要通过access_token获取授权用户信息。 表5 接口基本信息 接口名称 接口路径 接口协议 接口方法 token
环境管理中心。 在左侧导航栏中,选择“系统管理 > 域名配置”。 在右侧域名配置区域,单击“默认域名”后的“编辑”,设置默认域名,单击“保存”。 图1 设置域名 域名设置完成后,将域名分享给业务用户,业务用户在浏览器中输入域名,即可访问业务应用的登录页。 应用可见设置,支持一个运
平台域名是平台为当前环境分配的一个子域名,用于企业成员用户登录访问。 在右侧域名配置区域,单击“平台域名”后的“编辑”,编辑域名配置,单击“保存”。 域名设置完成后,将域名分享给业务用户,业务用户在浏览器中输入域名,即可访问业务应用的登录页。 图1 编辑默认域名 应用可见设置,支持一个运行环境同时
查询应用页签的列表。 服务编排 服务编排接口,包括编排Flow和查看服务编排运行实例两个接口。 表3 服务编排接口 API 说明 编排Flow 编排某个服务编排。 查看服务编排运行实例 查询服务编排信息。 脚本 脚本接口,包括运行、调试和获取脚本签名信息等接口。通过这些接口,您可以运行脚本、对脚本进行调试等。
返回“集成”页面,单击已创建接口后的,选择“查看”,进入接口预览页面。 单击接口后的,可查看定义的API信息。 单击“测试一下”,可模拟API接口调用。 图2 API接口请求参数信息 图3 API接口返回参数信息 API接口的请求参数和返回消息体,为绑定的资源(如脚本,服务编排等)所配置的入参和出参。
"allowChatter": false, "allowStreamingApiAccess": false, "allowBulkApiAccess": false, "allowSearch": false, "allowSharing":
AstroZero域名/u-route/baas/metadata/v1.0/Object/{object_id} 表1 路径参数 参数 是否必选 参数类型 描述 object_Id 是 String 参数解释: 对象的ID值,可通过调用查询所有自定义对象接口查看(响应消息中的“id”)。
配置API 使用说明 原生服务旨在帮助您在AstroZero平台上或外部系统,调用已开发好的服务。为了完成调用,需要知道服务开放了哪些接口,以及这些接口的请求参数、返回参数,完成设计API后,可在服务编排中进行调用,也可将API再封装为自定义公共接口,供外部系统调用自定义公共接口。
API 数据模块 元数据 服务编排 脚本 BPM 导入导出 连接器
预置API 脚本中预置的API 标准页面中预置的API 高级页面中预置的API
创建Picklist对象 功能介绍 创建一个Picklist对象。 URI POST AstroZero域名/u-route/baas/metadata/v1.0/Picklist 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 参数解释:
AstroZero域名/u-route/baas/metadata/v1.0/object/{object_id}/Trigger 表1 路径参数 参数 是否必选 参数类型 描述 object_Id 是 String 参数解释: 对象的ID值,可通过调用查询所有自定义对象接口查看(响应消息中的“id”)。
AstroZero域名/u-route/baas/metadata/v1.0/Object/{object_id}/Field 表1 路径参数 参数 是否必选 参数类型 描述 Object_id 是 String 参数解释: 对象的ID值,可通过调用查询所有自定义对象接口查看(响应消息中的“id”)。
AstroZero域名/u-route/baas/bp/v2.0/metadata/definitions/{bpm_id} 表1 路径参数 参数 是否必选 参数类型 描述 bpm_id 是 String 参数解释: BPM的实例ID,可通过调用按条件查询BPM对象接口查看(响应消息中的“id”)。
按条件更新数据 功能介绍 按条件更新数据,该接口为同步接口(同步接口是指调用后,会等待函数执行结束后,才返回结果)。 在此之前需要先创建对象以及待更新的数据记录。 URI PUT AstroZero域名/u-route/baas/data/v1.0/bobject/{objectName}
对象的ID值,可通过调用查询所有自定义对象接口查看(响应消息中的“id”)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 trigger_id 是 String 参数解释: 触发器的ID值,可通过调用5.2.3.13-根据object_id查询trigger接口查看(响应消息中的“id”)。
功能介绍 调试脚本,该接口是同步接口(同步接口是指调用后,会等待函数执行结束后,才返回结果)。满足输入参数条件后执行该脚本,会在控制台打印出debug日志和运行结果。 在脚本保存成功和输入参数正确的情况下,才可以成功执行该脚本。 URI POST AstroZero域名/u-route/baas/script/v1
功能介绍 运行脚本,该接口是同步接口(同步接口是指调用后,会等待函数执行结束后,才返回结果)。满足输入参数条件后执行该脚本,不会在控制台打印出日志,但会输出运行结果。 在脚本保存成功和输入参数正确的情况下,可以运行该脚本,但该接口目前已很少使用(可以用custom API运行脚本)。 URI