共用方式為

Weather - Get Tropical Storm Forecast

  • 參考
服務:
Maps
API 版本:
1.1

使用 來取得國家氣象預測機構所預測的氣象雨清單。

Get Tropical Storm Forecasts API 是一個 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 參數

名稱 位於 必要 類型 Description
format
 path True

JsonFormat

所需的回應格式。 僅支援 json 格式。
api-version
 query True

string

Azure 地圖服務 API 的版本號碼。
basinId
 query True

basinId

水道標識碼
govId
 query True

integer

int32

政府 Storm 識別碼
year
 query True

integer

int32

()

details
 query

boolean

若為 true，則回應中包含風弧度摘要數據
radiiGeometry
 query

boolean

若為 true，則回應中包含風弧度摘要數據和 geoJSON 詳細數據
unit
 query

WeatherDataUnit

指定以計量單位或英制單位傳回數據。 預設值為計量。
windowGeometry
 query

boolean

若為 true，回應中會包含 geoJSON (geoJSON) 的視窗幾何數據

要求標頭

名稱 必要 類型 Description
x-ms-client-id

string

指定哪一個帳戶用於搭配 Microsoft Entra ID 安全性模型使用。 它代表 Azure 地圖服務帳戶的唯一標識碼，而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。 若要在 Azure 地圖服務中使用 Microsoft 專案標識碼安全性，請參閱下列 文章 以取得指引。

回應

名稱 類型 Description
200 OK

StormForecastResult

確定
Other Status Codes

ErrorResponse

發生意外錯誤。

安全性

AADToken

這些是 entra OAuth 2.0 Flow Microsoft 。 與 Azure 角色型存 取控制配對時，可用來控制對 Azure 地圖服務 REST API 的存取。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務資源帳戶或子資源的存取權。 任何使用者、群組或服務主體都可以透過內建角色或由一或多個 Azure 地圖服務 REST API 許可權組成的自定義角色來授與存取權。

若要實作案例，建議您檢視 驗證概念。 總而言之，此安全性定義提供一個解決方案，可透過能夠針對特定 API 和範圍進行存取控制的物件，將應用程式模型化 () 。

備註

  • 此安全性定義 需要使用x-ms-client-id 標頭來指出應用程式要求存取權的 Azure 地圖服務資源。 這可以從 地圖服務管理 API 取得。

Authorization URL專屬於 Azure 公用雲端實例。 主權雲端具有唯一的授權 URL，Microsoft Entra ID 設定。 * 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 管理平面設定 Azure 角色型存取控制。 * Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

這是您在 Azure 入口網站中 建立 Azure 地圖服務帳戶 或使用 PowerShell、CLI、Azure SDK 或 REST API 時所佈建的共用密鑰。

使用此金鑰時，任何應用程式都可以存取所有 REST API。 換句話說，此金鑰可作為發行帳戶中的主要金鑰。

對於公開的應用程式，我們建議使用 機密用戶端應用程式 方法來存取 Azure 地圖服務 REST API，以便安全地儲存您的密鑰。

類型: apiKey
位於: query

SAS Token

這是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 地圖服務資源 上的清單 SAS 作業建立共用存取簽章令牌。

使用此令牌時，任何應用程式都有權使用 Azure 角色型訪問控制進行存取，並精細控制到期、速率和區域 (特定令牌的使用) 。 換句話說，SAS 令牌可用來允許應用程式以比共用密鑰更安全的方式控制存取。

對於公開的應用程式，我們建議在 地圖帳戶資源 上設定允許的來源特定清單，以限制轉譯濫用，並定期更新 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
        }
      }
    }
  ]
}

定義

名稱 Description
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

政府發行的 Storm 預測
StormForecastResult

政府發行的預測清單
StormWindRadiiSummary

當要求中 details=true 或 radiiGeometry=true 時顯示。
UnitType

與所顯示單位類型相關聯的數值標識碼。 可用於單元翻譯。 如需詳細資訊，請參閱 Azure 地圖服務中的天氣服務 。
WeatherDataUnit

指定以度量單位或英制單位傳回數據。 預設值為計量。
WeatherUnit

與天氣相關的指定單位特定值。
WeatherWindow

Storm 的預測視窗

basinId

二元標識碼

名稱 類型 Description
AL

string

大西洋
CP

string

太平洋中部
EP

string

東部太平洋
NI

string

北印度海
NP

string

太平洋北部
SI

string

印度南部
SP

string

南太平洋

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。
type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。
code

string

錯誤碼。
details

ErrorDetail[]

錯誤詳細資料。
message

string

錯誤訊息。
target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

錯誤物件。

GeoJsonGeometry

有效的 GeoJSON geometry 物件。 此類型必須是七個有效 GeoJSON 幾何類型的其中一個 -Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 如需詳細資訊 ，請參閱 RFC 7946 。

名稱 類型 Description
type

GeoJsonObjectType

指定 GeoJSON 類型。 必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonGeometryCollection

有效的 GeoJSON GeometryCollection 物件類型。 如需詳細資訊 ，請參閱 RFC 7946 。

名稱 類型 Description
geometries GeoJsonGeometry[]:

包含有效的 GeoJSON 幾何物件清單。 請注意 ，GeoJSON 中的座標以 x、y 順序 (經度、緯度) 。
type string:

GeometryCollection

指定 GeoJSON 類型。 必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonLineString

有效的 GeoJSON LineString 幾何類型。 如需詳細資訊 ，請參閱 RFC 7946 。

名稱 類型 Description
coordinates

number[]

幾何座標 GeoJson LineString 。
type string:

LineString

指定 GeoJSON 類型。 必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiLineString

有效的 GeoJSON MultiLineString 幾何類型。 如需詳細資訊 ，請參閱 RFC 7946 。

名稱 類型 Description
coordinates

number[]

幾何座標 GeoJson MultiLineString 。
type string:

MultiLineString

指定 GeoJSON 類型。 必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 幾何類型。 如需詳細資訊 ，請參閱 RFC 7946 。

名稱 類型 Description
coordinates

number[]

幾何座標 GeoJson MultiPoint 。
type string:

MultiPoint

指定 GeoJSON 類型。 必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPolygon

有效的 GeoJSON MultiPolygon 物件類型。 如需詳細資訊 ，請參閱 RFC 7946 。

名稱 類型 Description
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 。

名稱 類型 Description
coordinates

number[]

Position是具有兩個或多個元素的數位數位數位數位。 前兩個專案是 經度 和 緯度，以該順序精確。 高度/高度 是選擇性的第三個專案。 如需詳細資訊 ，請參閱 RFC 7946 。
type string:

Point

指定 GeoJSON 類型。 必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonPolygon

有效的 GeoJSON Polygon 幾何類型。 如需詳細資訊 ，請參閱 RFC 7946 。

名稱 類型 Description
coordinates

number[]

GeoJson Polygon幾何類型的座標。
type string:

Polygon

指定 GeoJSON 類型。 必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

JsonFormat

所需的回應格式。 僅支援 json 格式。

名稱 類型 Description
json

string

JavaScript 物件表示法數據交換格式

LatLongPair

以緯度和經度表示的位置。

名稱 類型 Description
latitude

number

Latitude 屬性
longitude

number

經度屬性

RadiusSector

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

名稱 類型 Description
beginBearing

number

以度為單位，表示象限的開頭。
endBearing

number

以度為單位的象限結束。
range

number

象限的半徑，以貝氏英哩為單位。

StormForecast

政府發行的 Storm 預測

名稱 類型 Description
dateTime

string

預測有效日期時間，以ISO8601格式顯示。
initializedDateTime

string

建立預測的日期時間，以ISO8601格式顯示。
location

LatLongPair

Storm 的座標
maxWindGust

WeatherUnit

與暴風相關聯的最大風速。 可能是 NULL。
status

string

可能的狀態值包括：

  • 卡里尼斯雨
  • 深層氣氣
  • 抑鬱症
  • 極嚴重的水流
  • (1-5)
  • 密集的殭氣
  • 中度風雨
  • 後置氣氣
  • 潛在的氣氣
  • 嚴重水流
  • 嚴重暴風雨
  • 亞熱帶的
  • 超級風雲
  • 氣氣
  • (1-5)
  • 氣氣
  • 水殭
  • 水雨
  • 颱風
  • 非常密集的氣氣
  • 非常嚴重的風雲
  • 非常強的錯字
  • 新式錯字
sustainedWind

WeatherUnit

與暴風相關聯的最大持續風速。 可能是 NULL。
windRadiiSummary

StormWindRadiiSummary[]

當要求中 details=true 或 radiiGeometry=true 時顯示。
window

WeatherWindow

包含指定時段內 storm 的預測視窗相關信息， (不是整個圓錐) 。 如果要求中的 windowGeometry=true，此物件將會包含視窗幾何的 geoJSON 詳細數據。

StormForecastResult

政府發行的預測清單

名稱 類型 Description
nextLink

string

是傳回之功能下一頁的連結。 如果是最後一頁，則不會有此欄位。
results

StormForecast[]

政府發行的預測清單

StormWindRadiiSummary

當要求中 details=true 或 radiiGeometry=true 時顯示。

名稱 類型 Description
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

與所顯示單位類型相關聯的數值標識碼。 可用於單元翻譯。 如需詳細資訊，請參閱 Azure 地圖服務中的天氣服務 。

名稱 類型 Description
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

指定以度量單位或英制單位傳回數據。 預設值為計量。

名稱 類型 Description
imperial

string

以單位傳回數據。 一些英制系統的範例單位是華氏和英哩。
metric

string

以計量單位傳回數據。 計量系統的一些範例單位為攝氏和公里。

WeatherUnit

與天氣相關的指定單位特定值。

名稱 類型 Description
unit

string

傳回值的單位類型。
unitType

UnitType

與所顯示單位類型相關聯的數值標識碼。 可用於單元翻譯。 如需詳細資訊，請參閱 Azure 地圖服務中的天氣服務 。
value

number

捨入值。

WeatherWindow

Storm 的預測視窗

名稱 類型 Description
beginDateTime

string

移動視窗開頭的 DateTime，以ISO8601格式顯示。
beginStatus

string

視窗開頭的 Storm 狀態。
endDateTime

string

移動視窗結尾的 DateTime，以ISO8601格式顯示。
endStatus

string

視窗結尾處的 Storm 狀態。
geometry GeoJsonGeometry:

當要求中的 windowGeometry=true 時顯示。 GeoJSON 物件，包含描述指定時間範圍內移動時間範圍之座標的座標。
left

LatLongPair

時間範圍左邊的點位置。
right

LatLongPair

時間範圍結尾視窗右側點的位置。