Compartir a través de

Weather - Get Tropical Storm Forecast

  • Referencia
Servicio:
Maps
Versión de la API:
1.1

Utilice para obtener una lista de las tormentas tropicales previstas por las agencias nacionales de previsión meteorológica.

La Get Tropical Storm Forecasts API es una solicitud HTTP GET que devuelve previsiones de tormenta tropical emitidas por el gobierno individuales. La información sobre las tormentas tropicales previstas incluye, ubicación, estado, fecha en que se creó la previsión, ventana, velocidad del viento y radios de viento.

GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}
Con parámetros opcionales: 
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}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
format
 path True

JsonFormat

Formato deseado de la respuesta. Solo se admite el formato json.
api-version
 query True

string

Número de versión de la API de Azure Maps.
basinId
 query True

basinId

Identificador de cuenca
govId
 query True

integer

int32

Id. de tormenta de administración pública
year
 query True

integer

int32

Año del ciclón
details
 query

boolean

Cuando es true, los datos de resumen de los radios de viento se incluyen en la respuesta.
radiiGeometry
 query

boolean

Cuando es true, los datos de resumen de los radios de viento y los detalles geoJSON se incluyen en la respuesta.
unit
 query

WeatherDataUnit

Especifica que se devuelven los datos en unidades métricas o unidades imperiales. El valor predeterminado es la métrica.
windowGeometry
 query

boolean

Cuando es true, los datos de geometría de ventana (geoJSON) se incluyen en la respuesta.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-id

string

Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Id. de Entra de Microsoft. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar la seguridad de id. de Entra de Microsoft en Azure Maps, consulte los siguientes artículos para obtener instrucciones.

Respuestas

Nombre Tipo Description
200 OK

StormForecastResult

Aceptar
Other Status Codes

ErrorResponse

Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0 . Cuando se empareja con el control de acceso basado en rol de Azure , se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio mediante un rol integrado o un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

  • Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps .

Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de id. de Microsoft Entra. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST. * El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Se trata de una clave compartida que se aprovisiona al crear una cuenta de Azure Maps en Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el enfoque de aplicaciones cliente confidenciales para acceder a las API REST de Azure Maps para que la clave se pueda almacenar de forma segura.

Tipo: apiKey
En: query

SAS Token

Se trata de un token de firma de acceso compartido que se crea a partir de la operación List SAS en el recurso de Azure Maps a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. En otras palabras, el token de SAS se puede usar para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta de asignación para limitar la representación del abuso y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

Get Tropical Storm Forecasts

Solicitud de ejemplo

GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year=2021&basinId=NP&govId=2

Respuesta de muestra

status code:
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
        }
      }
    }
  ]
}

Definiciones

Nombre Description
basinId

Identificador de cuenca
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
ErrorDetail

Detalle del error.
ErrorResponse

Respuesta de error
GeoJsonGeometry

Objeto geometry válido GeoJSON . El tipo debe ser uno de los siete tipos de geometría GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon y GeometryCollection. Consulte RFC 7946 para obtener más información.
GeoJsonGeometryCollection

Tipo de objeto válido GeoJSON GeometryCollection . Consulte RFC 7946 para obtener más información.
GeoJsonLineString

Un tipo de geometría válido GeoJSON LineString . Consulte RFC 7946 para obtener más información.
GeoJsonMultiLineString

Un tipo de geometría válido GeoJSON MultiLineString . Consulte RFC 7946 para obtener más información.
GeoJsonMultiPoint

Un tipo de geometría válido GeoJSON MultiPoint . Consulte RFC 7946 para obtener más información.
GeoJsonMultiPolygon

Tipo de objeto válido GeoJSON MultiPolygon . Consulte RFC 7946 para obtener más información.
GeoJsonPoint

Un tipo de geometría válido GeoJSON Point . Consulte RFC 7946 para obtener más información.
GeoJsonPolygon

Un tipo de geometría válido GeoJSON Polygon . Consulte RFC 7946 para obtener más información.
JsonFormat

Formato deseado de la respuesta. Solo se admite el formato json.
LatLongPair

Una ubicación representada como latitud y longitud.
RadiusSector

Rodamiento 0–90 = cuadrante NE; 90–180 = cuadrante SE; 180–270 = cuadrante SW; 270–360 = cuadrante NW.
StormForecast

Previsión de tormentas emitida por el gobierno
StormForecastResult

Lista de previsiones emitidas por el Gobierno
StormWindRadiiSummary

Se muestra cuando details=true o radiiGeometry=true en la solicitud.
UnitType

Valor de identificador numérico asociado al tipo de unidad que se muestra. Se puede usar para la traducción unitaria. Consulte Servicios meteorológicos en Azure Maps para más información.
WeatherDataUnit

Especifica que se devuelvan los datos en unidades métricas o unidades imperiales. El valor predeterminado es la métrica.
WeatherUnit

Valor específico de una unidad determinada relacionada con el tiempo.
WeatherWindow

Ventana de previsión de la tormenta

basinId

Identificador de cuenca

Nombre Tipo Description
AL

string

Atlántico
CP

string

Pacífico Central
EP

string

Pacífico oriental
NI

string

Océano Índico norte
NP

string

Pacífico noroeste
SI

string

Océano Índico suroeste
SP

string

Pacífico sur

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorDetail[]

Los detalles del error.
message

string

El mensaje de error.
target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

GeoJsonGeometry

Objeto geometry válido GeoJSON . El tipo debe ser uno de los siete tipos de geometría GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon y GeometryCollection. Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
type

GeoJsonObjectType

Especifica el tipo GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonGeometryCollection

Tipo de objeto válido GeoJSON GeometryCollection . Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
geometries GeoJsonGeometry[]:

Contiene una lista de objetos geometry válidos GeoJSON . Tenga en cuenta que las coordenadas de GeoJSON están en x, y order (longitud, latitud).
type string:

GeometryCollection

Especifica el tipo GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonLineString

Un tipo de geometría válido GeoJSON LineString . Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
coordinates

number[]

Coordenadas de la GeoJson LineString geometría.
type string:

LineString

Especifica el tipo GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonMultiLineString

Un tipo de geometría válido GeoJSON MultiLineString . Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
coordinates

number[]

Coordenadas de la GeoJson MultiLineString geometría.
type string:

MultiLineString

Especifica el tipo GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonMultiPoint

Un tipo de geometría válido GeoJSON MultiPoint . Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
coordinates

number[]

Coordenadas de la GeoJson MultiPoint geometría.
type string:

MultiPoint

Especifica el tipo GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonMultiPolygon

Tipo de objeto válido GeoJSON MultiPolygon . Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
coordinates

number[]

Contiene una lista de objetos válidos GeoJSON Polygon . Tenga en cuenta que las coordenadas de GeoJSON están en x, y order (longitud, latitud).
type string:

MultiPolygon

Especifica el tipo GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonPoint

Un tipo de geometría válido GeoJSON Point . Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
coordinates

number[]

Un Position es una matriz de números con dos o más elementos. Los dos primeros elementos son longitud y latitud, precisamente en ese orden. Altitud/Elevación es un tercer elemento opcional. Consulte RFC 7946 para obtener más información.
type string:

Point

Especifica el tipo GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonPolygon

Un tipo de geometría válido GeoJSON Polygon . Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
coordinates

number[]

Coordenadas para el GeoJson Polygon tipo de geometría.
type string:

Polygon

Especifica el tipo GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

JsonFormat

Formato deseado de la respuesta. Solo se admite el formato json.

Nombre Tipo Description
json

string

Formato de intercambio de datos de notación de objetos JavaScript

LatLongPair

Una ubicación representada como latitud y longitud.

Nombre Tipo Description
latitude

number

Propiedad Latitude
longitude

number

Longitud (propiedad)

RadiusSector

Rodamiento 0–90 = cuadrante NE; 90–180 = cuadrante SE; 180–270 = cuadrante SW; 270–360 = cuadrante NW.

Nombre Tipo Description
beginBearing

number

Rodamiento, en grados, del principio del cuadrante.
endBearing

number

Rodamiento, en grados, del final del cuadrante.
range

number

Radio del cuadrante, en millas marinas.

StormForecast

Previsión de tormentas emitida por el gobierno

Nombre Tipo Description
dateTime

string

Fecha y hora en que la previsión es válida, que se muestra en formato ISO8601.
initializedDateTime

string

Fecha y hora en que se creó la previsión, que se muestra en formato ISO8601.
location

LatLongPair

Coordenadas de la tormenta
maxWindGust

WeatherUnit

Velocidad máxima del viento asociada a la tormenta. Puede ser NULL.
status

string

Entre los valores de estado posibles se incluyen:

  • Tormenta ciclónica
  • Depresión profunda
  • Depresión
  • Tormenta ciclonicia extremadamente grave
  • Categoría huracán (1-5)
  • Ciclón tropical intenso
  • Tormenta tropical moderada
  • Ciclón post tropical
  • Ciclon tropical potencial
  • Tormenta ciclónica grave
  • Tormenta tropical severa
  • Subtropical
  • Tormenta superciclónica
  • Ciclón tropical
  • Categoría ciclón tropical (1-5)
  • Depresión tropical
  • Alteración tropical
  • Tormenta tropical
  • Tifón
  • Ciclón tropical muy intenso
  • Tormenta ciclónica muy grave
  • Tifón muy fuerte
  • Tifón violento
sustainedWind

WeatherUnit

Velocidad máxima de viento sostenido asociada a la tormenta. Puede ser NULL.
windRadiiSummary

StormWindRadiiSummary[]

Se muestra cuando details=true o radiiGeometry=true en la solicitud.
window

WeatherWindow

Contiene información sobre la ventana de previsión de la tormenta durante el período de tiempo especificado (no el cono completo). Si windowGeometry=true en la solicitud, este objeto incluirá detalles geoJSON para la geometría de ventana.

StormForecastResult

Lista de previsiones emitidas por el Gobierno

Nombre Tipo Description
nextLink

string

es el vínculo a la página siguiente de las características devueltas. Si es la última página, no se trata de este campo.
results

StormForecast[]

Lista de previsiones emitidas por el Gobierno

StormWindRadiiSummary

Se muestra cuando details=true o radiiGeometry=true en la solicitud.

Nombre Tipo Description
dateTime

string

DateTime para el que los datos de resumen de los radios de viento son válidos, se muestran en formato ISO8601.
radiiGeometry GeoJsonGeometry:

Objeto GeoJSON. Se muestra cuando radiiGeometry=true en la solicitud. Describe el contorno de los cuadrantes del radio del viento.
radiusSectorData

RadiusSector[]

Contiene la información necesaria para trazar cuadrantes de radio del viento. Rodamiento 0–90 = cuadrante NE; 90–180 = cuadrante SE; 180–270 = cuadrante SW; 270–360 = cuadrante NW.
windSpeed

WeatherUnit

Velocidad del viento asociada con radiusSectorData.

UnitType

Valor de identificador numérico asociado al tipo de unidad que se muestra. Se puede usar para la traducción unitaria. Consulte Servicios meteorológicos en Azure Maps para más información.

Nombre Tipo 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

Especifica que se devuelvan los datos en unidades métricas o unidades imperiales. El valor predeterminado es la métrica.

Nombre Tipo Description
imperial

string

Devuelve datos en unidades imperiales. Algunas unidades de ejemplo del sistema imperial son Fahrenheit y milla.
metric

string

Devolver datos en unidades de métricas. Algunas unidades de ejemplo del sistema de métricas son Celsius y kilómetro.

WeatherUnit

Valor específico de una unidad determinada relacionada con el tiempo.

Nombre Tipo Description
unit

string

Tipo de unidad para el valor devuelto.
unitType

UnitType

Valor de identificador numérico asociado al tipo de unidad que se muestra. Se puede usar para la traducción unitaria. Consulte Servicios meteorológicos en Azure Maps para más información.
value

number

Valor redondeado.

WeatherWindow

Ventana de previsión de la tormenta

Nombre Tipo Description
beginDateTime

string

DateTime del principio de la ventana de movimiento, que se muestra en ISO8601 formato.
beginStatus

string

Estado de Storm al principio de la ventana.
endDateTime

string

DateTime del final de la ventana de movimiento, que se muestra en formato ISO8601.
endStatus

string

Estado de Storm al final de la ventana.
geometry GeoJsonGeometry:

Se muestra cuando windowGeometry=true en la solicitud. Objeto GeoJSON que contiene coordenadas que describen la ventana de movimiento durante el período de tiempo especificado.
left

LatLongPair

Ubicación del punto en el lado izquierdo de la ventana en el momento del período de tiempo.
right

LatLongPair

Ubicación del punto en el lado derecho de la ventana al final del período de tiempo.