管理API

TorchServe 提供以下 API，允许您在运行时管理工作流：

1. 注册工作流

2. 描述工作流程的状态

3. 取消工作流

4. 列出已注册的工作流

工作流管理API监听8081端口，默认情况下仅可从localhost访问。要更改默认设置，请参阅TorchServe配置。

注册工作流

POST /workflows

• url - 工作流程归档下载URL。支持以下位置:

  • a本地工作流归档 (.war)；文件必须在workflow_store文件夹中（并且不在子文件夹中）。

  • 一个使用HTTP(s)协议的URI。TorchServe可以从互联网上下载.war个文件。

• workflow_name - 流程的名称；这个名称将在其他API中作为{workflow_name}使用，作为路径的一部分。如果此参数不存在，则将使用MANIFEST.json中的modelName。

curl -X POST  "http://localhost:8081/workflows?url=https://<public_url>/myworkflow.mar"

{
  "status": "Workflow myworkflow has been registered and scaled successfully."
}

工作流程注册API解析由工作流档案(.war)提供的工作流程规范文件(.yaml)，并使用规范中提供的配置将DAG中指定的所有模型注册到TorchServe。

描述工作流程

GET /workflows/{workflow_name}

使用Describe Workflow API 获取工作流的详细信息：

curl http://localhost:8081/workflows/myworkflow
[
  {
    "workflowName": "myworkflow",
    "workflowUrl": "myworkflow.war",
    "minWorkers": 1,
    "maxWorkers": 1,
    "batchSize": 8,
    "maxBatchDelay": 5000,
    "workflowDag": "{preprocessing=[m1], m1=[postprocessing]}"
  }
]

注销工作流

DELETE /workflows/{workflow_name}

使用Unregister Workflow API释放系统资源，通过从TorchServe注销一个工作流：

curl -X DELETE http://localhost:8081/workflows/myworkflow

{
  "status": "Workflow \"myworkflow\" unregistered"
}

列表工作流

GET /models

• limit - (可选) 返回的最大项目数。作为查询参数传递。默认值为 100。

• next_page_token - (可选) 下一页查询。作为查询参数传递。此值由先前的API调用返回。

使用工作流API查询当前注册的工作流列表：

curl "http://localhost:8081/workflows"

这个API支持分页：

curl "http://localhost:8081/workflows?limit=2&next_page_token=2"

{
  "nextPageToken": "4",
  "workflows": [
    {
      "workflowName": "myworkflow1",
      "workflowUrl": "myworkflow1.war"
    },
    {
      "workflowName": "myworkflow2",
      "workflowUrl": "myworkflow2.war"
    }
  ]
}