Weather - Get Air Quality Daily Forecasts

Slouží k získání denních předpovědí kvality ovzduší na další jeden až sedm dní, které zahrnují úrovně znečišťujících látek, potenciální rizika a navrhovaná opatření.

Rozhraní Get Air Quality Daily Forecasts API je požadavek HTTP GET , který vrací podrobné informace o koncentraci znečišťujících látek a celkovém stavu předpokládané denní kvality ovzduší. Služba může poskytovat předpokládané denní informace o kvalitě ovzduší pro nadcházející 1 až 7 dnů, včetně úrovní znečištění, hodnot indexu kvality ovzduší, dominantního znečisťujícího znečištění a stručného prohlášení shrnující úroveň rizika a navrhovaná opatření.

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}

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
format
path True

JsonFormat

Požadovaný formát odpovědi. Podporuje se pouze json formát.

api-version
query True

string

Číslo verze rozhraní API služby Azure Maps

query
query True

number[]

Příslušný dotaz zadaný jako řetězec oddělený čárkami složený podle zeměpisné šířky následované zeměpisnou délkou, např. "47.641268,-122.125679".

duration
query

DailyDuration

int32

Určuje, kolik dní od této chvíle bychom chtěli vědět o kvalitě ovzduší. Dostupné hodnoty jsou 1, 2, 3, 4, 5, 6 a 7. Výchozí hodnota je 1.

language
query

string

Jazyk, ve kterém se mají vracet výsledky hledání. Měl by být jednou z podporovaných značek jazyka IETF, nerozlišují se malá a velká písmena. Pokud data v zadaném jazyce nejsou pro konkrétní pole k dispozici, použije se výchozí jazyk.

Podrobnosti najdete v části Podporované jazyky .

Hlavička požadavku

Name Vyžadováno Typ Description
x-ms-client-id

string

Určuje, který účet je určen pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a dá se načíst z rozhraní API účtu roviny správy Služby Azure Maps. Informace o použití zabezpečení Microsoft Entra ID ve službě Azure Maps najdete v následujících článcích .

Odpovědi

Name Typ Description
200 OK

DailyAirQualityForecastResult

OK

Other Status Codes

ErrorResponse

Došlo k neočekávané chybě.

Zabezpečení

AADToken

Toto jsou toky Microsoft Entra OAuth 2.0 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k rozhraním REST API služby Azure Maps. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika účtům prostředků nebo dílčím prostředkům Azure Maps. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k rozhraním REST API služby Azure Maps.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.

Poznámky

  • Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení prostředku Azure Maps, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map .

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití webové sady SDK služby Azure Maps umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Jedná se o sdílený klíč, který se zřídí při vytvoření účtu Azure Maps na webu Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace přístup ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve který je vystavený.

U veřejně vystavených aplikací doporučujeme použít pro přístup k rozhraním REST API služby Azure Maps přístup k důvěrným klientským aplikacím , aby se váš klíč mohl bezpečně uložit.

Typ: apiKey
V: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v prostředku Azure Maps prostřednictvím roviny správy Azure portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.

Typ: apiKey
V: header

Příklady

Get Daily Air Quality Forecasts

Ukázkový požadavek

GET https://atlas.microsoft.com/weather/airQuality/forecasts/daily/json?api-version=1.1&query=47.632346,-122.13887&duration=3

Ukázková odpověď

{
  "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."
    }
  ]
}

Definice

Name Description
DailyAirQuality

Informace o kvalitě ovzduší v určitém místě v určitém čase.

DailyAirQualityForecastResult

Tento objekt se vrátí z úspěšného volání Získat denní prognózu kvality ovzduší.

DailyDuration

Určuje, kolik dní od této chvíle bychom chtěli vědět o kvalitě ovzduší. Dostupné hodnoty jsou 1, 2, 3, 4, 5, 6 a 7. Výchozí hodnota je 1.

DominantPollutant

Typ znečisťujících látek. Upozorňujeme, že další mohou být kdykoli přidány.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Odpověď na chybu

JsonFormat

Požadovaný formát odpovědi. Podporuje se pouze json formát.

DailyAirQuality

Informace o kvalitě ovzduší v určitém místě v určitém čase.

Name Typ Description
category

string

Jednoslovný popis kvality ovzduší v požadovaném jazyce. Například "Vynikající".

categoryColor

string

Jedinečná barva odpovídající kategorii tohoto výsledku kvality ovzduší.

dateTime

string

Datum a čas aktuálního pozorování zobrazeného ve formátu ISO 8601, například 2019-10-27T19:39:57-08:00.

description

string

Textové vysvětlení této kvality ovzduší je výsledkem požadovaného jazyka.

dominantPollutant

DominantPollutant

Znečisťovately s nejvyšší koncentrací.

globalIndex

number

Mezinárodně normalizované hodnocení kvality ovzduší v rozsahu od 0 do 300 nahoru, přičemž vyšší čísla představují horší kvalitu ovzduší.

index

number

Hodnocení kvality ovzduší na stupnici stanovené místními regulačními orgány. Měřítka se mohou značně lišit v závislosti na umístění. Další informace najdete na Wikipedii .

DailyAirQualityForecastResult

Tento objekt se vrátí z úspěšného volání Získat denní prognózu kvality ovzduší.

Name Typ Description
nextLink

string

Je odkaz na další stránku vrácených funkcí. Pokud je to poslední stránka, toto pole není.

results

DailyAirQuality[]

Seznam všech denních předpovědí kvality ovzduší pro dotazované místo.

DailyDuration

Určuje, kolik dní od této chvíle bychom chtěli vědět o kvalitě ovzduší. Dostupné hodnoty jsou 1, 2, 3, 4, 5, 6 a 7. Výchozí hodnota je 1.

Name Typ Description
1

string

2

string

3

string

4

string

5

string

6

string

7

string

DominantPollutant

Typ znečisťujících látek. Upozorňujeme, že další mohou být kdykoli přidány.

Name Typ Description
Carbon Monoxide

string

Oxid uhelnatý ("CO")

Nitrogen Dioxide

string

Oxid dusičitý ("NO2")

Ozone

string

Ozón ("O3")

Particulate Matter 10

string

Částice 10 ("PM10")

Particulate Matter 2.5

string

Částice 2,5 ("PM2,5")

Sulfur Dioxide

string

Oxid siřičitý ("SO2")

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.

type

string

Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě

code

string

Kód chyby

details

ErrorDetail[]

Podrobnosti o chybě

message

string

Chybová zpráva

target

string

Cíl chyby.

ErrorResponse

Odpověď na chybu

Name Typ Description
error

ErrorDetail

Objekt chyby.

JsonFormat

Požadovaný formát odpovědi. Podporuje se pouze json formát.

Name Typ Description
json

string

Formát výměny dat v zápisu objektů JavaScriptu