Partilhar via

Weather - Get Tropical Storm Forecast

  • Referência
Serviço:
Maps
Versão da API:
1.1

Usado para obter uma lista de tempestades tropicais previstas pelas agências nacionais de previsão meteorológica.

A Get Tropical Storm Forecasts API é um pedido HTTP GET que devolve previsões individuais de tempestades tropicais emitidas pelo governo. As informações sobre as tempestades tropicais previstas incluem, localização, estado, data em que a previsão foi criada, janela, velocidade do vento e raios do vento.

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

Name Em Necessário Tipo Description
format
 path True

JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.
api-version
 query True

string

Número da versão da API do Azure Maps.
basinId
 query True

basinId

Identificador da bacia
govId
 query True

integer

int32

ID da tempestade do governo
year
 query True

integer

int32

Ano do(s) ciclone(s)
details
 query

boolean

Quando verdadeiro, os dados de resumo dos raios de vento são incluídos na resposta
radiiGeometry
 query

boolean

Quando verdadeiro, os dados de resumo de raios de vento e os detalhes geoJSON são incluídos na resposta
unit
 query

WeatherDataUnit

Especifica para devolver os dados em unidades métricas ou unidades imperiais. O valor predefinido é métrica.
windowGeometry
 query

boolean

Quando verdadeiro, os dados de geometria de janela (geoJSON) são incluídos na resposta

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-client-id

string

Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta do Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão do Azure Maps. Para utilizar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientações.

Respostas

Name Tipo Description
200 OK

StormForecastResult

OK
Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os Fluxos Microsoft Entra OAuth 2.0 . Quando emparelhado com o controlo de acesso baseado em funções do Azure , pode ser utilizado para controlar o acesso às APIs REST do Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais contas de recursos ou sub-recursos do Azure Maps. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para as APIs REST do Azure Maps.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

  • Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso do Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps .

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * A utilização do SDK Web do Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

Esta é uma chave partilhada que é aprovisionada quando Cria uma conta do Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder às APIs REST do Azure Maps para que a sua chave possa ser armazenada em segurança.

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Tipo: apiKey
Em: header

Exemplos

Get Tropical Storm Forecasts

Pedido de amostra

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

Resposta da amostra

Código de estado:
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
        }
      }
    }
  ]
}

Definições

Name Description
basinId

Identificador da bacia
ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta a erros
GeoJsonGeometry

Um objeto de geometria válido GeoJSON . O tipo tem de ser um dos sete tipos de geometria GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.
GeoJsonGeometryCollection

Um tipo de objeto válido GeoJSON GeometryCollection . Consulte RFC 7946 para obter detalhes.
GeoJsonLineString

Um tipo de geometria válido GeoJSON LineString . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiLineString

Um tipo de geometria válido GeoJSON MultiLineString . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPoint

Um tipo de geometria válido GeoJSON MultiPoint . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPolygon

Um tipo de objeto válido GeoJSON MultiPolygon . Consulte RFC 7946 para obter detalhes.
GeoJsonPoint

Um tipo de geometria válido GeoJSON Point . Consulte RFC 7946 para obter detalhes.
GeoJsonPolygon

Um tipo de geometria válido GeoJSON Polygon . Consulte RFC 7946 para obter detalhes.
JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.
LatLongPair

Uma localização representada como latitude e longitude.
RadiusSector

Rolamento de 0 a 90 = quadrante NE; 90–180 = quadrante SE; 180-270 = quadrante SW; 270–360 = quadrante NW.
StormForecast

Previsão de tempestade emitida pelo governo
StormForecastResult

A lista de previsões emitidas pelo Governo
StormWindRadiiSummary

Apresentado quando details=true ou radiiGeometry=true no pedido.
UnitType

Valor de ID numérico associado ao tipo de unidade que está a ser apresentada. Pode ser utilizado para tradução de unidades. Veja Serviços de meteorologia no Azure Maps para obter detalhes.
WeatherDataUnit

Especifica para devolver os dados em unidades de métricas ou unidades imperiais. O valor predefinido é métrica.
WeatherUnit

Valor específico de uma determinada unidade relacionada com as condições meteorológicas.
WeatherWindow

Janela de previsão para a tempestade

basinId

Identificador da bacia

Name Tipo Description
AL

string

Atlântico
CP

string

Pacífico Central
EP

string

Pacífico Oriental
NI

string

Oceano Índico Do Norte
NP

string

Noroeste do Pacífico
SI

string

Sudoeste do Oceano Índico
SP

string

Pacífico Sul

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Resposta a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

GeoJsonGeometry

Um objeto de geometria válido GeoJSON . O tipo tem de ser um dos sete tipos de geometria GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.

Name Tipo Description
type

GeoJsonObjectType

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonGeometryCollection

Um tipo de objeto válido GeoJSON GeometryCollection . Consulte RFC 7946 para obter detalhes.

Name Tipo Description
geometries GeoJsonGeometry[]:

Contém uma lista de objetos de geometria válidos GeoJSON . Tenha em atenção que as coordenadas em GeoJSON estão por ordem x, y (longitude, latitude).
type string:

GeometryCollection

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonLineString

Um tipo de geometria válido GeoJSON LineString . Consulte RFC 7946 para obter detalhes.

Name Tipo Description
coordinates

number[]

Coordenadas para a GeoJson LineString geometria.
type string:

LineString

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiLineString

Um tipo de geometria válido GeoJSON MultiLineString . Consulte RFC 7946 para obter detalhes.

Name Tipo Description
coordinates

number[]

Coordenadas para a GeoJson MultiLineString geometria.
type string:

MultiLineString

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPoint

Um tipo de geometria válido GeoJSON MultiPoint . Consulte RFC 7946 para obter detalhes.

Name Tipo Description
coordinates

number[]

Coordenadas para a GeoJson MultiPoint geometria.
type string:

MultiPoint

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPolygon

Um tipo de objeto válido GeoJSON MultiPolygon . Consulte RFC 7946 para obter detalhes.

Name Tipo Description
coordinates

number[]

Contém uma lista de objetos válidos GeoJSON Polygon . Tenha em atenção que as coordenadas em GeoJSON estão por ordem x, y (longitude, latitude).
type string:

MultiPolygon

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPoint

Um tipo de geometria válido GeoJSON Point . Consulte RFC 7946 para obter detalhes.

Name Tipo Description
coordinates

number[]

A Position é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são longitude e latitude, precisamente por essa ordem. Altitude/Elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.
type string:

Point

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPolygon

Um tipo de geometria válido GeoJSON Polygon . Consulte RFC 7946 para obter detalhes.

Name Tipo Description
coordinates

number[]

Coordenadas para o GeoJson Polygon tipo de geometria.
type string:

Polygon

Especifica o GeoJSON tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.

Name Tipo Description
json

string

O Formato de Intercâmbio de Dados de Notação de Objetos JavaScript

LatLongPair

Uma localização representada como latitude e longitude.

Name Tipo Description
latitude

number

Propriedade Latitude
longitude

number

Propriedade Longitude

RadiusSector

Rolamento de 0 a 90 = quadrante NE; 90–180 = quadrante SE; 180-270 = quadrante SW; 270–360 = quadrante NW.

Name Tipo Description
beginBearing

number

Tendo, em graus, o início do quadrante.
endBearing

number

Tendo, em graus, o fim do quadrante.
range

number

O raio do quadrante, em milhas náuticas.

StormForecast

Previsão de tempestade emitida pelo governo

Name Tipo Description
dateTime

string

Datetime a previsão é válida, apresentada no formato ISO8601.
initializedDateTime

string

Datetime a previsão foi criada, apresentada no formato ISO8601.
location

LatLongPair

Coordenadas da tempestade
maxWindGust

WeatherUnit

Velocidade máxima da rajada de vento associada à tempestade. Pode ser NULO.
status

string

Os valores de estado possíveis incluem:

  • Tempestade ciclónica
  • Depressão profunda
  • Depressão
  • Tempestade ciclónica extremamente severa
  • Categoria de furacão (1-5)
  • Ciclone tropical intenso
  • Tempestade tropical moderada
  • Ciclone pós-tropical
  • Potencial ciclone tropical
  • Tempestade ciclónica severa
  • Tempestade tropical severa
  • Subtropical
  • Tempestade super ciclónica
  • Ciclone tropical
  • Categoria de ciclone tropical (1-5)
  • Depressão tropical
  • Perturbação tropical
  • Tempestade tropical
  • Tufão
  • Ciclone tropical muito intenso
  • Tempestade ciclónica muito severa
  • Tufão muito forte
  • Tufão violento
sustainedWind

WeatherUnit

Velocidade máxima sustentada do vento associada à tempestade. Pode ser NULO.
windRadiiSummary

StormWindRadiiSummary[]

Apresentado quando details=true ou radiiGeometry=true no pedido.
window

WeatherWindow

Contém informações sobre a janela de previsão do storm durante o período de tempo especificado (não todo o cone). Se windowGeometry=true no pedido, este objeto incluirá detalhes geoJSON para geometria da janela.

StormForecastResult

A lista de previsões emitidas pelo Governo

Name Tipo Description
nextLink

string

É a ligação para a página seguinte das funcionalidades devolvidas. Se for a última página, não este campo.
results

StormForecast[]

A lista de previsões emitidas pelo Governo

StormWindRadiiSummary

Apresentado quando details=true ou radiiGeometry=true no pedido.

Name Tipo Description
dateTime

string

DateTime para o qual os dados de resumo de raios de vento são válidos, apresentados no formato ISO8601.
radiiGeometry GeoJsonGeometry:

Objeto GeoJSON. Apresentado quando radiiGeometry=true no pedido. Descreve o contorno dos quadrantes do raio do vento.
radiusSectorData

RadiusSector[]

Contém as informações necessárias para desenhar quadrantes de raios de vento. Rolamento 0-90 = quadrante NE; 90-180 = quadrante SE; 180-270 = quadrante SW; 270-360 = quadrante NW.
windSpeed

WeatherUnit

Velocidade do vento associada ao radiusSectorData.

UnitType

Valor de ID numérico associado ao tipo de unidade que está a ser apresentada. Pode ser utilizado para tradução de unidades. Veja Serviços de meteorologia no Azure Maps para obter detalhes.

Name 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 para devolver os dados em unidades de métricas ou unidades imperiais. O valor predefinido é métrica.

Name Tipo Description
imperial

string

Devolver dados em unidades imperiais. Algumas unidades de exemplo do sistema imperial são Fahrenheit e mile.
metric

string

Devolver dados em unidades de métricas. Algumas unidades de exemplo do sistema de métricas são Celsius e km.

WeatherUnit

Valor específico de uma determinada unidade relacionada com as condições meteorológicas.

Name Tipo Description
unit

string

Tipo de unidade para o valor devolvido.
unitType

UnitType

Valor de ID numérico associado ao tipo de unidade que está a ser apresentada. Pode ser utilizado para tradução de unidades. Veja Serviços de meteorologia no Azure Maps para obter detalhes.
value

number

Valor arredondado.

WeatherWindow

Janela de previsão para a tempestade

Name Tipo Description
beginDateTime

string

DateTime do início da janela de movimento, apresentado no formato ISO8601.
beginStatus

string

Estado da tempestade no início da janela.
endDateTime

string

DateTime do fim da janela de movimento, apresentado no formato ISO8601.
endStatus

string

Estado da tempestade no final da janela.
geometry GeoJsonGeometry:

Apresentado quando windowGeometry=true no pedido. Objeto GeoJSON que contém coordenadas que descrevem a janela de movimento durante o período de tempo especificado.
left

LatLongPair

Localização do ponto no lado esquerdo da janela no momento do período de tempo.
right

LatLongPair

Localização do ponto no lado direito da janela no final do período de tempo.