AIaieev
Endpoints

Get Endpoint Status

Changed on

Returns the current status of an endpoint. Includes replica status summary when active.

get/endpoints/{endpoint_id}

Request

  • Base URL
    https://external.aieev.cloud:5000/external/api/v1
  • URL
    https://external.aieev.cloud:5000/external/api/v1/endpoints/{endpoint_id}
  • Auth
    HTTP bearer

Path parameters

endpoint_idstring required
Example:51c910f7-ecde-4c6c-88f8-d8e37ca9d598

Unique endpoint ID.

Response

Endpoint status.

endpoint_idstring

Unique endpoint ID.

namestring

Endpoint name.

endpoint_typestring

Endpoint type.

is_activeboolean

Whether the endpoint is active.

statusstring

Current status. When active, fetched in real-time from Ray Serve.

num_replicasinteger

Current number of replicas.

enable_autoscalingboolean

Whether autoscaling is enabled.

instance_type_namestring nullable

Instance type name.

serving_endpoint_urlstring nullable

Public endpoint URL.

replica_status_summaryobject nullable

Replica count by status. Only available when endpoint is active.

tagsstring[]

Tags assigned to the endpoint.

created_atstring date-time

Creation time.

updated_atstring date-time

Last update time.

Example response

{
  "endpoint_id": "51c910f7-ecde-4c6c-88f8-d8e37ca9d598",
  "name": "aieev-endpoint",
  "endpoint_type": "container",
  "is_active": true,
  "status": "RUNNING",
  "num_replicas": 2,
  "instance_type_name": "RTX 5090",
  "serving_endpoint_url": "https://ap-1.aieev.cloud/endpoints/51c910f7-ecde-4c6c-88f8-d8e37ca9d598",
  "error": {
    "type": "/errors/upstream-timeout",
    "title": "Upstream timeout",
    "status": 504,
    "code": "UPSTREAM_TIMEOUT"
  },
  "replica_status_summary": {
    "RUNNING": 2,
    "STARTING": 0
  },
  "tags": [
    "prod",
    "llm"
  ]
}

Changes

  • 932394b3676bRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status