Weather - Get Air Quality Daily Forecasts
使用 來取得未來一到七天的每日空氣質量預測,包括污染物水準、潛在風險和建議的預防措施。
Get Air Quality Daily Forecasts
API 是 HTTP GET
要求,會傳回有關污染物濃度和每日空氣質量預測整體狀態的詳細資訊。 該服務可以為即將到來的1至7天提供預測的每日空氣質量資訊,包括污染水準、空氣品質指數值、佔主導地位的污染物,以及總結風險水準和建議的預防措施的簡短聲明。
GET https://atlas.microsoft.com/weather/airQuality/forecasts/daily/json?api-version=1.1&query={query}
GET https://atlas.microsoft.com/weather/airQuality/forecasts/daily/json?api-version=1.1&language={language}&query={query}&duration={duration}
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
format
|
path | True |
回應所需的格式。 僅支援 |
|
api-version
|
query | True |
string |
Azure 地圖服務 API 的版本號碼。 |
query
|
query | True |
number[] |
指定為逗號分隔字串的適用查詢,由緯度所組成,後面接著經度,例如 “47.641268,-122.125679”。 天氣資訊通常適用於陸地上的位置、被陸地包圍的水體,以及大約50海裡海岸線的海洋區域。 |
duration
|
query | int32 |
指定從現在起多少天,我們想要知道空氣品質。 可用的值為 1、2、3、4、5、6 和 7。 預設值為 1。 |
|
language
|
query |
string |
應該傳回搜尋結果的語言。 應該是其中一個支援的 IETF 語言標記,不區分大小寫。 當特定欄位無法使用指定語言的數據時,會使用預設語言。 如需詳細資訊,請參閱 支援的語言。 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
x-ms-client-id |
string |
指定要與 Microsoft Entra ID 安全性模型搭配使用的帳戶。 它代表 Azure 地圖服務帳戶的唯一標識碼,而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。 若要在 Azure 地圖服務中使用 Microsoft Entra ID 安全性,請參閱下列 文章 以取得指引。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
還行 |
|
Other Status Codes |
發生未預期的錯誤。 |
安全性
AADToken
這些是 Entra OAuth 2.0 Flow
若要實作案例,建議您檢視
筆記
- 此安全性定義 需要 使用
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 地圖服務資源
使用此令牌時,任何應用程式都有權使用 Azure 角色型訪問控制進行存取,並更精細地控制特定令牌的到期、速率和區域。 換句話說,SAS 令牌可用來讓應用程式以比共用密鑰更安全的方式控制存取。
對於公開的應用程式,我們建議在 對應帳戶資源上設定允許的來源特定清單, 以限制轉譯濫用,並定期更新 SAS 令牌。
類型:
apiKey
位於:
header
範例
Get Daily Air Quality Forecasts
範例要求
GET https://atlas.microsoft.com/weather/airQuality/forecasts/daily/json?api-version=1.1&query=47.632346,-122.13887&duration=3
範例回覆
{
"results": [
{
"dateTime": "2021-07-18T07:00:00+00:00",
"index": 35.1,
"globalIndex": 42.2,
"dominantPollutant": "Ozone",
"category": "Fair",
"categoryColor": "#FFC300",
"description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure."
},
{
"dateTime": "2021-07-19T07:00:00+00:00",
"index": 31.6,
"globalIndex": 37,
"dominantPollutant": "Ozone",
"category": "Fair",
"categoryColor": "#FFC300",
"description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure."
},
{
"dateTime": "2021-07-20T07:00:00+00:00",
"index": 33.6,
"globalIndex": 40,
"dominantPollutant": "Ozone",
"category": "Fair",
"categoryColor": "#FFC300",
"description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure."
}
]
}
定義
名稱 | Description |
---|---|
Daily |
特定時間特定位置空氣質量的相關信息。 |
Daily |
此物件會從成功的 Get Daily Air Quality Forecast 呼叫傳回。 |
Daily |
指定從現在起多少天,我們想要知道空氣品質。 可用的值為 1、2、3、4、5、6 和 7。 預設值為 1。 |
Dominant |
污染物類型。 請注意,您可以隨時新增更多。 |
Error |
資源管理錯誤其他資訊。 |
Error |
錯誤詳細數據。 |
Error |
錯誤回應 |
Json |
回應所需的格式。 僅支援 |
DailyAirQuality
特定時間特定位置空氣質量的相關信息。
名稱 | 類型 | Description |
---|---|---|
category |
string |
要求語言中空氣品質的單字描述。 例如,“Excellent”。 |
categoryColor |
string |
對應到此空氣質量結果類別的唯一色彩。 |
dateTime |
string |
以 ISO 8601 格式顯示的目前觀察日期和時間,例如 2019-10-27T19:39:57-08:00。 |
description |
string |
此空氣品質的文字說明會導致要求的語言。 |
dominantPollutant |
濃度最高的污染物。 |
|
globalIndex |
number |
從0到300,國際標準化的空氣質量評級從0提高到300,較高的數位代表空氣質量惡化。 |
index |
number |
當地監管機構對規模設置的空氣質量評級。 縮放比例可能會根據位置而有所不同。 如需詳細資訊,請參閱維琪百科 |
DailyAirQualityForecastResult
此物件會從成功的 Get Daily Air Quality Forecast 呼叫傳回。
名稱 | 類型 | Description |
---|---|---|
nextLink |
string |
是傳回之功能下一頁的連結。 如果它是最後一頁,則沒有此欄位。 |
results |
查詢位置的所有每日空氣質量預測清單。 |
DailyDuration
指定從現在起多少天,我們想要知道空氣品質。 可用的值為 1、2、3、4、5、6 和 7。 預設值為 1。
名稱 | 類型 | Description |
---|---|---|
1 |
string |
|
2 |
string |
|
3 |
string |
|
4 |
string |
|
5 |
string |
|
6 |
string |
|
7 |
string |
DominantPollutant
污染物類型。 請注意,您可以隨時新增更多。
名稱 | 類型 | Description |
---|---|---|
Carbon Monoxide |
string |
一氧化碳 (“CO”) |
Nitrogen Dioxide |
string |
二氧化氮(“NO2”) |
Ozone |
string |
臭氧 (“O3”) |
Particulate Matter 10 |
string |
顆粒物 10 (“PM10”) |
Particulate Matter 2.5 |
string |
顆粒物 2.5 (“PM2.5”) |
Sulfur Dioxide |
string |
二氧化硫 (“SO2”) |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
名稱 | 類型 | Description |
---|---|---|
info |
object |
其他資訊。 |
type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
additionalInfo |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細數據。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
名稱 | 類型 | Description |
---|---|---|
error |
error 物件。 |
JsonFormat
回應所需的格式。 僅支援 json
格式。
名稱 | 類型 | Description |
---|---|---|
json |
string |