Freigeben über


Weather - Get Air Quality Daily Forecasts

Verwenden Sie, um tägliche Luftqualitätsprognosen für die nächsten ein bis sieben Tage zu erhalten, die Schadstoffwerte, potenzielle Risiken und vorgeschlagene Vorsichtsmaßnahmen enthalten.

Die Get Air Quality Daily Forecasts API ist eine HTTP-Anforderung GET , die detaillierte Informationen über die Schadstoffkonzentration und den Gesamtstatus der prognostizierten täglichen Luftqualität zurückgibt. Der Dienst kann tägliche Luftqualitätsinformationen für die kommenden 1 bis 7 Tage bereitstellen, einschließlich Verschmutzungsgraden, Luftqualitätsindexwerten, dem dominierenden Schadstoff und einer kurzen Erklärung, in der das Risikoniveau und die vorgeschlagenen Vorsichtsmaßnahmen zusammengefasst sind.

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-Parameter

Name In Erforderlich Typ Beschreibung
format
path True

JsonFormat

Gewünschtes Format der Antwort. Nur das json-Format wird unterstützt.

api-version
query True

string

Versionsnummer der Azure Maps API.

query
query True

number[]

Die anwendbare Abfrage, die als kommagetrennte Zeichenfolge angegeben ist, die nach Breitengrad gefolgt von Längengrad besteht, z. B. "47.641268,-122.125679".

duration
query

DailyDuration

int32

Gibt an, für wie viele Tage wir in diesem Zeitraum mehr über die Luftqualität erfahren möchten. Verfügbare Werte sind 1, 2, 3, 4, 5, 6 und 7. Der Standardwert ist 1.

language
query

string

Sprache, in der Suchergebnisse zurückgegeben werden sollen. Sollte eines der unterstützten IETF-Sprachtags sein, wobei die Groß-/Kleinschreibung nicht beachtet wird. Wenn Daten in der angegebenen Sprache für ein bestimmtes Feld nicht verfügbar sind, wird die Standardsprache verwendet.

Weitere Informationen finden Sie unter Unterstützte Sprachen .

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-id

string

Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Konto-API der Azure Maps-Verwaltungsebene abgerufen werden. Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie in den folgenden Artikeln .

Antworten

Name Typ Beschreibung
200 OK

DailyAirQualityForecastResult

OK

Other Status Codes

ErrorResponse

Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, kann sie verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

Hinweise

  • Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.

Der Authorization URL ist spezifisch für die öffentliche Azure-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen. * Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht das konfigurationsbasierte Einrichten einer Anwendung für mehrere Anwendungsfälle.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

subscription-key

Dies ist ein freigegebener Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal erstellen oder PowerShell, die CLI, Azure SDKs oder die REST-API verwenden.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, den Ansatz vertraulicher Clientanwendungen zu verwenden, um auf Azure Maps-REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

SAS Token

Hierbei handelt es sich um ein Shared Access Signature Token, das aus dem Sas-Listenvorgang für die Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Get Daily Air Quality Forecasts

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
DailyAirQuality

Informationen zur Luftqualität an einem bestimmten Ort zu einem bestimmten Zeitpunkt.

DailyAirQualityForecastResult

Dieses Objekt wird von einem erfolgreichen Aufruf "Get Daily Air Quality Forecast" zurückgegeben.

DailyDuration

Gibt an, für wie viele Tage wir in diesem Zeitraum mehr über die Luftqualität erfahren möchten. Verfügbare Werte sind 1, 2, 3, 4, 5, 6 und 7. Der Standardwert ist 1.

DominantPollutant

Art des Schadstoffs. Bitte beachten Sie, dass jederzeit weitere hinzugefügt werden können.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort

JsonFormat

Gewünschtes Format der Antwort. Nur das json-Format wird unterstützt.

DailyAirQuality

Informationen zur Luftqualität an einem bestimmten Ort zu einem bestimmten Zeitpunkt.

Name Typ Beschreibung
category

string

Ein-Wort-Beschreibung der Luftqualität in der angeforderten Sprache. Beispiel: "Ausgezeichnet".

categoryColor

string

Eine eindeutige Farbe, die der Kategorie dieses Luftqualitätsergebnisses entspricht.

dateTime

string

Datum und Uhrzeit der aktuellen Beobachtung im ISO 8601-Format, z. B. 2019-10-27T19:39:57-08:00.

description

string

Eine textliche Erklärung dieser Luftqualität führt zu der angeforderten Sprache.

dominantPollutant

DominantPollutant

Der Schadstoff mit der höchsten Konzentration.

globalIndex

number

International normalisierte Luftqualitätsbewertung auf einer Skala von 0 bis 300 und höher, wobei höhere Zahlen eine schlechtere Luftqualität darstellen.

index

number

Luftqualitätsbewertung auf einer Skala, die von lokalen Regulierungsbehörden festgelegt wird. Die Skalierungen können je nach Standort stark variieren. Weitere Informationen finden Sie unter Wikipedia .

DailyAirQualityForecastResult

Dieses Objekt wird von einem erfolgreichen Aufruf "Get Daily Air Quality Forecast" zurückgegeben.

Name Typ Beschreibung
nextLink

string

Ist der Link zur nächsten Seite der zurückgegebenen Features. Wenn es sich um die letzte Seite handelt, ist dieses Feld nicht vorhanden.

results

DailyAirQuality[]

Eine Liste aller täglichen Luftqualitätsprognosen für den abgefragten Standort.

DailyDuration

Gibt an, für wie viele Tage wir in diesem Zeitraum mehr über die Luftqualität erfahren möchten. Verfügbare Werte sind 1, 2, 3, 4, 5, 6 und 7. Der Standardwert ist 1.

Name Typ Beschreibung
1

string

2

string

3

string

4

string

5

string

6

string

7

string

DominantPollutant

Art des Schadstoffs. Bitte beachten Sie, dass jederzeit weitere hinzugefügt werden können.

Name Typ Beschreibung
Carbon Monoxide

string

Kohlenmonoxid ("CO")

Nitrogen Dioxide

string

Stickstoffdioxid ("NO2")

Ozone

string

Ozon ("O3")

Particulate Matter 10

string

Partikel 10 ("PM10")

Particulate Matter 2.5

string

Feinstaub 2.5 ("PM2.5")

Sulfur Dioxide

string

Schwefeldioxid ("SO2")

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.

type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

JsonFormat

Gewünschtes Format der Antwort. Nur das json-Format wird unterstützt.

Name Typ Beschreibung
json

string

Das Datenaustauschformat der JavaScript-Objektnotation