Weather - Get Current Air Quality

Başvuru

Service:: Maps

API Version:: 1.1

Olası riskleri ve önerilen önlemleri içeren güncel hava kalitesi bilgilerini almak için kullanın.

Get Current Air Quality API, kirlilik düzeyleri, hava kalitesi dizin değerleri, baskın kirletici ve risk düzeyini ve önerilen önlemleri özetleyen kısa bir ifade de dahil olmak üzere kirleticilerin konsantrasyonu ve geçerli hava kalitesi için genel durum hakkında ayrıntılı bilgi döndüren bir HTTP GET isteğidir.

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

With optional parameters:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
format	path	True	JsonFormat	Yanıtın istenen biçimi. Yalnızca `json` biçim desteklenir.
api-version	query	True	string	Azure Haritalar API'sinin sürüm numarası.
query	query	True	number[]	Enlem ve ardından boylam tarafından oluşturulan virgülle ayrılmış bir dize olarak belirtilen ilgili sorgu; örneğin, "47.641268,-122.125679".
language	query		string	Arama sonuçlarının döndürülmesi gereken dil. Büyük/küçük harfe duyarsız, desteklenen IETF dil etiketlerinden biri olmalıdır. Belirtilen dildeki veriler belirli bir alan için kullanılabilir olmadığında, varsayılan dil kullanılır. Ayrıntılar için lütfen Desteklenen Diller'e bakın.
pollutants	query		boolean	Her kirletici hakkında ayrıntılı bilgi döndüren Boole değeri. Varsayılan olarak True değeridir.

İstek Başlığı

Name	Gerekli	Tür	Description
x-ms-client-id		string	Hangi hesabın Microsoft Entra ID güvenlik modeliyle birlikte kullanıma yönelik olduğunu belirtir. Azure Haritalar hesabı için benzersiz bir kimliği temsil eder ve Azure Haritalar yönetim düzlemi Hesap API'sinden alınabilir. Azure Haritalar'de Microsoft Entra ID güvenliği kullanmak için rehberlik için aşağıdaki makalelere bakın.

Yanıtlar

Name	Tür	Description
200 OK	AirQualityResult	Tamam
Other Status Codes	ErrorResponse	Beklenmeyen bir hata oluştu.

Güvenlik

AADToken

Bunlar Microsoft Entra OAuth 2.0 Akışlarıdır. Azure rol tabanlı erişim denetimiyle eşleştirildiğinde, Azure Haritalar REST API'lerine erişimi denetlemek için kullanılabilir. Azure rol tabanlı erişim denetimleri, bir veya daha fazla Azure Haritalar kaynak hesabına veya alt kaynağa erişim tanımlamak için kullanılır. Tüm kullanıcılara, gruplara veya hizmet sorumlularına yerleşik bir rol veya Azure Haritalar REST API'leri için bir veya daha fazla izinden oluşan özel bir rol aracılığıyla erişim verilebilir.

Senaryoları uygulamak için kimlik doğrulama kavramlarını görüntülemenizi öneririz. Özetle, bu güvenlik tanımı belirli API'ler ve kapsamlar üzerinde erişim denetimi yapabilen nesneler aracılığıyla uygulamaları modellemek için bir çözüm sağlar.

Notlar

Bu güvenlik tanımı, uygulamanın erişim istediği Azure Haritalar kaynağı belirtmek için üst bilgi kullanımını x-ms-client-idgerektirir. Bu, Haritalar yönetim API'sinden alınabilir.

Authorization URL, Azure genel bulut örneğine özgüdür. Bağımsız bulutların benzersiz Yetkilendirme URL'leri ve Microsoft Entra ID yapılandırmaları vardır. * Azure rol tabanlı erişim denetimi azure yönetim düzleminden Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla yapılandırılır. * Azure Haritalar Web SDK'sının kullanımı, bir uygulamanın birden çok kullanım örneği için yapılandırma tabanlı kurulumuna olanak tanır.

Microsoft kimlik platformu hakkında daha fazla bilgi için bkz. Microsoft kimlik platformu genel bakış.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Bu, Azure portal bir Azure Haritalar hesabı İçerik Oluşturucu veya PowerShell, CLI, Azure SDK'ları veya REST API'sini kullandığınızda sağlanan paylaşılan bir anahtardır.

Bu anahtarla, tüm uygulamalar tüm REST API'lere erişebilir. Başka bir deyişle, bu anahtar, verildikleri hesapta ana anahtar olarak kullanılabilir.

Herkese açık uygulamalar için, anahtarınızın güvenli bir şekilde depolanabilmesi için gizli istemci uygulamaları yaklaşımını kullanarak Azure Haritalar REST API'lerine erişmenizi öneririz.

Type: apiKey
In: query

SAS Token

Bu paylaşılan erişim imzası belirteci, Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzlemi aracılığıyla Azure Haritalar kaynağındaki SAS listeleme işleminden oluşturulur.

Bu belirteçle, tüm uygulamalar Azure rol tabanlı erişim denetimleri ve belirli bir belirteç için kullanım süre sonu, oran ve bölgeler için ayrıntılı denetim ile erişim yetkisine sahip olur. Başka bir deyişle SAS Belirteci, uygulamaların paylaşılan anahtardan daha güvenli bir şekilde erişimi denetlemesine izin vermek için kullanılabilir.

Herkese açık uygulamalar için önerimiz, işleme kötüye kullanımını sınırlamak ve SAS Belirtecini düzenli olarak yenilemek için Harita hesabı kaynağında izin verilen kaynakların belirli bir listesini yapılandırmayı önermektedir.

Type: apiKey
In: header

Örnekler

Get Current Air Quality

Sample Request

HTTP

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

Sample Response

Status code:: 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
          }
        }
      ]
    }
  ]
}

Tanımlar

Name	Description
AirQuality	Belirli bir konumda belirli bir zamanda hava kalitesi hakkında bilgi.
AirQualityResult	Bu nesne, başarılı bir Get Air Quality çağrısından döndürülür.
DominantPollutant	Kirletici türü. İstediğiniz zaman daha fazla eklenebileceklerini lütfen unutmayın.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
JsonFormat	Yanıtın istenen biçimi. Yalnızca `json` biçim desteklenir.
Pollutant	Bireysel bir kirletici hakkında ayrıntılı bilgi. =false ise `pollutants`döndürülmedi.
PollutantType	Kirletici türü. İstediğiniz zaman daha fazla eklenebileceklerini lütfen unutmayın.
UnitType	Görüntülenen birim türüyle ilişkili sayısal kimlik değeri. Birim çevirisi için kullanılabilir. Ayrıntılar için lütfen Azure Haritalar'daki Hava durumu hizmetlerine bakın.
WeatherUnit	Hava durumuyla ilgili belirli bir birimin belirli değeri.

AirQuality

Belirli bir konumda belirli bir zamanda hava kalitesi hakkında bilgi.

Name	Tür	Description
category	string	İstenen dilde hava kalitesinin tek sözcüklü açıklaması. Örneğin, "Mükemmel".
categoryColor	string	Bu hava kalitesi sonucunun kategorisine karşılık gelen benzersiz bir renk.
dateTime	string	ISO 8601 biçiminde görüntülenen geçerli gözlemin tarih ve saati; örneğin, 2019-10-27T19:39:57-08:00.
description	string	Bu hava kalitesinin metinsel açıklaması istenen dilde sonuçlanır.
dominantPollutant	DominantPollutant	En yüksek konsantrasyona sahip kirletici.
globalIndex	number	0 ila 300 ve üzeri bir ölçekte uluslararası olarak normalleştirilmiş hava kalitesi derecelendirmesi, daha yüksek sayılar daha kötü hava kalitesini temsil eder.
index	number	Yerel düzenleme kuruluşları tarafından ölçek kümesinde hava kalitesi derecelendirmesi. Ölçekler konuma göre büyük ölçüde farklılık gösterebilir. Daha fazla bilgi için bkz. Wikipedia .
pollutants	Pollutant[]	Bireysel kirleticiler hakkında bilgi.

AirQualityResult

Bu nesne, başarılı bir Get Air Quality çağrısından döndürülür.

Name	Tür	Description
nextLink	string	, döndürülen özelliklerin sonraki sayfasının bağlantısıdır. Bu son sayfaysa, bu alan yok.
results	AirQuality[]	Sorgulanan konum için tüm hava kalitesi sonuçlarının listesi.

DominantPollutant

Kirletici türü. İstediğiniz zaman daha fazla eklenebileceklerini lütfen unutmayın.

Name	Tür	Description
Carbon Monoxide	string	Karbon monoksit ("CO")
Nitrogen Dioxide	string	Azot dioksit ("NO2")
Ozone	string	Ozon ("O3")
Particulate Matter 10	string	Partikül madde 10 ("PM10")
Particulate Matter 2.5	string	Partikül madde 2.5 ("PM2.5")
Sulfur Dioxide	string	Sülfür dioksit ("SO2")

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

JsonFormat

Yanıtın istenen biçimi. Yalnızca json biçim desteklenir.

Name	Tür	Description
json	string	JavaScript Nesne Gösterimi Veri Değişim Biçimi

Pollutant

Bireysel bir kirletici hakkında ayrıntılı bilgi. =false ise pollutantsdöndürülmedi.

Name	Tür	Description
concentration	WeatherUnit	Hava hacmi başına kirletici parçacıkların sayısını içeren bir nesne.
globalIndex	number	0 ila 300 ve üzeri bir ölçekte uluslararası olarak normalleştirilmiş hava kalitesi derecelendirmesi, daha yüksek sayılar daha kötü hava kalitesini temsil eder.
index	number	Yerel düzenleme kuruluşları tarafından ölçek kümesinde hava kalitesi derecelendirmesi. Ölçekler konuma göre büyük ölçüde farklılık gösterebilir. Daha fazla bilgi için bkz. Wikipedia .
name	string	kirleticinin İngilizce adı.
type	PollutantType	Kirletici türü. İstediğiniz zaman daha fazla eklenebileceklerini lütfen unutmayın.

PollutantType