Leer en inglés

Compartir a través de


Weather - Get Air Quality Daily Forecasts

Utilice para obtener previsiones diarias de calidad del aire para los próximos uno a siete días que incluyen niveles contaminantes, posibles riesgos y precauciones sugeridas.

La Get Air Quality Daily Forecasts API es una solicitud HTTP GET que devuelve información detallada sobre la concentración de contaminantes y el estado general de la calidad diaria prevista del aire. El servicio puede proporcionar información de calidad del aire diaria prevista para los próximos 1 a 7 días, incluidos los niveles de contaminación, los valores de índice de calidad del aire, el contaminante dominante, y una breve declaración que resume el nivel de riesgo y sugiere precauciones.

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}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
format
path True

JsonFormat

Formato deseado de la respuesta. Solo se admite el formato json.

api-version
query True

string

Número de versión de la API de Azure Maps.

query
query True

number[]

La consulta aplicable especificada como una cadena separada por comas compuesta por latitud seguida de longitud, por ejemplo, "47.641268,-122.125679".

duration
query

DailyDuration

int32

Especifica durante cuántos días de ahora nos gustaría saber sobre la calidad del aire. Los valores disponibles son 1, 2, 3, 4, 5, 6 y 7. El valor predeterminado es 1.

language
query

string

Idioma en el que se deben devolver los resultados de búsqueda. Debe ser una de las etiquetas de idioma IETF admitidas, sin distinción entre mayúsculas y minúsculas. Cuando los datos del idioma especificado no están disponibles para un campo específico, se usa el idioma predeterminado.

Consulte Idiomas admitidos para obtener más información.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-id

string

Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de id. de Microsoft Entra. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar la seguridad de id. de Microsoft Entra en Azure Maps, consulte los siguientes artículos para obtener instrucciones.

Respuestas

Nombre Tipo Description
200 OK

DailyAirQualityForecastResult

Aceptar

Other Status Codes

ErrorResponse

Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0 . Cuando se empareja con el control de acceso basado en rol de Azure , se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en rol de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio mediante un rol integrado o un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para el modelado de aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

  • Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps .

Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de id. de Microsoft Entra. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST. * El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

subscription-key

Se trata de una clave compartida que se aprovisiona al crear una cuenta de Azure Maps en Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el enfoque de aplicaciones cliente confidenciales para acceder a las API REST de Azure Maps para que la clave se pueda almacenar de forma segura.

Tipo: apiKey
En: query

SAS Token

Se trata de un token de firma de acceso compartido que se crea a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.

Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en roles de Azure y al control específico de la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta de mapa para limitar la representación de abusos y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

Get Daily Air Quality Forecasts

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
DailyAirQuality

Información sobre la calidad del aire en una ubicación específica en un momento específico.

DailyAirQualityForecastResult

Este objeto se devuelve de una llamada correcta a Get Daily Air Quality Forecast.

DailyDuration

Especifica durante cuántos días de ahora nos gustaría saber sobre la calidad del aire. Los valores disponibles son 1, 2, 3, 4, 5, 6 y 7. El valor predeterminado es 1.

DominantPollutant

Tipo de contaminante. Tenga en cuenta que se pueden agregar más en cualquier momento.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error

JsonFormat

Formato deseado de la respuesta. Solo se admite el formato json.

DailyAirQuality

Información sobre la calidad del aire en una ubicación específica en un momento específico.

Nombre Tipo Description
category

string

Descripción de una palabra de la calidad del aire en el idioma solicitado. Por ejemplo, "Excelente".

categoryColor

string

Color único correspondiente a la categoría de este resultado de calidad del aire.

dateTime

string

Fecha y hora de la observación actual mostrada en formato ISO 8601, por ejemplo, 2019-10-27T19:39:57-08:00.

description

string

Una explicación textual de esta calidad del aire da como resultado el idioma solicitado.

dominantPollutant

DominantPollutant

Contaminante con mayor concentración.

globalIndex

number

Clasificación de calidad del aire normalizada internacionalmente en una escala de 0 a 300 y superiores, con números más altos que representan una peor calidad del aire.

index

number

Clasificación de la calidad del aire en un conjunto de escalado por organismos reguladores locales. Las escalas pueden variar ampliamente en función de la ubicación. Consulte Wikipedia para obtener más información.

DailyAirQualityForecastResult

Este objeto se devuelve de una llamada correcta a Get Daily Air Quality Forecast.

Nombre Tipo Description
nextLink

string

es el vínculo a la página siguiente de las características devueltas. Si es la última página, no se trata de este campo.

results

DailyAirQuality[]

Una lista de todas las previsiones diarias de calidad del aire para la ubicación consultada.

DailyDuration

Especifica durante cuántos días de ahora nos gustaría saber sobre la calidad del aire. Los valores disponibles son 1, 2, 3, 4, 5, 6 y 7. El valor predeterminado es 1.

Nombre Tipo Description
1

string

2

string

3

string

4

string

5

string

6

string

7

string

DominantPollutant

Tipo de contaminante. Tenga en cuenta que se pueden agregar más en cualquier momento.

Nombre Tipo Description
Carbon Monoxide

string

Monóxido de carbono ("CO")

Nitrogen Dioxide

string

Dióxido de nitrógeno ("NO2")

Ozone

string

Ozono ("O3")

Particulate Matter 10

string

Materia de partículas 10 ("PM10")

Particulate Matter 2.5

string

Materia de partículas 2.5 ("PM2.5")

Sulfur Dioxide

string

Dióxido de azufre ("SO2")

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.

type

string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Los detalles del error.

message

string

El mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

JsonFormat

Formato deseado de la respuesta. Solo se admite el formato json.