Predictive Metric - Get

получение прогнозных данных метрик автомасштабирования в будущем

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings/{autoscaleSettingName}/predictiveMetrics?api-version=2022-10-01&timespan={timespan}&interval={interval}&metricNamespace={metricNamespace}&metricName={metricName}&aggregation={aggregation}

Параметры URI

Имя В Обязательно Тип Описание
autoscaleSettingName
path True

string

Имя параметра автомасштабирования.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя не учитывает регистр.

subscriptionId
path True

string (uuid)

Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).

aggregation
query True

string

Список типов агрегирования (разделенных запятыми) для извлечения.

api-version
query True

string

minLength: 1

Версия API, используемая для этой операции.

interval
query True

string (duration)

Интервал (т. е. timegrain) запроса.

metricName
query True

string

Имена метрик (разделенные запятыми) для извлечения. Особый случай: если имя метрик имеет в нем запятую, используйте %2, чтобы указать ее. Например: "Метрика,Имя1" должно быть "Метрика%2Name1"

metricNamespace
query True

string

Пространство имен метрик для запроса определений метрик.

timespan
query True

string

Интервал времени запроса. Это строка со следующим форматом "startDateTime_ISO/endDateTime_ISO".

Ответы

Имя Тип Описание
200 OK

PredictiveResponse

Операция Azure успешно завершена.

Other Status Codes

AutoscaleErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Get Metric for data

Образец запроса

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Insights/autoscalesettings/vmss1-Autoscale-775/predictiveMetrics?api-version=2022-10-01&timespan=2021-10-14T22:00:00.000Z/2021-10-16T22:00:00.000Z&interval=PT1H&metricNamespace=Microsoft.Compute/virtualMachineScaleSets&metricName=PercentageCPU&aggregation=Total

Пример ответа

{
  "data": [
    {
      "timeStamp": "2021-10-14T22:00:00Z",
      "value": 123
    },
    {
      "timeStamp": "2021-10-14T22:02:00Z",
      "value": 120
    },
    {
      "timeStamp": "2021-10-14T22:02:00Z",
      "value": 88
    },
    {
      "timeStamp": "2021-10-14T22:03:00Z",
      "value": 100
    }
  ],
  "interval": "PT1H",
  "metricName": "PercentageCPU",
  "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1",
  "timespan": "2021-10-14T22:00:00.000Z/2021-10-16T22:00:00.000Z"
}

Определения

Имя Описание
AutoscaleErrorResponse

Описывает формат ответа на ошибку.

AutoscaleErrorResponseError

Объект ошибки.

createdByType

Тип удостоверения, создавшего ресурс.

PredictiveResponse

Ответ на запрос метрик.

PredictiveValue

Представляет значение прогнозной метрики в данном контейнере.

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

AutoscaleErrorResponse

Описывает формат ответа на ошибку.

Имя Тип Описание
error

AutoscaleErrorResponseError

Объект ошибки.

systemData

systemData

Системные метаданные, связанные с ответом.

AutoscaleErrorResponseError

Объект ошибки.

Имя Тип Описание
code

string

Один из определяемых сервером кодов ошибок.

details

string

Доступное для чтения представление сведений об ошибке.

message

string

Читаемое пользователем представление ошибки.

target

string

Целевой объект конкретной ошибки.

createdByType

Тип удостоверения, создавшего ресурс.

Значение Описание
User
Application
ManagedIdentity
Key

PredictiveResponse

Ответ на запрос метрик.

Имя Тип Описание
data

PredictiveValue[]

значение коллекции.

interval

string (duration)

Интервал (размер окна), для которого были возвращены данные метрик. Это может быть скорректировано в будущем и возвращено обратно из того, что было первоначально запрошено. Это не имеется, если был выполнен запрос метаданных.

metricName

string

Запрашиваемые метрики

targetResourceId

string

ресурс прогнозной метрики.

timespan

string

Интервал времени, для которого извлекаются данные. Его значение состоит из двух даты и времени, разделенных "/". Это может быть скорректировано в будущем и возвращено обратно из того, что было первоначально запрошено.

PredictiveValue

Представляет значение прогнозной метрики в данном контейнере.

Имя Тип Описание
timeStamp

string (date-time)

метка времени для значения метрик в формате ISO 8601.

value

number (double)

Прогнозное значение в этом контейнере времени.

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя Тип Описание
createdAt

string (date-time)

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt

string (date-time)

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy

string

Идентификатор, который последний раз изменил ресурс.

lastModifiedByType

createdByType

Тип удостоверения, который последний раз изменил ресурс.