通过

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

Pool - List Usage Metrics

  • 参考
服务:
Batch Service
API 版本:
2024-07-01.20.0

列出指定帐户的按池聚合的单个时间间隔的使用情况指标。
如果未指定包含 poolId 的$filter子句，响应将包括帐户中存在的所有池，这些池在返回的聚合间隔的时间范围内存在。 如果未指定$filter子句（包括 startTime 或 endTime），则这些筛选器默认为当前可用的最后一个聚合间隔的开始和结束时间;即，仅返回最后一个聚合间隔。

GET {batchUrl}/poolusagemetrics?api-version=2024-07-01.20.0
具有可选参数: 
GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI 参数

名称 在 必需 类型 说明
batchUrl
 path True

string

所有 Azure Batch 服务请求的基本 URL。
api-version
 query True

string

客户端 API 版本。
$filter
 query

string

OData $filter 子句。 有关构造此筛选器的详细信息，请参阅 https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics。
endtime
 query

string

date-time

包含指标的最近时间。 这必须在当前时间之前至少两小时。 如果未指定，则默认为当前可用的最后一个聚合间隔的结束时间。
maxresults
 query

integer

int32

响应中要返回的最大项数。 最多将返回 1000 个结果。
starttime
 query

string

date-time

要从中包括指标的最早时间。 这必须在当前时间之前至少两个半小时。 如果未指定，则默认为当前可用的最后一个聚合间隔的开始时间。
timeout
 query

integer

int32

服务器处理请求的最长时间（以秒为单位）。 默认值为 30 秒。 如果该值大于 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，请显式设置它。

响应

名称 类型 说明
200 OK

PoolListUsageMetricsResult

包含池使用情况详细信息列表的响应。

标头

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
Other Status Codes

BatchError

Batch 服务中的错误。

安全性

azure_auth

Microsoft Entra OAuth 2.0 身份验证代码流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

Authorization

类型: apiKey
在: header

示例

Pool list usage metrics

示例请求

GET account.region.batch.azure.com/poolusagemetrics?api-version=2024-07-01.20.0

示例响应

状态代码:
200 
{
  "value": [
    {
      "startTime": "2013-04-01T00:00:00Z",
      "endTime": "2013-04-01T00:30:00Z",
      "poolId": "p1",
      "vmSize": "a1",
      "totalCoreHours": 39.384838
    },
    {
      "startTime": "2013-04-01T00:30:00Z",
      "endTime": "2013-04-01T01:00:00Z",
      "poolId": "p2",
      "vmSize": "a8",
      "totalCoreHours": 3039.384838
    }
  ]
}

定义

名称 说明
BatchError

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

Azure Batch 错误响应中包含的附加信息项。
ErrorMessage

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

列出帐户的使用指标的结果。
PoolUsageMetrics

跨聚合间隔池的使用情况指标。

BatchError

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

名称 类型 说明
code

string

错误的标识符。 代码是固定的，旨在以编程方式使用。
message

ErrorMessage

描述错误的消息，旨在适合在用户界面中显示。
values

BatchErrorDetail[]

包含有关错误的更多详细信息的键值对的集合。

BatchErrorDetail

Azure Batch 错误响应中包含的附加信息项。

名称 类型 说明
key

string

指定 Value 属性含义的标识符。
value

string

错误响应附带的其他信息。

ErrorMessage

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

名称 类型 说明
lang

string

错误消息的语言代码
value

string

消息的文本。

PoolListUsageMetricsResult

列出帐户的使用指标的结果。

名称 类型 说明
odata.nextLink

string

用于获取下一组结果的 URL。
value

PoolUsageMetrics[]

池使用情况指标数据。

PoolUsageMetrics

跨聚合间隔池的使用情况指标。

名称 类型 说明
endTime

string

此条目涵盖的聚合间隔的结束时间。
poolId

string

在此条目中聚合其指标的池的 ID。
startTime

string

此项涵盖的聚合间隔的开始时间。
totalCoreHours

number

在此聚合间隔期间池中使用的总核心小时数。
vmSize

string

池中虚拟机的大小。 池中的所有 VM 大小都相同。
有关池中虚拟机的可用大小的信息，请参阅为 Azure Batch 池中的计算节点选择 VM 大小（https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes）。