ray.serve.schema.ServeInstanceDetails#

class ray.serve.schema.ServeInstanceDetails(*, controller_info: ServeActorDetails, proxy_location: ProxyLocation | None = None, http_options: HTTPOptionsSchema | None = None, grpc_options: gRPCOptionsSchema | None = None, proxies: Dict[str, ProxyDetails], deploy_mode: ServeDeployMode = ServeDeployMode.MULTI_APP, applications: Dict[str, ApplicationDetails], target_capacity: ConstrainedFloatValue | None = None)[source]#

Bases: BaseModel

Serve metadata with system-level info and details on all applications deployed to the Ray cluster.

This is the response JSON schema for v2 REST API GET /api/serve/applications.

Methods

__init__

Create a new model by parsing and validating input data from keyword arguments.

construct

Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.

copy

Duplicate a model, optionally choose which fields to include, exclude and change.

dict

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

get_empty_schema_dict

Empty Serve instance details dictionary.

json

Generate a JSON representation of the model, include and exclude arguments as per dict().

update_forward_refs

Try to update ForwardRefs on fields based on this Model, globalns and localns.

Attributes

controller_info

proxy_location

http_options

grpc_options

proxies

deploy_mode

applications

target_capacity