Weather - Get Tropical Storm Forecast

Ссылка

Служба:: Maps

Версия API:: 1.1

Используйте для получения списка тропических штормов, прогнозируемых национальными агентствами по прогнозированию погоды.

API Get Tropical Storm Forecasts представляет собой HTTP-запрос GET , который возвращает индивидуальные прогнозы тропических штормов, выпущенные правительством. Информация о прогнозируемых тропических штормах включает в себя местоположение, статус, дату создания прогноза, окно, скорость ветра и радиусы ветра.

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

Имя	В	Обязательно	Тип	Описание
format	path	True	JsonFormat	Требуемый формат ответа. Поддерживается только `json` формат.
api-version	query	True	string	Номер версии API Azure Maps.
basinId	query	True	basinId	Идентификатор бассейна
govId	query	True	integer (int32)	Правительственный шторм Id
year	query	True	integer (int32)	Год циклона (циклонов)
details	query		boolean	Если значение равно true, в ответ включаются сводные данные о радиусах ветра
radiiGeometry	query		boolean	Если значение равно true, в ответ включаются сводные данные о радиусах ветра и сведения о geoJSON
unit	query		WeatherDataUnit	Указывает, что данные возвращаются в метрических или британских единицах. Значение по умолчанию — metric.
windowGeometry	query		boolean	Если значение true, данные геометрии окна (geoJSON) включаются в ответ

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности идентификатора Microsoft Entra. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Сведения о том, как использовать безопасность идентификатора Microsoft Entra в Azure Maps, см. в следующих статьях .

Ответы

Имя	Тип	Описание
200 OK	StormForecastResult	ХОРОШО
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

Безопасность

AADToken

Это потоки Microsoft Entra OAuth 2.0. При паре с доступом на основе ролей Azure его можно использовать для управления доступом к REST API Azure Maps. Управление доступом на основе ролей Azure используется для назначения доступа к одной или нескольким учетным записям ресурсов Azure Maps или вложенным ресурсам. Доступ к любому пользователю, группе или субъекту-службе можно предоставить через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для REST API Azure Maps.

Для реализации сценариев рекомендуется просматривать концепции проверки подлинности . В целом, это определение безопасности предоставляет решение для моделирования приложений через объекты, способные управлять доступом в определенных API и областях.

Примечания.

Для этого определения безопасности требуется использовать заголовок x-ms-client-id, чтобы указать, к какой ресурсу Azure Maps приложение запрашивает доступ. Это можно получить из API управления карт.

Authorization URL зависит от экземпляра общедоступного облака Azure. В национальных облаках есть уникальные URL-адреса авторизации и конфигурации идентификатора Microsoft Entra. * Управление доступом на основе ролей Azure настраивается с плоскости управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API. * Использование веб-пакета SDK Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.

Дополнительные сведения о платформе удостоверений Майкрософт см. в обзоре платформы удостоверений Майкрософт.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, подготовленный при создания учетной записи Azure Maps на портале Azure или с помощью PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого ключа любой приложение может получить доступ ко всем REST API. Другими словами, этот ключ можно использовать в качестве главного ключа в учетной записи, в которую они выданы.

Для общедоступных приложений мы рекомендуем использовать конфиденциальные клиентские приложения, подход для доступа к REST API Azure Maps, чтобы ваш ключ можно было безопасно хранить.

Тип: apiKey
В: query

SAS Token

Это маркер подписанного URL-адреса создается из операции SAS списка на ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого маркера любой приложению разрешен доступ с помощью управления доступом на основе ролей Azure и точного управления сроком действия, скоростью и регионами, используемыми для конкретного маркера. Другими словами, маркер SAS можно использовать для разрешения приложений управлять доступом более защищенным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи карты карты, чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Тип: apiKey
В: header

Примеры

Get Tropical Storm Forecasts

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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
        }
      }
    }
  ]
}

Определения

Имя	Описание
basinId	Идентификатор бассейна
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
GeoJsonGeometry	Допустимый объект `GeoJSON` геометрии. Тип должен быть одним из семи допустимых типов геометрии GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в RFC 7946.
GeoJsonGeometryCollection	Допустимый тип объекта `GeoJSON GeometryCollection`. Дополнительные сведения см. в RFC 7946.
GeoJsonLineString	Допустимый тип геометрии `GeoJSON LineString`. Дополнительные сведения см. в RFC 7946.
GeoJsonMultiLineString	Допустимый тип геометрии `GeoJSON MultiLineString`. Дополнительные сведения см. в RFC 7946.
GeoJsonMultiPoint	Допустимый тип геометрии `GeoJSON MultiPoint`. Дополнительные сведения см. в RFC 7946.
GeoJsonMultiPolygon	Допустимый тип объекта `GeoJSON MultiPolygon`. Дополнительные сведения см. в RFC 7946.
GeoJsonPoint	Допустимый тип геометрии `GeoJSON Point`. Дополнительные сведения см. в RFC 7946.
GeoJsonPolygon	Допустимый тип геометрии `GeoJSON Polygon`. Дополнительные сведения см. в RFC 7946.
JsonFormat	Требуемый формат ответа. Поддерживается только `json` формат.
LatLongPair	Расположение, представленное в виде широты и долготы.
RadiusSector	Направление 0–90 = северо-восточный квадрант; 90–180 = юго-восточный квадрант; 180–270 = квадрант SW; 270–360 = Северо-Западный квадрант.
StormForecast	Правительственный прогноз шторма
StormForecastResult	Перечень прогнозов, выпускаемых Правительством Российской Федерации
StormWindRadiiSummary	Отображается, когда details=true или radiiGeometry=true в запросе.
UnitType	Числовое значение ID, связанное с типом отображаемой единицы измерения. Может использоваться для перевода единиц измерения. Дополнительные сведения см. в статье Службы погоды в Azure Maps .
WeatherDataUnit	Указывает, что данные возвращаются в метрических или британских единицах. Значение по умолчанию — metric.
WeatherUnit	Удельное значение данной единицы, связанное с погодой.
WeatherWindow	Окно прогноза шторма

basinId

Перечисление

Идентификатор бассейна

Значение	Описание
AL	Атлантический
CP	Центральная часть Тихого океана
EP	Восточная часть Тихого океана
NI	Северная часть Индийского океана
NP	Северо-западная часть Тихого океана
SI	Юго-западная часть Индийского океана
SP	Южно-Тихоокеанский регион

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

GeoJsonGeometry

Object

Допустимый объект GeoJSON геометрии. Тип должен быть одним из семи допустимых типов геометрии GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
type	GeoJsonObjectType	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonGeometryCollection

Object

Допустимый тип объекта GeoJSON GeometryCollection. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Содержит список допустимых `GeoJSON` геометрических объектов. примечание координат в GeoJSON находятся в порядке x, y (долгота, широта).
type	string: GeometryCollection	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonLineString

Object

Допустимый тип геометрии GeoJSON LineString. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
coordinates	number[] (double)	Координаты геометрии `GeoJson LineString`.
type	string: LineString	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonMultiLineString

Object

Допустимый тип геометрии GeoJSON MultiLineString. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
coordinates	number[] (double)	Координаты геометрии `GeoJson MultiLineString`.
type	string: MultiLineString	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonMultiPoint

Object

Допустимый тип геометрии GeoJSON MultiPoint. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
coordinates	number[] (double)	Координаты геометрии `GeoJson MultiPoint`.
type	string: MultiPoint	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonMultiPolygon

Object

Допустимый тип объекта GeoJSON MultiPolygon. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
coordinates	number[] (double)	Содержит список допустимых объектов `GeoJSON Polygon`. примечание координат в GeoJSON находятся в порядке x, y (долгота, широта).
type	string: MultiPolygon	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonPoint

Object

Допустимый тип геометрии GeoJSON Point. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
coordinates	number[] (double)	`Position` — это массив чисел с двумя или более элементами. Первые два элемента — это долготы и широты, точно в этом порядке. высоты или высоты является необязательным третьим элементом. Дополнительные сведения см. в RFC 7946.
type	string: Point	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonPolygon

Object

Допустимый тип геометрии GeoJSON Polygon. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
coordinates	number[] (double)	Координаты для типа геометрии `GeoJson Polygon`.
type	string: Polygon	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

JsonFormat

Перечисление

Требуемый формат ответа. Поддерживается только json формат.

Значение	Описание
json	формат обмена данными для объектов JavaScript

LatLongPair

Object

Расположение, представленное в виде широты и долготы.

Имя	Тип	Описание
latitude	number (double)	Свойство Latitude
longitude	number (double)	Свойство Долготы

RadiusSector

Object

Направление 0–90 = северо-восточный квадрант; 90–180 = юго-восточный квадрант; 180–270 = квадрант SW; 270–360 = Северо-Западный квадрант.

Имя	Тип	Описание
beginBearing	number (double)	Направление в градусах от начала квадранта.
endBearing	number (double)	Направление в градусах от конца квадранта.
range	number (double)	Радиус квадранта, в морских милях.

StormForecast

Object

Правительственный прогноз шторма

Имя	Тип	Описание
dateTime	string	Datetime прогноз действующий, отображается в ISO8601 формате.
initializedDateTime	string	Datetime — был создан прогноз, отображается в ISO8601 формате.
location	LatLongPair	Координаты шторма
maxWindGust	WeatherUnit	Максимальная скорость порывов ветра, связанная со штормом. Может иметь значение NULL.
status	string	Возможные значения статуса: Циклонический шторм Глубокая депрессия Депрессия Чрезвычайно сильный циклонический шторм Категория урагана (1-5) Интенсивный тропический циклон Умеренный тропический шторм Посттропический циклон Возможный тропический циклон Сильный циклонический шторм Сильный тропический шторм Субтропический Суперциклонический шторм Тропический циклон Категория тропических циклонов (1-5) Тропическая депрессия Тропические возмущения Тропический шторм Тайфун Очень интенсивный тропический циклон Очень сильный циклонический шторм Очень сильный тайфун Жестокий тайфун
sustainedWind	WeatherUnit	Максимальная устойчивая скорость ветра, связанная со штормом. Может иметь значение NULL.
windRadiiSummary	StormWindRadiiSummary[]	Отображается, когда details=true или radiiGeometry=true в запросе.
window	WeatherWindow	Содержит информацию об окне прогноза шторма за указанный период времени (а не обо всем конусе). Если windowGeometry=true в запросе, этот объект будет включать детали geoJSON для геометрии окна.

StormForecastResult

Object

Перечень прогнозов, выпускаемых Правительством Российской Федерации

Имя	Тип	Описание
nextLink	string	Ссылка на следующую страницу возвращаемых функций. Если это последняя страница, это поле не отображается.
results	StormForecast[]	Перечень прогнозов, выпускаемых Правительством Российской Федерации

StormWindRadiiSummary

Object

Отображается, когда details=true или radiiGeometry=true в запросе.

Имя	Тип	Описание
dateTime	string	DateTime, для которого действительны сводные данные по радиусам ветра, отображаются в ISO8601 формате.
radiiGeometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Объект GeoJSON. Отображается, когда radiiGeometry=true в запросе. Описывает контур квадрантов радиуса ветра.
radiusSectorData	RadiusSector[]	Содержит информацию, необходимую для построения квадрантов радиуса ветра. Направление 0–90 = северо-восточный квадрант; 90–180 = юго-восточный квадрант; 180–270 = квадрант SW; 270–360 = Северо-Западный квадрант.
windSpeed	WeatherUnit	Скорость ветра, связанная с radiusSectorData.

UnitType

Перечисление

Числовое значение ID, связанное с типом отображаемой единицы измерения. Может использоваться для перевода единиц измерения. Дополнительные сведения см. в статье Службы погоды в Azure Maps .

Значение	Описание
0	футы
1	дюймы
10	метры в секунду (м/с)
11	гектопаскали
12	дюймы ртутного столба
13	килопаскали
14	миллибары
15	миллиметры ртутного столба (мм рт. столба)
16	poundsPerSquareInch (фунт/кв. дюйм)
17	Цельсия
18	Фаренгейт
19	Кельвин
2	мили
20	процент
21	плавать
22	целое число
3	миллиметр
31	МикрограммКубический метр воздуха
4	сантиметр
5	метр
6	километр
7	километры в час (км/час)
8	узлы
9	миль в час

WeatherDataUnit

Перечисление

Указывает, что данные возвращаются в метрических или британских единицах. Значение по умолчанию — metric.

Значение	Описание
imperial	Возвращайте данные в британских единицах. Некоторыми примерами единиц имперской системы являются Фаренгейт и миля.
metric	Возвращайте данные в метрических единицах. Некоторыми примерами единиц метрической системы являются Цельсий и километр.

WeatherUnit

Object

Удельное значение данной единицы, связанное с погодой.

Имя	Тип	Описание
unit	string	Тип единицы измерения для возвращаемого значения.
unitType	UnitType (int32)	Числовое значение ID, связанное с типом отображаемой единицы измерения. Может использоваться для перевода единиц измерения. Дополнительные сведения см. в статье Службы погоды в Azure Maps .
value	number (float)	Округленное значение.

WeatherWindow

Object

Окно прогноза шторма

Имя	Тип	Описание
beginDateTime	string (date-time)	DateTime начала окна движения, отображается в формате ISO8601.
beginStatus	string	Статус шторма в начале окна.
endDateTime	string (date-time)	DateTime окончания окна движения, отображается в формате ISO8601.
endStatus	string	Статус шторма в конце окна.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Отображается, когда windowGeometry=true в запросе. Объект GeoJSON, содержащий координаты, описывающие окно движения в течение указанного таймфрейма.
left	LatLongPair	Расположение точки в левой части окна в момент таймфрейма.
right	LatLongPair	Расположение точки в правой части окна в конце таймфрейма.

Поделиться через

Weather - Get Tropical Storm Forecast

Параметры URI

Заголовок запроса

Ответы

Безопасность

AADToken

Примечания.

Области

subscription-key

SAS Token

Примеры

Get Tropical Storm Forecasts

Образец запроса

Пример ответа

Определения

basinId

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonGeometry

GeoJsonGeometryCollection

GeoJsonLineString

GeoJsonMultiLineString

GeoJsonMultiPoint

GeoJsonMultiPolygon

GeoJsonPoint

GeoJsonPolygon

JsonFormat

LatLongPair

RadiusSector

StormForecast

StormForecastResult

StormWindRadiiSummary

UnitType

WeatherDataUnit

WeatherUnit

WeatherWindow