Weather - Get Air Quality Daily Forecasts

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 1.1

Użyj, aby uzyskać codzienne prognozy jakości powietrza na następne od siedmiu dni, które obejmują poziom zanieczyszczeń, potencjalne ryzyko i sugerowane środki ostrożności.

Interfejs Get Air Quality Daily Forecasts API to żądanie HTTP GET , które zwraca szczegółowe informacje o stężeniu zanieczyszczeń i ogólnym stanie prognozowanej jakości powietrza dziennego. Usługa może zapewnić prognozowane codzienne informacje o jakości powietrza dla najbliższych 1 do 7 dni, w tym poziom zanieczyszczenia, wartości indeksu jakości powietrza, dominującego zanieczyszczeń i krótkie oświadczenie podsumowujące poziom ryzyka i sugerowane środki ostrożności.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
format	path	True	JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko `json` 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 rozdzielany przecinkami składa się z szerokości geograficznej, po której następuje długość geograficzna, np. "47.641268,-122.125679".
duration	query		DailyDuration int32	Określa, ile dni od teraz chcemy wiedzieć o jakości powietrza. Dostępne wartości to 1, 2, 3, 4, 5, 6 i 7. Wartość domyślna to 1.
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. Gdy 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 .

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-id		string	Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Microsoft Entra ID. Reprezentuje unikatowy identyfikator konta usługi Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania usługi Azure Maps. Aby użyć zabezpieczeń microsoft Entra ID w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DailyAirQualityForecastResult	OK
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy protokołu Microsoft Entra OAuth 2.0 . W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu oparte na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może 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 pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia 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.

Uwagi

Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id , aby wskazać, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami .

Element Authorization URL jest specyficzny 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 z 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 Sdk sieci Web 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 Omówienie platformy tożsamości firmy Microsoft.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenia 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.

Przy użyciu tego klucza każda aplikacja może uzyskać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może być używany jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu do interfejsów API REST usługi Azure Maps, aby można było bezpiecznie przechowywać klucz.

Typ: apiKey
W: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w 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 SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego tokenu 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 sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.

Typ: apiKey
W: header

Przykłady

Get Daily Air Quality Forecasts

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
DailyAirQuality	Informacje o jakości powietrza w określonej lokalizacji w określonym czasie.
DailyAirQualityForecastResult	Ten obiekt jest zwracany z pomyślnego wywołania Pobierz dzienną prognozę jakości powietrza.
DailyDuration	Określa, ile dni od teraz chcemy wiedzieć o jakości powietrza. Dostępne wartości to 1, 2, 3, 4, 5, 6 i 7. Wartość domyślna to 1.
DominantPollutant	Typ zanieczyszczeń. Należy pamiętać, że w dowolnym momencie można dodać więcej.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko `json` format.

DailyAirQuality

Informacje o jakości powietrza w określonej lokalizacji w określonym czasie.

Nazwa	Typ	Opis
category	string	Jeden wyraz opis jakości powietrza w żądanym języku. Na przykład "Doskonała".
categoryColor	string	Unikatowy kolor odpowiadający kategorii tego wyniku jakości powietrza.
dateTime	string	Data i godzina bieżącej obserwacji wyświetlanej w formacie ISO 8601, na przykład 2019-10-27T19:39:57-08:00.
description	string	Tekstowe wyjaśnienie tej jakości powietrza powoduje, że żądany język.
dominantPollutant	DominantPollutant	Zanieczyszczający o najwyższym stężeniu.
globalIndex	number	Międzynarodowa znormalizowana ocena jakości powietrza w skali od 0 do 300 i w górę, z wyższymi liczbami reprezentującymi gorszą jakość powietrza.
index	number	Ocena jakości powietrza w zestawie skalowania przez lokalne organy regulacyjne. Skalowanie może się znacznie różnić w zależności od lokalizacji. Aby uzyskać więcej informacji, zobacz Wikipedię .

DailyAirQualityForecastResult

Ten obiekt jest zwracany z pomyślnego wywołania Pobierz dzienną prognozę jakości powietrza.

Nazwa	Typ	Opis
nextLink	string	Jest to link do następnej strony zwróconych funkcji. Jeśli jest to ostatnia strona, nie ma tego pola.
results	DailyAirQuality[]	Lista wszystkich dziennych prognoz jakości powietrza dla żądanej lokalizacji.

DailyDuration

Określa, ile dni od teraz chcemy wiedzieć o jakości powietrza. Dostępne wartości to 1, 2, 3, 4, 5, 6 i 7. Wartość domyślna to 1.

Nazwa	Typ	Opis
1	string
2	string
3	string
4	string
5	string
6	string
7	string

DominantPollutant

Typ zanieczyszczeń. Należy pamiętać, że w dowolnym momencie można dodać więcej.

Nazwa	Typ	Opis
Carbon Monoxide	string	Tlenek węgla ("CO")
Nitrogen Dioxide	string	Dwutlenek azotu ("NO2")
Ozone	string	Ozone ("O3")
Particulate Matter 10	string	Cząstki stałe 10 ("PM10")
Particulate Matter 2.5	string	Cząstki stałe 2,5 ("PM2,5")
Sulfur Dioxide	string	Dwutlenek siarki ("SO2")

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	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	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	ErrorDetail	Obiekt błędu.

JsonFormat

Żądany format odpowiedzi. Obsługiwany jest tylko json format.

Nazwa	Typ	Opis
json	string	Format wymiany danych notacji obiektów JavaScript

Udostępnij za pośrednictwem