Compute Node - Upload Batch Service Logs

リファレンス

サービス:: Batch Service

API バージョン:: 2024-07-01.20.0

指定したコンピューティングノードから Azure Blob Storage に Azure Batch サービスのログファイルをアップロードします。
これは、エラーが発生し、Azure サポートにエスカレートする場合に、コンピューティングノードから自動で Azure Batch サービスログファイルを収集するためのものです。 Batch サービスに関する問題のデバッグを支援するために、Azure Batch サービスのログファイルを Azure サポートと共有する必要があります。

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?api-version=2024-07-01.20.0

省略可能なパラメーターを含む:

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?timeout={timeout}&api-version=2024-07-01.20.0

URI パラメーター

名前	/	必須	型	説明
batchUrl	path	True	string	すべての Azure Batch サービス要求のベース URL。
nodeId	path	True	string	Azure Batch サービスログファイルのアップロード元となるコンピューティングノードの ID。
poolId	path	True	string	コンピューティングノードを含むプールの ID。
api-version	query	True	string	クライアント API のバージョン。
timeout	query		integer (int32)	サーバーが要求の処理に費やすことができる最大時間 (秒単位)。既定は 30 秒です。値が 30 より大きい場合は、代わりに既定値が使用されます。

要求ヘッダー

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

名前	型	説明
client-request-id	string (uuid)	呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。
return-client-request-id	boolean	サーバーが応答で client-request-id を返す必要があるかどうか。
ocp-date	string (date-time-rfc1123)	要求が発行された時刻。通常、クライアントライブラリはこれを現在のシステムクロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。

要求本文

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

名前	必須	型	説明
containerUrl	True	string	Batch サービスログファイルのアップロード先となる Azure Blob Storage 内のコンテナーの URL。ユーザー割り当てマネージド ID が使用されていない場合、URL には、コンテナーへの書き込みアクセス許可を付与する Shared Access Signature (SAS) が含まれている必要があります。 SAS 期間は、アップロードが完了するまでの十分な時間を許可する必要があります。 SAS の開始時刻は省略可能であり、指定しないことをお勧めします。
startTime	True	string (date-time)	Batch サービスログファイルのアップロード元の時間範囲の開始。時間範囲内のログメッセージを含むログファイルがアップロードされます。つまり、操作では、ログファイル全体が常にアップロードされるため、要求されたログよりも多くのログが取得される可能性がありますが、操作で取得するログは要求された数よりも少なくなります。
endTime		string (date-time)	Batch サービスログファイルのアップロード元の時間範囲の終わり。時間範囲内のログメッセージを含むログファイルがアップロードされます。つまり、操作では、ログファイル全体が常にアップロードされるため、要求されたログよりも多くのログが取得される可能性がありますが、操作で取得するログは要求された数よりも少なくなります。省略した場合、既定では startTime の後に使用可能なすべてのログがアップロードされます。
identityReference		ComputeNodeIdentityReference	containerUrl で指定された Azure Blob Storage へのアクセスに使用するユーザー割り当て ID への参照。 ID には、Azure Blob Storage コンテナーへの書き込みアクセス権が必要です。

応答

名前	型	説明
200 OK	UploadBatchServiceLogsResult	Batch サービスへの要求が成功しました。ヘッダー client-request-id: string request-id: string
Other Status Codes	BatchError	Batch サービスからのエラー。

名前

型

説明

200 OK

UploadBatchServiceLogsResult

Batch サービスへの要求が成功しました。

ヘッダー

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

Other Status Codes

BatchError

Batch サービスからのエラー。

セキュリティ

azure_auth

Microsoft Entra OAuth 2.0 認証コードフロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

Authorization

型: apiKey
/: header

例

Upload BatchService Logs

要求のサンプル

HTTP

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/uploadbatchservicelogs?api-version=2024-07-01.20.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"
}

応答のサンプル

状態コード:: 200

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

定義

名前	説明
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batch エラー応答に含まれる追加情報の項目。
ComputeNodeIdentityReference	コンピューティングノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
ErrorMessage	Azure Batch エラー応答で受信したエラーメッセージ。
UploadBatchServiceLogsConfiguration	コンピューティングノードの Azure Batch サービスログファイルのアップロード構成。
UploadBatchServiceLogsResult	特定のコンピューティングノードから Batch サービスログファイルをアップロードした結果。

BatchError

Object

Azure Batch サービスから受信したエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
message	ErrorMessage	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
values	BatchErrorDetail[]	エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

Object

Azure Batch エラー応答に含まれる追加情報の項目。

名前	型	説明
key	string	Value プロパティの意味を指定する識別子。
value	string	エラー応答に含まれる追加情報。

ComputeNodeIdentityReference

Object

コンピューティングノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。

名前	型	説明
resourceId	string	ユーザー割り当て ID の ARM リソース ID。

ErrorMessage

Object

Azure Batch エラー応答で受信したエラーメッセージ。

名前	型	説明
lang	string	エラーメッセージの言語コード
value	string	メッセージのテキスト。

UploadBatchServiceLogsConfiguration

Object

コンピューティングノードの Azure Batch サービスログファイルのアップロード構成。

名前	型	説明
containerUrl	string	Batch サービスログファイルのアップロード先となる Azure Blob Storage 内のコンテナーの URL。ユーザー割り当てマネージド ID が使用されていない場合、URL には、コンテナーへの書き込みアクセス許可を付与する Shared Access Signature (SAS) が含まれている必要があります。 SAS 期間は、アップロードが完了するまでの十分な時間を許可する必要があります。 SAS の開始時刻は省略可能であり、指定しないことをお勧めします。
endTime	string (date-time)	Batch サービスログファイルのアップロード元の時間範囲の終わり。時間範囲内のログメッセージを含むログファイルがアップロードされます。つまり、操作では、ログファイル全体が常にアップロードされるため、要求されたログよりも多くのログが取得される可能性がありますが、操作で取得するログは要求された数よりも少なくなります。省略した場合、既定では startTime の後に使用可能なすべてのログがアップロードされます。
identityReference	ComputeNodeIdentityReference	containerUrl で指定された Azure Blob Storage へのアクセスに使用するユーザー割り当て ID への参照。 ID には、Azure Blob Storage コンテナーへの書き込みアクセス権が必要です。
startTime	string (date-time)	Batch サービスログファイルのアップロード元の時間範囲の開始。時間範囲内のログメッセージを含むログファイルがアップロードされます。つまり、操作では、ログファイル全体が常にアップロードされるため、要求されたログよりも多くのログが取得される可能性がありますが、操作で取得するログは要求された数よりも少なくなります。

UploadBatchServiceLogsResult

Object

特定のコンピューティングノードから Batch サービスログファイルをアップロードした結果。

名前	型	説明
numberOfFilesUploaded	integer (int32)	アップロードされるログファイルの数。
virtualDirectoryName	string	Batch サービスログファイルのアップロード先となる Azure Blob Storage コンテナー内の仮想ディレクトリ。仮想ディレクトリ名は、アップロードされた各ログファイルの BLOB 名の一部であり、poolId、nodeId、および一意識別子に基づいて構築されています。

次の方法で共有

Compute Node - Upload Batch Service Logs

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

スコープ

Authorization

例

Upload BatchService Logs

要求のサンプル

応答のサンプル

定義

BatchError

BatchErrorDetail

ComputeNodeIdentityReference

ErrorMessage

UploadBatchServiceLogsConfiguration

UploadBatchServiceLogsResult

その他のリソース