您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

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}&timespan={timespan}&interval={interval}&aggregation={aggregation}&sensitivities={sensitivities}&$filter={$filter}&resultType={resultType}&api-version=2019-03-01

URI 参数

Name In Required Type Description
resourceUri
path True
  • string

资源的标识符。

api-version
query True
  • string

用于此操作的 API 版本。

$filter
query
  • string

$filter 用于减少返回的指标数据集。 示例:指标包含元数据 A、 B 和 C. - 返回 C 的所有时序,其中 A = a1,B = b1 或 b2 $filter=A eq 'a1' 和 B eq 'b1' 或 B eq 'b2' and C eq '*' - 无效变体: $filter=A eq 'a1' and B eq 'b1' and C eq '*' 或 B = 'b2' 这是无效的,因为逻辑或运算符不能分隔两个不同的元数据名称。 - 返回所有时序,其中 A = a1,B = b1,C = c1:$filter=A eq 'a1' 和 B eq 'b1' and C eq 'c1' - 返回所有时序,其中 A = a1 $filter=A eq 'a1' and B eq 'and C eq ''' 。 特殊情况:当维度名称或维度值使用圆括号时。 例如:当维度名称为 dim (test) 1 时,不使用 $filter= "dim (test) 1 eq '' " use **$filter= "dim %2528test%2529 1 eq '' "** 当维度名称为 dim (test) 3 且维度值为 dim 时 3 (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

查询 (间隔,即 timegrain) 查询。

metricnames
query
  • string

指标的名称 (逗号分隔) 检索。 特殊情况:如果指标名称本身有一个逗号,则使用 %2 来指示它。 例如:"Metric,Name1"应为 "Metric%2Name1"

metricnamespace
query
  • string

要查询其指标定义的指标命名空间。

resultType
query

仅允许检索基线的元数据。 在数据请求中检索所有信息。

sensitivities
query
  • string

要检索的以逗号分隔 (的) 列表。

timespan
query
  • string

查询的时间跨度。 它是采用"startDateTime_ISO/endDateTime_ISO"格式的字符串。

响应

Name Type Description
200 OK

成功请求获取指标基线值列表。

Other Status Codes

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Get metric baselines

Sample Request

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

Sample Response

{
  "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
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}

定义

BaselineMetadata

表示基线元数据值。

BaselineSensitivity

基线的敏感度。

ErrorResponse

描述错误响应的格式。

MetricBaselinesResponse

指标基线的列表。

MetricSingleDimension

指标维度名称和值。

ResultType

仅允许检索基线的元数据。 在数据请求中检索所有信息。

SingleBaseline

单个敏感度值的基线值。

SingleMetricBaseline

单个指标的基线结果。

TimeSeriesBaseline

单个时序的基线值。

BaselineMetadata

表示基线元数据值。

Name Type Description
name
  • string

基线元数据的名称。

value
  • string

基线元数据的值。

BaselineSensitivity

基线的敏感度。

Name Type Description
High
  • string
Low
  • string
Medium
  • string

ErrorResponse

描述错误响应的格式。

Name Type Description
code
  • string

错误代码

message
  • string

指示操作失败原因的错误消息。

MetricBaselinesResponse

指标基线的列表。

Name Type Description
value

指标基线列表。

MetricSingleDimension

指标维度名称和值。

Name Type Description
name
  • string

维度的名称。

value
  • string

维度的值。

ResultType

仅允许检索基线的元数据。 在数据请求中检索所有信息。

Name Type Description
Data
  • string
Metadata
  • string

SingleBaseline

单个敏感度值的基线值。

Name Type Description
highThresholds
  • number[]

基线的高阈值。

lowThresholds
  • number[]

基线的低阈值。

sensitivity

基线的敏感度。

SingleMetricBaseline

单个指标的基线结果。

Name Type Description
id
  • string

指标基线 ID。

name
  • string

检索其基线的指标的名称。

properties.baselines

查询的每个时序的基线。

properties.interval
  • string

返回 (数据的) 窗口大小的间隔。 将来可能会对此进行调整,并返回最初请求的 。 如果已提出元数据请求,则不存在此情况。

properties.namespace
  • string

已查询指标的命名空间。

properties.timespan
  • string

检索数据的时间跨度。 其值由两个连接的日期/时间组成,用"/"分隔。 将来可能会对此进行调整,并返回最初请求的 。

type
  • string

指标基线资源的资源类型。

TimeSeriesBaseline

单个时序的基线值。

Name Type Description
aggregation
  • string

指标的聚合类型。

data

每个敏感度的基线值。

dimensions

此时序的维度。

metadataValues

基线元数据值。

timestamps
  • string[]

基线的时间戳列表。