API请求
URLs
PUT zstack/v1/ai/model-services/app/Headers
Authorization: OAuth the-session-uuidBody
{
"deployAppDevelopmentService": {
"uuid": "0d42d5aa4aeb3d2bb5d091ded6424381",
"zoneUuid": "65b12a8e3aa632efb58eb12d4160a73f",
"cpuNum": 8,
"name": "model-service",
"type": "VirtualMachine",
"memorySize": 17179869184
},
"systemTags": [],
"userTags": []
}说明: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"deployAppDevelopmentService":{"uuid":"0d42d5aa4aeb3d2bb5d091ded6424381","zoneUuid":"65b12a8e3aa632efb58eb12d4160a73f","cpuNum":8,"name":"model-service","type":"VirtualMachine","memorySize":17179869184}}' \
http://localhost:8080/zstack/v1/ai/model-services/app/参数列表
| 名字 | 类型 | 位置 | 描述 | 可选值 | 起始版本 |
|---|---|---|---|---|---|
| uuid (可选) | String | body(包含在deployAppDevelopmentService结构中) | 资源的UUID,唯一标示该资源 | 5.2.1 | |
| description (可选) | String | body(包含在deployAppDevelopmentService结构中) | 资源的详细描述 | 5.2.1 | |
| modelUuid (可选) | String | body(包含在deployAppDevelopmentService结构中) | 模型uuid | 5.2.1 | |
| zoneUuid | String | body(包含在deployAppDevelopmentService结构中) | 区域UUID | 5.2.1 | |
| vmImageUuid (可选) | String | body(包含在deployAppDevelopmentService结构中) | 云主机镜像uuid | 5.2.1 | |
| primaryStorageUuid (可选) | String | body(包含在deployAppDevelopmentService结构中) | 主存储UUID | 5.2.1 | |
| datasetUuids (可选) | List | body(包含在deployAppDevelopmentService结构中) | 数据集uuid | 5.2.1 | |
| modelServiceGroupUuids (可选) | List | body(包含在deployAppDevelopmentService结构中) | 推理服务uuid | 5.2.1 | |
| dockerImage (可选) | String | body(包含在deployAppDevelopmentService结构中) | 容器镜像 | 5.2.1 | |
| cpuNum (可选) | Integer | body(包含在deployAppDevelopmentService结构中) | cpu数量 | 5.2.1 | |
| name | String | body(包含在deployAppDevelopmentService结构中) | 资源名称 | 5.2.1 | |
| type | String | body(包含在deployAppDevelopmentService结构中) | 部署类型 |
|
5.2.1 |
| memorySize (可选) | Long | body(包含在deployAppDevelopmentService结构中) | 内存大小 | 5.2.1 | |
| l3NetworkUuids (可选) | List | body(包含在deployAppDevelopmentService结构中) | 三层网络 | 5.2.1 | |
| serviceBootUptime (可选) | Integer | body(包含在deployAppDevelopmentService结构中) | 服务启动时间 | 5.2.1 | |
| systemTags (可选) | List | body | 系统标签 | 5.2.1 | |
| userTags (可选) | List | body | 用户标签 | 5.2.1 | |
| requestCpuNum (可选) | Integer | body(包含在deployAppDevelopmentService结构中) | 请求CPU数量。 | 5.5.22 | |
| requestMemorySize (可选) | Long | body(包含在deployAppDevelopmentService结构中) | 请求内存大小。 | 5.5.22 | |
| serviceLivez (可选) | String | body(包含在deployAppDevelopmentService结构中) | 服务存活探针。 | 5.5.22 | |
| serviceReadyz (可选) | String | body(包含在deployAppDevelopmentService结构中) | 服务就绪探针。 | 5.5.22 | |
| projectUuid (可选) | String | body(包含在deployAppDevelopmentService结构中) | 项目UUID。 | 5.5.22 | |
| resourceUuid (可选) | String | body(包含在deployAppDevelopmentService结构中) | 资源UUID | 5.3.46 | |
| tagUuids (可选) | List | body(包含在deployAppDevelopmentService结构中) | 标签UUID列表 | 5.3.46 | |
| environmentVariables (可选) | Map | body(包含在deployAppDevelopmentService结构中) | 环境变量。 | 5.5.22 | |
| startupParameters (可选) | Map | body(包含在deployAppDevelopmentService结构中) | 启动参数。 | 5.5.22 | |
| clusterUuid (可选) | String | body(包含在deployAppDevelopmentService结构中) | 集群UUID。 | 5.5.22 | |
| rootDiskOfferingUuid (可选) | String | body(包含在deployAppDevelopmentService结构中) | 根云盘规格UUID。 | 5.5.22 | |
| rootDiskSize (可选) | Long | body(包含在deployAppDevelopmentService结构中) | 根云盘大小。 | 5.5.22 |
API返回
返回示例
{
"inventory": {
"uuid": "groupUuid",
"name": "app-service",
"status": "Running"
},
"app": {
"uuid": "appUuid",
"deploymentStatus": "Running",
"packageVersion": "1.0.0"
}
}返回字段
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| success | Boolean | 操作是否成功 | 5.1.8 |
| error | ErrorCode | 错误码,操作成功时该字段为null | 5.1.8 |
| inventory | ModelServiceInstanceGroupInventory | 模型服务实例组清单 | 5.1.8 |
| app | ApplicationDevelopmentServiceInventory | 应用开发服务清单 | 5.1.8 |
#inventory
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID,唯一标识该资源 | 5.1.8 |
| modelServiceUuid | String | 模型服务UUID | 5.1.8 |
| modelUuid | String | 模型UUID | 5.1.8 |
| instances | List | 模型服务实例列表 | 5.1.8 |
| datasetRefInventories | List | 数据集引用列表 | 5.1.8 |
| status | String | 实例组状态 | 5.1.8 |
| modelServiceType | String | 模型服务类型 | 5.1.8 |
| type | String | 实例组类型 | 5.1.8 |
| name | String | 实例组名称 | 5.1.8 |
| description | String | 实例组描述 | 5.1.8 |
| yaml | String | YAML配置 | 5.1.8 |
| supportMetrics | List | 支持的指标列表 | 5.1.8 |
| exportPath | String | 导出路径 | 5.1.8 |
| createDate | Timestamp | 创建时间 | 5.1.8 |
| lastOpDate | Timestamp | 最后一次修改时间 | 5.1.8 |
#app
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID,唯一标识该资源 | 5.1.8 |
| modelServiceUuid | String | 模型服务UUID | 5.1.8 |
| modelUuid | String | 模型UUID | 5.1.8 |
| instances | List | 模型服务实例列表 | 5.1.8 |
| datasetRefInventories | List | 数据集引用列表 | 5.1.8 |
| status | String | 实例组状态 | 5.1.8 |
| modelServiceType | String | 模型服务类型 | 5.1.8 |
| type | String | 实例组类型 | 5.1.8 |
| name | String | 实例组名称 | 5.1.8 |
| description | String | 实例组描述 | 5.1.8 |
| yaml | String | YAML配置 | 5.1.8 |
| supportMetrics | List | 支持的指标列表 | 5.1.8 |
| exportPath | String | 导出路径 | 5.1.8 |
| createDate | Timestamp | 创建时间 | 5.1.8 |
| lastOpDate | Timestamp | 最后一次修改时间 | 5.1.8 |
| deploymentStatus | String | 部署状态 | 5.1.8 |
| packageVersion | String | 软件包版本 | 5.1.8 |
| service | ModelServiceInventory | 关联的模型服务 | 5.1.8 |
SDK示例
Java
SDK
DeployAppDevelopmentServiceAction action = new DeployAppDevelopmentServiceAction();
action.uuid = "0d42d5aa4aeb3d2bb5d091ded6424381";
action.zoneUuid = "65b12a8e3aa632efb58eb12d4160a73f";
action.cpuNum = 8;
action.name = "model-service";
action.type = "VirtualMachine";
action.memorySize = 17179869184;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeployAppDevelopmentServiceAction.Result res = action.call();Python
SDK
DeployAppDevelopmentServiceAction action = DeployAppDevelopmentServiceAction()
action.uuid = "0d42d5aa4aeb3d2bb5d091ded6424381"
action.zoneUuid = "65b12a8e3aa632efb58eb12d4160a73f"
action.cpuNum = 8
action.name = "model-service"
action.type = "VirtualMachine"
action.memorySize = 17179869184
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeployAppDevelopmentServiceAction.Result res = action.call()