Weather - Get Severe Weather Alerts

參考

服務:: Maps

API 版本:: 1.1

使用取得有關惡劣天氣狀況的資訊，例如颶風、雷暴、洪水、閃電、熱浪或指定位置的森林火災。

惡劣的天氣現象可能會嚴重影響我們的日常生活和商業運營。例如，熱帶風暴、大風或洪水等惡劣天氣狀況可能會關閉道路和迫使物流公司重新路由，導致到達目的地的延誤，並打破冷藏食品的冷鏈。

Get Severe Weather Alerts API 是 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 參數

名稱	位於	必要	類型	Description
format	path	True	JsonFormat	回應所需的格式。僅支援 `json` 格式。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。
query	query	True	number[]	指定為逗號分隔字串的適用查詢，由緯度所組成，後面接著經度，例如 “47.641268，-122.125679”。天氣資訊通常適用於陸地上的位置、被陸地包圍的水體，以及大約50海裡海岸線的海洋區域。
details	query		string	傳回惡劣天氣警示的完整詳細數據。可用的值為 `true` - 傳回完整詳細數據。預設會傳回所有詳細數據。 `false` - 傳回已截斷版本的警示數據，排除警示詳細數據的區域特定完整描述（`alertDetails`）。
language	query		string	應該傳回搜尋結果的語言。應該是其中一個支援的 IETF 語言標記，不區分大小寫。當特定欄位無法使用指定語言的數據時，會使用預設語言。如需詳細資訊，請參閱支援的語言。

要求標頭

名稱	必要	類型	Description
x-ms-client-id		string	指定要與 Microsoft Entra ID 安全性模型搭配使用的帳戶。它代表 Azure 地圖服務帳戶的唯一標識碼，而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。若要在 Azure 地圖服務中使用 Microsoft Entra ID 安全性，請參閱下列文章以取得指引。

回應

名稱	類型	Description
200 OK	SevereWeatherAlertsResult	還行
Other Status Codes	ErrorResponse	發生未預期的錯誤。

安全性

AADToken

這些是 Entra OAuth 2.0 Flow Microsoft。與 Azure 角色型存取配對時，控制它可用來控制 Azure 地圖服務 REST API 的存取。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務資源帳戶或子資源的存取權。任何使用者、群組或服務主體都可以透過內建角色或由一或多個 Azure 地圖服務 REST API 許可權所組成的自定義角色來授與存取權。

若要實作案例，建議您檢視驗證概念。總而言之，此安全性定義會透過能夠針對特定 API 和範圍進行訪問控制的物件，提供模型化應用程式的解決方案。

筆記

此安全性定義需要使用 x-ms-client-id 標頭來指出應用程式要求存取的 Azure 地圖服務資源。這可以從地圖管理 API 取得。

Authorization URL 專屬於 Azure 公用雲端實例。主權雲端具有唯一的授權 URL，Microsoft Entra ID 設定。 * 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 管理平面設定 Azure 角色型存取控制。 * Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式。

如需Microsoft身分識別平臺的詳細資訊，請參閱 Microsoft 身分識別平臺概觀。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

這是當您在 Azure 入口網站或使用 PowerShell、CLI、Azure SDK 或 REST API 建立 Azure 地圖服務帳戶時所佈建的共用密鑰。

使用此金鑰，任何應用程式都可以存取所有 REST API。換句話說，此金鑰可用來做為帳戶中核發的主要密鑰。

針對公開的應用程式，我們建議使用機密用戶端應用程式方法來存取 Azure 地圖服務 REST API，以便安全地儲存您的密鑰。

類型: apiKey
位於: query

SAS Token

這是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 azure 地圖服務資源列表 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"
        }
      ]
    }
  ]
}

定義

名稱	Description
AlertArea	受影響地區內發出的惡劣天氣警報相關信息。如果相同位置有多個警示作用中，則會依 API 回應內的 `priority` 順序傳回警示，而回應頂端會傳回最高優先順序的警示。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
JsonFormat	回應所需的格式。僅支援 `json` 格式。
LatestStatus	目前區域中警示的最新狀態。
LatestStatusKeyword	警示最新狀態的關鍵詞。
SevereWeatherAlert	惡劣天氣警示的相關信息。
SevereWeatherAlertDescription	惡劣天氣警示的描述。
SevereWeatherAlertsResult	此物件會從成功的取得嚴重天氣警示呼叫傳回。

AlertArea

受影響地區內發出的惡劣天氣警報相關信息。如果相同位置有多個警示作用中，則會依 API 回應內的 priority 順序傳回警示，而回應頂端會傳回最高優先順序的警示。

名稱	類型	Description
alertDetails	string	與警示相關聯的完整詳細數據。如果 `details`=True，則傳回。此欄位一律會以發行提供者選擇的語言傳回，而 Azure 地圖服務只會傳回提供者所建立的專案。請注意，某些國家/地區可能會提供其原生語言和英文。語言參數不適用於此欄位。
alertDetailsLanguageCode	string	`alertDetails`的語言。此欄位有助於指出 `alertDetails` 的語言可能與要求的語言參數不同。如果 `details`=True，則傳回。語言代碼衍生自 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

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

JsonFormat

回應所需的格式。僅支援 json 格式。

名稱	類型	Description
json	string	JavaScript 物件表示法數據交換格式

LatestStatus

目前區域中警示的最新狀態。

名稱	類型	Description
english	LatestStatusKeyword	警示的最新狀態關鍵詞，英文（en-US）。
localized	string	警示的最新狀態關鍵詞，以指定的語言顯示。根據預設，會以英文傳回（en-US）。

LatestStatusKeyword

警示最新狀態的關鍵詞。

名稱	類型	Description
Cancel	string	「取消」- 警示在原始到期時間之前已取消。
Continue	string	「繼續」- 警示自初始發行后已更新，但未對 `alertDetails`、`startTime`、`endTime`或 `class`進行變更。
Correct	string	「正確」- 已修改警示以更正先前的錯誤。
Expire	string	「到期」- 警示已過期且不再作用中。
Extend	string	「延長」- 警示自初始發行後已於時間、區域中或兩者延長。
New	string	「新增」- 初始發行時警示的狀態。
Update	string	「更新」- 警示自初始發行后已更新。
Upgrade	string	「升級」- 警示自初始發行后已升級至較高類別或類別。

SevereWeatherAlert

惡劣天氣警示的相關信息。

名稱	類型	Description
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

惡劣天氣警示的描述。

名稱	類型	Description
english	string	英文警示的描述（en-US）。
localized	string	指定語言的警示描述。如果未在要求中指定語言參數，則預設會傳回英文（en-US）。

SevereWeatherAlertsResult

此物件會從成功的取得嚴重天氣警示呼叫傳回。

名稱	類型	Description
results	SevereWeatherAlert[]	查詢位置的所有惡劣天氣警示清單。

共用方式為