Consulta de una lista de servicios
Función
Esta API se utiliza para obtener servicios de modelo.
URI
GET /v1/{project_id}/services
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. Para obtener más información sobre cómo obtener un ID de proyecto, consulte Obtención de un ID y un nombre de proyecto. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
service_id |
No |
String |
ID de servicio |
service_name |
No |
String |
Nombre servicio |
model_id |
No |
String |
ID del modelo |
cluster_id |
No |
String |
ID del grupo de recursos dedicado, que se deja en blanco de forma predeterminada |
workspace_id |
No |
String |
ID del espacio de trabajo. Valor predeterminado: 0 |
infer_type |
No |
String |
Modo de inferencia. El valor puede ser real-time o batch. De forma predeterminada, este parámetro se deja en blanco. |
status |
No |
String |
Estado del servicio De forma predeterminada, el estado del servicio no está filtrado. Puede consultar información por estado de servicio. Los valores posibles son running, deploying, concerning, failed, stopped, y finished. |
offset |
No |
Integer |
Página de inicio de la lista de paginación. Valor predeterminado: 0 |
limit |
No |
Integer |
Número máximo de registros devueltos en cada página. El valor predeterminado es 1000. El valor recomendado oscila entre 10 y 50. |
sort_by |
No |
String |
Modo de clasificación. El valor puede ser publish_at o service_name. Valor predeterminado: public_at |
order |
No |
String |
Orden de clasificación. El valor puede ser asc o desc, indicando el orden ascendente o descendente. Valor predeterminado: desc |
Cuerpo de la solicitud
No hay
Cuerpo de respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
total_count |
Integer |
Número total de servicios que cumplen los criterios de búsqueda cuando no se implementa ninguna paginación |
count |
Integer |
Número de servicios en el resultado de la consulta. Si no se establecen offset y limit, los valores de count y total_count son los mismos. |
services |
service array |
Recopilación de los servicios consultados. Para más detalles, consulte Tabla 4. |
Parámetro |
Tipo |
Descripción |
---|---|---|
service_id |
String |
ID de servicio |
service_name |
String |
Nombre servicio |
description |
String |
Descripción del Servicio |
tenant |
String |
Tenant al que pertenece un servicio |
project |
String |
Proyecto al que pertenece un servicio |
owner |
String |
Usuario al que pertenece un servicio |
publish_at |
Long |
Tiempo de lanzamiento del servicio más reciente, en milisegundos calculado a partir de 1970.1.1 0:0:0 UTC |
infer_type |
String |
Modo de inferencia. El valor puede ser real-time o batch. |
workspace_id |
String |
ID del espacio de trabajo. Valor predeterminado: 0 |
status |
String |
Estado del servicio El valor puede estar running, deploying, concerning, failed, stopped, o finished.
|
start_time |
Number |
Tiempo de inicio del servicio por lotes, en milisegundos calculado a partir de 1970.1.1 0:0:0 UTC. Este parámetro se devuelve solo cuando el servicio es un servicio por lotes. |
finished_time |
Number |
Tiempo de finalización del servicio por lotes, en milisegundos calculado a partir de 1970.1.1 0:0:0 UTC. Este parámetro se devuelve solo cuando el servicio es un servicio por lotes. |
progress |
integer |
Progreso del despliegue. Este parámetro se devuelve cuando el estado es deploying. |
invocation_times |
Long |
Número total de llamadas de servicio |
failed_times |
Long |
Número de llamadas de servicio fallidas |
is_shared |
Boolean |
Si un servicio está suscrito |
shared_count |
Number |
Número de servicios suscritos |
schedule |
schedule array |
Programación de servicios. Para más detalles, consulte Tabla 5. |
due_time |
number |
Tiempo cuando un servicio en tiempo real se detiene automáticamente, en milisegundos calculados a partir de 1970.1.1 0:0:0 UTC. |
operation_time |
number |
Tiempo de funcionamiento de una solicitud |
is_opened_sample_collection |
String |
Si desea habilitar la recopilación de datos. El valor predeterminado es false. |
transition_at |
number |
Hora en que cambia el estado del servicio |
is_free |
Boolean |
Si un servicio utiliza la variante gratis |
additional_properties |
Map<String, Object> |
Atributo de servicio adicional. Si este parámetro no se establece, no se devuelve ningún valor. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
type |
Sí |
String |
Tipo de programación. Solo se admite el valor stop. |
time_unit |
Sí |
String |
Unidad de tiempo de programación. Opciones:
|
duration |
Sí |
Integer |
Valor que se asigna a la unidad de tiempo. Por ejemplo, si la tarea se detiene después de dos horas, establezca time_unit en HOURS y duration en 2. |
Muestras
A continuación se muestra cómo consultar servicios de modelo.
- Modelo de solicitud
GET https://endpoint/v1/{project_id}/services
- Modelo de respuesta
{ "count": 2, "total_count": 2, "services": [ { "service_id": "8da30673-908d-45a7-90a4-65f98e69fc34", "service_name": "service-demo", "tenant": "xxx", "project": "xxx", "owner": "xxx", "publish_at": 1584622900171, "infer_type": "real-time", "status": "stopped", "progress": 100, "invocation_times": 0, "failed_times": 0, "is_shared": false, "shared_count": 0, "workspace_id": "0", "schedule": [ { "type": "stop", "duration": 1, "time_unit": "HOURS" } ], "due_time": 1584626633902, "operation_time": 1586250354961, "is_opened_sample_collection": false, "additional_properties": {}, "is_free": false, "transition_at": 1584623163721, }, { "service_id": "912f1a4a-5962-455c-b11c-5fdf06045cb3", "service_name": "service-demo2", "tenant": "xxx", "project": "xxx", "owner": "xxx", "publish_at": 1584618274410, "infer_type": "real-time", "status": "stopped", "progress": 100, "invocation_times": 0, "failed_times": 0, "is_shared": false, "shared_count": 0, "workspace_id": "0", "schedule": [ { "type": "stop", "duration": 1, "time_unit": "HOURS" } ], "due_time": 1584622027673, "operation_time": 1586250354961, "is_opened_sample_collection": false, "additional_properties": {}, "is_free": false, "transition_at": 1584618498528, } ] }
Código de estado
Para obtener más información sobre el código de estado, consulte Tabla 1.