Weather - Get Tropical Storm Search
Slouží k získání seznamu bouřek vydaných národními agenturami pro předpověď počasí.
Rozhraní Get Tropical Storm Search
API je požadavek HTTP GET
, který vrací seznam vládou vystavených tropických bouří podle roku, ID oblasti a ID státní správy. Informace o tropických bouřích zahrnují ID vlády, ID kotliny, stav, rok, název a zda je subtropický.
GET https://atlas.microsoft.com/weather/tropical/storms/json?api-version=1.1&year={year}
GET https://atlas.microsoft.com/weather/tropical/storms/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
format
|
path | True |
Požadovaný formát odpovědi Podporuje se pouze |
|
api-version
|
query | True |
string |
Číslo verze rozhraní API Azure Maps. |
year
|
query | True |
integer int32 |
Rok cyklonu(ů) |
basin
|
query |
Identifikátor umyvadla |
||
gov
|
query |
integer int32 |
ID stormu pro státní správu |
Hlavička požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
x-ms-client-id |
string |
Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a je možné ho načíst z rozhraní API účtu roviny správy Azure Maps. Pokud chcete použít Microsoft Entra ID zabezpečení v Azure Maps pokyny najdete v následujících článcích. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Došlo k neočekávané chybě. |
Zabezpečení
AADToken
Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.
Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a obory.
Poznámky
- Tato definice zabezpečení vyžaduje použití hlavičky
x-ms-client-id
k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. Můžete ho získat z rozhraní MAPS MANAGEMENT API.
Je Authorization URL
specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID.
* Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
* Použití sady AZURE MAPS Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.
- Další informace o Microsoft identity platform najdete v přehledu Microsoft identity platform.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Jedná se o sdílený klíč, který se zřídí při Create účtu Azure Maps v Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto klíčem může každá aplikace přistupovat ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve kterému je vystavený.
U veřejně vystavených aplikací doporučujeme pro přístup k Azure Maps rozhraní REST API použít přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.
Type:
apiKey
In:
query
SAS Token
Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v Azure Maps prostředku prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto tokenem má každá aplikace autorizaci pro přístup pomocí řízení přístupu na základě role v Azure a podrobnou kontrolu vypršení platnosti, četnosti a oblastí použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup zabezpečeným způsobem než sdílený klíč.
U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku účtu map , aby se omezilo zneužití vykreslování, a pravidelně obnovovat token SAS.
Type:
apiKey
In:
header
Příklady
Get Tropical Storm Search |
Get Tropical Storm Search With Three Properties |
Get Tropical Storm Search
Sample Request
GET https://atlas.microsoft.com/weather/tropical/storms/json?api-version=1.1&year=2021&basinId=AL
Sample Response
{
"results": [
{
"year": "2021",
"basinId": "AL",
"govId": 1,
"name": "Ana",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 2,
"name": "Bill",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 3,
"name": "Claudette",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 4,
"name": "Danny",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 5,
"name": "Elsa",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 6,
"name": "Fred",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 7,
"name": "Grace",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 8,
"name": "Henri",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 9,
"name": "Ida",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 10,
"name": "Kate",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 11,
"name": "Julian",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 12,
"name": "Larry",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 13,
"name": "Mindy",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 14,
"name": "Nicholas",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 15,
"name": "ODETTE",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 16,
"name": "Peter",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 17,
"name": "Rose",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 18,
"name": "Sam",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 19,
"name": "Teresa",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 20,
"name": "Victor",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 21,
"name": "Wanda",
"isActive": false,
"isRetired": false,
"isSubtropical": false
}
]
}
Get Tropical Storm Search With Three Properties
Sample Request
GET https://atlas.microsoft.com/weather/tropical/storms/json?api-version=1.1&year=2021&basinId=AL&govId=1
Sample Response
{
"results": [
{
"year": "2021",
"basinId": "AL",
"govId": 1,
"name": "Ana",
"isActive": false,
"isRetired": false,
"isSubtropical": false
}
]
}
Definice
Name | Description |
---|---|
basin |
Identifikátor umyvadla |
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě |
Error |
Chybová odpověď |
Json |
Požadovaný formát odpovědi Podporuje se pouze |
Storm |
Search vládní bouře |
Storm |
Aktivní událost storm vystavená státní správou |
basinId
Identifikátor umyvadla
Name | Typ | Description |
---|---|---|
AL |
string |
Atlantic |
CP |
string |
Střední Tichomoří |
EP |
string |
Východní Tichomoří |
NI |
string |
Severní Indický oceán |
NP |
string |
Severozápad Tichomoří |
SI |
string |
Jihozápad Indického oceánu |
SP |
string |
Jižní Tichomoří |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Typ další informace. |
ErrorDetail
Podrobnosti o chybě
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě. |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě. |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
ErrorResponse
Chybová odpověď
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
JsonFormat
Požadovaný formát odpovědi Podporuje se pouze json
formát.
Name | Typ | Description |
---|---|---|
json |
string |
StormSearchResult
Search vládní bouře
Name | Typ | Description |
---|---|---|
nextLink |
string |
Je odkaz na další stránku vrácených funkcí. Pokud se jedná o poslední stránku, toto pole není. |
results |
Search vládní bouře |
StormSearchResultItem
Aktivní událost storm vystavená státní správou
Name | Typ | Description |
---|---|---|
basinId |
Identifikátor pánve (AL, EP, SI, NI, CP, NP, SP) |
|
govId |
integer |
ID stormu pro státní správu. To bude odpovídat číslu deprese. |
isActive |
boolean |
Platí, pokud deprese byla aktualizována v poslední době. |
isRetired |
boolean |
Ano, pokud název bouře byl trvale vyřazen ve zdrojové kotlině. |
isSubtropical |
boolean |
Platí, když je deprese klasifikována jako subtropický cyklon. |
name |
string |
Název deprese. |
year |
string |
Rok vzniku |