你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Weather - Get Current Air Quality

参考

服务:: Maps

API 版本:: 1.1

使用获取当前空气质量信息，包括潜在风险和建议的预防措施。

API Get Current Air Quality 是一个 HTTP GET 请求，可返回有关污染物浓度和当前空气质量总体状态的详细信息，包括污染水平、空气质量指数值、主要污染物，以及汇总风险级别和建议的预防措施的简短声明。

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}

URI 参数

名称	在	必需	类型	说明
format	path	True	JsonFormat	响应的所需格式。仅支持 `json` 格式。
api-version	query	True	string	Azure Maps API 的版本号。
query	query	True	number[]	指定为由纬度后跟经度组成的逗号分隔字符串的适用查询，例如“47.641268，-122.125679”。
language	query		string	返回搜索结果时应采用的语言。应该是受支持的 IETF 语言标记之一，不区分大小写。当指定语言的数据不适用于特定字段时，将使用默认语言。有关详细信息，请参阅支持的语言。
pollutants	query		boolean	返回有关每种污染物的详细信息的布尔值。默认情况下为 True。

请求头

名称	必需	类型	说明
x-ms-client-id		string	指定用于与 Microsoft Entra ID 安全模型结合使用的帐户。它表示 Azure Maps 帐户的唯一 ID，可从 Azure Maps 管理平面帐户 API 检索。若要在 Azure Maps 中使用 Microsoft Entra ID 安全性，请参阅以下文章以获取指导。

响应

名称	类型	说明
200 OK	AirQualityResult	确定
Other Status Codes	ErrorResponse	发生了意外错误。

安全性

AADToken

这些是 Microsoft Entra OAuth 2.0 流。与 Azure 基于角色的访问控制配对时，它可用于控制对 Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个 Azure Maps 资源帐户或子资源的访问权限。可以通过内置角色或由 Azure Maps REST API 的一个或多个权限组成的自定义角色授予任何用户、组或服务主体的访问权限。

若要实现方案，建议查看身份验证概念。总之，此安全定义提供了一种解决方案，用于通过能够对特定 API 和作用域进行访问控制的对象对应用程序 () 建模。

备注

此安全定义 需要使用x-ms-client-id 标头来指示应用程序请求访问的 Azure Maps 资源。这可以从地图管理 API 获取。

Authorization URL特定于 Azure 公有云实例。主权云具有唯一的授权 URL 和Microsoft Entra ID 配置。 * Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面配置的。 * 使用 Azure Maps Web SDK 可以针对多个用例对应用程序进行基于配置的设置。

有关Microsoft标识平台的详细信息，请参阅 Microsoft标识平台概述。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

这是在 Azure 门户中或使用 PowerShell、CLI、Azure SDK 或 REST API 创建 Azure Maps 帐户时预配的共享密钥。

使用此密钥，任何应用程序都可以访问所有 REST API。换句话说，此密钥可用作颁发密钥的帐户中的主密钥。

对于公开的应用程序，我们建议使用机密客户端应用程序方法来访问 Azure Maps REST API，以便安全地存储密钥。

类型: apiKey
在: query

SAS Token

这是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 通过 Azure 管理平面通过 Azure Maps 资源上的列出 SAS 操作创建的共享访问签名令牌。

使用此令牌，任何应用程序都有权使用 Azure 基于角色的访问控制进行访问，并精细控制特定令牌的过期、速率和区域 () 。换句话说，SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

对于公开的应用程序，我们建议在 Map 帐户资源上配置允许的来源的特定列表，以限制呈现滥用，并定期续订 SAS 令牌。

类型: apiKey
在: header

示例

Get Current Air Quality

示例请求

HTTP

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

示例响应

状态代码:: 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
          }
        }
      ]
    }
  ]
}

定义

名称	说明
AirQuality	有关特定时间特定位置的空气质量的信息。
AirQualityResult	此对象是从成功的获取空气质量调用返回的。
DominantPollutant	污染物的类型。请注意，随时可能会添加更多内容。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
JsonFormat	响应的所需格式。仅支持 `json` 格式。
Pollutant	有关单个污染物的详细信息。如果 `pollutants`=false，则不返回。
PollutantType	污染物的类型。请注意，随时可能会添加更多内容。
UnitType	与显示的单位类型关联的数值 ID 值。可用于单元翻译。有关详细信息，请参阅 Azure Maps 中的天气服务。
WeatherUnit	与天气相关的给定单位的特定值。

AirQuality

有关特定时间特定位置的空气质量的信息。

名称	类型	说明
category	string	用所需语言对空气质量进行单字描述。例如，“优秀”。
categoryColor	string	对应于此空气质量结果类别的唯一颜色。
dateTime	string	以 ISO 8601 格式显示的当前观察值的日期和时间，例如 2019-10-27T19：39：57-08：00。
description	string	此空气质量的文本说明将生成请求的语言。
dominantPollutant	DominantPollutant	浓度最高的污染物。
globalIndex	number	国际标准化空气质量评级从 0 到 300 及更高，数字越高，空气质量越差。
index	number	由当地监管机构设置的空气质量评级。缩放因位置而异。有关详细信息，请参阅维基百科。
pollutants	Pollutant[]	有关单个污染物的信息。

AirQualityResult

此对象是从成功的获取空气质量调用返回的。

名称	类型	说明
nextLink	string	是指向返回的功能的下一页的链接。如果是最后一页，则不使用此字段。
results	AirQuality[]	查询位置的所有空气质量结果的列表。

DominantPollutant

污染物的类型。请注意，随时可能会添加更多内容。

名称	类型	说明
Carbon Monoxide	string	一氧化碳 (“CO”)
Nitrogen Dioxide	string	二氧化氮 (“NO2”)
Ozone	string	臭氧 (“O3”)
Particulate Matter 10	string	颗粒物 10 (“PM10”)
Particulate Matter 2.5	string	颗粒物 2.5 (“PM2.5”)
Sulfur Dioxide	string	二氧化硫 (“SO2”)

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

JsonFormat

响应的所需格式。仅支持 json 格式。

名称	类型	说明
json	string	JavaScript 对象表示法数据交换格式

Pollutant

有关单个污染物的详细信息。如果 pollutants=false，则不返回。

名称	类型	说明
concentration	WeatherUnit	包含每卷空气的污染物颗粒数的对象。
globalIndex	number	国际标准化空气质量评级从 0 到 300 及更高，数字越高，空气质量越差。
index	number	由当地监管机构设置的空气质量评级。缩放因位置而异。有关详细信息，请参阅维基百科。
name	string	污染物的名称（英文）。
type	PollutantType	污染物的类型。请注意，随时可能会添加更多内容。

PollutantType