Compute Node - Upload Batch Service Logs

  • リファレンス
サービス:
Batch Service
API バージョン:
2023-11-01.18.0

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

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?api-version=2023-11-01.18.0
省略可能なパラメーターを含む: 
POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?timeout={timeout}&api-version=2023-11-01.18.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 秒です。

要求ヘッダー

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 Service ログ ファイルをアップロードするAzure Blob Storage内のコンテナーの URL。
ユーザー割り当てマネージド ID が使用されていない場合、URL には、コンテナーへの書き込みアクセス許可を付与する Shared Access Signature (SAS) が含まれている必要があります。 SAS 期間には、アップロードが完了するまでの十分な時間が必要です。 SAS の開始時刻は省略可能であり、指定しないことをお勧めします。
startTime True

string

Batch Service ログ ファイルをアップロードする時間範囲の開始。
時間範囲内のログ メッセージを含むログ ファイルがアップロードされます。 つまり、ログ ファイル全体が常にアップロードされるため、操作で要求されたログよりも多くのログが取得される可能性がありますが、要求されたログよりも少ないログを取得しないようにする必要があります。
endTime

string

Batch Service ログ ファイルをアップロードする時間範囲の終わり。
時間範囲内のログ メッセージを含むログ ファイルがアップロードされます。 つまり、ログ ファイル全体が常にアップロードされるため、操作で要求されたログよりも多くのログが取得される可能性がありますが、要求されたログよりも少ないログを取得しないようにする必要があります。 省略した場合、既定では 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 サービスからのエラー。

セキュリティ

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

要求のサンプル

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

応答のサンプル

状態コード:
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

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

名前 型 説明
code

string

エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。
message

ErrorMessage

ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。
values

BatchErrorDetail[]

エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

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

名前 型 説明
key

string

Value プロパティの意味を指定する識別子。
value

string

エラー応答に含まれる追加情報。

ComputeNodeIdentityReference

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

名前 型 説明
resourceId

string

ユーザー割り当て ID の ARM リソース ID。

ErrorMessage

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

名前 型 説明
lang

string

エラー メッセージの言語コード
value

string

メッセージのテキストです。

UploadBatchServiceLogsConfiguration

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

名前 型 説明
containerUrl

string

Batch Service ログ ファイルをアップロードするAzure Blob Storage内のコンテナーの URL。
ユーザー割り当てマネージド ID が使用されていない場合、URL には、コンテナーへの書き込みアクセス許可を付与する Shared Access Signature (SAS) が含まれている必要があります。 SAS 期間には、アップロードが完了するまでの十分な時間が必要です。 SAS の開始時刻は省略可能であり、指定しないことをお勧めします。
endTime

string

Batch Service ログ ファイルをアップロードする時間範囲の終わり。
時間範囲内のログ メッセージを含むログ ファイルがアップロードされます。 つまり、ログ ファイル全体が常にアップロードされるため、操作で要求されたログよりも多くのログが取得される可能性がありますが、要求されたログよりも少ないログを取得しないようにする必要があります。 省略した場合、既定では startTime の後に使用可能なすべてのログがアップロードされます。
identityReference

ComputeNodeIdentityReference

containerUrl で指定されたAzure Blob Storageにアクセスするために使用するユーザー割り当て ID への参照。
ID には、Azure Blob Storage コンテナーへの書き込みアクセス権が必要です。
startTime

string

Batch Service ログ ファイルをアップロードする時間範囲の開始。
時間範囲内のログ メッセージを含むログ ファイルがアップロードされます。 つまり、ログ ファイル全体が常にアップロードされるため、操作で要求されたログよりも多くのログが取得される可能性がありますが、要求されたログよりも少ないログを取得しないようにする必要があります。

UploadBatchServiceLogsResult

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

名前 型 説明
numberOfFilesUploaded

integer

アップロードされるログ ファイルの数。
virtualDirectoryName

string

Batch Service ログ ファイルがアップロードされるコンテナー内の仮想ディレクトリAzure Blob Storage。
仮想ディレクトリ名は、アップロードされた各ログ ファイルの BLOB 名の一部であり、poolId、nodeId、および一意識別子に基づいて構築されています。