Weather - Get Tropical Storm Forecast

Ссылка

Служба:: Maps

Версия API:: 1.1

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

Get Tropical Storm Forecasts API — это 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	Идентификатор шторма для правительства
year	query	True	integer int32	Год циклона
details	query		boolean	Если задано значение true, в ответ включаются сводные данные по радиусам ветра.
radiiGeometry	query		boolean	Если задано значение true, в ответ включаются сводные данные по радиусам ветра и сведения о geoJSON.
unit	query		WeatherDataUnit	Указывает, как возвращать данные в единицах метрик или в единицах империи. Значение по умолчанию — метрика.
windowGeometry	query		boolean	Если задано значение true, данные геометрии окна (geoJSON) включаются в ответ.

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

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи плоскости управления Azure Maps. Инструкции по использованию безопасности Microsoft Entra ID в 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-адреса, созданный с помощью операции List SAS в ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

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

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи map , чтобы ограничить использование маркера 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` объект geometry. Тип должен быть одним из семи допустимых геометрических типов 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 = квадрант NE; 90–180 = квадрант SE; 180–270 = квадрант SW; 270–360 = Квадрант NW.
StormForecast	Правительственный прогноз шторма
StormForecastResult	Список опубликованных правительством прогнозов
StormWindRadiiSummary	Отображается, когда details=true или radiiGeometry=true в запросе.
UnitType	Числовое значение идентификатора, связанное с типом отображаемой единицы измерения. Может использоваться для преобразования единиц. Дополнительные сведения см. в статье Службы погоды в Azure Maps .
WeatherDataUnit	Указывает, как возвращать данные в единицах метрик или в единицах империи. Значение по умолчанию — метрика.
WeatherUnit	Конкретное значение заданной единицы измерения, связанное с погодой.
WeatherWindow	Окно прогноза для шторма

basinId

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

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

ErrorAdditionalInfo

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

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

ErrorDetail

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

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

ErrorResponse

Сообщение об ошибке

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

GeoJsonGeometry

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

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

GeoJsonGeometryCollection

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

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

GeoJsonLineString

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

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

GeoJsonMultiLineString

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

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

GeoJsonMultiPoint

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

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

GeoJsonMultiPolygon

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

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

GeoJsonPoint

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

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

GeoJsonPolygon

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

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

JsonFormat

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

Имя	Тип	Описание
json	string	Формат обмена данными нотации объектов JavaScript

LatLongPair

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

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

RadiusSector

Несущее 0–90 = квадрант NE; 90–180 = квадрант SE; 180–270 = квадрант SW; 270–360 = Квадрант NW.

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

StormForecast

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

Имя	Тип	Описание
dateTime	string	Дата и время прогноза является допустимым и отображается в ISO8601 формате.
initializedDateTime	string	Дата создания прогноза в 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

Список опубликованных правительством прогнозов

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

StormWindRadiiSummary

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

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

UnitType

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

Имя	Тип	Описание
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

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

Имя	Тип	Описание
imperial	string	Возвращает данные в имперских единицах. Некоторые примеры единиц имперской системы — это по Fahrenheit и миля.
metric	string	Возвращает данные в единицах метрик. Некоторые примеры единиц метрики: Цельсия и километр.

WeatherUnit

Конкретное значение заданной единицы измерения, связанное с погодой.

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

WeatherWindow

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

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

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