Weather - Get Air Quality Daily Forecasts
Gunakan untuk mendapatkan prakiraan kualitas udara harian selama satu hingga tujuh hari ke depan yang mencakup tingkat polutan, potensi risiko, dan tindakan pencegahan yang disarankan.
Get Air Quality Daily Forecasts
API adalah permintaan HTTP GET
yang mengembalikan informasi terperinci tentang konsentrasi polutan dan status keseluruhan prakiraan kualitas udara harian. Layanan ini dapat memberikan prakiraan informasi kualitas udara harian untuk 1 hingga 7 hari mendatang, termasuk tingkat polusi, nilai indeks kualitas udara, polutan dominan, dan pernyataan singkat yang meringkas tingkat risiko dan tindakan pencegahan yang disarankan.
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}
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
format
|
path | True |
Format respons yang diinginkan. Hanya |
|
api-version
|
query | True |
string |
Nomor versi API Azure Maps. |
query
|
query | True |
number[] |
Kueri yang berlaku ditentukan sebagai string yang dipisahkan koma yang terdiri dari garis lintang diikuti oleh bujur misalnya "47.641268,-122.125679". |
duration
|
query | int32 |
Menentukan berapa hari dari sekarang kami ingin tahu tentang kualitas udara. Nilai yang tersedia adalah 1, 2, 3, 4, 5, 6, dan 7. Nilai default adalah 1. |
|
language
|
query |
string |
Bahasa tempat hasil pencarian harus dikembalikan. Harus menjadi salah satu tag bahasa IETF yang didukung, tidak peka huruf besar/kecil. Saat data dalam bahasa tertentu tidak tersedia untuk bidang tertentu, bahasa default digunakan. Silakan merujuk ke Bahasa yang Didukung untuk detailnya. |
Header Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
x-ms-client-id |
string |
Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan Microsoft Entra ID. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan Microsoft Entra ID di Azure Maps lihat artikel berikut untuk panduan. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Terjadi kesalahan tak terduga. |
Keamanan
AADToken
Ini adalah Alur OAuth 2.0 Microsoft Entra. Saat dipasangkan dengan kontrol akses berbasis peran Azure, kontrol akses tersebut dapat digunakan untuk mengontrol akses ke Azure Maps REST API. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa Azure Maps akun sumber daya atau sub-sumber daya. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin untuk Azure Maps REST API.
Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini menyediakan solusi untuk memodelkan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.
Catatan
- Definisi keamanan ini memerlukan penggunaan
x-ms-client-id
header untuk menunjukkan sumber daya Azure Maps mana yang diminta akses aplikasi. Ini dapat diperoleh dari API manajemen Maps .
Authorization URL
khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi Microsoft Entra ID.
* Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.
* Penggunaan Azure Maps Web SDK memungkinkan penyiapan berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.
- Untuk informasi selengkapnya tentang platform identitas Microsoft, lihat gambaran umum platform identitas Microsoft.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nama | Deskripsi |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Ini adalah kunci bersama yang disediakan saat Anda Create akun Azure Maps di portal Azure atau menggunakan PowerShell, CLI, Azure SDK, atau REST API.
Dengan kunci ini, aplikasi apa pun dapat mengakses semua REST API. Dengan kata lain, kunci ini dapat digunakan sebagai kunci master di akun tempat kunci tersebut dikeluarkan.
Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan pendekatan aplikasi klien rahasia untuk mengakses Azure Maps REST API sehingga kunci Anda dapat disimpan dengan aman.
Type:
apiKey
In:
query
SAS Token
Ini adalah token tanda tangan akses bersama dibuat dari operasi Daftar SAS pada sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.
Dengan token ini, aplikasi apa pun berwenang untuk mengakses dengan kontrol akses berbasis peran Azure dan kontrol halus ke kedaluwarsa, laju, dan wilayah penggunaan untuk token tertentu. Dengan kata lain, Token SAS dapat digunakan untuk memungkinkan aplikasi mengontrol akses dengan cara yang lebih aman daripada kunci bersama.
Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah mengonfigurasi daftar asal tertentu yang diizinkan di sumber daya akun Peta untuk membatasi penyalahgunaan penyalahgunaan dan memperbarui Token SAS secara teratur.
Type:
apiKey
In:
header
Contoh
Get Daily Air Quality Forecasts
Sample Request
GET https://atlas.microsoft.com/weather/airQuality/forecasts/daily/json?api-version=1.1&query=47.632346,-122.13887&duration=3
Sample Response
{
"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."
}
]
}
Definisi
Nama | Deskripsi |
---|---|
Daily |
Informasi tentang kualitas udara di lokasi tertentu pada waktu tertentu. |
Daily |
Objek ini dikembalikan dari panggilan Prakiraan Kualitas Udara Harian yang berhasil. |
Daily |
Menentukan berapa hari dari sekarang kami ingin tahu tentang kualitas udara. Nilai yang tersedia adalah 1, 2, 3, 4, 5, 6, dan 7. Nilai default adalah 1. |
Dominant |
Jenis polutan. Harap dicatat bahwa lebih banyak dapat ditambahkan kapan saja. |
Error |
Info tambahan kesalahan manajemen sumber daya. |
Error |
Detail kesalahan. |
Error |
Respons kesalahan |
Json |
Format respons yang diinginkan. Hanya |
DailyAirQuality
Informasi tentang kualitas udara di lokasi tertentu pada waktu tertentu.
Nama | Jenis | Deskripsi |
---|---|---|
category |
string |
Deskripsi satu kata tentang kualitas udara dalam bahasa yang diminta. Misalnya, "Sangat Baik". |
categoryColor |
string |
Warna unik yang sesuai dengan kategori hasil kualitas udara ini. |
dateTime |
string |
Tanggal dan waktu pengamatan saat ini ditampilkan dalam format ISO 8601, misalnya, 2019-10-27T19:39:57-08:00. |
description |
string |
Penjelasan tekstual tentang kualitas udara ini menghasilkan bahasa yang diminta. |
dominantPollutant |
Polutan dengan konsentrasi tertinggi. |
|
globalIndex |
number |
Peringkat kualitas udara yang dinormalisasi secara internasional pada skala dari 0 hingga 300 ke atas, dengan angka yang lebih tinggi mewakili kualitas udara yang lebih buruk. |
index |
number |
Peringkat kualitas udara pada skala yang ditetapkan oleh badan pengatur lokal. Skala dapat bervariasi secara luas berdasarkan lokasi. Lihat Wikipedia untuk informasi selengkapnya. |
DailyAirQualityForecastResult
Objek ini dikembalikan dari panggilan Prakiraan Kualitas Udara Harian yang berhasil.
Nama | Jenis | Deskripsi |
---|---|---|
nextLink |
string |
adalah tautan ke halaman berikutnya dari fitur yang dikembalikan. Jika itu halaman terakhir, tidak ada bidang ini. |
results |
Daftar semua prakiraan kualitas udara harian untuk lokasi yang dikueri. |
DailyDuration
Menentukan berapa hari dari sekarang kami ingin tahu tentang kualitas udara. Nilai yang tersedia adalah 1, 2, 3, 4, 5, 6, dan 7. Nilai default adalah 1.
Nama | Jenis | Deskripsi |
---|---|---|
1 |
string |
|
2 |
string |
|
3 |
string |
|
4 |
string |
|
5 |
string |
|
6 |
string |
|
7 |
string |
DominantPollutant
Jenis polutan. Harap dicatat bahwa lebih banyak dapat ditambahkan kapan saja.
Nama | Jenis | Deskripsi |
---|---|---|
Carbon Monoxide |
string |
Karbon monoksida ("CO") |
Nitrogen Dioxide |
string |
Nitrogen dioksida ("NO2") |
Ozone |
string |
Ozone ("O3") |
Particulate Matter 10 |
string |
Materi partikulat 10 ("PM10") |
Particulate Matter 2.5 |
string |
Materi partikulat 2.5 ("PM2.5") |
Sulfur Dioxide |
string |
Sulfur dioksida ("SO2") |
ErrorAdditionalInfo
Info tambahan kesalahan manajemen sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
info |
object |
Info tambahan. |
type |
string |
Jenis info tambahan. |
ErrorDetail
Detail kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
additionalInfo |
Info tambahan kesalahan. |
|
code |
string |
Kode kesalahan. |
details |
Detail kesalahan. |
|
message |
string |
Pesan kesalahan. |
target |
string |
Target kesalahan. |
ErrorResponse
Respons kesalahan
Nama | Jenis | Deskripsi |
---|---|---|
error |
Objek kesalahan. |
JsonFormat
Format respons yang diinginkan. Hanya json
format yang didukung.
Nama | Jenis | Deskripsi |
---|---|---|
json |
string |