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


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

Термин "поставщик" применяется к администратору службы и к любым делегированным поставщикам. Операторы Azure Stack Hub и делегированные поставщики с помощью API использования ресурсов для поставщиков могут просматривать данные об использовании ресурсов их непосредственными клиентами. Например, как показано на следующей схеме, с помощью API для поставщиков P0 может получить сведения о прямом использовании ресурсов для P1 и P2, а P1 — для P3 и P4.

Концептуальная модель иерархии поставщиков

Справка о вызовах API

Запрос

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

Этот API использования является API поставщика, поэтому вызывающему объекту должна быть назначена роль владельца, участника или читателя в подписке поставщика.

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

Аргументы

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

Ответ

GET
/subscriptions/sub1/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime=reportedStartTime=2014-05-01T00%3a00%3a00%2b00%3a00&reportedEndTime=2015-06-01T00%3a00%3a00%2b00%3a00&aggregationGranularity=Daily&subscriberId=sub1.1&api-version=1.0
{
"value": [
{

"id":
"/subscriptions/sub1.1/providers/Microsoft.Commerce.Admin/UsageAggregate/sub1.1-

meterID1",
"name": "sub1.1-meterID1",
"type": "Microsoft.Commerce.Admin/UsageAggregate",

"properties": {
"subscriptionId":"sub1.1",
"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"

}
},

. . .

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

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

Получение сведений о потреблении

PowerShell

Чтобы данные об использовании создавались, должны существовать активно работающие ресурсы, например, действующая виртуальная машина или учетная запись хранения, содержащая некоторые данные. Если вы не знаете, есть ли у вас активные ресурсы в Azure Stack Hub Marketplace, разверните виртуальную машину, откройте для нее колонку мониторинга и проверьте выполнение. Следующие командлеты PowerShell позволяют просмотреть данные о потреблении:

  1. Установка PowerShell для Azure Stack Hub.

  2. Настройте среду PowerShell пользователя Azure Stack Hub или оператора Azure Stack Hub .

  3. Чтобы получить данные об использовании, вызовите PowerShell Get-AzsSubscriberUsage.

    Get-AzsSubscriberUsage -ReportedStartTime "2017-09-06T00:00:00Z" -ReportedEndTime "2017-09-07T00:00:00Z"
    

REST API

Вы можете собирать сведения об использовании для удаленных подписок путем вызова службы Microsoft.Commerce.Admin.

Возврат данных об использовании по всем клиентам для удаленных подписок для активных пользователей

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

Возврат данных об использовании по удаленному или активному клиенту

Метод Универсальный код ресурса (URI) запроса
GET https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&subscriberId={subscriber-id}&api-version=2015-06-01-preview

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