通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Compute Node - Upload Batch Service Logs

  • 参考
Service:
Batch Service
API Version:
2023-11-01.18.0

将Azure Batch服务日志文件从指定的计算节点上传到Azure Blob 存储。
如果遇到错误并希望升级到Azure 支持，这是为了自动从计算节点收集Azure Batch服务日志文件。 应与 Azure 支持 共享Azure Batch服务日志文件，以帮助调试 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

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

调用方生成的请求标识，采用不带修饰的 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

Azure Blob 存储中要向其上传 Batch 服务日志文件的容器的 URL， () 。
如果未使用用户分配的托管标识，URL 必须包含共享访问签名 (SAS) 向容器授予写入权限。 SAS 持续时间必须留出足够的时间来完成上传。 SAS 的开始时间是可选的，建议不要指定。
startTime True

string

上传 Batch 服务日志文件的时间范围的开始时间范围 () 。
将上传时间范围内包含日志消息的任何日志文件。 这意味着，由于始终上传整个日志文件，操作检索的日志数可能多于请求的日志数，但操作检索的日志不应少于请求的日志数。
endTime

string

上传 Batch 服务日志文件的时间范围的结束时间 () 。
将上传时间范围内包含日志消息的任何日志文件。 这意味着，由于始终上传整个日志文件，操作检索的日志数可能多于请求的日志数，但操作检索的日志不应少于请求的日志数。 如果省略，则默认为上传 startTime 之后可用的所有日志。
identityReference

ComputeNodeIdentityReference

对用于访问 containerUrl 指定的Azure Blob 存储的用户分配标识的引用。
标识必须对 Azure Blob 存储 容器具有写入访问权限。

响应

名称 类型 说明
200 OK

UploadBatchServiceLogsResult

对 Batch 服务的请求已成功。

Headers

  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Batch 服务中的错误。

安全性

azure_auth

Microsoft Entra OAuth 2.0 身份验证代码流

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

Scopes

名称 说明
user_impersonation 模拟用户帐户

Authorization

Type: apiKey
In: header

示例

Upload BatchService Logs

Sample Request

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
}

定义

名称 说明
BatchError

从Azure Batch服务收到的错误响应。
BatchErrorDetail

Azure Batch错误响应中包含的其他信息项。
ComputeNodeIdentityReference

对与计算节点将使用的 Batch 池关联的用户分配标识的引用。
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 池关联的用户分配标识的引用。

名称 类型 说明
resourceId

string

用户分配的标识的 ARM 资源 ID。

ErrorMessage

Azure Batch错误响应中收到的错误消息。

名称 类型 说明
lang

string

错误消息的语言代码
value

string

消息的文本。

UploadBatchServiceLogsConfiguration

计算节点Azure Batch服务日志文件上传配置。

名称 类型 说明
containerUrl

string

Azure Blob 存储中要向其上传 Batch 服务日志文件的容器的 URL， () 。
如果未使用用户分配的托管标识，URL 必须包含共享访问签名 (SAS) 向容器授予写入权限。 SAS 持续时间必须留出足够的时间来完成上传。 SAS 的开始时间是可选的，建议不要指定。
endTime

string

上传 Batch 服务日志文件的时间范围的结束时间 () 。
将上传时间范围内包含日志消息的任何日志文件。 这意味着，由于始终上传整个日志文件，操作检索的日志数可能多于请求的日志数，但操作检索的日志不应少于请求的日志数。 如果省略，则默认为上传 startTime 之后可用的所有日志。
identityReference

ComputeNodeIdentityReference

对用于访问 containerUrl 指定的Azure Blob 存储的用户分配标识的引用。
标识必须对 Azure Blob 存储 容器具有写入访问权限。
startTime

string

上传 Batch 服务日志文件的时间范围的开始时间范围 () 。
将上传时间范围内包含日志消息的任何日志文件。 这意味着，由于始终上传整个日志文件，操作检索的日志数可能多于请求的日志数，但操作检索的日志不应少于请求的日志数。

UploadBatchServiceLogsResult

从特定计算节点上传 Batch 服务日志文件的结果。

名称 类型 说明
numberOfFilesUploaded

integer

将上传的日志文件数。
virtualDirectoryName

string

Azure Blob 存储容器中的虚拟目录， () 的 Batch 服务日志文件将上传到该容器中。
虚拟目录名称是上传的每个日志文件的 Blob 名称的一部分，它是基于 poolId、nodeId 和唯一标识符生成的。