Compute Node - Upload Batch Service Logs

Référence

Service:: Batch Service

API Version:: 2023-11-01.18.0

Chargez Azure Batch fichiers journaux de service à partir du nœud de calcul spécifié vers Stockage Blob Azure.
Il s’agit de collecter Azure Batch fichiers journaux de service de manière automatisée à partir de nœuds de calcul si vous rencontrez une erreur et que vous souhaitez passer à support Azure. Les fichiers journaux de service Azure Batch doivent être partagés avec support Azure pour faciliter le débogage des problèmes avec le service Batch.

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?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.
nodeId	path	True	string	ID du nœud de calcul à partir duquel vous souhaitez charger les fichiers journaux de service Azure Batch.
poolId	path	True	string	ID du pool qui contient le nœud de calcul.
api-version	query	True	string	Version de l’API cliente.
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.

Corps de la demande

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

Nom	Obligatoire	Type	Description
containerUrl	True	string	URL du conteneur dans Stockage Blob Azure vers laquelle charger le ou les fichiers journaux du service Batch. Si une identité managée affectée par l’utilisateur n’est pas utilisée, l’URL doit inclure une signature d’accès partagé (SAP) accordant des autorisations d’écriture au conteneur. La durée de la signature d’accès partagé doit laisser suffisamment de temps pour que le chargement se termine. L’heure de début de la signature d’accès partagé est facultative et il est recommandé de ne pas spécifier.
startTime	True	string	Début de l’intervalle de temps à partir duquel charger le ou les fichiers journaux du service Batch. Tout fichier journal contenant un message de journal dans l’intervalle de temps est chargé. Cela signifie que l’opération peut récupérer plus de journaux que ce qui a été demandé, car le fichier journal entier est toujours chargé, mais l’opération ne doit pas récupérer moins de journaux que demandé.
endTime		string	Fin de l’intervalle de temps à partir duquel charger le ou les fichiers journaux du service Batch. Tout fichier journal contenant un message de journal dans l’intervalle de temps est chargé. Cela signifie que l’opération peut récupérer plus de journaux que ce qui a été demandé, car le fichier journal entier est toujours chargé, mais l’opération ne doit pas récupérer moins de journaux que demandé. S’il est omis, la valeur par défaut consiste à charger tous les journaux disponibles après startTime.
identityReference		ComputeNodeIdentityReference	Référence à l’identité affectée par l’utilisateur à utiliser pour accéder Stockage Blob Azure spécifiée par containerUrl. L’identité doit avoir un accès en écriture au conteneur Stockage Blob Azure.

Réponses

Nom	Type	Description
200 OK	UploadBatchServiceLogsResult	La demande adressée au service Batch a réussi. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Erreur du service Batch.

Nom

Type

Description

200 OK

UploadBatchServiceLogsResult

La demande adressée au service Batch a réussi.

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

Upload BatchService Logs

Sample Request

HTTP

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/uploadbatchservicelogs?api-version=2023-11-01.18.0



{
  "containerUrl": "https://somestorageacct.blob.core.windows.net/batch-compute-node-logs?se=2017-12-09T18%3A51%3A00Z&sp=w&sv=2016-05-31&sr=c&sig",
  "startTime": "2017-11-27T00:00:00Z"
}

Sample Response

Status code:: 200

{
  "virtualDirectoryName": "poolId/tvm-1695681911-1-20161121t182739z/0795539d-82fe-48e3-bbff-2964905b6de0",
  "numberOfFilesUploaded": 8
}

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.
ComputeNodeIdentityReference	Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera.
ErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.
UploadBatchServiceLogsConfiguration	Les fichiers journaux de service Azure Batch chargent la configuration d’un nœud de calcul.
UploadBatchServiceLogsResult	Résultat du chargement des fichiers journaux du service Batch à partir d’un nœud de calcul spécifique.

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.

ComputeNodeIdentityReference

Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera.

Nom	Type	Description
resourceId	string	ID de ressource ARM de l’identité affectée par l’utilisateur.

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.

UploadBatchServiceLogsConfiguration

Les fichiers journaux de service Azure Batch chargent la configuration d’un nœud de calcul.

Nom	Type	Description
containerUrl	string	URL du conteneur dans Stockage Blob Azure vers laquelle charger le ou les fichiers journaux du service Batch. Si une identité managée affectée par l’utilisateur n’est pas utilisée, l’URL doit inclure une signature d’accès partagé (SAP) accordant des autorisations d’écriture au conteneur. La durée de la signature d’accès partagé doit laisser suffisamment de temps pour que le chargement se termine. L’heure de début de la signature d’accès partagé est facultative et il est recommandé de ne pas spécifier.
endTime	string	Fin de l’intervalle de temps à partir duquel charger le ou les fichiers journaux du service Batch. Tout fichier journal contenant un message de journal dans l’intervalle de temps est chargé. Cela signifie que l’opération peut récupérer plus de journaux que ce qui a été demandé, car le fichier journal entier est toujours chargé, mais l’opération ne doit pas récupérer moins de journaux que demandé. S’il est omis, la valeur par défaut consiste à charger tous les journaux disponibles après startTime.
identityReference	ComputeNodeIdentityReference	Référence à l’identité affectée par l’utilisateur à utiliser pour accéder Stockage Blob Azure spécifiée par containerUrl. L’identité doit avoir un accès en écriture au conteneur Stockage Blob Azure.
startTime	string	Début de l’intervalle de temps à partir duquel charger le ou les fichiers journaux du service Batch. Tout fichier journal contenant un message de journal dans l’intervalle de temps est chargé. Cela signifie que l’opération peut récupérer plus de journaux que ce qui a été demandé, car le fichier journal entier est toujours chargé, mais l’opération ne doit pas récupérer moins de journaux que demandé.

UploadBatchServiceLogsResult

Résultat du chargement des fichiers journaux du service Batch à partir d’un nœud de calcul spécifique.

Nom	Type	Description
numberOfFilesUploaded	integer	Nombre de fichiers journaux qui seront chargés.
virtualDirectoryName	string	Répertoire virtuel dans Stockage Blob Azure conteneur dans lequel les fichiers journaux du service Batch seront chargés. Le nom du répertoire virtuel fait partie du nom de l’objet blob pour chaque fichier journal chargé, et il est généré basé sur poolId, nodeId et un identificateur unique.

Partager via

Compute Node - Upload Batch Service Logs

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

azure_auth

Scopes

Authorization

Exemples

Upload BatchService Logs

Sample Request

Sample Response

Définitions

BatchError

BatchErrorDetail

ComputeNodeIdentityReference

ErrorMessage

UploadBatchServiceLogsConfiguration

UploadBatchServiceLogsResult

Ressources supplémentaires