检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
分享Token 通过调用获取分享Token,可以获取临时Token,用户只要使用该临时Token即可访问文件,不用再使用“access-token”进行鉴权。 分享Token分为如下2个步骤: 获取分享Token,获取临时Token。 查看分享对象文件,使用临时Token访问文件。
(Guest):对于该类用户,平台接口都需要进行校验,未登录前使用Guest用户身份来访问平台接口,一般会赋予最小的权限。 使用的认证机制为:“OAuth 2.0鉴权登录认证”。 获取Token的认证接口,如表1所示。 表1 认证接口说明 接口 说明 生成Token的用户 是否可以直接访问接口 账号密码登录
构造请求 本节介绍REST API请求的组成,并以使用OAuth 2.0协议的客户端鉴权模式获取用户access_token为例说明如何调用API,该API获取access_token,access_token可以用于调用其他API时鉴权。 请求URI 请求URI由如下部分组成:
client_secret:鉴权的密钥。 根据鉴权ID和鉴权密钥调用接口“/baas/auth/v1.0/oauth2/token”,获取access_token。 表2 接口基本信息 接口名称 接口路径 接口协议 接口方法 token /baas/auth/v1.0/oauth2/token HTTPS
ss_token进行鉴权。 操作步骤 参考登录经典应用设计器中操作,登录经典版应用设计器。 在左侧列表中,单击,选择“HTTP > Rest服务”。 在新建或修改Rest服务时,设置鉴权信息。 图1 鉴权设置操作入口 图2 OAuth鉴权模式示例配置 父主题: 如何对接口鉴权
根据鉴权ID和鉴权密钥调用接口“/baas/auth/v1.0/oauth2/token”获取access_token。 表2 接口基本信息 接口名称 接口路径 接口协议 接口方法 token /baas/auth/v1.0/oauth2/token HTTPS POST 表3
查询服务编排信息。 脚本 脚本接口,包括运行、调试和获取脚本签名信息等接口。通过这些接口,您可以运行脚本、对脚本进行调试等。 表4 脚本接口 API 说明 运行脚本 运行脚本。 调试脚本 调试脚本。 获取脚本签名信息 获取脚本签名信息。 获取脚本内置库信息 获取脚本内置库的声明。 获取Flow公式信息
API 数据模块 元数据 服务编排 脚本 BPM 导入导出 连接器
在连接器详情页面,单击测试中的某个接口,再单击“测试一下”,可模拟API接口调用。 以“自然语言处理基础服务”中的“RunNer”接口为例。 图2 单击“RunNer”接口 图3 API接口请求参数信息 请务必按照“示例模型”中的格式配置接口请求参数,各接口请求参数配置说明请参见各服务的API参考,如《自然语言处理基础服务接口说明》。
配置API 使用说明 原生服务旨在帮助您在AstroZero平台上或外部系统,调用已开发好的服务。为了完成调用,需要知道服务开放了哪些接口,以及这些接口的请求参数、返回参数,完成设计API后,可在服务编排中进行调用,也可将API再封装为自定义公共接口,供外部系统调用自定义公共接口。
预置API 脚本中预置的API 标准页面中预置的API 高级页面中预置的API
API接口 如何开放API接口 如何进行接口鉴权 如何自定义错误码 如何控制接口访问权限 父主题: 经典版开发指导
源。 在接口列表中,单击接口后的,可查看定义的API信息。 单击“测试一下”,可模拟API接口调用。 图5 API接口请求参数信息 图6 API接口返回参数信息 API接口的请求参数和返回消息体,为绑定的资源(如脚本,服务编排等)所配置的入参和出参。 父主题: API接口
HttpUtils.getCsrfToken:通过ajax的方式去调用平台的接口时使用。如果使用平台桥接器的方式,平台会自动在请求header中,添加csrf-token头。 HttpUtils.getCsrfToken(function(csrfToken) { $.ajax({
如何调用API 构造请求 认证鉴权 返回结果
0的客户端鉴权模式,获取的用户access_token接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于使用OAuth 2.0的client credentials鉴权模式,获取的用户Token接口,返回如下所示的消息头。
获取脚本签名信息 功能介绍 获取脚本签名信息,该接口是同步接口(同步接口是指调用后,会等待函数执行结束后,才返回结果)。获取脚本的名称、输入参数、输出参数、声明的类名、方法名等相关信息。 只有用户保存或另存脚本时会调用该接口,当脚本中定义的输入参数或输出参数的类型错误时,该接口会执行报错。
器将返回内容解析为json对象。 是 access-token 当用户登录系统鉴权成功后,后台会生成一个token,在响应消息中携带,并存在浏览器中。下次再调用请求后,会带上这个token,表示这个用户已经被鉴权过。 是 该接口不用构造请求消息体。返回如下响应,表示成功查询对象列表。
获取Flow公式信息 功能介绍 获取Flow的公式,该接口是同步接口(同步接口是指调用后,会等待函数执行结束后,才返回结果)。这些公式可以使用Flow对变量或表达式进行转换,然后赋值给其他变量。 URI GET AstroZero域名/u-route/baas/formula/v1
获取脚本内置库信息 功能介绍 获取脚本内置库的声明,该接口为同步接口(同步接口是指调用后,会等待函数执行结束后,才返回结果)。获取AstroZero平台可以调用的typeScript库,其中包括脚本函数以及函数相关信息,并且可以获取ES5语法的标准库。 AstroZero平台可以