通过

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

Weather - Get Minute Forecast

  • 参考
服务:
Maps
API 版本:
1.1

使用 获取接下来 120 分钟的逐分钟预测，间隔为 1、5 和 15 分钟。

API Get Minute Forecast 是一个 HTTP GET 请求，它返回给定位置未来 120 分钟的逐分钟预测。 用户可以 1、5 和 15 分钟的间隔请求天气预测。 响应将包括降水 (类型（包括雨、雪）或) 、开始时间和降水强度值 (dBZ) 的混合物等详细信息。 有关详细信息，请参阅 请求逐分钟天气预报数据。

GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query={query}
具有可选参数: 
GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query={query}&interval={interval}&language={language}

URI 参数

名称 在 必需 类型 说明
format
 path True

JsonFormat

响应的所需格式。 仅支持 json 格式。
api-version
 query True

string

Azure Maps API 的版本号。
query
 query True

number[]

指定为逗号分隔字符串的适用查询，该字符串由纬度后跟经度组成，例如“47.641268，-122.125679”。
interval
 query

integer

指定返回的天气预报的时间间隔（以分钟为单位）。 支持的值为

  • 1 - 检索 1 分钟间隔的预测。 默认返回。
  • 5 - 检索 5 分钟间隔的预测。
  • 15 - 检索 15 分钟间隔的预测。
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

MinuteForecastResult

确定
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 可以针对多个用例对应用程序进行基于配置的设置。

类型: 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

示例

Successfully retrieve minute-by-minute forecasts for a given location

示例请求

GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query=47.632346,-122.138874&interval=15

示例响应

状态代码:
200 
{
  "summary": {
    "briefPhrase60": "Rain ending in 25 min",
    "shortPhrase": "Rain ending in 25 min",
    "briefPhrase": "Rain ending in 25 min",
    "longPhrase": "Rain ending in 25 min",
    "iconCode": 12
  },
  "intervalSummaries": [
    {
      "startMinute": 0,
      "endMinute": 24,
      "totalMinutes": 25,
      "shortPhrase": "Rain ending in %minute_value min",
      "briefPhrase": "Rain ending in %minute_value min",
      "longPhrase": "Rain ending in %minute_value min",
      "iconCode": 12
    },
    {
      "startMinute": 25,
      "endMinute": 119,
      "totalMinutes": 95,
      "shortPhrase": "No precip for %MINUTE_VALUE min",
      "briefPhrase": "No precipitation for at least %MINUTE_VALUE min",
      "longPhrase": "No precipitation for at least %MINUTE_VALUE min",
      "iconCode": 7
    }
  ],
  "intervals": [
    {
      "startTime": "2019-11-14T15:18:00-08:00",
      "minute": 0,
      "dbz": 23,
      "shortPhrase": "Light Rain",
      "threshold": "LIGHT",
      "color": {
        "red": 8,
        "green": 98,
        "blue": 2,
        "hex": "#086202"
      },
      "simplifiedColor": {
        "red": 35,
        "green": 190,
        "blue": 39,
        "hex": "#23BE27"
      },
      "precipitationType": "Rain",
      "iconCode": 12,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T15:33:00-08:00",
      "minute": 15,
      "dbz": 18,
      "shortPhrase": "Light Rain",
      "threshold": "LIGHT",
      "color": {
        "red": 32,
        "green": 133,
        "blue": 9,
        "hex": "#208509"
      },
      "simplifiedColor": {
        "red": 35,
        "green": 190,
        "blue": 39,
        "hex": "#23BE27"
      },
      "precipitationType": "Rain",
      "iconCode": 12,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T15:48:00-08:00",
      "minute": 30,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:03:00-08:00",
      "minute": 45,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:18:00-08:00",
      "minute": 60,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:33:00-08:00",
      "minute": 75,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:48:00-08:00",
      "minute": 90,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T17:03:00-08:00",
      "minute": 105,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    }
  ]
}

定义

名称 说明
ColorValue
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应
ForecastInterval
IconCode

表示显示 的图像的 iconPhrase数值。 有关详细信息，请参阅 Azure Maps 中的天气服务 。
IntervalSummary
JsonFormat

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

整个预测期间的短语摘要。
PrecipitationType

指定 (“雨”“雪”“冰”或“混合”) 的降水类型。 如果 dbz 为零，则响应中不存在 precipitationType。

ColorValue

名称 类型 说明
blue

integer

RGB 值的蓝色分量
green

integer

RGB 值的绿色分量。
hex

string

十六进制颜色值。
red

integer

RGB 值的红色分量。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ForecastInterval

名称 类型 说明
cloudCover

integer

表示云覆盖率的百分比。
color

ColorValue

映射到 dBZ 的全光谱颜色 (相对于 Z) 分贝。 如果 dbz 为零，则响应中不存在颜色。
dbz

number

表示预测降水强度的单位。
iconCode

IconCode

表示显示 的图像的 iconPhrase数值。 有关详细信息，请参阅 Azure Maps 中的天气服务 。
minute

integer

间隔的第一分钟。
precipitationType

PrecipitationType

指定 (“雨”“雪”“冰”或“混合”) 的降水类型。 如果 dbz 为零，则响应中不存在 precipitationType。
shortPhrase

string

描述间隔的降水情况的短语。
simplifiedColor

ColorValue

映射到降水类型和阈值的带状颜色。 如果 dbz 为零，则响应中不存在。
startTime

string

间隔开始的日期和时间，采用 ISO 8601 格式，例如 2019-10-27T19：39：57-08：00。
threshold

string

指定阈值的键。 与 precipitationType 一起，可用于确定 simplifiedColor。 如果 dbz 为零，则响应中不存在。

IconCode

表示显示 的图像的 iconPhrase数值。 有关详细信息，请参阅 Azure Maps 中的天气服务 。

名称 类型 说明
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

23

Integer

24

Integer

25

Integer

26

Integer

27

Integer

28

Integer

29

Integer

3

Integer

30

Integer

31

Integer

32

Integer

33

Integer

34

Integer

35

Integer

36

Integer

37

Integer

38

Integer

39

Integer

4

Integer

40

Integer

41

Integer

42

Integer

43

Integer

44

Integer

5

Integer

6

Integer

7

Integer

8

Integer

9

Integer

IntervalSummary

名称 类型 说明
briefPhrase

string

简短摘要短语。 短语长度约为 60 个字符。
endMinute

integer

摘要应用到的最后一分钟。
iconCode

IconCode

表示显示 的图像的 iconPhrase数值。 有关详细信息，请参阅 Azure Maps 中的天气服务 。
longPhrase

string

长摘要短语。 短语长度为 60+ 个字符。
shortPhrase

string

简短摘要短语。 短语长度约为 25 个字符。
startMinute

integer

摘要应用到的第一分钟。
totalMinutes

integer

应用摘要的分钟数。

JsonFormat

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

名称 类型 说明
json

string

JavaScript 对象表示法数据交换格式

MinuteForecastResult

名称 类型 说明
intervalSummaries

IntervalSummary[]

预测中每个间隔的摘要信息。 摘要分解了降水开始和停止的每个潜在间隔。
intervals

ForecastInterval[]

预测中每个间隔的预测数据。
summary

MinuteForecastSummary

整个预测期间的短语摘要。

MinuteForecastSummary

整个预测期间的短语摘要。

名称 类型 说明
briefPhrase

string

接下来 120 分钟的摘要短语。 短语长度约为 60 个字符。
briefPhrase60

string

接下来 60 分钟的摘要短语。 短语长度约为 60 个字符。
iconCode

IconCode

表示显示 的图像的 iconPhrase数值。 有关详细信息，请参阅 Azure Maps 中的天气服务 。
longPhrase

string

接下来 120 分钟的长摘要短语。 短语长度为 60+ 个字符。
shortPhrase

string

接下来 120 分钟的简短摘要短语。 短语长度约为 25 个字符。

PrecipitationType

指定 (“雨”“雪”“冰”或“混合”) 的降水类型。 如果 dbz 为零，则响应中不存在 precipitationType。

名称 类型 说明
Ice

string

Ice
Mix

string

组合
Rain

string

雨
Snow

string

雪