Weather - Get Current Air Quality
Służy do uzyskiwania aktualnych informacji o jakości powietrza, które obejmują potencjalne zagrożenia i sugerowane środki ostrożności.
Interfejs Get Current Air Quality API to żądanie HTTP GET , które zwraca szczegółowe informacje o stężeniu zanieczyszczeń i ogólnym stanie bieżącej jakości powietrza, w tym poziomy zanieczyszczeń, wartości indeksu jakości powietrza, dominujące zanieczyszczenie oraz krótkie oświadczenie podsumowujące poziom ryzyka i sugerowane środki ostrożności.
GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&query={query}
GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&language={language}&query={query}&pollutants={pollutants}
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
format
|
path | True |
Żądany format odpowiedzi. Obsługiwany jest tylko format |
|
|
api-version
|
query | True |
string |
Numer wersji interfejsu API usługi Azure Maps. |
|
query
|
query | True |
number[] |
Odpowiednie zapytanie określone jako ciąg rozdzielony przecinkami składające się z szerokości geograficznej, po której następuje długość geograficzna, np. "47.641268,-122.125679". Informacje o pogodzie są ogólnie dostępne dla lokalizacji na lądzie, zbiorników wodnych otoczonych lądem oraz obszarów oceanu, które znajdują się w odległości około 50 mil morskich od linii brzegowej. |
|
language
|
query |
string |
Język, w którym powinny być zwracane wyniki wyszukiwania. Powinien być jednym z obsługiwanych tagów języka IETF, bez uwzględniania wielkości liter. Jeśli dane w określonym języku nie są dostępne dla określonego pola, używany jest język domyślny. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki. |
|
|
pollutants
|
query |
boolean |
Wartość logiczna, która zwraca szczegółowe informacje o każdym zanieczyszczeniu. Domyślnie ma wartość True. |
Nagłówek żądania
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| x-ms-client-id |
string |
Wskazuje konto przeznaczone do użycia z modelem zabezpieczeń Microsoft Entra ID. Ten unikatowy identyfikator konta Azure Maps można uzyskać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby uzyskać więcej informacji na temat korzystania z zabezpieczeń Microsoft Entra ID w Azure Maps, zobacz Zarządzanie uwierzytelnianiem w Azure Maps. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
Wystąpił nieoczekiwany błąd. |
Zabezpieczenia
AADToken
Są to przepływy Microsoft Entra OAuth 2.0. Po połączeniu z dostępem opartym na rolach platformy Azure kontroli może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi mogą mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.
Aby zaimplementować scenariusze, zalecamy wyświetlenie koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.
Notes
- Ta definicja zabezpieczeń wymaga użycia nagłówka
x-ms-client-idw celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania Maps.
Authorization URL jest specyficzna dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów Entra firmy Microsoft.
* Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana na podstawie płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
* Użycie zestawu Web SDK usługi Azure Maps umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.
- Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Microsoft identity platform overview.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresów
| Nazwa | Opis |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Jest to klucz wspólny aprowizowany podczas tworzenie konta usługi Azure Maps w witrynie Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.
Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może służyć jako klucz główny na koncie, w którym są wystawiane.
W przypadku publicznie uwidocznionych aplikacji zalecamy użycie poufnych aplikacji klienckich podejście do uzyskiwania dostępu do interfejsów API REST usługi Azure Maps, aby klucz mógł być bezpiecznie przechowywany.
Typ:
apiKey
W:
query
SAS Token
Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji List SAS na zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej zabezpieczony niż klucz wspólny.
W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.
Typ:
apiKey
W:
header
Przykłady
Get Current Air Quality
Przykładowe zapytanie
GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&query=47.632346,-122.13887
Przykładowa odpowiedź
{
"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
}
}
]
}
]
}
Definicje
| Nazwa | Opis |
|---|---|
|
Air |
Obiekt Jakość powietrza dostarcza kompleksowych informacji o aktualnej jakości powietrza w podanej lokalizacji. Obejmuje to stężenia różnych zanieczyszczeń, numeryczne wartości Indeksu Jakości Powietrza (AQI) wskazujące ogólną jakość powietrza oraz identyfikację dominującego zanieczyszczenia wpływającego na jakość powietrza. Dodatkowo oferuje podsumowanie poziomu ryzyka, które krótko opisuje potencjalne zagrożenia zdrowotne i sugeruje środki ostrożności. |
|
Air |
Zestaw obiektów jakości powietrza , z których każdy dostarcza kompleksowych informacji o aktualnej jakości powietrza w podanej lokalizacji. |
|
Dominant |
Identyfikuje zanieczyszczenie o najwyższym stężeniu. |
|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
|
Error |
Szczegóły błędu. |
|
Error |
Odpowiedź na błąd |
|
Json |
Żądany format odpowiedzi. Obsługiwany jest tylko format |
| Pollutant |
Szczegółowe informacje o poszczególnych substancjach zanieczyszczających. Nie zwracane, jeśli |
|
Pollutant |
Określa sześć typów zanieczyszczeń śledzonych przez usługę Azure Maps Weather. |
|
Unit |
Liczba całkowita reprezentująca typ jednostki. Na przykład 17 dla stopni Celsjusza, 18 dla stopni Fahrenheita. Może być używany do przeliczania jednostek. Aby uzyskać pełną listę, zobacz Usługi pogodowe w Azure Maps. |
|
Weather |
Konkretna wartość danej jednostki związana z pogodą. |
AirQuality
Obiekt Jakość powietrza dostarcza kompleksowych informacji o aktualnej jakości powietrza w podanej lokalizacji. Obejmuje to stężenia różnych zanieczyszczeń, numeryczne wartości Indeksu Jakości Powietrza (AQI) wskazujące ogólną jakość powietrza oraz identyfikację dominującego zanieczyszczenia wpływającego na jakość powietrza. Dodatkowo oferuje podsumowanie poziomu ryzyka, które krótko opisuje potencjalne zagrożenia zdrowotne i sugeruje środki ostrożności.
| Nazwa | Typ | Opis |
|---|---|---|
| category |
string |
Zawiera jednowyrazowy opis jakości powietrza na okres prognozy w określonym języku, takim jak Słaba, Średnia lub Doskonała. |
| categoryColor |
string |
Zapewnia unikalny szesnastkowy kod koloru odpowiadający kategorii jakości powietrza dla każdego dnia w okresie prognozy. Ten kolor pomaga użytkownikom szybko wizualnie określić poziom jakości powietrza, a każdy kolor odpowiada kategorii takiej jak Słaby, Średni lub Doskonały. |
| dateTime |
string (date-time) |
Data i godzina aktualnego obserwacji, wyświetlane w formacie ISO 8601 (yyyy-mm-ddThh:mm:ss-hh:mm). Na przykład 2025-04-29T07:00:00-07:00. |
| description |
string |
Wyjaśnienie tekstowe tej jakości powietrza w żądanym języku. |
| dominantPollutant |
Identyfikuje zanieczyszczenie o najwyższym stężeniu. |
|
| globalIndex |
number (float) |
Zapewnia międzynarodowo ustandaryzowany sposób zrozumienia stężenia zanieczyszczeń w powietrzu. Oceny wahają się od 0 do 300 i więcej, przy czym wyższe wartości oznaczają gorszą jakość powietrza. Mierzone zanieczyszczenia obejmują PM2,5, PM10, NO2, SO2, CO oraz O3. |
| index |
number (float) |
Wskaźnik jakości powietrza (AQI) to skala oceny jakości powietrza ustalana przez lokalne organy regulacyjne. Skale mogą się znacznie różnić w zależności od lokalizacji. Więcej informacji można znaleźć w artykule Indeks jakości powietrza w Wikipedii. |
| pollutants |
Tablica zawierająca szczegółowe informacje o każdym zanieczyszczeniu w odpowiedzi. Zwracany, gdy |
AirQualityResult
Zestaw obiektów jakości powietrza , z których każdy dostarcza kompleksowych informacji o aktualnej jakości powietrza w podanej lokalizacji.
| Nazwa | Typ | Opis |
|---|---|---|
| nextLink |
string |
Zawiera adres URL do pobrania następnej strony z wynikami, jeśli odpowiedź jest paginowana. Jest to przydatne, gdy odpowiedź jest zbyt duża, by zwrócić ją w jednym połączeniu, co pozwala użytkownikom przejrzeć wiele stron z wynikami. |
| results |
Szczegółowe wyniki jakości powietrza w określonym obszarze, w tym właściwości takie jak indeks jakości powietrza (AQI), dominujące zanieczyszczenia, poziomy zanieczyszczeń, poziom ryzyka oraz zalecane środki ostrożności. |
DominantPollutant
Identyfikuje zanieczyszczenie o najwyższym stężeniu.
| Wartość | Opis |
|---|---|
| Carbon Monoxide |
Tlenek węgla (CO) jest bezbarwnym, bezwonnym i bez smaku, ale wysoce toksycznym gazem wytwarzanym w wyniku niepełnego spalania paliw zawierających węgiel. Typowe źródła to spaliny samochodowe, kuchenki gazowe, piece i pożary drewna. |
| Nitrogen Dioxide |
Dwutlenek azotu (NO2) jest znaczącym zanieczyszczeniem atmosfery. Jest regulowany i podlega zalecanym wytycznym dotyczącym limitów określonym przez Światową Organizację Zdrowia (WHO). |
| Ozone |
Ozon (O3) jest kluczowym składnikiem smogu fotochemicznego, brązowej, szkodliwej mgły spowijającej wiele dużych miast, powstałej w wyniku reakcji fotochemicznej między światłem słonecznym a niektórymi określonymi zanieczyszczeniami. |
| Particulate Matter 2.5 |
Cząstki stałe 2,5 (PM2,5) odnoszą się do drobnych cząstek o średnicy 2,5 mikrometra i mniejszej. Cząsteczki te są ponad 100 razy cieńsze niż ludzki włos i mogą pozostawać zawieszone w powietrzu przez dłuższy czas |
| Particulate Matter 10 |
Cząstki stałe 10 (PM10) odnoszą się do cząstek o średnicach zwykle 10 mikrometrów i mniejszych. Cząsteczki te mogą obejmować kurz, pyłki, sadzę, dym i kropelki cieczy. |
| Sulfur Dioxide |
Dwutlenek siarki (SO2) jest ciężkim, bezbarwnym gazem nieorganicznym o ostrym, drażniącym zapachu. Powstaje głównie w wyniku spalania paliw kopalnych w elektrowniach i obiektach przemysłowych, ale może być również emitowany ze źródeł naturalnych, takich jak wulkany. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
| Nazwa | Typ | Opis |
|---|---|---|
| info |
object |
Dodatkowe informacje. |
| type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
| Nazwa | Typ | Opis |
|---|---|---|
| additionalInfo |
Dodatkowe informacje o błędzie. |
|
| code |
string |
Kod błędu. |
| details |
Szczegóły błędu. |
|
| message |
string |
Komunikat o błędzie. |
| target |
string |
Element docelowy błędu. |
ErrorResponse
Odpowiedź na błąd
| Nazwa | Typ | Opis |
|---|---|---|
| error |
Obiekt błędu. |
JsonFormat
Żądany format odpowiedzi. Obsługiwany jest tylko format json.
| Wartość | Opis |
|---|---|
| json |
Pollutant
Szczegółowe informacje o poszczególnych substancjach zanieczyszczających. Nie zwracane, jeśli pollutants=false.
| Nazwa | Typ | Opis |
|---|---|---|
| concentration |
Obiekt zawierający liczbę cząstek zanieczyszczeń na objętość powietrza. |
|
| globalIndex |
number (float) |
Międzynarodowo znormalizowana ocena jakości powietrza w skali od 0 do 300 i wyżej, przy czym wyższe liczby oznaczają gorszą jakość powietrza. |
| index |
number (float) |
Ocena jakości powietrza w skali ustalonej przez lokalne organy regulacyjne. Skale mogą się znacznie różnić w zależności od lokalizacji. Więcej informacji można znaleźć w Wikipedii . |
| name |
string |
Nazwa substancji zanieczyszczającej w języku angielskim. |
| type |
Rodzaj zanieczyszczenia. Należy pamiętać, że w każdej chwili mogą zostać dodane kolejne. |
PollutantType
Określa sześć typów zanieczyszczeń śledzonych przez usługę Azure Maps Weather.
| Wartość | Opis |
|---|---|
| CO |
Tlenek węgla |
| NO2 |
Dwutlenek azotu |
| O3 |
Ozon |
| PM2.5 |
Pył zawieszony 2,5 |
| PM10 |
Pył zawieszony 10 |
| SO2 |
Dwutlenek siarki |
UnitType
Liczba całkowita reprezentująca typ jednostki. Na przykład 17 dla stopni Celsjusza, 18 dla stopni Fahrenheita. Może być używany do przeliczania jednostek. Aby uzyskać pełną listę, zobacz Usługi pogodowe w Azure Maps.
| Wartość | Opis |
|---|---|
| 0 |
feet |
| 1 |
inches |
| 2 |
miles |
| 3 |
millimeter |
| 4 |
centimeter |
| 5 |
miernik |
| 6 |
kilometer |
| 7 |
kilometersPerHour |
| 8 |
knots |
| 9 |
milesPerHour |
| 10 |
metersPerSecond |
| 11 |
hectoPascals |
| 12 |
inchesOfMercury |
| 13 |
kiloPascals |
| 14 |
millibars |
| 15 |
millimetersOfMercury |
| 16 |
poundsPerSquareInch |
| 17 |
Celsius |
| 18 |
Fahrenheit |
| 19 |
kelvin |
| 20 |
percent |
| 21 |
float |
| 22 |
liczba całkowita |
| 31 |
MicrogramsPerCubicMeterOfAir |
WeatherUnit
Konkretna wartość danej jednostki związana z pogodą.
| Nazwa | Typ | Opis |
|---|---|---|
| unit |
string |
Typ jednostki dla zwracanej wartości. |
| unitType |
Unit |
Liczba całkowita reprezentująca typ jednostki. Na przykład 17 dla stopni Celsjusza, 18 dla stopni Fahrenheita. Może być używany do przeliczania jednostek. Aby uzyskać pełną listę, zobacz Usługi pogodowe w Azure Maps. |
| value |
number (float) |
Wartość zaokrąglona. |