通过

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

Weather - Get Tropical Storm Forecast

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

用于获取国家天气预报机构预测的热带风暴列表。

API Get Tropical Storm Forecasts 是返回政府发布的单个热带风暴预报的 HTTP GET 请求。 有关预测的热带风暴的信息包括、位置、状态、预测的创建日期、窗口、风速和风半径。

GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}
具有可选参数: 
GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}&unit={unit}&details={details}&radiiGeometry={radiiGeometry}&windowGeometry={windowGeometry}

URI 参数

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

JsonFormat

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

string

Azure Maps API 的版本号。
basinId
 query True

basinId

盆地标识符
govId
 query True

integer

int32

政府风暴 ID
year
 query True

integer

int32

气旋年 ()

details
 query

boolean

如果为 true，则响应中包含风半径摘要数据
radiiGeometry
 query

boolean

如果为 true，则响应中包含风半径摘要数据和 geoJSON 详细信息
unit
 query

WeatherDataUnit

指定以公制单位或英制单位返回数据。 默认值为 metric。
windowGeometry
 query

boolean

如果为 true，则响应中包含 geoJSON) (窗口几何图形数据

请求头

名称 必需 类型 说明
x-ms-client-id

string

指定用于与 Microsoft Entra ID 安全模型结合使用的帐户。 它表示 Azure Maps 帐户的唯一 ID，可从 Azure Maps 管理平面帐户 API 检索。 若要在 Azure Maps 中使用 Microsoft Entra ID 安全性，请参阅以下 文章 以获取指导。

响应

名称 类型 说明
200 OK

StormForecastResult

确定
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

示例

Get Tropical Storm Forecasts

示例请求

GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year=2021&basinId=NP&govId=2

示例响应

状态代码:
200 
{
  "results": [
    {
      "dateTime": "2021-04-25T06:00:00+00:00",
      "initializedDateTime": "2021-04-24T18:00:00+00:00",
      "location": {
        "latitude": 22,
        "longitude": 137.8
      },
      "maxWindGust": {
        "value": 92.6,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 74.1,
        "unit": "km/h",
        "unitType": 7
      },
      "status": "Tropical Storm",
      "window": {
        "left": {
          "latitude": 22.56387,
          "longitude": 137.739517
        },
        "right": {
          "latitude": 21.4361,
          "longitude": 137.860489
        }
      }
    },
    {
      "dateTime": "2021-04-25T18:00:00+00:00",
      "initializedDateTime": "2021-04-24T18:00:00+00:00",
      "location": {
        "latitude": 23.7,
        "longitude": 142.4
      },
      "maxWindGust": {
        "value": 92.6,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 74.1,
        "unit": "km/h",
        "unitType": 7
      },
      "status": "Tropical Storm",
      "window": {
        "left": {
          "latitude": 24.45283,
          "longitude": 142.055313
        },
        "right": {
          "latitude": 22.94641,
          "longitude": 142.744675
        }
      }
    }
  ]
}

定义

名称 说明
basinId

盆地标识符
ErrorAdditionalInfo

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

错误详细信息。
ErrorResponse

错误响应
GeoJsonGeometry

有效的 GeoJSON geometry 对象。 类型必须是七种有效的 GeoJSON 几何类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 有关详细信息，请参阅 RFC 7946 。
GeoJsonGeometryCollection

有效的 GeoJSON GeometryCollection 对象类型。 有关详细信息，请参阅 RFC 7946 。
GeoJsonLineString

有效的 GeoJSON LineString 几何类型。 有关详细信息，请参阅 RFC 7946 。
GeoJsonMultiLineString

有效的 GeoJSON MultiLineString 几何类型。 有关详细信息，请参阅 RFC 7946 。
GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 几何类型。 有关详细信息，请参阅 RFC 7946 。
GeoJsonMultiPolygon

有效的 GeoJSON MultiPolygon 对象类型。 有关详细信息，请参阅 RFC 7946 。
GeoJsonPoint

有效的 GeoJSON Point 几何类型。 有关详细信息，请参阅 RFC 7946 。
GeoJsonPolygon

有效的 GeoJSON Polygon 几何类型。 有关详细信息，请参阅 RFC 7946 。
JsonFormat

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

表示为纬度和经度的位置。
RadiusSector

轴承 0–90 = NE 象限;90–180 = SE 象限;180–270 = SW 象限;270–360 = NW 象限。
StormForecast

政府发布的风暴预报
StormForecastResult

政府发布的预测列表
StormWindRadiiSummary

在请求中 details=true 或 radiiGeometry=true 时显示。
UnitType

与显示的单位类型关联的数值 ID 值。 可用于单元翻译。 有关详细信息，请参阅 Azure Maps 中的天气服务 。
WeatherDataUnit

指定以公制单位或英制单位返回数据。 默认值为 metric。
WeatherUnit

与天气相关的给定单位的特定值。
WeatherWindow

风暴的预测窗口

basinId

盆地标识符

名称 类型 说明
AL

string

大西洋
CP

string

中太平洋
EP

string

东太平洋
NI

string

北印度洋
NP

string

西北太平洋
SI

string

印度洋西南部
SP

string

南太平洋

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

GeoJsonGeometry

有效的 GeoJSON geometry 对象。 类型必须是七种有效的 GeoJSON 几何类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 有关详细信息，请参阅 RFC 7946 。

名称 类型 说明
type

GeoJsonObjectType

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonGeometryCollection

有效的 GeoJSON GeometryCollection 对象类型。 有关详细信息，请参阅 RFC 7946 。

名称 类型 说明
geometries GeoJsonGeometry[]:

包含有效 GeoJSON geometry 对象的列表。 请注意 ，GeoJSON 中的坐标采用 x、y 顺序 (经度、纬度) 。
type string:

GeometryCollection

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonLineString

有效的 GeoJSON LineString 几何类型。 有关详细信息，请参阅 RFC 7946 。

名称 类型 说明
coordinates

number[]

几何图形的 GeoJson LineString 坐标。
type string:

LineString

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiLineString

有效的 GeoJSON MultiLineString 几何类型。 有关详细信息，请参阅 RFC 7946 。

名称 类型 说明
coordinates

number[]

几何图形的 GeoJson MultiLineString 坐标。
type string:

MultiLineString

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 几何类型。 有关详细信息，请参阅 RFC 7946 。

名称 类型 说明
coordinates

number[]

几何图形的 GeoJson MultiPoint 坐标。
type string:

MultiPoint

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPolygon

有效的 GeoJSON MultiPolygon 对象类型。 有关详细信息，请参阅 RFC 7946 。

名称 类型 说明
coordinates

number[]

包含有效 GeoJSON Polygon 对象的列表。 请注意 ，GeoJSON 中的坐标采用 x、y 顺序 (经度、纬度) 。
type string:

MultiPolygon

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonPoint

有效的 GeoJSON Point 几何类型。 有关详细信息，请参阅 RFC 7946 。

名称 类型 说明
coordinates

number[]

是 Position 包含两个或多个元素的数字数组。 前两个元素是 经度 和 纬度，精确按此顺序排列。 海拔高度 是可选的第三个元素。 有关详细信息，请参阅 RFC 7946 。
type string:

Point

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonPolygon

有效的 GeoJSON Polygon 几何类型。 有关详细信息，请参阅 RFC 7946 。

名称 类型 说明
coordinates

number[]

GeoJson Polygon几何类型的坐标。
type string:

Polygon

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

JsonFormat

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

名称 类型 说明
json

string

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

LatLongPair

表示为纬度和经度的位置。

名称 类型 说明
latitude

number

Latitude 属性
longitude

number

Longitude 属性

RadiusSector

轴承 0–90 = NE 象限;90–180 = SE 象限;180–270 = SW 象限;270–360 = NW 象限。

名称 类型 说明
beginBearing

number

以度为单位表示的象限开始。
endBearing

number

以度为单位表示的象限结束。
range

number

象限的半径，以海里为单位。

StormForecast

政府发布的风暴预报

名称 类型 说明
dateTime

string

预测有效的日期/时间，以ISO8601格式显示。
initializedDateTime

string

创建预测的日期/时间，以ISO8601格式显示。
location

LatLongPair

风暴坐标
maxWindGust

WeatherUnit

与风暴相关的最大阵风速度。 可以为 NULL。
status

string

可能的状态值包括：

  • 气旋风暴
  • 深度抑郁
  • 抑郁症
  • 极其严重的气旋风暴
  • 飓风类别 (1-5)
  • 强热带气旋
  • 中度热带风暴
  • 后热带气旋
  • 潜在的热带气旋
  • 严重的气旋风暴
  • 强热带风暴
  • 亚热带的
  • 超级气旋风暴
  • 热带气旋
  • 热带气旋类别 (1-5)
  • 热带低气压
  • 热带干扰
  • 热带风暴
  • 台风
  • 非常强烈的热带气旋
  • 非常严重的气旋风暴
  • 非常强的台风
  • 猛烈台风
sustainedWind

WeatherUnit

与风暴相关的最大持续风速。 可以为 NULL。
windRadiiSummary

StormWindRadiiSummary[]

在请求中 details=true 或 radiiGeometry=true 时显示。
window

WeatherWindow

包含有关指定时间段内风暴的预报窗口的信息， (不是整个圆锥) 。 如果请求中的 windowGeometry=true，则此对象将包含窗口几何图形的 geoJSON 详细信息。

StormForecastResult

政府发布的预测列表

名称 类型 说明
nextLink

string

是指向返回的功能的下一页的链接。 如果是最后一页，则不使用此字段。
results

StormForecast[]

政府发布的预测列表

StormWindRadiiSummary

在请求中 details=true 或 radiiGeometry=true 时显示。

名称 类型 说明
dateTime

string

风半径摘要数据有效的 DateTime，以ISO8601格式显示。
radiiGeometry GeoJsonGeometry:

GeoJSON 对象。 在请求中 radiiGeometry=true 时显示。 描述风半径象限的轮廓。
radiusSectorData

RadiusSector[]

包含绘制风半径象限所需的信息。 轴承 0–90 = NE 象限;90–180 = SE 象限;180–270 = SW 象限;270–360 = NW 象限。
windSpeed

WeatherUnit

与 radiusSectorData 关联的风速。

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

UnitType

与显示的单位类型关联的数值 ID 值。 可用于单元翻译。 有关详细信息，请参阅 Azure Maps 中的天气服务 。
value

number

舍入值。

WeatherWindow

风暴的预测窗口

名称 类型 说明
beginDateTime

string

移动窗口开始的 DateTime，以ISO8601格式显示。
beginStatus

string

窗口开头的 Storm 状态。
endDateTime

string

移动窗口结束的 DateTime，以ISO8601格式显示。
endStatus

string

窗口末尾的 Storm 状态。
geometry GeoJsonGeometry:

在请求中 windowGeometry=true 时显示。 包含描述指定时间范围内移动窗口的坐标的 GeoJSON 对象。
left

LatLongPair

时间范围时窗口左侧点的位置。
right

LatLongPair

时间范围结束时窗口右侧点的位置。