Weather - Get Minute Forecast

參考

服務:: Maps

API 版本:: 1.1

使用，以1、5和15分鐘的間隔取得未來120分鐘的分鐘預測。

Get Minute Forecast API 是 HTTP GET 要求，會針對指定位置傳回未來 120 分鐘的分鐘預測。用戶可以以 1、5 和 15 分鐘的間隔要求天氣預報。回應將包括降水類型（包括雨、雪或兩者混合）、開始時間和降水強度值（dBZ）等詳細數據。如需詳細資訊，請參閱要求逐分鐘天氣預報數據。

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

含選擇性參數:

GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query={query}&interval={interval}&language={language}

URI 參數

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

要求標頭

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

回應

名稱	類型	Description
200 OK	MinuteForecastResult	還行
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 minute-by-minute forecasts for a given location

範例要求

HTTP

GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query=47.632346,-122.138874&interval=15

範例回覆

狀態碼:: 200

{
  "summary": {
    "briefPhrase60": "Rain ending in 25 min",
    "shortPhrase": "Rain ending in 25 min",
    "briefPhrase": "Rain ending in 25 min",
    "longPhrase": "Rain ending in 25 min",
    "iconCode": 12
  },
  "intervalSummaries": [
    {
      "startMinute": 0,
      "endMinute": 24,
      "totalMinutes": 25,
      "shortPhrase": "Rain ending in %minute_value min",
      "briefPhrase": "Rain ending in %minute_value min",
      "longPhrase": "Rain ending in %minute_value min",
      "iconCode": 12
    },
    {
      "startMinute": 25,
      "endMinute": 119,
      "totalMinutes": 95,
      "shortPhrase": "No precip for %MINUTE_VALUE min",
      "briefPhrase": "No precipitation for at least %MINUTE_VALUE min",
      "longPhrase": "No precipitation for at least %MINUTE_VALUE min",
      "iconCode": 7
    }
  ],
  "intervals": [
    {
      "startTime": "2019-11-14T15:18:00-08:00",
      "minute": 0,
      "dbz": 23,
      "shortPhrase": "Light Rain",
      "threshold": "LIGHT",
      "color": {
        "red": 8,
        "green": 98,
        "blue": 2,
        "hex": "#086202"
      },
      "simplifiedColor": {
        "red": 35,
        "green": 190,
        "blue": 39,
        "hex": "#23BE27"
      },
      "precipitationType": "Rain",
      "iconCode": 12,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T15:33:00-08:00",
      "minute": 15,
      "dbz": 18,
      "shortPhrase": "Light Rain",
      "threshold": "LIGHT",
      "color": {
        "red": 32,
        "green": 133,
        "blue": 9,
        "hex": "#208509"
      },
      "simplifiedColor": {
        "red": 35,
        "green": 190,
        "blue": 39,
        "hex": "#23BE27"
      },
      "precipitationType": "Rain",
      "iconCode": 12,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T15:48:00-08:00",
      "minute": 30,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:03:00-08:00",
      "minute": 45,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:18:00-08:00",
      "minute": 60,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:33:00-08:00",
      "minute": 75,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:48:00-08:00",
      "minute": 90,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T17:03:00-08:00",
      "minute": 105,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    }
  ]
}

定義

名稱	Description
ColorValue
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
ForecastInterval
IconCode	數值，表示顯示 `iconPhrase`的影像。如需詳細資訊，請參閱 Azure 地圖服務中的天氣服務。
IntervalSummary
JsonFormat	回應所需的格式。僅支援 `json` 格式。
MinuteForecastResult
MinuteForecastSummary	整個預測期間的片語摘要。
PrecipitationType	指定降水類型（“雨”“雪”“冰”或“混合”）。如果 dbz 為零，則 response 中沒有 precipitationType。

ColorValue

名稱	類型	Description
blue	integer	RGB 值的藍色元件
green	integer	RGB 值的綠色元件。
hex	string	十六進位色彩值。
red	integer	RGB 值的紅色元件。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

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

ErrorDetail

錯誤詳細數據。

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

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

ForecastInterval

名稱	類型	Description
cloudCover	integer	代表雲端涵蓋的百分比。
color	ColorValue	對應至 dBZ 的完整光譜色彩（相對於 Z 的分貝）。如果 dbz 為零，則響應中沒有色彩。
dbz	number	表示預測降水強度的單位。
iconCode	IconCode	數值，表示顯示 `iconPhrase`的影像。如需詳細資訊，請參閱 Azure 地圖服務中的天氣服務。
minute	integer	間隔的第一分鐘。
precipitationType	PrecipitationType	指定降水類型（“雨”“雪”“冰”或“混合”）。如果 dbz 為零，則 response 中沒有 precipitationType。
shortPhrase	string	描述間隔之降水條件的簡短詞組。
simplifiedColor	ColorValue	對應到降水類型和臨界值的帶狀色彩。如果 dbz 為零，則不會出現在回應中。
startTime	string	ISO 8601 格式間隔開始的日期和時間，例如 2019-10-27T19：39：57-08：00。
threshold	string	指定臨界值的索引鍵。除了 precipitationType，可以用來判斷簡化的 Color。如果 dbz 為零，則不會出現在回應中。

IconCode

數值，表示顯示 iconPhrase的影像。如需詳細資訊，請參閱 Azure 地圖服務中的天氣服務。

名稱	類型	Description
1	Integer
10	Integer
11	Integer
12	Integer
13	Integer
14	Integer
15	Integer
16	Integer
17	Integer
18	Integer
19	Integer
2	Integer
20	Integer
21	Integer
22	Integer
23	Integer
24	Integer
25	Integer
26	Integer
27	Integer
28	Integer
29	Integer
3	Integer
30	Integer
31	Integer
32	Integer
33	Integer
34	Integer
35	Integer
36	Integer
37	Integer
38	Integer
39	Integer
4	Integer
40	Integer
41	Integer
42	Integer
43	Integer
44	Integer
5	Integer
6	Integer
7	Integer
8	Integer
9	Integer

IntervalSummary

名稱	類型	Description
briefPhrase	string	簡短摘要片語。片語長度約為 60 個字元。
endMinute	integer	摘要套用的最後一分鐘。
iconCode	IconCode	數值，表示顯示 `iconPhrase`的影像。如需詳細資訊，請參閱 Azure 地圖服務中的天氣服務。
longPhrase	string	完整摘要片語。片語長度為 60+ 個字元。
shortPhrase	string	簡短摘要片語。片語長度約為 25 個字元。
startMinute	integer	要套用摘要的第一分鐘。
totalMinutes	integer	套用摘要的分鐘數。

JsonFormat

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

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

MinuteForecastResult

名稱	類型	Description
intervalSummaries	IntervalSummary[]	預測中每個間隔的摘要資訊。摘要會細分降水開始和停止的每個潛在間隔。
intervals	ForecastInterval[]	預測中每個間隔的預測數據。
summary	MinuteForecastSummary	整個預測期間的片語摘要。

MinuteForecastSummary

整個預測期間的片語摘要。

名稱	類型	Description
briefPhrase	string	接下來 120 分鐘的摘要詞組。片語長度約為 60 個字元。
briefPhrase60	string	接下來 60 分鐘的摘要片語。片語長度約為 60 個字元。
iconCode	IconCode	數值，表示顯示 `iconPhrase`的影像。如需詳細資訊，請參閱 Azure 地圖服務中的天氣服務。
longPhrase	string	接下來 120 分鐘的完整摘要片語。片語長度為 60+ 個字元。
shortPhrase	string	接下來 120 分鐘的簡短摘要片語。片語長度約為 25 個字元。

PrecipitationType

指定降水類型（“雨”“雪”“冰”或“混合”）。如果 dbz 為零，則 response 中沒有 precipitationType。

名稱	類型	Description
Ice	string	冰
Mix	string	混合
Rain	string	雨
Snow	string	雪

共用方式為