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=A eq 'a1' 和 B eq 'b1' 或 B eq 'b2' 和 C eq '*' - 无效变体:$filter=A eq 'a1' 和 B eq 'b1' 和 C eq '*' 或 B = 'b2' 这是无效的,因为逻辑或运算符不能分隔两个不同的元数据名称。 - 返回所有时序,其中 A = a1,B = b1 和 C = c1:$filter=A eq 'a1' 和 B eq 'b1' 和 C eq 'c1' - 返回所有时序,其中 A = a1 $filter=A eq 'a1' 和 B eq '' 和 C eq ''。 特殊情况:当维度名称或维度值使用圆括号时。 例如:当维度名称 dim(test) 1 而不是使用 $filter= “dim (test) 1 eq '' ” use **$filter= “dim %2528test%2529 1 eq '' ”** 当维度名称 dim (test) 3 和维度值为 dim3 (test) val 而不是使用 $filter= “dim (test) 3 eq 'dim3 (test) val' ” use $filter= “dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' ” |
|
|
aggregation
|
query |
string |
要检索的聚合类型列表(逗号分隔)。 |
|
|
interval
|
query |
string (duration) |
查询的间隔(即时间根)。 |
|
|
metricnames
|
query |
string |
要检索的指标的名称(逗号分隔)。 特殊情况:如果指标名本身有一个逗号,则使用 %2 来指示它。 例如:“Metric,Name1”应 “Metric%2Name1” |
|
|
metricnamespace
|
query |
string |
包含请求的指标名称的指标命名空间。 |
|
|
result
|
query |
仅允许检索基线的元数据。 在数据请求中检索所有信息。 |
||
|
sensitivities
|
query |
string |
要检索的敏感度列表(逗号分隔)。 |
|
|
timespan
|
query |
string |
查询的时间跨度。 它是格式为“startDateTime_ISO/endDateTime_ISO”的字符串。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
成功请求以获取指标基线值列表。 |
|
| Other Status Codes |
描述操作失败的原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
类型:
oauth2
流向:
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”的架构特定于服务,依赖于“type”字符串。 |
|
Baseline |
表示基线元数据值。 |
|
Baseline |
基线的敏感度。 |
| Error | |
|
Error |
描述错误响应的详细信息。 |
|
Error |
描述错误响应的格式。 |
|
Metric |
指标基线列表。 |
|
Metric |
指标维度名称和值。 |
|
Result |
仅允许检索基线的元数据。 在数据请求中检索所有信息。 |
|
Single |
单个敏感度值的基线值。 |
|
Single |
单个指标的基线结果。 |
|
Time |
单个时序的基线值。 |
AdditionalInfo
具有“type”和“info”属性的对象数组。 “info”的架构特定于服务,依赖于“type”字符串。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
object |
特定于类型的其他信息。 |
| type |
string |
其他信息的类型。 |
BaselineMetadata
表示基线元数据值。
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
string |
基线元数据的名称。 |
| value |
string |
基线元数据的值。 |
BaselineSensitivity
基线的敏感度。
| 值 | 说明 |
|---|---|
| Low | |
| Medium | |
| High |
Error
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
具有“type”和“info”属性的对象数组。 “info”的架构特定于服务,依赖于“type”字符串。 |
|
| code |
string |
可用于以编程方式标识错误的未分配字符串。 |
| details |
其他嵌套错误响应信息对象数组,如此协定所述。 |
|
| message |
string |
详细描述错误并提供调试信息。 如果在请求中设置了 Accept-Language,则必须将其本地化为该语言。 |
| target |
string |
特定错误的目标(例如,错误中属性的名称)。 |
ErrorDetail
描述错误响应的详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
具有“type”和“info”属性的对象数组。 “info”的架构特定于服务,依赖于“type”字符串。 |
|
| 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 |
指标基线 ID。 |
| 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) |
基线的时间戳列表。 |