API использования ресурсов для клиентов

  • Статья

Клиент может использовать API клиента для просмотра данных о том, как он использует ресурсы. Эти API совместимы с API использования Azure.

Как и в Azure, чтобы получить данные об использовании, вы можете использовать командлет Windows PowerShell Get-UsageAggregates.

Вызов API

Запрос

Запрос возвращает сведения о потреблении для указанной подписки и указанного периода времени. Запроса не содержит текст.

Метод Универсальный код ресурса (URI) запроса
GET https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&api-version=2015-06-01-preview&continuationToken={token-value}

Параметры

Параметр Описание
Armendpoint Конечная точка Azure Resource Manager среды Azure Stack Hub. В соответствии с соглашением Azure Stack Hub имя конечной точки Azure Resource Manager должно иметь формат https://management.{domain-name}. Например, для пакета средств разработки доменное имя — local.azurestack.external, а конечная точка Resource Manager — https://management.local.azurestack.external.
subId Идентификатор подписки пользователя, который выполняет вызов. Этот API служит для получения сведений об использовании только в пределах одной подписки. Чтобы получить сведения по всем клиентам, поставщики могут использовать API использования для поставщика ресурсов.
reportedStartTime Время начала выполнения запроса. Значение параметра DateTime должно быть в формате UTC и в начале часа; например, 13:00. Для сбора сведений за сутки это значение должно соответствовать полуночи в формате UTC. В этом формате используется экранирование символов ISO 8601. Например, значение 2015-06-16T18%3a53%3a11%2b00%3a00Z можно использовать в составе URI, так как символ двоеточия преобразован в %3a, а плюс — в %2b.
reportedEndTime Время завершения выполнения запроса. Действуют те же ограничения, что и для параметра reportedStartTime. Значение reportedEndTime не может быть в будущем.
aggregationGranularity Необязательный параметр, имеющий два дискретных потенциальных значения: ежедневно и ежечасно. Эти значения возвращают данные с разной степенью детализации: за сутки и за час. По умолчанию используется параметр daily .
api-version Версия протокола, который используется для выполнения этого запроса. Необходимо использовать версию 2015-06-01-preview.
continuationToken Маркер, полученный из последнего вызова к API использования для поставщиков. Этот маркер требуется, когда ответ превышает 1000 строк. Он служит закладкой в процессе выполнения. Если он отсутствует, данные извлекаются с начала суток или часа, в зависимости от уровня детализации.

Ответ

GET
/subscriptions/sub1/providers/Microsoft.Commerce/UsageAggregates?reportedStartTime=reportedStartTime=2014-05-01T00%3a00%3a00%2b00%3a00&reportedEndTime=2015-06-01T00%3a00%3a00%2b00%3a00&aggregationGranularity=Daily&api-version=1.0

{
"value": [
{

"id":
"/subscriptions/sub1/providers/Microsoft.Commerce/UsageAggregate/sub1-meterID1",
"name": "sub1-meterID1",
"type": "Microsoft.Commerce/UsageAggregate",

"properties": {
"subscriptionId":"sub1",
"usageStartTime": "2015-03-03T00:00:00+00:00",
"usageEndTime": "2015-03-04T00:00:00+00:00",
"instanceData":"{\"Microsoft.Resources\":{\"resourceUri\":\"resourceUri1\",\"location\":\"Alaska\",\"tags\":null,\"additionalInfo\":null}}",
"quantity":2.4000000000,
"meterId":"meterID1"

}
},

...

Сведения об ответе

Параметр Описание
идентификатор Уникальный идентификатор статистического выражения использования.
name Имя статистического выражения использования.
тип Определение ресурса.
subscriptionId Идентификатор подписки пользователя Azure
usageStartTime Начальное время включения в контейнер использования, к которому относится статистическое выражение использования (в формате UTC).
usageEndTime Конечное время включения в контейнер использования, к которому относится статистическое выражение использования (в формате UTC).
instanceData Пары "ключ-значение" из сведений об экземпляре (в новом формате):
resourceUri: полный идентификатор ресурса, включая группы ресурсов и имя экземпляра.
location: регион, в котором была запущена эта служба.
tags: теги ресурсов, которые указывает пользователь.
additionalInfo: дополнительные сведения о ресурсе, который был потреблен. Например, версия ОС или тип образа.
quantity Объем потребления ресурса за указанный промежуток времени.
meterId Уникальный идентификатор ресурса, который был потреблен (также называется ResourceID).

Дальнейшие действия