Получение метрик для плана
Область применения: Windows Пакет Azure
Извлекает метрики плана из указанной даты начала до указанной даты окончания.
Запрос
Укажите запрос на получение метрик плана следующим образом: замените <ServiceMgmt> адресом конечной точки API управления службами. <PlanIdentifier> следует заменить идентификатором плана для извлекаемого плана.
Метод |
Универсальный код ресурса (URI) запроса |
параметр "Версия HTTP" |
---|---|---|
GET |
<https:// ServiceMgmt>:30004/plans/<PlanIdentifier> |
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 (ОК). Если параметры URI неверны, этот запрос возвращает значение 404.
Дополнительные сведения о кодах состояния см. в разделе "Коды состояния" и "Коды ошибок" (Windows управление пакетом обновления Azure).
Заголовки откликов
Ответ содержит стандартные заголовки HTTP. Все стандартные заголовки соответствуют спецификации протокола HTTP/1.1.
Текст ответа
В следующей таблице описываются элементы текста запроса.
Имя элемента |
Описание |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Имя |
Имя метрики. Возможные значения: DailySignupCount или TotalSignupCount. |
||||||||||||
PrimaryAggregationType |
Тип первичной статистической обработки метрики. Значения включают total. |
||||||||||||
Unit |
Единица метрики. Возможны следующие значения:
|
||||||||||||
TimeGrain |
Интервал времени метрики. |
||||||||||||
StartTime |
Время начала возвращаемого набора значений метрик. |
||||||||||||
EndTime |
Время окончания возвращаемого набора значений метрик. |
||||||||||||
Значения |
Список значений метрик. В случае типа агрегирования Count используется следующий формат:
|
Пример
В следующем примере кода показан запрос на получение метрик плана .
GET https://<Computer>:30004/plans/Svclvfrkussi3occcwh/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: 3f9565a5-bdf6-41ac-a61e-d2de886f95df-2013-06-28 18:13:40Z
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
В следующем примере кода показан ответ get Plan 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
}
]
},
{
"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-28T07:00:00Z",
"Total": 0,
"Minimum": null,
"Maximum": null,
"Count": 1
}
]
}
]