你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Weather - Get Daily Historical Actuals
用于获取气候数据,例如每日实际观测到的每日温度、降水量、降雪量和积雪深度。
API Get Daily Historical Actuals
是一个 HTTP GET
请求,用于在给定坐标位置返回当天的气候数据,例如过去每天实际观测到的温度、降水、降雪、降雪深度和冷却/加热度日信息。 针对指定的日期范围请求数据,在单个 API 请求中最多为 31 天。 通常,历史数据可能可以追溯到过去 5 到 40 多年,具体取决于位置。
GET https://atlas.microsoft.com/weather/historical/actuals/daily/json?api-version=1.1&query={query}&startDate={startDate}&endDate={endDate}
GET https://atlas.microsoft.com/weather/historical/actuals/daily/json?api-version=1.1&query={query}&startDate={startDate}&endDate={endDate}&unit={unit}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
format
|
path | True |
响应的所需格式。 仅支持 |
|
api-version
|
query | True |
string |
Azure Maps API 的版本号。 |
end
|
query | True |
string date |
ISO 8601 格式的结束日期,例如 2019-10-28。 支持的日期范围是 1 到 31 个日历天,因此请确保指定 startDate 和 endDate 不超过 31 天, (即:startDate=2012-01-01&endDate=2012-01-31) 。 |
query
|
query | True |
number[] |
指定为由纬度后跟经度组成的逗号分隔字符串的适用查询,例如“47.641268,-122.125679”。 |
start
|
query | True |
string date |
ISO 8601 格式的开始日期,例如 2019-10-27。 支持的日期范围是 1 到 31 个日历天,因此请确保指定 startDate 和 endDate 不超过 31 天, (即:startDate=2012-01-01&endDate=2012-01-31) 。 |
unit
|
query |
指定以公制单位或英制单位返回数据。 默认值为 metric。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
x-ms-client-id |
string |
指定要与 Microsoft Entra ID 安全模型一起使用的帐户。 它表示 Azure Maps 帐户的唯一 ID,可以从 Azure Maps 管理平面帐户 API 检索。 若要在 Azure Maps 中使用 Microsoft Entra ID 安全性,请参阅以下 文章 以获取指导。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
确定 |
|
Other Status Codes |
发生了意外错误。 |
安全性
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
示例
Successful Daily Historical Actuals Request
示例请求
GET https://atlas.microsoft.com/weather/historical/actuals/daily/json?api-version=1.1&query=40.78,-77.89&startDate=2012-01-20&endDate=2012-01-22
示例响应
{
"results": [
{
"date": "2012-01-20T00:00:00-04:00",
"temperature": {
"maximum": {
"value": -6.1,
"unit": "C",
"unitType": 17
},
"minimum": {
"value": -11.1,
"unit": "C",
"unitType": 17
},
"average": {
"value": -8.6,
"unit": "C",
"unitType": 17
}
},
"degreeDaySummary": {
"heating": {
"value": 27,
"unit": "C",
"unitType": 17
},
"cooling": {
"value": 0,
"unit": "C",
"unitType": 17
}
},
"precipitation": {
"value": 10.9,
"unit": "mm",
"unitType": 3
},
"snowfall": {
"value": 12.19,
"unit": "cm",
"unitType": 4
},
"snowDepth": {
"value": 15.2,
"unit": "cm",
"unitType": 4
}
},
{
"date": "2012-01-21T00:00:00-04:00",
"temperature": {
"maximum": {
"value": -1.7,
"unit": "C",
"unitType": 17
},
"minimum": {
"value": -8.9,
"unit": "C",
"unitType": 17
},
"average": {
"value": -5.3,
"unit": "C",
"unitType": 17
}
},
"degreeDaySummary": {
"heating": {
"value": 24,
"unit": "C",
"unitType": 17
},
"cooling": {
"value": 0,
"unit": "C",
"unitType": 17
}
},
"precipitation": {
"value": 0,
"unit": "mm",
"unitType": 3
},
"snowfall": {
"value": 0.51,
"unit": "cm",
"unitType": 4
},
"snowDepth": {
"value": 12.7,
"unit": "cm",
"unitType": 4
}
},
{
"date": "2012-01-22T00:00:00-04:00",
"temperature": {
"maximum": {
"value": 0,
"unit": "C",
"unitType": 17
},
"minimum": {
"value": -7.2,
"unit": "C",
"unitType": 17
},
"average": {
"value": -3.6,
"unit": "C",
"unitType": 17
}
},
"degreeDaySummary": {
"heating": {
"value": 22,
"unit": "C",
"unitType": 17
},
"cooling": {
"value": 0,
"unit": "C",
"unitType": 17
}
},
"precipitation": {
"value": 0,
"unit": "mm",
"unitType": 3
},
"snowfall": {
"value": 0,
"unit": "cm",
"unitType": 4
},
"snowDepth": {
"value": 10.2,
"unit": "cm",
"unitType": 4
}
}
]
}
定义
名称 | 说明 |
---|---|
Daily |
|
Daily |
|
Degree |
|
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Json |
响应的所需格式。 仅支持 |
Unit |
与显示的单位类型关联的数值 ID 值。 可用于单元翻译。 有关详细信息,请参阅 Azure Maps 中的天气服务 。 |
Weather |
指定以公制单位或英制单位返回数据。 默认值为 metric。 |
Weather |
与天气相关的给定单位的特定值。 |
Weather |
返回的温度值。 |
DailyHistoricalActuals
名称 | 类型 | 说明 |
---|---|---|
date |
string |
以 ISO 8601 格式显示的当前观察的日期和时间,例如 2019-10-27T19:39:57-08:00。 |
degreeDaySummary |
加热或冷却度日信息的摘要。 度日是衡量某个位置有多冷或多暖的度量值。 日平均 () 记录的室外高温和低) 平均温度与标准温度65度F/18摄氏度进行比较。 |
|
precipitation |
降水量 (已下降的液体当量) 。 |
|
snowDepth |
积雪深度。 |
|
snowfall |
降雪量。 |
|
temperature |
温度值。 |
DailyHistoricalActualsResult
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
是指向返回的功能的下一页的链接。 如果是最后一页,则不使用此字段。 |
results |
每个请求日期的历史实际值。 |
DegreeDaySummary
名称 | 类型 | 说明 |
---|---|---|
cooling |
平均温度高于 65 度/18 摄氏度的度数。 |
|
heating |
平均温度低于 65 度/18 摄氏度的度数。 |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
JsonFormat
响应的所需格式。 仅支持 json
格式。
名称 | 类型 | 说明 |
---|---|---|
json |
string |
UnitType
与显示的单位类型关联的数值 ID 值。 可用于单元翻译。 有关详细信息,请参阅 Azure Maps 中的天气服务 。
名称 | 类型 | 说明 |
---|---|---|
0 |
Integer |
|
1 |
Integer |
|
10 |
Integer |
|
11 |
Integer |
|
12 |
Integer |
|
13 |
Integer |
|
14 |
Integer |
|
15 |
Integer |
|
16 |
Integer |
|
17 |
Integer |
|
18 |
Integer |
|
19 |
Integer |
|
2 |
Integer |
|
20 |
Integer |
|
21 |
Integer |
|
22 |
Integer |
|
3 |
Integer |
|
31 |
Integer |
|
4 |
Integer |
|
5 |
Integer |
|
6 |
Integer |
|
7 |
Integer |
|
8 |
Integer |
|
9 |
Integer |
WeatherDataUnit
指定以公制单位或英制单位返回数据。 默认值为 metric。
名称 | 类型 | 说明 |
---|---|---|
imperial |
string |
以英制单位返回数据。 帝国体系的一些示例单位是华氏度和英里。 |
metric |
string |
以指标单位返回数据。 指标系统的一些示例单位为摄氏度和公里。 |
WeatherUnit
与天气相关的给定单位的特定值。
名称 | 类型 | 说明 |
---|---|---|
unit |
string |
返回值的单位类型。 |
unitType |
与显示的单位类型关联的数值 ID 值。 可用于单元翻译。 有关详细信息,请参阅 Azure Maps 中的天气服务 。 |
|
value |
number |
舍入值。 |
WeatherUnitMaxMinAvg
返回的温度值。
名称 | 类型 | 说明 |
---|---|---|
average |
时间段的平均温度。 |
|
maximum |
时间段的最高温度。 |
|
minimum |
时间段的最低温度。 |