Weather - Get Tropical Storm Forecast
Az országos időjárás-előrejelzési ügynökségek által előrejelzett trópusi viharok listájának lekéréséhez használható.
Az Get Tropical Storm Forecasts
API egy HTTP-kérés GET
, amely az egyes kormányzati trópusi viharokra vonatkozó előrejelzéseket ad vissza. Az előrejelzett trópusi viharokkal kapcsolatos információk közé tartozik a hely, az állapot, az előrejelzés létrehozásának dátuma, az ablak, a szélsebesség és a szél radii.
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-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
format
|
path | True |
A válasz kívánt formátuma. Csak |
|
api-version
|
query | True |
string |
Az Azure Maps API verziószáma. |
basin
|
query | True |
Medence azonosítója |
|
gov
|
query | True |
integer int32 |
Kormányzati vihar azonosítója |
year
|
query | True |
integer int32 |
A ciklon(ok) éve |
details
|
query |
boolean |
Ha igaz, a szél radii összegző adatai szerepelnek a válaszban |
|
radii
|
query |
boolean |
Ha igaz, a szélsugár-összefoglaló adatok és a geoJSON-adatok szerepelnek a válaszban |
|
unit
|
query |
Megadja, hogy az adatokat metrikaegységekben vagy angolszász egységekben adja vissza. Az alapértelmezett érték a metrika. |
||
window
|
query |
boolean |
Ha igaz, az ablakgeometriai adatok (geoJSON) szerepelnek a válaszban |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
x-ms-client-id |
string |
Meghatározza, hogy melyik fiók legyen a Microsoft Entra ID biztonsági modellel együtt használva. Ez az Azure Maps-fiók egyedi azonosítóját jelöli, amely az Azure Maps felügyeleti sík fiók API-jából kérhető le. A Microsoft Entra ID security Azure Mapsben való használatához az alábbi cikkek nyújtanak útmutatást. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Váratlan hiba történt. |
Biztonság
AADToken
Ezek a Microsoft Entra OAuth 2.0-folyamatok . Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható az Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps-erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több Azure Maps REST API-ra vonatkozó engedélyből álló egyéni szerepkörrel.
A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.
Jegyzetek
- Ehhez a biztonsági definícióhoz a
x-ms-client-id
fejléc használatával kell jelezni, hogy az alkalmazás melyik Azure Maps-erőforráshoz kér hozzáférést. Ez a Maps management API-ból szerezhető be.
A Authorization URL
az Azure nyilvános felhőpéldányára vonatkozik. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra ID-konfigurációkkal rendelkeznek.
* Az Azure-beli szerepköralapú hozzáférés-vezérlés az Azure felügyeleti síkjáról van konfigurálva az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy REST API-kon keresztül.
* Az Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esetben.
- További információ a Microsoft identitásplatformról: A Microsoft identitásplatformjának áttekintése.
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Ez egy megosztott kulcs, amely akkor lesz kiépítve, ha Azure Maps-fiókot hoz létre az Azure Portalon, vagy PowerShell, CLI, Azure SDK-k vagy REST API használatával.
Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ez a kulcs használható főkulcsként abban a fiókban, amelyben ki vannak adva.
Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítését használja az Azure Maps REST API-k eléréséhez, hogy a kulcs biztonságosan tárolható legyen.
Típus:
apiKey
In:
query
SAS Token
Ez egy közös hozzáférésű jogosultságkód-jogkivonat az Azure Maps-erőforrás Sas listázása műveletéből jön létre az Azure felügyeleti síkon keresztül az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy REST API-kon keresztül.
Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonathoz használt lejárati időhöz, sebességhez és régióhoz. Más szóval az SAS-jogkivonattal az alkalmazások a megosztott kulcsnál biztonságosabb módon szabályozhatják a hozzáférést.
Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfiguráljon egy adott listát az engedélyezett forrásokról a térképfiók-erőforráson a leképezési visszaélések korlátozásához és az SAS-jogkivonat rendszeres megújításához.
Típus:
apiKey
In:
header
Példák
Get Tropical Storm Forecasts
Mintakérelem
GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year=2021&basinId=NP&govId=2
Mintaválasz
{
"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
}
}
}
]
}
Definíciók
Name | Description |
---|---|
basin |
Medence azonosítója |
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
A hiba részletei. |
Error |
Hibaválasz |
Geo |
Érvényes |
Geo |
Érvényes |
Geo |
Érvényes |
Geo |
Érvényes |
Geo |
Érvényes |
Geo |
Érvényes |
Geo |
Érvényes |
Geo |
Érvényes |
Json |
A válasz kívánt formátuma. Csak |
Lat |
Földrajzi szélességként és hosszúságként megadott hely. |
Radius |
Csapágy 0–90 = NE negyed; 90–180 = SE negyed; 180–270 = SW negyed; 270–360 = NW negyed. |
Storm |
Kormány által kiadott viharelőrejelzés |
Storm |
A kormány által kiadott előrejelzések listája |
Storm |
Akkor jelenik meg, ha details=true vagy radiiGeometry=true a kérelemben. |
Unit |
A megjelenített egység típusához társított numerikus azonosító érték. Az egységfordításhoz használható. A részletekért tekintse meg a Weather Servicest az Azure Mapsben . |
Weather |
Megadja, hogy az adatokat metrikaegységekben vagy angolszász egységekben adja vissza. Az alapértelmezett érték a metrika. |
Weather |
Adott egység adott, időjárással kapcsolatos értéke. |
Weather |
Előrejelzési ablak a viharra |
basinId
Medence azonosítója
Name | Típus | Description |
---|---|---|
AL |
string |
Atlanti |
CP |
string |
Csendes-óceán középső régiója |
EP |
string |
Csendes-óceán keleti régiója |
NI |
string |
Észak-Indiai-óceán |
NP |
string |
Északnyugati Csendes-óceán |
SI |
string |
Délnyugat-Indiai-óceán |
SP |
string |
Dél-Csendes-óceán |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
Name | Típus | Description |
---|---|---|
info |
object |
A további információk. |
type |
string |
A további információtípus. |
ErrorDetail
A hiba részletei.
Name | Típus | Description |
---|---|---|
additionalInfo |
A hiba további információi. |
|
code |
string |
A hibakód. |
details |
A hiba részletei. |
|
message |
string |
A hibaüzenet. |
target |
string |
A hibacél. |
ErrorResponse
Hibaválasz
Name | Típus | Description |
---|---|---|
error |
A hibaobjektum. |
GeoJsonGeometry
Érvényes GeoJSON
geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Pont, MultiPoint, Vonallánc, MultiLineString, Polygon, MultiPolygon és GeometryCollection. A részleteket az RFC 7946-os verziójában találja.
Name | Típus | Description |
---|---|---|
type |
Geo |
Megadja a típust |
GeoJsonGeometryCollection
Érvényes GeoJSON GeometryCollection
objektumtípus. A részleteket az RFC 7946-os verziójában találja.
Name | Típus | Description |
---|---|---|
geometries | GeoJsonGeometry[]: |
Érvényes geometriai objektumok listáját |
type |
string:
Geometry |
Megadja a típust |
GeoJsonLineString
Érvényes GeoJSON LineString
geometriatípus. A részleteket az RFC 7946-os verziójában találja.
Name | Típus | Description |
---|---|---|
coordinates |
number[] |
A geometria koordinátái |
type |
string:
Line |
Megadja a típust |
GeoJsonMultiLineString
Érvényes GeoJSON MultiLineString
geometriatípus. A részleteket az RFC 7946-os verziójában találja.
Name | Típus | Description |
---|---|---|
coordinates |
number[] |
A geometria koordinátái |
type |
string:
Multi |
Megadja a típust |
GeoJsonMultiPoint
Érvényes GeoJSON MultiPoint
geometriatípus. A részleteket az RFC 7946-os verziójában találja.
Name | Típus | Description |
---|---|---|
coordinates |
number[] |
A geometria koordinátái |
type |
string:
Multi |
Megadja a típust |
GeoJsonMultiPolygon
Érvényes GeoJSON MultiPolygon
objektumtípus. A részleteket az RFC 7946-os verziójában találja.
Name | Típus | Description |
---|---|---|
coordinates |
number[] |
Az érvényes |
type |
string:
Multi |
Megadja a típust |
GeoJsonPoint
Érvényes GeoJSON Point
geometriatípus. A részleteket az RFC 7946-os verziójában találja.
Name | Típus | Description |
---|---|---|
coordinates |
number[] |
Az A |
type |
string:
Point |
Megadja a típust |
GeoJsonPolygon
Érvényes GeoJSON Polygon
geometriatípus. A részleteket az RFC 7946-os verziójában találja.
Name | Típus | Description |
---|---|---|
coordinates |
number[] |
A geometriatípus koordinátái |
type |
string:
Polygon |
Megadja a típust |
JsonFormat
A válasz kívánt formátuma. Csak json
a formátum támogatott.
Name | Típus | Description |
---|---|---|
json |
string |
LatLongPair
Földrajzi szélességként és hosszúságként megadott hely.
Name | Típus | Description |
---|---|---|
latitude |
number |
Latitude tulajdonság |
longitude |
number |
Hosszúság tulajdonság |
RadiusSector
Csapágy 0–90 = NE negyed; 90–180 = SE negyed; 180–270 = SW negyed; 270–360 = NW negyed.
Name | Típus | Description |
---|---|---|
beginBearing |
number |
A negyed elejének csapágyazása fokban. |
endBearing |
number |
A kvadráns végéről fokban csapágyazva. |
range |
number |
A kvadráns sugara, tengeri mérföldben. |
StormForecast
Kormány által kiadott viharelőrejelzés
Name | Típus | Description |
---|---|---|
dateTime |
string |
Az előrejelzés érvényes dátumideje, ISO8601 formátumban jelenik meg. |
initializedDateTime |
string |
Az előrejelzés létrehozásának dátuma, amely ISO8601 formátumban jelenik meg. |
location |
A vihar koordinátái |
|
maxWindGust |
A viharhoz kapcsolódó maximális széllökés sebesség. Lehet, hogy NULL értékű. |
|
status |
string |
A lehetséges állapotértékek a következők:
|
sustainedWind |
A viharhoz kapcsolódó maximális tartós szélsebesség. Lehet, hogy NULL értékű. |
|
windRadiiSummary |
Akkor jelenik meg, ha details=true vagy radiiGeometry=true a kérelemben. |
|
window |
Információkat tartalmaz a vihar előrejelzési ablakáról a megadott időszakban (nem a teljes kúpon). Ha a windowGeometry=true érték szerepel a kérelemben, ez az objektum geoJSON-adatokat tartalmaz az ablakgeometriához. |
StormForecastResult
A kormány által kiadott előrejelzések listája
Name | Típus | Description |
---|---|---|
nextLink |
string |
Az a hivatkozás, amely a visszaadott funkciók következő oldalára mutató hivatkozás. Ha ez az utolsó oldal, akkor nem ez a mező. |
results |
A kormány által kiadott előrejelzések listája |
StormWindRadiiSummary
Akkor jelenik meg, ha details=true vagy radiiGeometry=true a kérelemben.
Name | Típus | Description |
---|---|---|
dateTime |
string |
DateTime, amelynél a szélsugár összegzési adatai érvényesek, ISO8601 formátumban jelennek meg. |
radiiGeometry | GeoJsonGeometry: |
GeoJSON-objektum. A radiiGeometry=true kéréskor jelenik meg. A szélsugár-kvadránsok körvonalát ismerteti. |
radiusSectorData |
A szélsugár-kvadránsok ábrázolásához szükséges információkat tartalmazza. Csapágy 0–90 = NE kvadráns; 90–180 = SE negyed; 180–270 = SW negyed; 270–360 = NW negyed. |
|
windSpeed |
A radiusSectorData-hoz társított szélsebesség. |
UnitType
A megjelenített egység típusához társított numerikus azonosító érték. Az egységfordításhoz használható. A részletekért tekintse meg a Weather Servicest az Azure Mapsben .
Name | Típus | 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
Megadja, hogy az adatokat metrikaegységekben vagy angolszász egységekben adja vissza. Az alapértelmezett érték a metrika.
Name | Típus | Description |
---|---|---|
imperial |
string |
Adatokat ad vissza angolszász egységekben. A birodalmi rendszer néhány példaegysége a Fahrenheit és a mérföld. |
metric |
string |
Adatokat ad vissza metrikaegységekben. A metrikarendszer néhány példaegysége a Celsius és a kilométer. |
WeatherUnit
Adott egység adott, időjárással kapcsolatos értéke.
Name | Típus | Description |
---|---|---|
unit |
string |
A visszaadott érték egységtípusa. |
unitType |
A megjelenített egység típusához társított numerikus azonosító érték. Az egységfordításhoz használható. A részletekért tekintse meg a Weather Servicest az Azure Mapsben . |
|
value |
number |
Kerekített érték. |
WeatherWindow
Előrejelzési ablak a viharra
Name | Típus | Description |
---|---|---|
beginDateTime |
string |
A mozgásablak elejének DateTime időpontja, amely ISO8601 formátumban jelenik meg. |
beginStatus |
string |
Vihar állapota az ablak elején. |
endDateTime |
string |
DateTime a mozgási ablak végén, ISO8601 formátumban jelenik meg. |
endStatus |
string |
Vihar állapota az ablak végén. |
geometry | GeoJsonGeometry: |
Akkor jelenik meg, ha a windowGeometry=true a kérelemben. GeoJSON-objektum, amely koordinátákat tartalmaz, amelyek a megadott időkereten belül ismertetik a mozgási ablakot. |
left |
Az ablak bal oldalán lévő pont helye az időkeret idején. |
|
right |
Az ablak jobb oldalán lévő pont helye az időkeret végén. |