你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Heat Map - Get

获取流量管理器配置文件的最新热度地图。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/heatMaps/default?api-version=2022-04-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/heatMaps/default?topLeft={topLeft}&botRight={botRight}&api-version=2022-04-01

URI 参数

名称 必需 类型 说明
heatMapType
path True

HeatMapType

流量管理器配置文件的 HeatMap 类型。

profileName
path True

string

流量管理器配置文件的名称。

resourceGroupName
path True

string

minLength: 1
maxLength: 90

资源组的名称。 名称不区分大小写。

subscriptionId
path True

string

获取唯一标识Microsoft Azure 订阅的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。

api-version
query True

string

客户端 API 版本。

botRight
query

number[]

要查询的矩形视口的右下纬度、经度对。

topLeft
query

number[]

要查询的矩形视口的左上纬度、经度对。

响应

名称 类型 说明
200 OK

HeatMapModel

流量管理器热度地图。

Other Status Codes

CloudError

默认响应。 它将根据错误定义进行反序列化。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

HeatMap-GET
HeatMap-GET-With-Null-Values
HeatMap-GET-With-TopLeft-BotRight

HeatMap-GET

示例请求

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficmanagerprofiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/default?api-version=2022-04-01

示例响应

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/latencyVolumeByLocation",
  "name": "default",
  "type": "Microsoft.Network/trafficManagerProfiles/heatMaps/latencyVolumeByLocation",
  "properties": {
    "startTime": "2017-08-15T12:00:00Z",
    "endTime": "2017-08-22T12:50:00Z",
    "endpoints": [
      {
        "endpointId": 1,
        "resourceId": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/azuresdkfornetautoresttrafficmanager3880"
      },
      {
        "endpointId": 2,
        "resourceId": "/subscriptions/562d4115-c01e-4m67-9bbd-c11c2d58ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1300/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3885/externalEndpoints/azuresdkfornetautoresttrafficmanager3881"
      }
    ],
    "trafficFlows": [
      {
        "latitude": 99.99,
        "longitude": 0,
        "sourceIp": "1.1.1.1",
        "queryExperiences": [
          {
            "endpointId": 1,
            "latency": 99.222,
            "queryCount": 1000000
          },
          {
            "endpointId": 2,
            "latency": 1.222,
            "queryCount": 1
          }
        ]
      },
      {
        "latitude": -99.99,
        "longitude": 1,
        "sourceIp": "2.255.1.1",
        "queryExperiences": [
          {
            "endpointId": 1,
            "latency": 96.222,
            "queryCount": 100
          },
          {
            "endpointId": 2,
            "latency": 4.222,
            "queryCount": 500
          }
        ]
      }
    ]
  }
}

HeatMap-GET-With-Null-Values

示例请求

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficmanagerprofiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/default?api-version=2022-04-01

示例响应

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/default",
  "name": "default",
  "type": "Microsoft.Network/trafficManagerProfiles/heatMaps/default",
  "properties": {
    "startTime": "2017-08-15T12:00:00Z",
    "endTime": "2017-08-22T12:50:00Z",
    "endpoints": [
      {
        "endpointId": 0,
        "resourceId": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/azuresdkfornetautoresttrafficmanager3880"
      },
      {
        "endpointId": 1,
        "resourceId": "/subscriptions/562d4115-c01e-4m67-9bbd-c11c2d58ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1300/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3885/externalEndpoints/azuresdkfornetautoresttrafficmanager3881"
      }
    ],
    "trafficFlows": [
      {
        "latitude": 99.99,
        "longitude": 0,
        "sourceIp": "1.1.1.1",
        "queryExperiences": [
          {
            "endpointId": 0,
            "latency": 99,
            "queryCount": 1000000
          },
          {
            "endpointId": 1,
            "latency": 1,
            "queryCount": 1
          }
        ]
      },
      {
        "latitude": 1.11,
        "longitude": -2.35,
        "sourceIp": "2.255.1.1",
        "queryExperiences": [
          {
            "endpointId": 0,
            "queryCount": 100
          },
          {
            "endpointId": 1,
            "latency": 4.222,
            "queryCount": 500
          }
        ]
      }
    ]
  }
}

HeatMap-GET-With-TopLeft-BotRight

示例请求

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficmanagerprofiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/default?topLeft=10,50.001&botRight=-50.001,80&api-version=2022-04-01

示例响应

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/latencyVolumeByLocation",
  "name": "default",
  "type": "Microsoft.Network/trafficManagerProfiles/heatMaps/latencyVolumeByLocation",
  "properties": {
    "startTime": "2017-08-15T12:00:00Z",
    "endTime": "2017-08-22T12:50:00Z",
    "endpoints": [
      {
        "endpointId": 1,
        "resourceId": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/azuresdkfornetautoresttrafficmanager3880"
      },
      {
        "endpointId": 2,
        "resourceId": "/subscriptions/562d4115-c01e-4m67-9bbd-c11c2d58ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1300/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3885/externalEndpoints/azuresdkfornetautoresttrafficmanager3881"
      }
    ],
    "trafficFlows": [
      {
        "latitude": 9.99,
        "longitude": 75.01,
        "sourceIp": "1.1.1.1",
        "queryExperiences": [
          {
            "endpointId": 1,
            "latency": 99.222,
            "queryCount": 1000000
          },
          {
            "endpointId": 2,
            "latency": 1.222,
            "queryCount": 1
          }
        ]
      },
      {
        "latitude": -49.99,
        "longitude": 51,
        "sourceIp": "2.255.1.1",
        "queryExperiences": [
          {
            "endpointId": 1,
            "latency": 96.222,
            "queryCount": 100
          },
          {
            "endpointId": 2,
            "latency": 4.222,
            "queryCount": 500
          }
        ]
      }
    ]
  }
}

定义

名称 说明
CloudError

Azure 资源管理器返回的错误

CloudErrorBody

Azure 资源管理器返回的错误的内容

HeatMapEndpoint

类是流量管理器终结点的稀疏表示形式。

HeatMapModel

表示流量管理器 HeatMap 的类。

HeatMapType

流量管理器配置文件的 HeatMap 类型。

QueryExperience

表示流量管理器 HeatMap 查询体验属性的类。

TrafficFlow

表示流量管理器 HeatMap 流量流属性的类。

CloudError

Azure 资源管理器返回的错误

名称 类型 说明
error

CloudErrorBody

错误的内容。

CloudErrorBody

Azure 资源管理器返回的错误的内容

名称 类型 说明
code

string

错误代码

details

CloudErrorBody[]

错误详细信息

message

string

错误信息

target

string

错误目标

HeatMapEndpoint

类是流量管理器终结点的稀疏表示形式。

名称 类型 说明
endpointId

integer

在查询体验中唯一标识此终结点的数字。

resourceId

string

此流量管理器终结点的 ARM 资源 ID。

HeatMapModel

表示流量管理器 HeatMap 的类。

名称 类型 说明
id

string

资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}

name

string

资源的名称

properties.endTime

string (date-time)

此 HeatMap 的时间窗口结束,独占。

properties.endpoints

HeatMapEndpoint[]

此 HeatMap 计算中使用的终结点。

properties.startTime

string (date-time)

此 HeatMap(含)的时间窗口的开始。

properties.trafficFlows

TrafficFlow[]

此 HeatMap 计算中生成的流量流。

type

string

资源的类型。 Ex- Microsoft.Network/trafficManagerProfiles。

HeatMapType

流量管理器配置文件的 HeatMap 类型。

说明
default

QueryExperience

表示流量管理器 HeatMap 查询体验属性的类。

名称 类型 说明
endpointId

integer

这些查询路由到的“endpoints”数组中的终结点的 ID。

latency

number (double)

源自此位置的查询所经历的延迟。

queryCount

integer

源自此位置的查询数。

TrafficFlow

表示流量管理器 HeatMap 流量流属性的类。

名称 类型 说明
latitude

number (double)

这些查询源自的大致纬度。

longitude

number (double)

这些查询源自的近似经度。

queryExperiences

QueryExperience[]

此 HeatMap 计算中生成的查询体验。

sourceIp

string

此查询体验源自的 IP 地址。