Baselines - List
Перечисляет базовые значения метрик дляресурса.
GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metricBaselines?api-version=2019-03-01
GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metricBaselines?metricnames={metricnames}&metricnamespace={metricnamespace}×pan={timespan}&interval={interval}&aggregation={aggregation}&sensitivities={sensitivities}&$filter={$filter}&resultType={resultType}&api-version=2019-03-01
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
resource
|
path | True |
string |
Идентификатор ресурса. |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для этой операции. |
|
$filter
|
query |
string |
$filter используется для уменьшения набора возвращаемых данных метрик. Пример. Метрика содержит метаданные A, B и C. — Возвращает все временные ряды C, где A = a1 и B = b1 или b2 $filter=Aq 'a1' и Bq 'b1' или Bq 'b2' и Cq '*' — Недопустимый вариант: $filter=A eq 'a1' и Bq 'b1' и C eq '*' или B = 'b2' Это недопустимо, так как логический или оператор не может разделить два разных имена метаданных. — Возвращает все временные ряды, где A = a1, B = b1 и C = c1: $filter=Aq 'a1' и Bq 'b1' и C eq 'c1' — возвращает все временные ряды, где A = a1 $filter=Aq 'a1' и B eq '' и C eq ''. Особый случай: если имя измерения или значение измерения использует круглые скобки. Например: если имя измерения dim (test) 1 вместо использования $filter= "dim (test) 1 eq '' " use **$filter= "dim %2528test%2529 1 eq '' "** Когда имя измерения (тест" (тест) 3 и значение измерения dim3 (test) val вместо использования $filter= "dim (test) 3 eq 'dim3 (test) val" использует $filter= "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' " |
|
|
aggregation
|
query |
string |
Список типов агрегирования (разделенных запятыми) для извлечения. |
|
|
interval
|
query |
string (duration) |
Интервал (т. е. timegrain) запроса. |
|
|
metricnames
|
query |
string |
Имена метрик (разделенные запятыми) для извлечения. Особый случай: если имя метрик имеет в нем запятую, используйте %2, чтобы указать ее. Например: "Метрика,Имя1" должно быть "Метрика%2Name1" |
|
|
metricnamespace
|
query |
string |
Пространство имен метрик, содержащее запрошенные имена метрик. |
|
|
result
|
query |
Позволяет получать только метаданные базового плана. По запросу данных извлекается все сведения. |
||
|
sensitivities
|
query |
string |
Список чувственных свойств (разделенных запятыми) для извлечения. |
|
|
timespan
|
query |
string |
Интервал времени запроса. Это строка со следующим форматом "startDateTime_ISO/endDateTime_ISO". |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Успешный запрос для получения списка базовых значений метрик. |
|
| Other Status Codes |
Ответ на ошибку, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 Azure Active Directory
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| user_impersonation | олицетворения учетной записи пользователя |
Примеры
Get metric baselines
Образец запроса
GET https://management.azure.com/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Insights/metricBaselines?timespan=2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z&interval=PT1H&aggregation=average&sensitivities=Low,Medium&api-version=2019-03-01
Пример ответа
{
"value": [
{
"id": "/subscriptions/11aeb0ed-456b-4ca0-8df5-b9fbdc63d0d3/resourceGroups/SmartAnalytics-DEV-VM/providers/Microsoft.Compute/virtualMachines/DemoVM1/providers/microsoft.insights/metricBaselines/Percentage CPU",
"type": "microsoft.insights/metricBaselines",
"name": "Percentage CPU",
"properties": {
"interval": "PT1H",
"timespan": "2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z",
"namespace": "microsoft.compute/virtualmachines",
"baselines": [
{
"aggregation": "average",
"dimensions": [],
"metadataValues": [
{
"name": "ErrorType",
"value": "TooManyAnomalies"
},
{
"name": "SeasonalityFrequency",
"value": "288"
}
],
"timestamps": [
"2019-03-12T11:00:00.000Z",
"2019-03-12T12:00:00.000Z"
],
"data": [
{
"sensitivity": "Low",
"lowThresholds": [
30,
31.1
],
"highThresholds": [
90.3453,
91.3453
]
},
{
"sensitivity": "Medium",
"lowThresholds": [
50,
51.1
],
"highThresholds": [
70.3453,
71.3453
]
}
]
}
]
}
}
]
}
Определения
| Имя | Описание |
|---|---|
|
Additional |
Массив объектов со свойствами type и info. Схема info зависит от строки типа, зависящей от службы. |
|
Baseline |
Представляет базовое значение метаданных. |
|
Baseline |
конфиденциальность базового плана. |
| Error | |
|
Error |
Описание сведений об ответе на ошибку. |
|
Error |
Описывает формат ответа на ошибку. |
|
Metric |
Список базовых показателей метрик. |
|
Metric |
Имя и значение измерения метрик. |
|
Result |
Позволяет получать только метаданные базового плана. По запросу данных извлекается все сведения. |
|
Single |
Базовые значения для одного значения конфиденциальности. |
|
Single |
Базовые результаты одной метрики. |
|
Time |
Базовые значения для одного временных рядов. |
AdditionalInfo
Массив объектов со свойствами type и info. Схема info зависит от строки типа, зависящей от службы.
| Имя | Тип | Описание |
|---|---|---|
| info |
object |
Дополнительные сведения, относящиеся к типу. |
| type |
string |
Тип дополнительных сведений. |
BaselineMetadata
Представляет базовое значение метаданных.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя базовых метаданных. |
| value |
string |
Значение базовых метаданных. |
BaselineSensitivity
конфиденциальность базового плана.
| Значение | Описание |
|---|---|
| Low | |
| Medium | |
| High |
Error
| Имя | Тип | Описание |
|---|---|---|
| additionalInfo |
Массив объектов со свойствами type и info. Схема info зависит от строки типа, зависящей от службы. |
|
| code |
string |
Нелокализованная строка, которую можно использовать для программной идентификации ошибки. |
| details |
Массив дополнительных вложенных объектов сведений об ответе на ошибки, как описано в этом контракте. |
|
| message |
string |
Подробно описывает ошибку и предоставляет сведения об отладке. Если Accept-Language задано в запросе, его необходимо локализовать на этом языке. |
| target |
string |
Целевой объект конкретной ошибки (например, имя свойства в ошибке). |
ErrorDetail
Описание сведений об ответе на ошибку.
| Имя | Тип | Описание |
|---|---|---|
| additionalInfo |
Массив объектов со свойствами type и info. Схема info зависит от строки типа, зависящей от службы. |
|
| code |
string |
Нелокализованная строка, которую можно использовать для программной идентификации ошибки. |
| message |
string |
Подробно описывает ошибку и предоставляет сведения об отладке. |
| target |
string |
Целевой объект конкретной ошибки (например, имя свойства в ошибке). |
ErrorResponse
Описывает формат ответа на ошибку.
| Имя | Тип | Описание |
|---|---|---|
| error |
MetricBaselinesResponse
Список базовых показателей метрик.
| Имя | Тип | Описание |
|---|---|---|
| value |
Список базовых показателей метрик. |
MetricSingleDimension
Имя и значение измерения метрик.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя измерения. |
| value |
string |
Значение измерения. |
ResultType
Позволяет получать только метаданные базового плана. По запросу данных извлекается все сведения.
| Значение | Описание |
|---|---|
| Data | |
| Metadata |
SingleBaseline
Базовые значения для одного значения конфиденциальности.
| Имя | Тип | Описание |
|---|---|---|
| highThresholds |
number[] (double) |
Высокие пороговые значения базового плана. |
| lowThresholds |
number[] (double) |
Низкие пороговые значения базового плана. |
| sensitivity |
конфиденциальность базового плана. |
SingleMetricBaseline
Базовые результаты одной метрики.
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Идентификатор базовой метрики. |
| name |
string |
Имя метрики, для которой были получены базовые показатели. |
| properties.baselines |
Базовый план для каждого временных рядов, запрашиваемого. |
|
| properties.interval |
string (duration) |
Интервал (размер окна), для которого были возвращены данные метрик. Это может быть скорректировано в будущем и возвращено обратно из того, что было первоначально запрошено. Это не имеется, если был выполнен запрос метаданных. |
| properties.namespace |
string |
Пространство имен метрик было запрошено. |
| properties.timespan |
string |
Интервал времени, для которого извлекаются данные. Его значение состоит из двух даты и времени, разделенных "/". Это может быть скорректировано в будущем и возвращено обратно из того, что было первоначально запрошено. |
| type |
string |
Тип ресурса базовой метрики. |
TimeSeriesBaseline
Базовые значения для одного временных рядов.
| Имя | Тип | Описание |
|---|---|---|
| aggregation |
string |
Тип агрегирования метрики. |
| data |
Базовые значения для каждой конфиденциальности. |
|
| dimensions |
Размеры этих временных рядов. |
|
| metadataValues |
Базовые значения метаданных. |
|
| timestamps |
string[] (date-time) |
Список меток времени базовых показателей. |