Weather - Get Severe Weather Alerts

リファレンス

Service:: Maps

API Version:: 1.1

特定の場所のハリケーン、雷雨、洪水、雷、熱波、森林火災などの厳しい気象条件に関する情報を取得するために使用します。

厳しい気象現象は、私たちの日常生活や事業運営に大きな影響を与える可能性があります。たとえば、熱帯暴風雨、強風、洪水などの厳しい気象条件では、道路を閉鎖し、物流会社が目的地への到着を遅らせ、冷凍食品のコールドチェーンを壊す艦隊を再ルーティングする必要があります。

Get Severe Weather Alerts API は、公式の政府気象機関と、グローバルから地域の気象アラートプロバイダーの両方から世界中で利用可能な厳しい気象アラートを返す HTTP GET 要求です。サービスは、アラートの種類、カテゴリ、レベルなどの詳細を返し、ハリケーン、雷雨、雷雨、熱波、森林火災など、要求された場所のアクティブな重大なアラートに関する詳細な説明を返すことができます。詳細については、「厳しい気象アラートを要求する」を参照してください。

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

With optional parameters:

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 言語タグの 1 つである必要があります。大文字と小文字は区別されません。指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。詳細については、「サポートされている言語」を参照してください。

要求ヘッダー

名前	必須	型	説明
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

これらは OAuth 2.0 フロー Microsoft Entraです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API をAzure Mapsするための 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタムロールを使用して、ユーザー、グループ、またはサービスプリンシパルにアクセス権を付与できます。

シナリオを実装するには、認証の概念を表示することをお勧めします。要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。

メモ

このセキュリティ定義では、ヘッダーを使用して、x-ms-client-idアプリケーションがアクセスを要求しているリソースAzure Maps示す必要があります。これは、 Maps 管理 API から取得できます。

は Authorization URL 、Azure パブリッククラウドインスタンスに固有です。ソブリンクラウドには、固有の承認 URL とMicrosoft Entra ID構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。 * Azure Maps Web SDK を使用すると、複数のユースケースに対してアプリケーションを構成ベースで設定できます。

Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。

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

Scopes

名前	説明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

これは、Azure portalでAzure Maps アカウントを作成するとき、または PowerShell、CLI、Azure SDK、または REST API を使用してプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションですべての REST API にアクセスできます。つまり、このキーは、発行先のアカウントのマスターキーとして使用できます。

公開されているアプリケーションの場合は、機密クライアントアプリケーションのアプローチを使用して、キーを安全に格納できるように、Azure Maps REST API にアクセスすることをお勧めします。

Type: apiKey
In: query

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。

このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンに対するきめ細かい制御が許可されます。言い換えると、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できます。

公開されているアプリケーションの場合、 Map アカウントリソースで許可される配信元の特定のリストを構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。

Type: apiKey
In: header

例

Successfully retrieve severe weather alerts

Sample Request

HTTP

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

Sample Response

Status code:: 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	このオブジェクトは、正常な Get Severe Weather Alerts 呼び出しから返されます。

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	error オブジェクト。

JsonFormat

応答の目的の形式。サポートされているのは json 形式のみです。

名前	型	説明
json	string	JavaScript オブジェクト表記データ交換形式

LatestStatus

現在の領域のアラートの最新の状態。

名前	型	説明
english	LatestStatusKeyword	アラートの最新の状態キーワード (keyword)英語 (en-US)。
localized	string	指定した言語で、アラートの最新の状態キーワード (keyword)。既定では、英語 (en-US) で返されます。

LatestStatusKeyword

アラートの最新の状態のキーワード。

名前	型	説明
Cancel	string	"キャンセル" - アラートは元の有効期限の前に取り消されました。
Continue	string	"Continue" - アラートは最初の発行以降に更新されましたが、、`startTimeendTime`、、または `class`に`alertDetails`変更が加えられました。
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

このオブジェクトは、正常な Get Severe Weather Alerts 呼び出しから返されます。

名前	型	説明
results	SevereWeatherAlert[]	クエリ対象の場所に関するすべての厳しい気象アラートの一覧。