ZStack AIOS

同步AI Nginx配置 (SyncAINginxConfiguration)

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

API请求

URLs

POST zstack/v1/ai/nginx/sync

Headers

Authorization: OAuth the-session-uuid

Body

{
  "param": {
    "syncAll": false
  },
  "systemTags": [],
  "userTags": []
}

说明：上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"param":{"syncAll":false}}' http://localhost:8080/zstack/v1/ai/nginx/sync

参数列表


名字	类型	位置	描述	起始版本
groupUuids (可选)	List	body(包含在param结构中)		5.1.20
dryRun (可选)	Boolean	body(包含在param结构中)		5.1.20
systemTags (可选)	List	body	系统标签	5.1.20
userTags (可选)	List	body	用户标签	5.1.20
syncAll (可选)	Boolean	body(包含在param结构中)		5.3.0

API返回

返回示例

{
  "unSyncedRules": []
}


名字	类型	描述	起始版本
success	boolean		5.1.20
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	5.1.20
unSyncedRules	List	详情参考unSyncedRules	5.1.20

#error


名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	5.1.20
description	String	错误的概要描述	5.1.20
details	String	错误的详细信息	5.1.20
elaboration	String	保留字段，默认为null	5.1.20
opaque	LinkedHashMap	保留字段，默认为null	5.1.20
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	5.1.20

#unSyncedRules


名字	类型	描述	起始版本
destUrl	String	重定向的目标URL	5.1.20
uuid	String	资源的UUID，唯一标示该资源	5.1.20
jupyterUrl	String	重定向的jupyter的URL	5.1.20
currentUrl	String	当前的URL	5.1.20
currentJupyterUrl	String	当前的juptyer的URL	5.1.20

SDK示例

Java SDK

SyncAINginxConfigurationAction action = new SyncAINginxConfigurationAction();
action.syncAll = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SyncAINginxConfigurationAction.Result res = action.call();

Python SDK

SyncAINginxConfigurationAction action = SyncAINginxConfigurationAction()
action.syncAll = false
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
SyncAINginxConfigurationAction.Result res = action.call()