Weather - Get Current Air Quality

Referencia

Service:: Maps

API Version:: 1.1

A potenciális kockázatokat és a javasolt óvintézkedéseket tartalmazó aktuális levegőminőségi információk lekérésére szolgál.

Az Get Current Air Quality API egy HTTP-kérés GET , amely részletes információkat ad vissza a szennyező anyagok koncentrációjáról és a jelenlegi levegőminőség általános állapotáról, beleértve a szennyezési szinteket, a levegőminőség-indexértékeket, az uralkodó szennyező anyagot, valamint egy rövid kimutatást, amely összefoglalja a kockázati szintet és a javasolt óvintézkedéseket.

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

With optional parameters:

GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&language={language}&query={query}&pollutants={pollutants}

URI-paraméterek

Name	In	Kötelező	Típus	Description
format	path	True	JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.
api-version	query	True	string	Azure Maps API verziószáma.
query	query	True	number[]	A megfelelő lekérdezés, amelyet vesszővel tagolt sztringként határoz meg, amelyet szélesség és hosszúság követ, például:"47.641268,-122.125679".
language	query		string	Az a nyelv, amelyben a keresési eredményeket vissza kell adni. A támogatott IETF nyelvcímkék egyikének kell lennie, a kis- és nagybetűk nem különböztethetők meg. Ha a megadott nyelvű adatok nem érhetők el egy adott mezőhöz, a rendszer az alapértelmezett nyelvet használja. Részletekért tekintse meg a támogatott nyelveket ismertető cikket.
pollutants	query		boolean	Logikai érték, amely részletes információkat ad vissza az egyes szennyező anyagokról. Alapértelmezés szerint igaz.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-id		string	Meghatározza, hogy melyik fiók legyen a Microsoft Entra ID biztonsági modellel együtt használva. Ez a Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeletisík Fiók API-jából. A Microsoft Entra ID biztonság Azure Maps az alábbi cikkekben talál útmutatást.

Válaszok

Name	Típus	Description
200 OK	AirQualityResult	OK
Other Status Codes	ErrorResponse	Váratlan hiba történt.

Biztonság

AADToken

Ezek a Microsoft Entra OAuth 2.0-folyamatok. Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva Azure Maps REST API-khoz való hozzáférés vezérlésére használható. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több rest API-Azure Maps ra vonatkozó engedélyből álló egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.

Jegyzetek

Ez a biztonsági definíció megköveteli a fejléc használatát annak x-ms-client-id jelzéséhez, hogy melyik Azure Maps erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps management API-ból szerezhető be.

A Authorization URL az Azure nyilvános felhőpéldányára vonatkozik. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra ID konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlése az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával. * A Azure Maps Web SDK használata lehetővé teszi az alkalmazások konfigurációalapú beállítását több használati esetben.

A Microsoft Identitásplatform kapcsolatos további információkért lásd: Microsoft Identitásplatform áttekintése.

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

Scopes

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

subscription-key

Ez egy megosztott kulcs, amely akkor lesz kiépítve, ha Létrehozás egy Azure Maps fiókot a Azure Portal vagy PowerShell, CLI, Azure SDK vagy REST API használatával.

Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ez a kulcs használható főkulcsként abban a fiókban, amelyben ki vannak adva.

Nyilvánosan közzétett alkalmazások esetén javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítését használja Azure Maps REST API-k eléréséhez, hogy a kulcs biztonságosan tárolható legyen.

Type: apiKey
In: query

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat a listázási SAS műveletből jön létre az Azure Maps erőforráson keresztül az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.

Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonathoz használt lejárati időhöz, sebességhez és régióhoz. Más szóval az SAS-jogkivonattal az alkalmazások a megosztott kulcsnál biztonságosabb módon szabályozhatják a hozzáférést.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfiguráljon egy adott listát az engedélyezett forrásokról a térképfiók-erőforráson a leképezési visszaélések korlátozásához és az SAS-jogkivonat rendszeres megújításához.

Type: apiKey
In: header

Példák

Get Current Air Quality

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "results": [
    {
      "dateTime": "2021-07-19T02:00:00+00:00",
      "index": 21.6,
      "globalIndex": 22.1,
      "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.",
      "pollutants": [
        {
          "type": "NO2",
          "name": "Nitrogen Dioxide",
          "index": 6.7,
          "globalIndex": 6.7,
          "concentration": {
            "value": 13.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "O3",
          "name": "Ozone",
          "index": 21.6,
          "globalIndex": 22.1,
          "concentration": {
            "value": 53.5,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM10",
          "name": "Particulate Matter 10",
          "index": 11.3,
          "globalIndex": 12.2,
          "concentration": {
            "value": 12.2,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM2.5",
          "name": "Particulate Matter 2.5",
          "index": 13.5,
          "globalIndex": 6.5,
          "concentration": {
            "value": 3.2,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "CO",
          "name": "Carbon Monoxide",
          "index": 1.2,
          "globalIndex": 0.6,
          "concentration": {
            "value": 118.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "SO2",
          "name": "Sulfur Dioxide",
          "index": 0.6,
          "globalIndex": 1.1,
          "concentration": {
            "value": 1.1,
            "unit": "µg/m³",
            "unitType": 31
          }
        }
      ]
    }
  ]
}

Definíciók

Name	Description
AirQuality	Információ a levegő minőségéről egy adott helyen egy adott időpontban.
AirQualityResult	Ezt az objektumot egy sikeres Levegőminőség lekérése hívás adja vissza.
DominantPollutant	A szennyező anyag típusa. Vegye figyelembe, hogy bármikor továbbiak is hozzáadhatók.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.
Pollutant	Részletes információk az egyes szennyező anyagokról. Nem ad vissza, ha `pollutants`=hamis.
PollutantType	A szennyező anyag típusa. Vegye figyelembe, hogy bármikor továbbiak is hozzáadhatók.
UnitType	A megjelenített egység típusához társított numerikus azonosító érték. Az egységfordításhoz használható. A részletekért tekintse meg az időjárási szolgáltatásokat Azure Maps.
WeatherUnit	Egy adott egység adott, időjárással kapcsolatos értéke.

AirQuality

Információ a levegő minőségéről egy adott helyen egy adott időpontban.

Name	Típus	Description
category	string	A levegőminőség egyszavas leírása a kért nyelven. Például: "Kiváló".
categoryColor	string	A levegőminőségi eredmény kategóriájának megfelelő egyedi szín.
dateTime	string	Az ISO 8601 formátumban megjelenített jelenlegi megfigyelés dátuma és időpontja, például 2019-10-27T19:39:57-08:00.
description	string	Ennek a levegőminőségnek a szöveges magyarázata a kért nyelvet eredményezi.
dominantPollutant	DominantPollutant	A legnagyobb koncentrációjú szennyező anyag.
globalIndex	number	Nemzetközileg normalizált levegőminőség-minősítés 0 és 300 közötti skálán, magasabb számokkal, amelyek rosszabb levegőminőséget képviselnek.
index	number	Levegőminőségi minősítés a helyi szabályozó szervek által meghatározott méretezési csoportban. A skálák a helytől függően széles körben változhatnak. További információt a Wikipédiában talál.
pollutants	Pollutant[]	Az egyes szennyező anyagokra vonatkozó információk.

AirQualityResult

Ezt az objektumot egy sikeres Levegőminőség lekérése hívás adja vissza.

Name	Típus	Description
nextLink	string	A a visszaadott funkciók következő oldalára mutató hivatkozás. Ha ez az utolsó oldal, akkor nem ez a mező.
results	AirQuality[]	A lekérdezett hely levegőminőségi eredményeinek listája.

DominantPollutant

A szennyező anyag típusa. Vegye figyelembe, hogy bármikor továbbiak is hozzáadhatók.

Name	Típus	Description
Carbon Monoxide	string	Szén-monoxid ("CO")
Nitrogen Dioxide	string	Nitrogén-dioxid ("NO2")
Ozone	string	Ózon ("O3")
Particulate Matter 10	string	Részecske 10 ("PM10")
Particulate Matter 2.5	string	Részecske 2,5 ("PM2.5")
Sulfur Dioxide	string	Kén-dioxid ("SO2")

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

JsonFormat

A válasz kívánt formátuma. Csak json a formátum támogatott.

Name	Típus	Description
json	string	A JavaScript object Notation Data Interchange formátuma

Pollutant

Részletes információk az egyes szennyező anyagokról. Nem ad vissza, ha pollutants=hamis.

Name	Típus	Description
concentration	WeatherUnit	Egy olyan objektum, amely a légszennyező részecskék számát tartalmazza levegőmennyiségenként.
globalIndex	number	Nemzetközileg normalizált levegőminőség-minősítés 0 és 300 közötti skálán, magasabb számokkal, amelyek rosszabb levegőminőséget képviselnek.
index	number	Levegőminőségi minősítés a helyi szabályozó szervek által meghatározott méretezési csoportban. A skálák a helytől függően széles körben változhatnak. További információt a Wikipédiában talál.
name	string	A szennyező anyag neve angolul.
type	PollutantType	A szennyező anyag típusa. Vegye figyelembe, hogy bármikor továbbiak is hozzáadhatók.

PollutantType