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

Weather - Get Severe Weather Alerts

参考

服务:: Maps

API 版本:: 1.1

使用获取有关给定位置的恶劣天气条件（如飓风、雷雨、洪水、闪电、热浪或森林火灾）的信息。

恶劣的天气现象会严重影响我们的日常生活和业务运营。例如，热带风暴、大风或洪水等恶劣天气条件可能会关闭道路，迫使物流公司重新路由车队，导致到达目的地的延误，并中断冷藏食品的冷链。

API Get Severe Weather Alerts 是一个 HTTP GET 请求，可返回全球官方政府气象机构和区域天气警报提供商提供的恶劣天气警报。该服务可以返回详细信息，例如警报类型、类别、级别和有关请求位置的活动严重警报的详细说明，例如飓风、雷雨、闪电、热浪或森林火灾。有关详细信息，请参阅请求恶劣天气警报

GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query={query}

具有可选参数:

GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query={query}&language={language}&details={details}

URI 参数

名称	在	必需	类型	说明
format	path	True	JsonFormat	响应的所需格式。仅支持 `json` 格式。
api-version	query	True	string	Azure Maps API 的版本号。
query	query	True	number[]	指定为由纬度后跟经度组成的逗号分隔字符串的适用查询，例如“47.641268，-122.125679”。
details	query		string	返回恶劣天气警报的完整详细信息。可用值为 `true` - 返回完整详细信息。默认情况下，返回所有详细信息。 `false` - 返回警报数据的截断版本，这不包括警报详细信息 () `alertDetails` 特定于区域的完整说明。
language	query		string	应返回搜索结果的语言。应该是受支持的 IETF 语言标记之一，不区分大小写。当指定语言的数据不适用于特定字段时，将使用默认语言。有关详细信息，请参阅支持的语言。

请求头

名称	必需	类型	说明
x-ms-client-id		string	指定要与 Microsoft Entra ID 安全模型一起使用的帐户。它表示 Azure Maps 帐户的唯一 ID，可以从 Azure Maps 管理平面帐户 API 检索。若要在 Azure Maps 中使用 Microsoft Entra ID 安全性，请参阅以下文章以获取指导。

响应

名称	类型	说明
200 OK	SevereWeatherAlertsResult	还行
Other Status Codes	ErrorResponse	发生了意外错误。

安全性

AADToken

这些是 Microsoft Entra OAuth 2.0 流。与 Azure 基于角色的访问控制配对后，它可用于控制对 Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个 Azure Maps 资源帐户或子资源的访问权限。可以通过内置角色或由 Azure Maps REST API 的一个或多个权限组成的自定义角色授予任何用户、组或服务主体的访问权限。

若要实现方案，建议查看身份验证概念。总之，此安全定义提供了一个解决方案，用于通过能够对特定 API 和作用域进行访问控制的对象对应用程序 () 建模。

备注

此安全定义 需要使用x-ms-client-id 标头来指示应用程序请求访问的 Azure Maps 资源。这可以从地图管理 API 获取。

Authorization URL特定于 Azure 公有云实例。主权云具有唯一的授权 URL 和Microsoft Entra ID 配置。 * Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面配置的。 * 使用 Azure Maps Web SDK 可以基于配置设置多个用例的应用程序。

有关Microsoft标识平台的详细信息，请参阅 Microsoft标识平台概述。

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

作用域

名称	说明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

这是在 Azure 门户中或使用 PowerShell、CLI、Azure SDK 或 REST API 创建 Azure Maps 帐户时预配的共享密钥。

使用此密钥，任何应用程序都可以访问所有 REST API。换句话说，此密钥可以用作颁发它们的帐户中的主密钥。

对于公开的应用程序，我们建议使用机密客户端应用程序方法来访问 Azure Maps REST API，以便安全地存储密钥。

类型: apiKey
在: query

SAS Token

这是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 通过 Azure 管理平面通过 Azure Maps 资源上的列出 SAS 操作创建的共享访问签名令牌。

使用此令牌，任何应用程序都有权使用 Azure 基于角色的访问控制进行访问，并精细控制特定令牌的过期、速率和区域 () 。换句话说，SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

对于公开的应用程序，我们建议在映射帐户资源上配置允许的来源的特定列表，以限制呈现滥用，并定期续订 SAS 令牌。

类型: apiKey
在: header

示例

Successfully retrieve severe weather alerts

示例请求

HTTP

GET https://atlas.microsoft.com/weather/severe/alerts/json?api-version=1.1&query=48.057,-81.091

示例响应

状态代码:: 200

{
  "results": [
    {
      "countryCode": "CA",
      "alertId": 242621,
      "description": {
        "localized": "Heat Warning",
        "english": "Heat Warning"
      },
      "category": "NON-PRECIPITATION",
      "priority": 31,
      "source": "Environment Canada",
      "sourceId": 3,
      "alertAreas": [
        {
          "name": "Kirkland Lake - Englehart",
          "summary": "Heat Warning in effect until Thursday, 3:16 AM EDT.  Source: Environment Canada",
          "startTime": "2020-06-29T19:44:00+00:00",
          "endTime": "2020-07-02T07:16:03+00:00",
          "latestStatus": {
            "localized": "Continue",
            "english": "Continue"
          },
          "alertDetails": "\nA heat event continues through Thursday.\n\nDaytime high temperatures in the low thirties with overnight lows near 18 degrees Celsius are expected to continue until Thursday. Humidex values are expected to reach between 36 and 40 today. Cooler air will move into the region Thursday night. \n\nPlease refer to your public forecast for further details on expected temperatures.\n\nHot and humid air can also bring deteriorating air quality and can result in the air quality health index to approach the high risk category.\n\n###\n\nExtreme heat affects everyone.\n\nThe risks are greater for young children, pregnant women, older adults, people with chronic illnesses and people working or exercising outdoors.\n\nWatch for the effects of heat illness: swelling, rash, cramps, fainting, heat exhaustion, heat stroke and the worsening of some health conditions.\n\nPlease continue to monitor alerts and forecasts issued by Environment Canada. To report severe weather, send an email to ONstorm@canada.ca or tweet reports using #ONStorm.\n",
          "alertDetailsLanguageCode": "en-CA"
        }
      ]
    },
    {
      "countryCode": "CA",
      "alertId": 242633,
      "description": {
        "localized": "Heat Warning",
        "english": "Heat Warning"
      },
      "category": "NON-PRECIPITATION",
      "priority": 31,
      "source": "Environment Canada",
      "sourceId": 3,
      "alertAreas": [
        {
          "name": "Kirkland Lake - Englehart",
          "summary": "Heat Warning in effect until 9:25 PM EDT.  Source: Environment Canada",
          "startTime": "2020-07-01T09:25:59+00:00",
          "endTime": "2020-07-02T01:25:59+00:00",
          "latestStatus": {
            "localized": "New",
            "english": "New"
          },
          "alertDetails": "\nA heat event is expected through Thursday.  \n\nDaytime high temperatures in the low thirties on Wednesday and Thursday with overnight lows near 18 degrees Celsius are expected. This heat event may be extended into the weekend with daytime high temperatures near 30 degrees Celsius. \n\nPlease refer to your public forecast for further details on expected temperatures.  \n\nHot and humid air can also bring deteriorating air quality and can result in the Air Quality Health Index to approach the high risk category.\n\n###\n\nExtreme heat affects everyone.\n\nThe risks are greater for young children, pregnant women, older adults, people with chronic illnesses and people working or exercising outdoors.\n\nPlease continue to monitor alerts and forecasts issued by Environment Canada. To report severe weather, send an email to ONstorm@canada.ca or tweet reports using #ONStorm.\n",
          "alertDetailsLanguageCode": "en-CA"
        }
      ]
    }
  ]
}

定义

名称	说明
AlertArea	有关在受影响区域内发出的恶劣天气警报的信息 () 。如果多个警报针对同一位置处于活动状态，则警报将按 API 响应中的的顺序 `priority` 返回，最高优先级警报将在响应顶部返回。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
JsonFormat	响应的所需格式。仅支持 `json` 格式。
LatestStatus	当前区域中警报的最新状态。
LatestStatusKeyword	警报最新状态的关键字。
SevereWeatherAlert	有关恶劣天气警报的信息。
SevereWeatherAlertDescription	恶劣天气警报的说明。
SevereWeatherAlertsResult	此对象从成功的“获取恶劣天气警报”调用中返回。

AlertArea

有关在受影响区域内发出的恶劣天气警报的信息 () 。如果多个警报针对同一位置处于活动状态，则警报将按 API 响应中的的顺序 priority 返回，最高优先级警报将在响应顶部返回。

名称	类型	说明
alertDetails	string	与警报关联的完整详细信息。如果 =True，则 `details`返回。此字段始终以颁发提供程序选择的语言 () 返回，Azure Maps 仅返回提供程序创建的内容。请注意，某些国家/地区可能提供其母语和英语。语言参数将不适用于此字段。
alertDetailsLanguageCode	string	的语言 `alertDetails`。此字段有助于指出，的语言 `alertDetails` 可能与请求的语言参数不同。如果 =True，则 `details`返回。语言代码派生自 ISO 639-1 Alpha-2 代码。
endTime	string	警报的结束日期和时间，采用 ISO 8601 格式，例如 2019-10-27T19：39：57-08：00。如果警报跨越多个时区，则响应中返回的时间是到请求坐标位置的本地时间。
latestStatus	LatestStatus	当前区域中警报的最新状态。
name	string	受警报影响的区域的名称。请求的位置位于警报区域下。
startTime	string	警报的开始日期和时间，采用 ISO 8601 格式，例如 2019-10-27T19：39：57-08：00。如果警报跨越多个时区，则响应中返回的时间是到请求坐标位置的本地时间。
summary	string	返回区域中汇总警报的文本。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

JsonFormat

响应的所需格式。仅支持 json 格式。

名称	类型	说明
json	string	JavaScript 对象表示法数据交换格式

LatestStatus

当前区域中警报的最新状态。

名称	类型	说明
english	LatestStatusKeyword	警报的最新状态关键字（英语 (en-US) ）。
localized	string	警报的最新状态关键字，采用指定语言。默认情况下，以英语 (en-US) 返回。

LatestStatusKeyword

警报最新状态的关键字。

名称	类型	说明
Cancel	string	“取消”- 警报在其原始过期时间之前已取消。
Continue	string	“继续”- 警报自初始发布以来已更新，但未对 `alertDetails`、 `startTime`、 `endTime`或 `class`进行更改。
Correct	string	“正确”- 已修改警报以更正以前的错误。
Expire	string	“过期”- 警报已过期，不再处于活动状态。
Extend	string	“扩展”- 警报自最初发出以来，已在时间、区域或两者中扩展。
New	string	“新建”- 初始发出时警报的状态。
Update	string	“更新”- 警报自初始发布以来已更新。
Upgrade	string	“升级” - 警报自初始发布以来已升级到更高的类或类别。

SevereWeatherAlert

有关恶劣天气警报的信息。

名称	类型	说明
alertAreas	AlertArea[]	有关特定于受影响区域的警报的信息 () 。
alertId	integer	天气警报的唯一数字标识符。
category	string	警报类别。
class	string	警报的分类。此字段并非适用于所有国家/地区，因此并非始终返回。
countryCode	string	2 个字符的 ISO 3166-1 Alpha-2 国家/地区代码，例如“US”。
description	SevereWeatherAlertDescription	警报的说明。
disclaimer	string	有关警报信息来源的免责声明。此字段并非始终可用。例如，免责声明可能包括有关警报延迟或潜在问题的详细信息。
level	string	警报的严重级别。此字段并非适用于所有国家/地区，因此并非始终返回。
priority	integer	表示给定警报在发起的国家/地区内的重要性或排名顺序的数字。数字越小，表示优先级越高。例如，1 是最高优先级。该数字因国家/地区而异，并随着每个国家/地区的发展其警报系统而变化。
source	string	警报信息的提供程序。默认情况下，源以英语 (en-US) 返回。警报来自官方的政府气象机构和领先的全球天气警报提供商。
sourceId	integer	与警报数据的源提供程序名称关联的数字标识符。

SevereWeatherAlertDescription

恶劣天气警报的说明。

名称	类型	说明
english	string	警报的英文说明 (en-US) 。
localized	string	指定语言的警报说明。默认情况下，如果未在请求中指定语言参数，则返回英语 (en-US) 。

SevereWeatherAlertsResult

此对象从成功的“获取恶劣天气警报”调用中返回。

名称	类型	说明
results	SevereWeatherAlert[]	查询位置的所有恶劣天气警报的列表。

通过