ZStack AIOS

HTTP Headers

面向开发者的 API 使用规范、SDK 调用方式和 AIOS 相关接口说明。

当前API使用如下自定义HTTP Headers：

Authorization

除了少数API外（例如登录API），使用ZStack AIOS API前都需要一个会话(session)，在调用API时通过Authorization HTTP Header传递会话UUID。该Header的格式为：

Authorization: OAuth 会话UUID

举例：

Authorization: OAuth 34cbfddd470a47d8bdb0727cd2182618

说明： OAuth和会话UUID之间用空格分隔。

对于异步API，可以通过X-Job-UUID HTTP Header来指定该API Job的UUID，例如：

X-Job-UUID: d825b1a26f4e474b8c59306081920ff2

如果未指定该HTTP Header，ZStack AIOS会自动为API Job生成一个UUID。

说明：

X-Job-UUID必须为一个v4版本的UUID（即随机UUID）字符串去掉连接符-。ZStack AIOS会验证X-Job-UUID格式的合法性，并对非法的字符串返回一个400 Bad Request的错误。

对于异步API，可以通过X-Web-Hook HTTP Header指定一个回调URL用于接收API 返回。通过使用回调URL的方法，调用者可以避免使用轮询去查询一个异步API的执行结果。举例：

X-Web-Hook: http://localhost:5000/api-callback

当使用了X-Web-Hook回调的方式获取异步API结果时，ZStack AIOS推送给回调URL的HTTP Post请求中会包含X-Job-Success HTTP Header指明该异步API的执行结果是成功还是失败。例如：

X-Job-Success: true

当值为true时执行成功，为false时执行失败。