Получение метрик для надстройки

Статья
08/24/2015

Область применения: Windows Azure Pack

Извлекает метрики надстройки из указанной даты начала до указанной даты окончания.

Запрос

Замените <ServiceMgmt> адресом конечной точки API управления службами. Замените <AddonId> идентификатором надстройки для собираемых метрик.

Метод	Универсальный код ресурса (URI) запроса	параметр "Версия HTTP"
GET	<https:// ServiceMgmt>:30004/addons/<AddonId>/metrics	HTTP/1.1

Параметры URI

В следующей таблице описаны параметры URI.

Параметр универсального кода ресурса (URI)	Описание
startTime	Обязательный. DateTime для начала сбора метрик.
endTime	Обязательный. Дата и время для прекращения сбора метрик.

Заголовки запросов

В следующей таблице перечислены обязательные и необязательные заголовки запросов.

Заголовок запроса	Описание
Авторизация: носитель	Обязательный. Токен носителя авторизации.
x-ms-principal-id	Обязательный. Идентификатор участника.
x-ms-client-request-id	Необязательный элемент. Идентификатор запроса клиента.
x-ms-client-session-id	Необязательный элемент. Идентификатор сеанса клиента.
x-ms-principal-liveid	Необязательный элемент. Идентификатор основной динамической трансляции.

Текст запроса

Отсутствует.

Ответ

Ответ включает код состояния HTTP, набор заголовков ответа и текст ответа.

Код состояния

Успешная операция возвращает код состояния 200 (ОК). Возвращает значение 404, если параметры URI неверны.

Сведения о кодах состояния см. в разделе "Коды состояния" и "Коды ошибок" (Windows управления пакетом обновления Azure).

Заголовки откликов

Ответ для этой операции включает стандартные заголовки HTTP. Все стандартные заголовки соответствуют спецификации протокола HTTP/1.1.

Текст ответа

В следующей таблице описаны элементы текста ответа.

Имя

Имя метрики. Это может быть DailySignupCount или TotalSignupCount.

PrimaryAggregationType

Основной тип агрегирования метрики. Значения включают "Total"

ConfigState

Единица метрики. Значения: "Bytes" BytesPerSec", "Count", "Megabytes", "Milliseconds", "Other", "Percentage", "Seconds".

TimeGrain

Интервал времени метрики.

StartTime

Время начала возвращаемого набора значений метрик.

EndTime

Время окончания возвращаемого набора значений метрик.

Значения

Список значений метрик. В случае типа агрегирования Count используется следующий формат:

Имя элемента	Описание
Время создания	Дата и время записи значения метрики.
Итог	Для "DailySignUp" — общее количество зарегистрированных ежедневных регистрации. Для параметра TotalSignUp — общее количество подписок.
Минимальные	Минимальное значение
Максимальная	Максимальное значение
Счетчик	Число значений

Пример

В следующем примере кода показан запрос на добавление метрик надстройки .

GET https://<Computer>:30004/addons/GoldAhihps8jy/metrics?startTime=2013-06-22T07%3a00%3a00.0000000Z&endTime=2013-06-29T07%3a00%3a00.0000000Z HTTP/1.1
Authorization: Bearer <Token>
x-ms-client-request-id: 5b933374-0387-4f5d-8bce-13f5c067d54b-2013-06-28 18:30:18Z
x-ms-client-session-id: d19ca528-d7bf-4a62-9d4d-03adbb4f6c74
x-ms-principal-id: <COMPUTER>\Administrator
Accept-Language: en-US
x-ms-principal-liveid: <COMPUTER>\Administrator
Host: <Computer>:30004

В следующем примере кода показан ответ add-on Metrics .

[
  {
    "Name": "DailySignupCount",
    "PrimaryAggregationType": "Total",
    "Unit": "Count",
    "TimeGrain": "1.00:00:00",
    "StartTime": "2013-06-22T07:00:00Z",
    "EndTime": "2013-06-29T07:00:00Z",
    "Values": [
      {
        "TimeCreated": "2013-06-22T07:00:00Z",
        "Total": 0,
        "Minimum": null,
        "Maximum": null,
        "Count": 1
      },
      {
        "TimeCreated": "2013-06-23T07:00:00Z",
        "Total": 0,
        "Minimum": null,
        "Maximum": null,
        "Count": 1
      },
      {
        "TimeCreated": "2013-06-28T07:00:00Z",
        "Total": 0,
        "Minimum": null,
        "Maximum": null,
        "Count": 1
      }
    ]
  },
  {
    "Name": "TotalSignupCount",
    "PrimaryAggregationType": "Total",
    "Unit": "Count",
    "TimeGrain": "1.00:00:00",
    "StartTime": "2013-06-22T07:00:00Z",
    "EndTime": "2013-06-29T07:00:00Z",
    "Values": [
      {
        "TimeCreated": "2013-06-22T07:00:00Z",
        "Total": 0,
        "Minimum": null,
        "Maximum": null,
        "Count": 1
      },
      {
        "TimeCreated": "2013-06-27T07:00:00Z",
        "Total": 0,
        "Minimum": null,
        "Maximum": null,
        "Count": 1
      },
      {
        "TimeCreated": "2013-06-28T07:00:00Z",
        "Total": 0,
        "Minimum": null,
        "Maximum": null,
        "Count": 1
      }
    ]
  }
]

См. также:

Интерфейсы надстроек администратора

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