Weather - Get Tropical Storm Forecast
Используйте для получения списка тропических штормов, прогнозируемых национальными агентствами по прогнозированию погоды.
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 |
Требуемый формат ответа. Поддерживается только формат |
|
api-version
|
query | True |
string |
Номер версии API Azure Maps |
basin
|
query | True |
Идентификатор бассейна |
|
gov
|
query | True |
integer int32 |
Правительственный шторм id |
year
|
query | True |
integer int32 |
Год циклона |
details
|
query |
boolean |
Если значение равно true, в ответ включаются сводные данные по радиусам ветра. |
|
radii
|
query |
boolean |
Если значение равно true, в ответ включаются сводные данные по радиусам ветра и сведения о geoJSON. |
|
unit
|
query |
Указывает, что данные возвращаются в единицах метрик или в единицах империи. Значение по умолчанию — metric. |
||
window
|
query |
boolean |
Если значение равно true, в ответ включаются геометрические данные окна (geoJSON). |
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
x-ms-client-id |
string |
Указывает учетную запись, предназначенную для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
ОК |
|
Other Status Codes |
Произошла непредвиденная ошибка. |
Безопасность
AADToken
Это Microsoft Entra потоков OAuth 2.0. В сочетании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе может быть предоставлен доступ через встроенную или пользовательскую роль, состоящую из одного или нескольких разрешений для Azure Maps REST API.
Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, которые могут управлять доступом к определенным API и областям.
Примечания
- Это определение безопасности требует использования заголовка
x-ms-client-id
, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами .
объект Authorization URL
предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID.
* Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.
* Использование веб-пакета SDK для Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.
- Дополнительные сведения о платформа удостоверений Майкрософт см. в платформа удостоверений Майкрософт обзоре.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя | Описание |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Это общий ключ, который подготавливается при Create учетной записи Azure Maps в портал Azure или с помощью PowerShell, CLI, пакетов AZURE SDK или REST API.
С помощью этого ключа любое приложение может получить доступ ко всем REST API. Иными словами, этот ключ можно использовать в качестве ключа master в учетной записи, в которую они выдаются.
Для общедоступных приложений мы рекомендуем использовать подход конфиденциальных клиентских приложений для доступа к Azure Maps REST API, чтобы ключ можно было безопасно хранить.
Type:
apiKey
In:
query
SAS Token
Этот маркер подписанного URL-адреса создается из операции List SAS в ресурсе Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.
С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов использования конкретного маркера. Иными словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.
Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи сопоставления , чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.
Type:
apiKey
In:
header
Примеры
Get Tropical Storm Forecasts
Sample Request
GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year=2021&basinId=NP&govId=2
Sample Response
{
"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
}
}
}
]
}
Определения
Имя | Описание |
---|---|
basin |
Идентификатор бассейна |
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Сообщение об ошибке |
Geo |
Допустимый |
Geo |
Допустимый |
Geo |
Допустимый |
Geo |
Допустимый |
Geo |
Допустимый |
Geo |
Допустимый |
Geo |
Допустимый |
Geo |
Допустимый |
Json |
Требуемый формат ответа. Поддерживается только формат |
Lat |
Расположение, представленное в виде широты и долготы. |
Radius |
Подшипник 0–90 = квадрант NE; 90–180 = квадрант SE; 180–270 = квадрант SW; 270–360 = Квадрант NW. |
Storm |
Правительственный прогноз шторма |
Storm |
Список опубликованных правительством прогнозов |
Storm |
Отображается, когда details=true или radiiGeometry=true в запросе. |
Unit |
Числовое значение идентификатора, связанное с типом отображаемой единицы измерения. Может использоваться для преобразования единиц. Дополнительные сведения см. в разделе Службы погоды в Azure Maps. |
Weather |
Указывает, как возвращать данные в единицах метрик или в единицах империи. Значение по умолчанию — метрика. |
Weather |
Конкретное значение заданной единицы измерения, связанное с погодой. |
Weather |
Окно прогноза для шторма |
basinId
Идентификатор бассейна
Имя | Тип | Описание |
---|---|---|
AL |
string |
Атлантик |
CP |
string |
Центрально-Тихоокеанский регион |
EP |
string |
Восточная часть Тихого океана |
NI |
string |
Северная часть Индийского океана |
NP |
string |
Северо-Западная часть Тихого океана |
SI |
string |
Юго-запад Индийского океана |
SP |
string |
Южно-Тихоокеанский регион |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Тип дополнительных сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Сообщение об ошибке
Имя | Тип | Описание |
---|---|---|
error |
Объект ошибки. |
GeoJsonGeometry
Допустимый GeoJSON
объект geometry. Тип должен быть одним из семи допустимых геометрических типов GeoJSON: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в документе RFC 7946 .
Имя | Тип | Описание |
---|---|---|
type |
Geo |
Указывает тип элемента |
GeoJsonGeometryCollection
Допустимый GeoJSON GeometryCollection
тип объекта. Дополнительные сведения см. в документе RFC 7946 .
Имя | Тип | Описание |
---|---|---|
geometries | GeoJsonGeometry[]: |
Содержит список допустимых |
type |
string:
Geometry |
Указывает тип элемента |
GeoJsonLineString
Допустимый GeoJSON LineString
тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
Имя | Тип | Описание |
---|---|---|
coordinates |
number[] |
Координаты геометрии |
type |
string:
Line |
Указывает тип элемента |
GeoJsonMultiLineString
Допустимый GeoJSON MultiLineString
тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
Имя | Тип | Описание |
---|---|---|
coordinates |
number[] |
Координаты геометрии |
type |
string:
Multi |
Указывает тип элемента |
GeoJsonMultiPoint
Допустимый GeoJSON MultiPoint
тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
Имя | Тип | Описание |
---|---|---|
coordinates |
number[] |
Координаты геометрии |
type |
string:
Multi |
Указывает тип элемента |
GeoJsonMultiPolygon
Допустимый GeoJSON MultiPolygon
тип объекта. Дополнительные сведения см. в документе RFC 7946 .
Имя | Тип | Описание |
---|---|---|
coordinates |
number[] |
Содержит список допустимых |
type |
string:
Multi |
Указывает тип элемента |
GeoJsonPoint
Допустимый GeoJSON Point
тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
Имя | Тип | Описание |
---|---|---|
coordinates |
number[] |
— |
type |
string:
Point |
Указывает тип элемента |
GeoJsonPolygon
Допустимый GeoJSON Polygon
тип геометрии. Дополнительные сведения см. в документе RFC 7946 .
Имя | Тип | Описание |
---|---|---|
coordinates |
number[] |
Координаты для |
type |
string:
Polygon |
Указывает тип элемента |
JsonFormat
Требуемый формат ответа. Поддерживается только формат json
.
Имя | Тип | Описание |
---|---|---|
json |
string |
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 |
Координаты шторма |
|
maxWindGust |
Максимальная скорость порыва ветра, связанная с штормом. Может иметь значение "NULL". |
|
status |
string |
Возможные значения состояния:
|
sustainedWind |
Максимальная устойчивая скорость ветра, связанная с штормом. Может иметь значение "NULL". |
|
windRadiiSummary |
Отображается, когда details=true или radiiGeometry=true в запросе. |
|
window |
Содержит сведения о окне прогноза для шторма в течение указанного периода времени (а не обо всем конусе). Если windowGeometry=true в запросе, этот объект будет содержать сведения о geoJSON для геометрии окна. |
StormForecastResult
Список опубликованных правительством прогнозов
Имя | Тип | Описание |
---|---|---|
nextLink |
string |
— это ссылка на следующую страницу возвращаемых функций. Если это последняя страница, это поле отсутствует. |
results |
Список опубликованных правительством прогнозов |
StormWindRadiiSummary
Отображается, когда details=true или radiiGeometry=true в запросе.
Имя | Тип | Описание |
---|---|---|
dateTime |
string |
DateTime, для которого допустимы сводные данные по радиусам ветра, отображаются в ISO8601 формате. |
radiiGeometry | GeoJsonGeometry: |
Объект GeoJSON. Отображается, когда radiiGeometry=true в запросе. Описывает контур квадрантов радиуса ветра. |
radiusSectorData |
Содержит сведения, необходимые для построения квадрантов радиуса ветра. Несущее 0–90 = квадрант NE; 90–180 = квадрант SE; 180–270 = квадрант SW; 270–360 = Квадрант NW. |
|
windSpeed |
Скорость ветра, связанная с 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 |
Числовое значение идентификатора, связанное с типом отображаемой единицы измерения. Может использоваться для преобразования единиц. Дополнительные сведения см. в разделе Службы погоды в Azure Maps. |
|
value |
number |
Округленное значение. |
WeatherWindow
Окно прогноза для шторма
Имя | Тип | Описание |
---|---|---|
beginDateTime |
string |
DateTime начала окна перемещения, отображаемого в ISO8601 формате. |
beginStatus |
string |
Состояние Storm в начале окна. |
endDateTime |
string |
DateTime конца окна перемещения, отображаемого в ISO8601 формате. |
endStatus |
string |
Состояние Storm в конце окна. |
geometry | GeoJsonGeometry: |
Отображается, когда windowGeometry=true в запросе. Объект GeoJSON, содержащий координаты, описывающие окно перемещения в течение указанного периода времени. |
left |
Расположение точки в левой части окна во время интервала времени. |
|
right |
Расположение точки в правой части окна в конце интервала времени. |