Account - List Pool Node Counts

Référence

Service:: Batch Service

API Version:: 2023-11-01.18.0

Obtient le nombre de nœuds de calcul dans chaque état, regroupés par pool. Notez que les nombres retournés peuvent ne pas toujours être à jour. Si vous avez besoin d’un nombre exact de nœuds, utilisez une requête de liste.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
batchUrl	path	True	string	URL de base pour toutes les demandes de service Azure Batch.
api-version	query	True	string	Version de l’API cliente.
$filter	query		string	Clause de $filter OData. Pour plus d’informations sur la construction de ce filtre, consultez https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch.
maxresults	query		integer int32	Nombre maximal d’éléments à retourner dans la réponse.
timeout	query		integer int32	Durée maximale que le serveur peut consacrer au traitement de la demande, en secondes. La valeur par défaut est 30 secondes.

En-tête de la demande

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

Nom	Type	Description
client-request-id	string uuid	Identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que des accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Indique si le serveur doit retourner le client-request-id dans la réponse.
ocp-date	string date-time-rfc1123	Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure actuelle de l’horloge système ; définissez-la explicitement si vous appelez directement l’API REST.

Réponses

Nom	Type	Description
200 OK	PoolNodeCountsListResult	La réponse contient le nombre de nœuds de calcul dans chaque état de nœud de calcul, regroupés par pool. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Erreur du service Batch.

Nom

Type

Description

200 OK

PoolNodeCountsListResult

La réponse contient le nombre de nœuds de calcul dans chaque état de nœud de calcul, regroupés par pool.

Headers

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

Other Status Codes

BatchError

Erreur du service Batch.

Sécurité

azure_auth

flux de code d’authentification OAuth 2.0 Microsoft Entra

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Authorization

Type: apiKey
In: header

Exemples

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
      }
    }
  ]
}

Définitions

Nom	Description
BatchError	Réponse d’erreur reçue du service Azure Batch.
BatchErrorDetail	Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.
ErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.
NodeCounts	Nombre de nœuds de calcul dans chaque état de nœud de calcul.
PoolNodeCounts	Nombre de nœuds de calcul dans chaque état d’un pool.
PoolNodeCountsListResult	Résultat de la liste des nombres de nœuds de calcul dans le compte.

BatchError

Réponse d’erreur reçue du service Azure Batch.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
message	ErrorMessage	Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.
values	BatchErrorDetail[]	Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.

Nom	Type	Description
key	string	Identificateur spécifiant la signification de la propriété Value.
value	string	Informations supplémentaires incluses dans la réponse d’erreur.

ErrorMessage

Message d’erreur reçu dans une réponse d’erreur Azure Batch.

Nom	Type	Description
lang	string	Code de langue du message d’erreur
value	string	Texte du message.

NodeCounts

Nombre de nœuds de calcul dans chaque état de nœud de calcul.

Nom	Type	Description
creating	integer	Nombre de nœuds de calcul dans l’état de création.
idle	integer	Nombre de nœuds de calcul dans l’état inactif.
leavingPool	integer	Nombre de nœuds de calcul dans l’état leavingPool.
offline	integer	Nombre de nœuds de calcul dans l’état hors connexion.
preempted	integer	Nombre de nœuds de calcul dans l’état préempté.
rebooting	integer	Nombre de nœuds de calcul dans l’état de redémarrage.
reimaging	integer	Nombre de nœuds de calcul dans l’état de réimage.
running	integer	Nombre de nœuds de calcul dans l’état en cours d’exécution.
startTaskFailed	integer	Nombre de nœuds de calcul dans l’état startTaskFailed.
starting	integer	Nombre de nœuds de calcul dans l’état de départ.
total	integer	Nombre total de nœuds de calcul.
unknown	integer	Nombre de nœuds de calcul dans l’état inconnu.
unusable	integer	Nombre de nœuds de calcul dans l’état inutilisable.
waitingForStartTask	integer	Nombre de nœuds de calcul dans l’état waitingForStartTask.

PoolNodeCounts

Nombre de nœuds de calcul dans chaque état d’un pool.

Nom	Type	Description
dedicated	NodeCounts	Nombre de nœuds de calcul dédiés dans chaque état.
lowPriority	NodeCounts	Nombre de nœuds de calcul spot/basse priorité dans chaque état.
poolId	string	ID du pool.

PoolNodeCountsListResult

Résultat de la liste des nombres de nœuds de calcul dans le compte.

Nom	Type	Description
odata.nextLink	string	URL permettant d’obtenir l’ensemble de résultats suivant.
value	PoolNodeCounts[]	Liste des nombres de nœuds de calcul par pool.

Account - List Pool Node Counts

Paramètres URI

En-tête de la demande

Réponses

Sécurité

azure_auth

Scopes

Authorization

Exemples

NodeCountsPayload

Sample Request

Sample Response

Définitions

BatchError

BatchErrorDetail

ErrorMessage

NodeCounts

PoolNodeCounts

PoolNodeCountsListResult

Ressources supplémentaires