Weather - Get Current Air Quality
Utilizzare per ottenere informazioni correnti sulla qualità dell'aria che includono potenziali rischi e precauzioni suggerite.
L'API Get Current Air Quality
è una richiesta HTTP GET
che restituisce informazioni dettagliate sulla concentrazione di inquinanti e sullo stato complessivo per la qualità dell'aria corrente, inclusi i livelli di inquinamento, i valori degli indici di qualità dell'aria, l'inquinanti dominante e una breve dichiarazione che riepiloga il livello di rischio e le precauzioni suggerite.
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}
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
format
|
path | True |
Formato desiderato della risposta. È supportato solo il formato |
|
api-version
|
query | True |
string |
Numero di versione dell'API Mappe di Azure. |
query
|
query | True |
number[] |
La query applicabile specificata come stringa delimitata da virgole composta da latitudine seguita da longitudine, ad esempio "47.641268,-122.125679". |
language
|
query |
string |
Lingua in cui devono essere restituiti i risultati della ricerca. Deve essere uno dei tag di lingua IETF supportati, senza distinzione tra maiuscole e minuscole. Quando i dati nella lingua specificata non sono disponibili per un campo specifico, viene usata la lingua predefinita. Per informazioni dettagliate, vedere Lingue supportate . |
|
pollutants
|
query |
boolean |
Valore booleano che restituisce informazioni dettagliate su ogni inquinanti. Per impostazione predefinita, è True. |
Intestazione della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
x-ms-client-id |
string |
Specifica l'account destinato all'utilizzo in combinazione con il modello di sicurezza Microsoft Entra ID. Rappresenta un ID univoco per l'account Mappe di Azure e può essere recuperato dall'API account del piano di gestione di Mappe di Azure. Per usare la sicurezza di Microsoft Entra ID in Mappe di Azure, vedere gli articoli seguenti per indicazioni. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Si è verificato un errore imprevisto. |
Sicurezza
AADToken
Si tratta dei flussi Microsoft Entra OAuth 2.0 . Se abbinato al controllo degli accessi in base al ruolo di Azure , può essere usato per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso in base al ruolo di Azure vengono usati per designare l'accesso a uno o più account di risorse di Mappe di Azure o a risorse secondarie. A qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per le API REST di Mappe di Azure.
Per implementare scenari, è consigliabile visualizzare i concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.
Note
- Questa definizione di sicurezza richiede l'uso dell'intestazione
x-ms-client-id
per indicare a quale risorsa di Mappe di Azure l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe .
è Authorization URL
specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni ID Microsoft Entra.
* Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.
* L'utilizzo di Azure Maps Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.
- Per altre informazioni su Microsoft Identity Platform, vedere Panoramica di Microsoft Identity Platform.
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome | Descrizione |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Si tratta di una chiave condivisa di cui viene effettuato il provisioning quando si crea un account mappe di Azure nel portale di Azure o usando PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o l'API REST.
Con questa chiave, qualsiasi applicazione può accedere a tutte le API REST. In altre parole, questa chiave può essere usata come chiave master nell'account in cui vengono rilasciati.
Per le applicazioni esposte pubblicamente, è consigliabile usare l'approccio alle applicazioni client riservate per accedere alle API REST di Mappe di Azure in modo che la chiave possa essere archiviata in modo sicuro.
Tipo:
apiKey
In:
query
SAS Token
Si tratta di un token di firma di accesso condiviso creato dall'operazione Elenca firma di accesso condiviso nella risorsa mappe di Azure tramite il piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.
Con questo token, qualsiasi applicazione è autorizzata ad accedere con i controlli di accesso in base al ruolo di Azure e il controllo granulare alla scadenza, alla frequenza e alle aree d'uso per il token specifico. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.
Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa dell'account map per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.
Tipo:
apiKey
In:
header
Esempio
Get Current Air Quality
Esempio di richiesta
GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&query=47.632346,-122.13887
Risposta di esempio
{
"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
}
}
]
}
]
}
Definizioni
Nome | Descrizione |
---|---|
Air |
Informazioni sulla qualità dell'aria in una posizione specifica in un momento specifico. |
Air |
Questo oggetto viene restituito da una chiamata Get Air Quality riuscita. |
Dominant |
Tipo di inquinanti. Si noti che è possibile aggiungere altri elementi in qualsiasi momento. |
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
Error |
Dettagli dell'errore. |
Error |
Risposta di errore |
Json |
Formato desiderato della risposta. È supportato solo il formato |
Pollutant |
Informazioni dettagliate su un singolo inquinanti. Non restituito se |
Pollutant |
Tipo di inquinanti. Si noti che è possibile aggiungere altri elementi in qualsiasi momento. |
Unit |
Valore ID numerico associato al tipo di unità visualizzata. Può essere usato per la conversione unità. Per informazioni dettagliate, vedere Servizi meteo in Mappe di Azure . |
Weather |
Valore specifico di una determinata unità relativa al meteo. |
AirQuality
Informazioni sulla qualità dell'aria in una posizione specifica in un momento specifico.
Nome | Tipo | Descrizione |
---|---|---|
category |
string |
Descrizione in una sola parola della qualità dell'aria nella lingua richiesta. Ad esempio, "Eccellente". |
categoryColor |
string |
Colore univoco corrispondente alla categoria di questo risultato di qualità dell'aria. |
dateTime |
string |
Data e ora dell'osservazione corrente visualizzata in formato ISO 8601, ad esempio 2019-10-27T19:39:57-08:00. |
description |
string |
Una spiegazione testuale di questa qualità dell'aria comporta la lingua richiesta. |
dominantPollutant |
L'inquinanti con la massima concentrazione. |
|
globalIndex |
number |
Classificazione della qualità dell'aria normalizzata a livello internazionale su una scala da 0 a 300 e superiore, con numeri più elevati che rappresentano una qualità dell'aria peggiore. |
index |
number |
Classificazione della qualità dell'aria su un set di scalabilità da parte di organismi di regolazione locali. Le scale possono variare notevolmente in base alla posizione. Per altre informazioni, vedere Wikipedia . |
pollutants |
Informazioni sui singoli inquinanti. |
AirQualityResult
Questo oggetto viene restituito da una chiamata Get Air Quality riuscita.
Nome | Tipo | Descrizione |
---|---|---|
nextLink |
string |
è il collegamento alla pagina successiva delle funzionalità restituite. Se si tratta dell'ultima pagina, nessun campo. |
results |
Elenco di tutti i risultati della qualità dell'aria per la posizione di query. |
DominantPollutant
Tipo di inquinanti. Si noti che è possibile aggiungere altri elementi in qualsiasi momento.
Nome | Tipo | Descrizione |
---|---|---|
Carbon Monoxide |
string |
Monossido di carbonio ("CO") |
Nitrogen Dioxide |
string |
Anidride azoto ("NO2") |
Ozone |
string |
Ozono ("O3") |
Particulate Matter 10 |
string |
Particolato 10 ("PM10") |
Particulate Matter 2.5 |
string |
Particolato 2.5 ("PM2.5") |
Sulfur Dioxide |
string |
Anidride solforosa ("SO2") |
ErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
Nome | Tipo | Descrizione |
---|---|---|
info |
object |
Informazioni aggiuntive. |
type |
string |
Tipo di informazioni aggiuntive. |
ErrorDetail
Dettagli dell'errore.
Nome | Tipo | Descrizione |
---|---|---|
additionalInfo |
Informazioni aggiuntive sull'errore. |
|
code |
string |
Codice di errore. |
details |
Dettagli dell'errore. |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione dell'errore. |
ErrorResponse
Risposta di errore
Nome | Tipo | Descrizione |
---|---|---|
error |
Oggetto error. |
JsonFormat
Formato desiderato della risposta. È supportato solo il formato json
.
Nome | Tipo | Descrizione |
---|---|---|
json |
string |
Pollutant
Informazioni dettagliate su un singolo inquinanti. Non restituito se pollutants
=false.
Nome | Tipo | Descrizione |
---|---|---|
concentration |
Oggetto contenente il numero di particelle inquinanti per volume di aria. |
|
globalIndex |
number |
Classificazione della qualità dell'aria normalizzata a livello internazionale su una scala da 0 a 300 e superiore, con numeri più elevati che rappresentano una qualità dell'aria peggiore. |
index |
number |
Classificazione della qualità dell'aria su un set di scalabilità da parte di organismi di regolazione locali. Le scale possono variare notevolmente in base alla posizione. Per altre informazioni, vedere Wikipedia . |
name |
string |
Nome dell'inquinanti in inglese. |
type |
Tipo di inquinanti. Si noti che è possibile aggiungere altri elementi in qualsiasi momento. |
PollutantType
Tipo di inquinanti. Si noti che è possibile aggiungere altri elementi in qualsiasi momento.
Nome | Tipo | Descrizione |
---|---|---|
CO |
string |
Monossido di carbonio ("CO") |
NO2 |
string |
Anidride azoto ("NO2") |
O3 |
string |
Ozono ("O3") |
PM10 |
string |
Particolato 10 ("PM10") |
PM2.5 |
string |
Particolato 2.5 ("PM2.5") |
SO2 |
string |
Anidride solforosa ("SO2") |
UnitType
Valore ID numerico associato al tipo di unità visualizzata. Può essere usato per la conversione unità. Per informazioni dettagliate, vedere Servizi meteo in Mappe di Azure .
Nome | Tipo | Descrizione |
---|---|---|
0 |
Integer |
|
1 |
Integer |
|
10 |
Integer |
|
11 |
Integer |
|
12 |
Integer |
|
13 |
Integer |
|
14 |
Integer |
|
15 |
Integer |
|
16 |
Integer |
|
17 |
Integer |
|
18 |
Integer |
|
19 |
Integer |
|
2 |
Integer |
|
20 |
Integer |
|
21 |
Integer |
|
22 |
Integer |
|
3 |
Integer |
|
31 |
Integer |
|
4 |
Integer |
|
5 |
Integer |
|
6 |
Integer |
|
7 |
Integer |
|
8 |
Integer |
|
9 |
Integer |
WeatherUnit
Valore specifico di una determinata unità relativa al meteo.
Nome | Tipo | Descrizione |
---|---|---|
unit |
string |
Tipo di unità per il valore restituito. |
unitType |
Valore ID numerico associato al tipo di unità visualizzata. Può essere usato per la conversione unità. Per informazioni dettagliate, vedere Servizi meteo in Mappe di Azure . |
|
value |
number |
Valore arrotondato. |