Weather - Get Current Air Quality

Referensi

Layanan:: Maps

Versi API:: 1.1

Gunakan untuk mendapatkan informasi kualitas udara saat ini yang mencakup potensi risiko dan tindakan pencegahan yang disarankan.

Get Current Air Quality API adalah permintaan HTTP GET yang mengembalikan informasi terperinci tentang konsentrasi polutan dan status keseluruhan untuk kualitas udara saat ini, 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/current/json?api-version=1.1&query={query}

Dengan parameter opsional:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
format	path	True	JsonFormat	Format respons yang diinginkan. Hanya `json` format yang didukung.
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".
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.
pollutants	query		boolean	Nilai Boolean yang mengembalikan informasi terperinci tentang setiap polutan. Secara default adalah True.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-id		string	Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan ID Microsoft Entra. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan ID Microsoft Entra di Azure Maps, lihat artikel berikut ini untuk panduan.

Respons

Nama	Jenis	Deskripsi
200 OK	AirQualityResult	OK
Other Status Codes	ErrorResponse	Terjadi kesalahan tak terduga.

Keamanan

AADToken

Ini adalah Alur Microsoft Entra OAuth 2.0 . Saat dipasangkan dengan kontrol akses berbasis peran Azure , kontrol akses tersebut dapat digunakan untuk mengontrol akses ke REST API Azure Maps. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa akun sumber daya atau sub-sumber daya Azure Maps. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin ke REST API Azure Maps.

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 meminta 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 ID Microsoft Entra. * Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Microsoft Azure, PowerShell, CLI, Azure SDK, atau REST API. * Penggunaan Azure Maps Web SDK memungkinkan penyiapan aplikasi berbasis konfigurasi untuk beberapa kasus penggunaan.

Untuk informasi selengkapnya tentang platform identitas Microsoft, lihat Gambaran umum platform identitas Microsoft.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Ini adalah kunci bersama yang disediakan saat Anda Membuat akun Azure Maps di portal Microsoft 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 REST API Azure Maps sehingga kunci Anda dapat disimpan dengan aman.

Jenis: apiKey
Dalam: 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 Microsoft 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.

Jenis: apiKey
Dalam: header

Contoh

Get Current Air Quality

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 200

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

Definisi

Nama	Deskripsi
AirQuality	Informasi tentang kualitas udara di lokasi tertentu pada waktu tertentu.
AirQualityResult	Objek ini dikembalikan dari panggilan Get Air Quality yang berhasil.
DominantPollutant	Jenis polutan. Harap dicatat bahwa lebih banyak dapat ditambahkan kapan saja.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
JsonFormat	Format respons yang diinginkan. Hanya `json` format yang didukung.
Pollutant	Informasi terperinci tentang polutan individu. Tidak dikembalikan jika `pollutants`=false.
PollutantType	Jenis polutan. Harap dicatat bahwa lebih banyak dapat ditambahkan kapan saja.
UnitType	Nilai ID numerik yang terkait dengan jenis unit yang ditampilkan. Dapat digunakan untuk terjemahan unit. Silakan merujuk ke layanan Cuaca di Azure Maps untuk detailnya.
WeatherUnit	Nilai spesifik unit tertentu yang terkait dengan cuaca.

AirQuality

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	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.
pollutants	Pollutant[]	Informasi tentang polutan individu.

AirQualityResult

Objek ini dikembalikan dari panggilan Get Air Quality 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	AirQuality[]	Daftar semua hasil kualitas udara untuk lokasi yang dikueri.

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	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

JsonFormat

Format respons yang diinginkan. Hanya json format yang didukung.

Nama	Jenis	Deskripsi
json	string	Format Pertukaran Data Notasi Objek JavaScript

Pollutant

Informasi terperinci tentang polutan individu. Tidak dikembalikan jika pollutants=false.

Nama	Jenis	Deskripsi
concentration	WeatherUnit	Objek yang berisi jumlah partikel polutan per volume udara.
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.
name	string	Nama polutan dalam bahasa Inggris.
type	PollutantType	Jenis polutan. Harap dicatat bahwa lebih banyak dapat ditambahkan kapan saja.

PollutantType