Account - List Pool Node Counts

Referencia

Service:: Batch Service

API Version:: 2023-11-01.18.0

Obtiene el número de nodos de ejecución en cada estado, agrupados por grupo. Tenga en cuenta que es posible que los números devueltos no siempre estén actualizados. Si necesita recuentos exactos de nodos, use una consulta de lista.

GET {batchUrl}/nodecounts?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/nodecounts?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
batchUrl	path	True	string	Dirección URL base de todas las solicitudes de servicio de Azure Batch.
api-version	query	True	string	Versión de la API de cliente.
$filter	query		string	Una cláusula de $filter OData. Para obtener más información sobre cómo construir este filtro, vea https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch.
maxresults	query		integer int32	Número máximo de elementos que se van a devolver en la respuesta.
timeout	query		integer int32	Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos.

Encabezado de la solicitud

Media Types: "application/json; odata=minimalmetadata"

Nombre	Tipo	Description
client-request-id	string uuid	La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Si el servidor debe devolver el client-request-id en la respuesta.
ocp-date	string date-time-rfc1123	Hora a la que se emitió la solicitud. Normalmente, las bibliotecas cliente establecen esto en la hora actual del reloj del sistema; establézcalo explícitamente si llama directamente a la API REST.

Respuestas

Nombre	Tipo	Description
200 OK	PoolNodeCountsListResult	La respuesta contiene el número de nodos de ejecución en cada estado de nodo de ejecución, agrupado por grupo. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Error del servicio Batch.

Nombre

Tipo

Description

200 OK

PoolNodeCountsListResult

La respuesta contiene el número de nodos de ejecución en cada estado de nodo de ejecución, agrupado por grupo.

Headers

client-request-id: string
request-id: string

Other Status Codes

BatchError

Error del servicio Batch.

Seguridad

azure_auth

flujo de código de autenticación de OAuth 2.0 Microsoft Entra

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	Suplantación de su cuenta de usuario

Authorization

Type: apiKey
In: header

Ejemplos

NodeCountsPayload

Sample Request

HTTP

GET account.region.batch.azure.com/nodecounts?api-version=2023-11-01.18.0

Sample Response

Status code:: 200

{
  "value": [
    {
      "poolId": "pool1",
      "dedicated": {
        "creating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "total": 0
      },
      "lowPriority": {
        "creating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 2,
        "starting": 1,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "total": 3
      }
    },
    {
      "poolId": "pool2",
      "dedicated": {
        "creating": 0,
        "idle": 1,
        "leavingPool": 0,
        "offline": 3,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "total": 4
      },
      "lowPriority": {
        "creating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "total": 0
      }
    },
    {
      "poolId": "pool3",
      "dedicated": {
        "creating": 0,
        "idle": 5,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 4,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "total": 9
      },
      "lowPriority": {
        "creating": 7,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 4,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "total": 11
      }
    }
  ]
}

Definiciones

Nombre	Description
BatchError	Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail	Elemento de información adicional incluida en una respuesta de error Azure Batch.
ErrorMessage	Mensaje de error recibido en una respuesta de error Azure Batch.
NodeCounts	Número de nodos de proceso en cada estado de nodo de ejecución.
PoolNodeCounts	Número de nodos de proceso en cada estado de un grupo.
PoolNodeCountsListResult	Resultado de enumerar los recuentos de nodos de proceso en la cuenta.

BatchError

Respuesta de error recibida del servicio Azure Batch.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	ErrorMessage	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
values	BatchErrorDetail[]	Colección de pares clave-valor que contiene detalles adicionales sobre el error.

BatchErrorDetail

Elemento de información adicional incluida en una respuesta de error Azure Batch.

Nombre	Tipo	Description
key	string	Identificador que especifica el significado de la propiedad Value.
value	string	La información adicional incluida con la respuesta de error.

ErrorMessage

Mensaje de error recibido en una respuesta de error Azure Batch.

Nombre	Tipo	Description
lang	string	Código de idioma del mensaje de error
value	string	Texto del mensaje.

NodeCounts

Número de nodos de proceso en cada estado de nodo de ejecución.

Nombre	Tipo	Description
creating	integer	Número de nodos de proceso en el estado de creación.
idle	integer	Número de nodos de ejecución en estado inactivo.
leavingPool	integer	Número de nodos de proceso en el estado leavingPool.
offline	integer	Número de nodos de proceso en estado sin conexión.
preempted	integer	Número de nodos de proceso en estado adelantado.
rebooting	integer	Recuento de nodos de proceso en estado de reinicio.
reimaging	integer	Número de nodos de proceso en estado de restablecimiento de imagen.
running	integer	Número de nodos de ejecución en estado de ejecución.
startTaskFailed	integer	Número de nodos de ejecución en el estado startTaskFailed.
starting	integer	Número de nodos de proceso en el estado inicial.
total	integer	Número total de nodos de proceso.
unknown	integer	Número de nodos de proceso en el estado desconocido.
unusable	integer	Número de nodos de ejecución en estado inutilizable.
waitingForStartTask	integer	Número de nodos de ejecución en estado waitingForStartTask.

PoolNodeCounts

Número de nodos de proceso en cada estado de un grupo.

Nombre	Tipo	Description
dedicated	NodeCounts	Número de nodos de proceso dedicados en cada estado.
lowPriority	NodeCounts	Número de nodos de proceso de prioridad baja o de acceso puntual en cada estado.
poolId	string	Identificador del grupo.

PoolNodeCountsListResult

Resultado de enumerar los recuentos de nodos de proceso en la cuenta.

Nombre	Tipo	Description
odata.nextLink	string	Dirección URL para obtener el siguiente conjunto de resultados.
value	PoolNodeCounts[]	Una lista de recuentos de nodos de proceso por grupo.

Account - List Pool Node Counts

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

azure_auth

Scopes

Authorization

Ejemplos

NodeCountsPayload

Sample Request

Sample Response

Definiciones

BatchError

BatchErrorDetail

ErrorMessage

NodeCounts

PoolNodeCounts

PoolNodeCountsListResult

Recursos adicionales