mirror of
https://github.com/vale981/ray
synced 2025-03-06 18:41:40 -05:00
154 lines
No EOL
3.3 KiB
Markdown
154 lines
No EOL
3.3 KiB
Markdown
(serve-rest-api)=
|
|
|
|
# Serve REST API
|
|
|
|
## REST API
|
|
|
|
```
|
|
GET /api/serve/deployments/ HTTP 1.1
|
|
Host: http://localhost:52365/
|
|
Accept: application/json
|
|
```
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200 OK
|
|
Content-Type: application/json
|
|
|
|
```
|
|
|
|
### `PUT "/api/serve/deployments/"`
|
|
|
|
Declaratively deploys the Serve application. Starts Serve on the Ray cluster if it's not already running. See the [config schema](serve-rest-api-config-schema) for the request's JSON schema.
|
|
|
|
**Example Request**:
|
|
|
|
```
|
|
PUT /api/serve/deployments/ HTTP 1.1
|
|
Host: http://localhost:52365/
|
|
Accept: application/json
|
|
|
|
{
|
|
"import_path": "fruit.deployment_graph",
|
|
"runtime_env": {
|
|
"working_dir": "https://github.com/ray-project/serve_config_examples/archive/HEAD.zip"
|
|
},
|
|
"deployments": [
|
|
{"name": "MangoStand", "user_config": {"price": 1}},
|
|
{"name": "OrangeStand", "user_config": {"price": 2}},
|
|
{"name": "PearStand", "user_config": {"price": 3}}
|
|
]
|
|
}
|
|
```
|
|
|
|
**Example Response**
|
|
|
|
|
|
```http
|
|
HTTP/1.1 200 OK
|
|
Content-Type: application/json
|
|
```
|
|
|
|
### `GET "/api/serve/deployments/status"`
|
|
|
|
Gets the Serve application's current status, including all the deployment statuses. This config represents the current goal state for the Serve application. Starts a Serve application on the Ray cluster if it's not already running. See the [status schema](serve-rest-api-status-schema) for the response's JSON schema.
|
|
|
|
**Example Request**:
|
|
|
|
```
|
|
GET /api/serve/deployments/ HTTP 1.1
|
|
Host: http://localhost:52365/
|
|
Accept: application/json
|
|
```
|
|
|
|
**Example Response**
|
|
|
|
```http
|
|
HTTP/1.1 200 OK
|
|
Content-Type: application/json
|
|
|
|
```
|
|
|
|
### `DELETE "/api/serve/deployments/"`
|
|
|
|
Shuts down the Serve application running on the Ray cluster. Has no
|
|
effect if Serve is not running on the Ray cluster.
|
|
|
|
**Example Request**:
|
|
|
|
```
|
|
DELETE /api/serve/deployments/ HTTP 1.1
|
|
Host: http://localhost:52365/
|
|
Accept: application/json
|
|
```
|
|
|
|
**Example Response**
|
|
|
|
```http
|
|
HTTP/1.1 200 OK
|
|
Content-Type: application/json
|
|
```
|
|
|
|
(serve-rest-api-config-schema)=
|
|
|
|
## Config Schema
|
|
|
|
```{eval-rst}
|
|
.. autopydantic_model:: ray.serve.schema.ServeApplicationSchema
|
|
|
|
```
|
|
|
|
(serve-rest-api-status-schema)=
|
|
|
|
## Status Schema
|
|
|
|
```{eval-rst}
|
|
.. autopydantic_model:: ray.serve.schema.ServeStatusSchema
|
|
|
|
``` |