Weather - Get Daily Historical Actuals

參考

服務:: Maps

API 版本:: 1.1

使用來取得氣候學數據，例如過去的每日實際觀測溫度、降水、降雪和降雪深度。

Get Daily Historical Actuals API 是 HTTP GET 要求，會傳回氣候學數據，例如過去每日實際觀察到的溫度、降水、降雪、降雪深度和冷卻 /加熱度日資訊，用於指定座標位置的當天。數據會針對指定的日期範圍要求，在單一 API 要求中最多 31 天。一般而言，根據位置而定，歷史數據可能早在過去 5 到 40 年為止即可使用。

GET https://atlas.microsoft.com/weather/historical/actuals/daily/json?api-version=1.1&query={query}&startDate={startDate}&endDate={endDate}

含選擇性參數:

GET https://atlas.microsoft.com/weather/historical/actuals/daily/json?api-version=1.1&query={query}&startDate={startDate}&endDate={endDate}&unit={unit}

URI 參數

名稱	位於	必要	類型	Description
format	path	True	JsonFormat	回應所需的格式。僅支援 `json` 格式。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。
endDate	query	True	string date	ISO 8601 格式的結束日期，例如 2019-10-28。支援的日期範圍是 1 到 31 個行事曆天，因此請務必指定 startDate 和 endDate，且不超過最多 31 天（也就是 startDate=2012-01-01&endDate=2012-01-31）。
query	query	True	number[]	指定為逗號分隔字串的適用查詢，由緯度所組成，後面接著經度，例如 “47.641268，-122.125679”。天氣資訊通常適用於陸地上的位置、被陸地包圍的水體，以及大約50海裡海岸線的海洋區域。
startDate	query	True	string date	ISO 8601 格式的開始日期，例如 2019-10-27。支援的日期範圍是 1 到 31 個行事曆天，因此請務必指定 startDate 和 endDate，且不超過最多 31 天（也就是 startDate=2012-01-01&endDate=2012-01-31）。
unit	query		WeatherDataUnit	指定以度量單位或英制單位傳回數據。預設值為計量。

要求標頭

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

回應

名稱	類型	Description
200 OK	DailyHistoricalActualsResult	還行
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

範例

Successful Daily Historical Actuals Request

範例要求

HTTP

GET https://atlas.microsoft.com/weather/historical/actuals/daily/json?api-version=1.1&query=40.78,-77.89&startDate=2012-01-20&endDate=2012-01-22

範例回覆

狀態碼:: 200

{
  "results": [
    {
      "date": "2012-01-20T00:00:00-04:00",
      "temperature": {
        "maximum": {
          "value": -6.1,
          "unit": "C",
          "unitType": 17
        },
        "minimum": {
          "value": -11.1,
          "unit": "C",
          "unitType": 17
        },
        "average": {
          "value": -8.6,
          "unit": "C",
          "unitType": 17
        }
      },
      "degreeDaySummary": {
        "heating": {
          "value": 27,
          "unit": "C",
          "unitType": 17
        },
        "cooling": {
          "value": 0,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "value": 10.9,
        "unit": "mm",
        "unitType": 3
      },
      "snowfall": {
        "value": 12.19,
        "unit": "cm",
        "unitType": 4
      },
      "snowDepth": {
        "value": 15.2,
        "unit": "cm",
        "unitType": 4
      }
    },
    {
      "date": "2012-01-21T00:00:00-04:00",
      "temperature": {
        "maximum": {
          "value": -1.7,
          "unit": "C",
          "unitType": 17
        },
        "minimum": {
          "value": -8.9,
          "unit": "C",
          "unitType": 17
        },
        "average": {
          "value": -5.3,
          "unit": "C",
          "unitType": 17
        }
      },
      "degreeDaySummary": {
        "heating": {
          "value": 24,
          "unit": "C",
          "unitType": 17
        },
        "cooling": {
          "value": 0,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "value": 0,
        "unit": "mm",
        "unitType": 3
      },
      "snowfall": {
        "value": 0.51,
        "unit": "cm",
        "unitType": 4
      },
      "snowDepth": {
        "value": 12.7,
        "unit": "cm",
        "unitType": 4
      }
    },
    {
      "date": "2012-01-22T00:00:00-04:00",
      "temperature": {
        "maximum": {
          "value": 0,
          "unit": "C",
          "unitType": 17
        },
        "minimum": {
          "value": -7.2,
          "unit": "C",
          "unitType": 17
        },
        "average": {
          "value": -3.6,
          "unit": "C",
          "unitType": 17
        }
      },
      "degreeDaySummary": {
        "heating": {
          "value": 22,
          "unit": "C",
          "unitType": 17
        },
        "cooling": {
          "value": 0,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "value": 0,
        "unit": "mm",
        "unitType": 3
      },
      "snowfall": {
        "value": 0,
        "unit": "cm",
        "unitType": 4
      },
      "snowDepth": {
        "value": 10.2,
        "unit": "cm",
        "unitType": 4
      }
    }
  ]
}

定義

名稱	Description
DailyHistoricalActuals
DailyHistoricalActualsResult
DegreeDaySummary
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
JsonFormat	回應所需的格式。僅支援 `json` 格式。
UnitType	與所顯示的單位類型相關聯的數值標識碼。可用於單元翻譯。如需詳細資訊，請參閱 Azure 地圖服務中的天氣服務。
WeatherDataUnit	指定以度量單位或英制單位傳回數據。預設值為計量。
WeatherUnit	與天氣相關的指定單位的特定值。
WeatherUnitMaxMinAvg	傳回的溫度值。

DailyHistoricalActuals

名稱	類型	Description
date	string	以 ISO 8601 格式顯示的目前觀察日期和時間，例如 2019-10-27T19：39：57-08：00。
degreeDaySummary	DegreeDaySummary	加熱或冷卻度日資訊的摘要。度日是測量位置的冷度或暖度。一度日將記錄位置的平均（高低）戶外溫度與標準溫度為65度F/18攝氏度進行比較。
precipitation	WeatherUnit	已經下降的降水量（液體對等）。
snowDepth	WeatherUnit	雪深度。
snowfall	WeatherUnit	降雪量。
temperature	WeatherUnitMaxMinAvg	溫度值。

DailyHistoricalActualsResult

名稱	類型	Description
nextLink	string	是傳回之功能下一頁的連結。如果它是最後一頁，則沒有此欄位。
results	DailyHistoricalActuals[]	每個要求日期的歷史實際值。

DegreeDaySummary

名稱	類型	Description
cooling	WeatherUnit	平均溫度高於 65 度 F/ 18 度 C 的度數。
heating	WeatherUnit	平均溫度低於 65 度 F/ 18 度 C 的度數。

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 物件表示法數據交換格式

UnitType

與所顯示的單位類型相關聯的數值標識碼。可用於單元翻譯。如需詳細資訊，請參閱 Azure 地圖服務中的天氣服務。

名稱	類型	Description
0	Integer
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
3	Integer
31	Integer
4	Integer
5	Integer
6	Integer
7	Integer
8	Integer
9	Integer

WeatherDataUnit

指定以度量單位或英制單位傳回數據。預設值為計量。

名稱	類型	Description
imperial	string	以英制單位傳回數據。帝國系統的一些範例單位是華氏和英里。
metric	string	以計量單位傳回數據。計量系統的一些範例單位為攝氏和公里。

WeatherUnit

與天氣相關的指定單位的特定值。

名稱	類型	Description
unit	string	傳回值的單位類型。
unitType	UnitType	與所顯示的單位類型相關聯的數值標識碼。可用於單元翻譯。如需詳細資訊，請參閱 Azure 地圖服務中的天氣服務。
value	number	四捨五入的值。

WeatherUnitMaxMinAvg

傳回的溫度值。

名稱	類型	Description
average	WeatherUnit	時間週期的平均溫度。
maximum	WeatherUnit	時間週期的最高溫度。
minimum	WeatherUnit	時間週期的最低溫度。

共用方式為