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

Weather - Get Air Quality Daily Forecasts

参考

服务:: Maps

API 版本:: 1.1

用于获取未来 1 到 7 天的每日空气质量预报，其中包括污染物水平、潜在风险和建议的预防措施。

API Get Air Quality Daily Forecasts 是一个 HTTP GET 请求，用于返回有关污染物浓度和预测每日空气质量总体状态的详细信息。该服务可以提供未来 1 至 7 天的每日空气质量预测信息，包括污染水平、空气质量指数值、主要污染物，以及总结风险级别和建议预防措施的简短声明。

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}

URI 参数

名称	在	必需	类型	说明
format	path	True	JsonFormat	响应的所需格式。仅支持 `json` 格式。
api-version	query	True	string	Azure Maps API 的版本号。
query	query	True	number[]	指定为逗号分隔字符串的适用查询，后跟经度，例如“47.641268，-122.125679”。通常，天气信息适用于陆地上的位置、被陆地包围的水体以及距离海岸线约 50 海里以内的海洋区域。
duration	query		DailyDuration (int32)	指定从现在起多少天我们想知道的空气质量。可用值为 1、2、3、4、5、6 和 7。默认值为 1。
language	query		string	应返回搜索结果的语言。应该是受支持的 IETF 语言标记之一，不区分大小写。当指定语言中的数据不适用于特定字段时，将使用默认语言。有关详细信息，请参阅支持的语言。

请求头

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

响应

名称	类型	说明
200 OK	DailyAirQualityForecastResult	好的
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 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

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

类型: apiKey
在: header

示例

Get Daily Air Quality Forecasts

示例请求

HTTP

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

示例响应

状态代码:: 200

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

定义

名称	说明
DailyAirQuality	有关特定时间特定位置的空气质量的信息。
DailyAirQualityForecastResult	此对象是从成功的 Get Daily Air Quality Forecast 调用返回的。
DailyDuration	指定从现在起多少天我们想知道的空气质量。可用值为 1、2、3、4、5、6 和 7。默认值为 1。
DominantPollutant	污染物类型。请注意，可能随时添加更多内容。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
JsonFormat	响应的所需格式。仅支持 `json` 格式。

DailyAirQuality

Object

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

名称	类型	说明
category	string	以所请求的语言对空气质量进行单字描述。例如，“Excellent”。
categoryColor	string	与此空气质量结果的类别对应的唯一颜色。
dateTime	string (date-time)	以 ISO 8601 格式显示的当前观测的日期和时间，例如，2019-10-27T19：39：57-08：00。
description	string	该空气质量的文字解释以所要求的语言产生。
dominantPollutant	DominantPollutant	浓度最高的污染物。
globalIndex	number (float)	国际标准化空气质量评级，范围从 0 到 300 及以上，数字越高表示空气质量越差。
index	number (float)	由当地监管机构设定的空气质量评级。比例尺可能因位置而异。有关更多信息，请参阅维基百科。

DailyAirQualityForecastResult

Object

此对象是从成功的 Get Daily Air Quality Forecast 调用返回的。

名称	类型	说明
nextLink	string	该链接指向返回的功能的下一页。如果是最后一页，则不显示此字段。
results	DailyAirQuality[]	查询位置的所有每日空气质量预报的列表。

DailyDuration

枚举

指定从现在起多少天我们想知道的空气质量。可用值为 1、2、3、4、5、6 和 7。默认值为 1。

值	说明
1	1 天
2	2 天
3	3 天
4	4 天
5	5 天
6	6 天
7	7 天

DominantPollutant

枚举

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

值	说明
Carbon Monoxide	一氧化碳（“CO”）
Nitrogen Dioxide	二氧化氮（“NO2”）
Ozone	臭氧（“O3”）
Particulate Matter 10	颗粒物 10 （“PM10”）
Particulate Matter 2.5	颗粒物 2.5 （“PM2.5”）
Sulfur Dioxide	二氧化硫（“SO2”）

ErrorAdditionalInfo

Object

资源管理错误附加信息。

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

ErrorDetail

Object

错误详细信息。

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

ErrorResponse

Object

错误响应

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

JsonFormat

枚举

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

值	说明
json	JavaScript 对象表示法数据交换格式