共用方式為


Weather - Get Tropical Storm Active

用來取得國家氣象預報機構發出的作用中氣象雨清單。

Get Tropical Storm Active API 是一項 HTTP GET 要求,會傳回所有政府發行的作用中暴風雨清單。 有關暴風雨的資訊包括政府標識碼、水位標識符、來源年份、名稱,以及是否為子系。

GET https://atlas.microsoft.com/weather/tropical/storms/active/json?api-version=1.1

URI 參數

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

JsonFormat

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

api-version
query True

string

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

要求標頭

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

string

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

回應

名稱 類型 Description
200 OK

ActiveStormResult

確定

Other Status Codes

ErrorResponse

發生意外錯誤。

安全性

AADToken

這些是 Microsoft Entra OAuth 2.0 流程。 與 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 Active

範例要求

GET https://atlas.microsoft.com/weather/tropical/storms/active/json?api-version=1.1

範例回覆

{
  "results": [
    {
      "year": "2021",
      "basinId": "EP",
      "name": "Hilda",
      "isActive": true,
      "isSubtropical": false,
      "govId": 8
    },
    {
      "year": "2021",
      "basinId": "EP",
      "name": "TD 9E",
      "isActive": true,
      "isSubtropical": false,
      "govId": 9
    },
    {
      "year": "2021",
      "basinId": "NP",
      "name": "TWELVE",
      "isActive": true,
      "isSubtropical": false,
      "govId": 12
    },
    {
      "year": "2021",
      "basinId": "NP",
      "name": "LUPIT",
      "isActive": true,
      "isSubtropical": false,
      "govId": 13
    },
    {
      "year": "2021",
      "basinId": "NP",
      "name": "FOURTEEN",
      "isActive": true,
      "isSubtropical": false,
      "govId": 14
    },
    {
      "year": "2021",
      "basinId": "NP",
      "name": "FIFTEEN",
      "isActive": true,
      "isSubtropical": false,
      "govId": 15
    }
  ]
}

定義

名稱 Description
ActiveStorm

政府發行的作用中 Storm

ActiveStormResult

所有政府發行的作用中 Storm

basinId

二元標識碼

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

JsonFormat

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

ActiveStorm

政府發行的作用中 Storm

名稱 類型 Description
basinId

basinId

區位標識碼 (AL、EP、SI、NI、CP、NP、SP)

govId

integer

政府 Storm 識別碼。 這會比對擷取次數。

isActive

boolean

True 是表示 如果最近更新了耙耙。

isSubtropical

boolean

True 是表示 當被分類為子向性耙耙。

name

string

擷取者的名稱。

year

string

原點年份

ActiveStormResult

所有政府發行的作用中 Storm

名稱 類型 Description
nextLink

string

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

results

ActiveStorm[]

所有政府發行的作用中 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

錯誤物件。

JsonFormat

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

名稱 類型 Description
json

string

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