ray.serve.get_deployment_handle#

ray.serve.get_deployment_handle(deployment_name: str, app_name: Optional[str] = None) → ray.serve.handle.DeploymentHandle[source]#

Get a handle to a deployment by name.

This is a developer API and is for advanced Ray users and library developers.

Parameters

  • deployment_name – Name of deployment to get a handle to.

  • app_name – Application in which deployment resides. If calling from inside a Serve application and app_name is not specified, this will default to the application from which this API is called.

Raises

RayServeException – If no Serve controller is running, or if calling from outside a Serve application and no application name is specified.

DeveloperAPI: This API may change across minor Ray releases.