Поделиться через

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

  • Статья

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

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

Вызов API

Запрос

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

Method URI запроса
ПОЛУЧИТЬ https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&api-version=2015-06-01-preview&continuationToken={token-value}

Параметры

Параметр Description
Армэндпоинт Конечная точка диспетчера ресурсов Azure для вашей среды Azure Stack Hub. В соответствии с соглашением Azure Stack Hub имя конечной точки Azure Resource Manager должно иметь формат https://management.{domain-name}. Например, если для пакета средств разработки установлено доменное имя local.azurestack.external, то конечная точка Azure Resource Manager будет https://management.local.azurestack.external.
subId Идентификатор подписки пользователя, который выполняет вызов. Вы можете использовать этот API только для запроса использования одной подписки. Поставщики могут использовать API использования ресурсов, чтобы получить данные по всем арендаторам.
сообщенное время начала Время начала выполнения запроса. Значение Дата/Время должно быть в UTC и должно быть на начале часа; например, 13:00. Для сбора сведений за сутки это значение должно соответствовать полуночи в формате UTC. Формат представляет собой экранированную версию ISO 8601, чтобы его можно было использовать в URI. Например, значение 2015-06-16T18%3a53%3a11%2b00%3a00Z имеет двоеточие, преобразованное в %3a, и плюс, преобразованный в %2b, что делает его пригодным для URI.
заявленное время окончания Время завершения выполнения запроса. Действуют те же ограничения, что и для параметра reportedStartTime. Значение reportedEndTime не может быть в будущем.
гранулярность агрегации Необязательный дискретный параметр, который имеет два возможных значения: daily (за сутки) или hourly (за час). Как предполагают значения, один возвращает данные с дневной гранулярностью, а другой — с почасовым разрешением. Вариант ежедневный используется по умолчанию.
api-version Версия протокола, который используется для выполнения этого запроса. Необходимо использовать версию 2015-06-01-preview.
токен продолжения Маркер, полученный из последнего вызова к провайдеру 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"

}
},

...

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

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

Следующие шаги