Consulta de grupos de recursos dedicados
Función
Esta API se utiliza para consultar grupos de recursos dedicados.
URI
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID y un nombre de proyecto. |
cluster_name |
No |
String |
Nombre del clúster. De forma predeterminada, el nombre del clúster no está filtrado. |
status |
No |
String |
Estado del clúster. De forma predeterminada, el estado no está filtrado. |
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 |
Campo de clasificación. Las opciones son las siguientes:
|
order |
No |
String |
Modo de clasificación. Las opciones son las siguientes:
|
Cuerpo de respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
total_count |
integer |
Número total de clústeres que cumplen los criterios de búsqueda cuando no se implementa ninguna paginación |
count |
integer |
Número de clústeres en el resultado de la consulta. Si no se establecen offset y limit, los valores de count y total son los mismos. |
clusters |
cluster array |
Lista de clústeres consultados. Para más detalles, consulte Tabla 3. |
Parámetro |
Tipo |
Descripción |
---|---|---|
cluster_id |
String |
ID del clúster |
cluster_name |
String |
Nombre del clúster |
description |
String |
Observaciones del grupo |
tenant |
String |
Tenant al que pertenece un clúster |
project |
String |
Proyecto al que pertenece un clúster |
owner |
String |
Usuario al que pertenece un clúster |
created_at |
integer |
Tiempo en que se crea un clúster, en milisegundos calculado a partir de 1970.1.1 0:0:0 UTC |
status |
String |
Estado del clúster. El valor puede ser deploying, running, concerning, o abnormal. |
nodes |
Object |
Configuración del nodo. Para más detalles, consulte Tabla 4. |
allocatable_cpu_cores |
float |
Número de núcleos de CPU disponibles |
allocatable_memory |
integer |
Número de recursos de memoria disponibles |
allocatable_gpus |
float |
Número de núcleos de GPU disponibles |
product_id |
String |
ID del producto. Este parámetro se devuelve solo cuando el clúster se factura anualmente/mensualmente. |
order_id |
String |
ID de pedido. Este parámetro se devuelve solo cuando el clúster se factura anualmente/mensualmente. |
period_type |
String |
Tipo de período de suscripción. El valor puede ser year o month. Este parámetro se devuelve solo cuando el clúster se factura anualmente/mensualmente. |
period_num |
integer |
Número de períodos de suscripción. Este parámetro se devuelve solo cuando el clúster se factura anualmente/mensualmente. |
Parámetro |
Tipo |
Descripción |
---|---|---|
specification |
String |
Especificaciones del nodo |
count |
integer |
Cantidad de nodos |
available_count |
integer |
Número de nodos disponibles |
Muestras
- Muestra de solicitud
GET https://endpoint/v1/{project_id}/clusters
- Muestra de respuesta
{ "total_count": 1, "count": 1, "clusters": [ { "cluster_id": "ff808081673fbb3d01673fbb824d0000", "cluster_name": "my-cluster", "description": "", "tenant": "tenant_id", "project": "project_id", "owner": "owner_id", "created_at": 1574923077927, "status": "running", "nodes": { "specification": "modelarts.vm.cpu.8ud", "count": 1, "available_count": 1 }, "allocatable_cpu_cores": 5.5, "allocatable_memory": 4096, "allocatable_gpus": 0.5 } ] }
Código de estado
Para obtener más información sobre el código de estado, consulte Tabla 1.