Weather - Get Tropical Storm Active

Verwenden Sie diese Option, um eine Liste der aktiven tropischen Stürme abzurufen, die von den nationalen Wettervorhersageagenturen herausgegeben wird.
Bei der Get Tropical Storm Active API handelt es sich um eine HTTP-Anforderung GET , die eine Liste aller von der Regierung ausgegebenen aktiven tropischen Stürme zurückgibt. Zu den Informationen über die tropischen Stürme gehören die ID der Regierung, die ID des Einzugsgebiets, das Entstehungsjahr, der Name und ob es sich um subtropische Stürme handelt.

GET {endpoint}/weather/tropical/storms/active/json?api-version=1.1

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
path True

string (uri)

Der Hostname des Azure Maps-Dienstes. Verwenden Sie https://atlas.microsoft.com für die Azure Public Cloud. Um eine bestimmte Azure Maps Geografie oder eine souveräne Cloud anzusprechen, siehe Azure Maps geografischer Umfang.

format
path True

JsonFormat

Gewünschtes Format der Antwort. Nur json Format wird unterstützt.

api-version
query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-id

string

Gibt das Konto an, das für die Nutzung mit dem Microsoft Entra ID-Sicherheitsmodell vorgesehen ist. Diese eindeutige ID für das Azure Maps-Konto kann aus der Azure Maps Management-Plane-Konto-API abgerufen werden. Weitere Informationen zur Nutzung Microsoft Entra ID Sicherheit in Azure Maps finden Sie unter Authentifizierung verwalten in Azure Maps.

Antworten

Name Typ Beschreibung
200 OK

ActiveStormResult

Die Anforderung ist erfolgreich.

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

AadToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. In Kombination mit Azure rollenbasierten Zugriffs Steuerung kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Azure-rollenbasierte Zugriffskontrollen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.

Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.

Note

  • Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id-Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Karten-Verwaltungs-APIerworben werden.
  • Die Authorization URL ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über einzigartige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen.
  • Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
  • Die Verwendung des Azure Maps Web SDK ermöglicht das konfigurationsbasierte Einrichten einer Anwendung für mehrere Anwendungsfälle.
  • Weitere Informationen zur Microsoft Identity Platform finden Sie unter Übersicht über die Microsoft Identity Platform.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
https://atlas.microsoft.com/.default

subscription-key

Dies ist ein freigegebener Schlüssel, der bereitgestellt wird, wenn Sie Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.

Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, die vertraulichen Clientanwendungen Ansatz für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: header

SAS Token

Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und feinkörniger Kontrolle auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token autorisiert. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen das Steuern des Zugriffs auf eine sicherere Weise zu ermöglichen als der freigegebene Schlüssel.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge auf der Zuordnungskontoressource zu konfigurieren,, um das Rendern von Missbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Get Tropical Storm Active

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ActiveStorm

Ein derzeit weltweit aktiver tropischer Sturm kehrte als ein einziger Eintrag im Jahr zurück ActiveStormResult.results. Jeder Eintrag fasst den Sturm mit den Kennungen zusammen, die für die Referenz an anderer Stelle in den Get Tropical Storm APIs erforderlich sind – das Ursprungsbecken des Ozeans (basinId), die von der Regierung ausgegebene Kennung (govId) und das Ursprungsjahr (year) – zusammen mit dem offiziellen Namen des Sturms (zum Beispiel Hilda oder LUPIT) und Flaggen, die angeben, ob er noch aktiv ist und ob er als subtropisch klassifiziert ist.

ActiveStormResult

Die Reaktion erfolgte durch die Get Tropical Storm Active-Operation, bei der alle derzeit weltweit aktiven tropischen Sturme aufgeführt wurden, wie sie von nationalen Wettervorhersageagenturen gemeldet wurden. Jeder Eintrag im results Array enthält den ActiveStorm Namen des Sturms, das Ursprungsbecken des Ozeanbeckens, die von der Regierung ausgegebene Kennung, das Ursprungsjahr sowie den aktiven und subtropischen Status. Wenn die Ergebnismenge zu groß ist, um in eine einzige Antwort zu passen, nextLink trägt sie die URL für die nächste Seite.

BasinId

Die basinId Enumeration kategorisiert die verschiedenen Ozeanbecken, in denen tropische Stürme entstehen können. Jedem Becken wird eine eindeutige Kennung zugewiesen, mit der der Ort des Ursprungs des Sturms angegeben werden kann.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

JsonFormat

Gewünschtes Format der Antwort. Nur json Format wird unterstützt.

ActiveStorm

Ein derzeit weltweit aktiver tropischer Sturm kehrte als ein einziger Eintrag im Jahr zurück ActiveStormResult.results. Jeder Eintrag fasst den Sturm mit den Kennungen zusammen, die für die Referenz an anderer Stelle in den Get Tropical Storm APIs erforderlich sind – das Ursprungsbecken des Ozeans (basinId), die von der Regierung ausgegebene Kennung (govId) und das Ursprungsjahr (year) – zusammen mit dem offiziellen Namen des Sturms (zum Beispiel Hilda oder LUPIT) und Flaggen, die angeben, ob er noch aktiv ist und ob er als subtropisch klassifiziert ist.

Name Typ Beschreibung
basinId

BasinId

Das Ozeanbecken, in dem der tropische Sturm entstand. Einer der Werte BasinId ist AL (Atlantik), CP (Zentralpazifik), EP (Ostpazifik), NI (Nordindisch), NP (Nordwestpazifik), SI (Südindisch) oder SP (Südpazifik). Zum Beispiel EP für einen Sturm, der im östlichen Pazifik seinen Ursprung hat.

govId

integer (int32)

Die von der Regierung ausgegebene Kennung, die dem Sturm von seiner nationalen Wettervorhersagebehörde zugewiesen wurde, eindeutig innerhalb (basinId, year). Verwenden Sie dies zusammen mit basinId und year um den Sturm in den anderen Get Tropical Storm-Operationen zu referenzieren.

isActive

boolean

true wenn der tropische Sturm derzeit aktiv ist und noch von der aussendenden Behörde verfolgt wird; false wenn er nicht mehr aktiv ist.

isSubtropical

boolean

true wenn der Sturm als subtropischer Wirbelsturm klassifiziert wird – ein Hybridsystem mit Eigenschaften sowohl tropischer als auch extratropischer Zyklone; false ansonsten.

name

string

Der offizielle Name des Sturms, wie von der zuständigen nationalen Wettervorhersagebehörde festgelegt – zum Beispiel Hilda oder LUPIT. Stürme, die noch nicht offiziell benannt wurden, werden typischerweise durch einen Platzhalter wie TD 9E oder ein Zahlenwort wie TWELVE identifiziert.

year

string

Das vierstellige Kalenderjahr, in dem der tropische Sturm entstand – zum Beispiel 2021. In Kombination mit basinId und govIdidentifiziert dies den Sturm eindeutig über Jahre hinweg.

ActiveStormResult

Die Reaktion erfolgte durch die Get Tropical Storm Active-Operation, bei der alle derzeit weltweit aktiven tropischen Sturme aufgeführt wurden, wie sie von nationalen Wettervorhersageagenturen gemeldet wurden. Jeder Eintrag im results Array enthält den ActiveStorm Namen des Sturms, das Ursprungsbecken des Ozeanbeckens, die von der Regierung ausgegebene Kennung, das Ursprungsjahr sowie den aktiven und subtropischen Status. Wenn die Ergebnismenge zu groß ist, um in eine einzige Antwort zu passen, nextLink trägt sie die URL für die nächste Seite.

Name Typ Beschreibung
nextLink

string

Die URL, um die nächste Seite mit Ergebnissen abzurufen, wenn die Antwort paginiert ist, eignet sich für die Navigation durch Ergebnisse, ist zu groß, um in einem einzigen Aufruf zurückzugeben. Leer, wenn es keine weiteren Seiten mehr gibt.

results

ActiveStorm[]

Die derzeit aktiven tropischen Stürme, mit einem Eintritt pro Sturm. Jede ActiveStorm gibt den Namen des Sturms an (zum Beispiel Hilda), das Entstehungsbecken des Ozeans (zum Beispiel EP für den östlichen Pazifik), die von der Regierung ausgegebene Kennung und das Ursprungsjahr sowie ob der Sturm noch aktiv ist und ob er als subtropisch eingestuft wird.

BasinId

Die basinId Enumeration kategorisiert die verschiedenen Ozeanbecken, in denen tropische Stürme entstehen können. Jedem Becken wird eine eindeutige Kennung zugewiesen, mit der der Ort des Ursprungs des Sturms angegeben werden kann.

Wert Beschreibung
AL

Der Atlantische Ozean. Entscheidend für die Verfolgung von Hurrikanen, die den amerikanischen Kontinent und die Karibik betreffen. Es ist eine der aktivsten Regionen für tropische Stürme.

CP

Der zentrale Pazifische Ozean. Dieses Becken wird für Stürme verwendet, die Hawaii und die umliegenden Gebiete betreffen.

EP

Der östliche Pazifische Ozean. Dieses Becken verfolgt Stürme, die die Westküste Amerikas, einschließlich Mexiko und Mittelamerika, betreffen. Es grenzt an das Zentralpazifikbecken.

NI

Der nördliche Indische Ozean. Dieses Becken umfasst Stürme, die Südasien betreffen, darunter Länder wie Indien und Bangladesch, die häufig von Wirbelstürmen betroffen sind.

NP

Der Nordwestpazifik. Dieses Becken ist wichtig für die Verfolgung von Taifunen, die Ostasien betreffen, darunter Länder wie China, Japan und die Philippinen. Es ist die aktivste tropische Sturmregion weltweit.

SI

Der südliche Indische Ozean. Dieses Becken, das südlich des Äquators liegt, umfasst Zyklone, die Madagaskar, Afrika und die umliegenden Regionen betreffen.

SP

Der Südpazifik. Dieses Becken, das südlich des Äquators liegt, ist relevant für Zyklone, die Australien und die südpazifischen Inseln betreffen.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

JsonFormat

Gewünschtes Format der Antwort. Nur json Format wird unterstützt.

Wert Beschreibung
json

das JavaScript Object Notation Data Interchange Format