Weather - Get Tropical Storm Active

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

GET {endpoint}/weather/tropical/storms/active/json?api-version=1.1

Параметры URI

Имя В Обязательно Тип Описание
endpoint
path True

string

format
path True

JsonFormat

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

api-version
query True

string

minLength: 1

Версия API, используемая для данной операции.

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

Имя Обязательно Тип Описание
x-ms-client-id

string

Указывает аккаунт, предназначенный для использования с моделью безопасности Microsoft Entra ID. Этот уникальный идентификатор для Azure Maps аккаунта можно получить с управляющего плана Azure Maps Account API. Для получения дополнительной информации об использовании Microsoft Entra ID безопасности в Azure Maps см. раздел Управление аутентификацией в Azure Maps.

Ответы

Имя Тип Описание
200 OK

ActiveStormResult

Запрос выполнен успешно.

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

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

AadToken

Это Microsoft Entra OAuth 2.0 потоки. В сочетании с управлением Azure ролевым доступом он может использоваться для управления доступом к Azure Maps REST API. Ролевые контроли доступа Azure используются для обозначения доступа к одной или нескольким учетной записи ресурсов или подресурсам Azure Maps. Любой пользователь, группа или принципал сервиса может получить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений Azure Maps REST API.\n\nДля реализации сценариев рекомендуем ознакомиться с концепциями аутентификационные концепции. В заключение, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных контролировать доступ к определённым API и областям видимости.\n\n#### Примечания\n* Это определение безопасности требует использование заголовка x-ms-client-id для указания, к какому Azure Maps ресурсу приложение запрашивает доступ. Её можно получить через API управления Maps.\n* \nAuthorization URL специфичен для экземпляра публичного облака Azure. Облака Sovereign имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. \n* \nУправление доступом на основе ролей Azure настраивается с плоскости управления Azure через портал Azure, PowerShell, CLI, Azure SDKs или REST API.\n* \nИспользование Azure Maps Web SDK позволяет настраивать приложение на основе конфигурации для нескольких сценариев использования.\n* Для получения дополнительной информации о платформа удостоверений Майкрософт см. платформа удостоверений Майкрософт обзор.

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

Области

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

subscription-key

Это общий ключ, который создаётся при Создайте Azure Maps аккаунт в Azure-портале или с помощью PowerShell, CLI, Azure SDKs или REST API.\n\n С помощью этого ключа любое приложение может получить доступ ко всем REST API. Другими словами, этот ключ может использоваться как мастер-ключ на счете, на котором они выпущены.\n\n Для публично открытых приложений мы рекомендуем использовать подход confidential client applications для доступа к Azure Maps REST API, чтобы ваш ключ можно было безопасно хранить.

Тип: apiKey
В: header

SAS Token

Это токен общего доступа, созданный из операции List SAS на ресурсе Azure Maps/c0> через плоскость управления Azure через портал Azure, PowerShell, CLI, Azure SDKs или REST API.\n\n С помощью этого токена любое приложение имеет право на доступ с помощью Azure ролевые контроли доступа и тонкий контроль истечения срока действия, скорости и региона использования конкретного токена. Другими словами, SAS Token может использоваться для того, чтобы приложения могли управлять доступом более защищённо, чем общий ключ.\n\n Для публично открытых приложений мы рекомендуем настроить конкретный список разрешённых источников на ресурсе аккаунта Map , чтобы ограничить злоупотребления рендерингом и регулярно продлевать токен SAS.

Тип: apiKey
В: header

Примеры

Get Tropical Storm Active

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

GET {endpoint}/weather/tropical/storms/active/json?api-version=1.1

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

{
  "results": [
    {
      "name": "Hilda",
      "basinId": "EP",
      "govId": 8,
      "isActive": true,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "TD 9E",
      "basinId": "EP",
      "govId": 9,
      "isActive": true,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "TWELVE",
      "basinId": "NP",
      "govId": 12,
      "isActive": true,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "LUPIT",
      "basinId": "NP",
      "govId": 13,
      "isActive": true,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "FOURTEEN",
      "basinId": "NP",
      "govId": 14,
      "isActive": true,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "FIFTEEN",
      "basinId": "NP",
      "govId": 15,
      "isActive": true,
      "isSubtropical": false,
      "year": "2021"
    }
  ]
}

Определения

Имя Описание
ActiveStorm

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

ActiveStormResult

Объект ActiveStormResult предоставляет исчерпывающую информацию о текущих тропических штормах. Он включает множество объектов ActiveStorm , каждый из которых описывает конкретные характеристики отдельных штормов. К этим характеристикам относятся идентификатор шторма, идентификатор бассейна, год происхождения, название и субтропический статус.

BasinId

Идентификатор бассейна для тропических штормов.

ErrorAdditionalInfo

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

ErrorDetail

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

ErrorResponse

Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа об ошибках OData.).

JsonFormat

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

ActiveStorm

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

Имя Тип Описание
basinId

BasinId

Классифицирует различные океанические бассейны, откуда могут возникать тропические штормы. Каждому бассейну присваивается уникальный идентификатор, который помогает указать место возникновения шторма. Допустимые идентификаторы бассейна включают AL, CP, EP, NI, NP, SI и SP.

govId

integer (int32)

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

isActive

boolean

Указывает, активен ли тропический шторм в данный момент. Если это правда, шторм активен; если это ложно, шторм не активен.

isSubtropical

boolean

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

name

string

Название бури.

year

string

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

ActiveStormResult

Объект ActiveStormResult предоставляет исчерпывающую информацию о текущих тропических штормах. Он включает множество объектов ActiveStorm , каждый из которых описывает конкретные характеристики отдельных штормов. К этим характеристикам относятся идентификатор шторма, идентификатор бассейна, год происхождения, название и субтропический статус.

Имя Тип Описание
nextLink

string

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

results

ActiveStorm[]

Множество объектов ActiveStorm , каждый из которых содержит важную информацию о продолжающемся тропическом шторме, как сообщают национальные агентства прогнозирования погоды.

BasinId

Идентификатор бассейна для тропических штормов.

Значение Описание
AL

Атлантический океан. Имеет решающее значение для отслеживания ураганов, которые затрагивают Америку и Карибский бассейн. Это один из самых активных регионов для тропических штормов.

CP

Центральная часть Тихого океана. Этот бассейн используется для штормов, затрагивающих Гавайи и прилегающие районы.

EP

Восточная часть Тихого океана. В этом бассейне отслеживаются штормы, влияющие на западное побережье Северной и Южной Америки, включая Мексику и Центральную Америку. Он примыкает к центральной части Тихого океана.

NI

Северная часть Индийского океана. Этот бассейн охватывает штормы, влияющие на Южную Азию, включая такие страны, как Индия и Бангладеш, которые часто страдают от циклонов.

NP

Северо-западная часть Тихого океана. Этот бассейн важен для отслеживания тайфунов, которые влияют на Восточную Азию, включая такие страны, как Китай, Япония и Филиппины. Это самые активные регионы тропических штормов в мире.

SI

Южная часть Индийского океана. Этот бассейн, расположенный к югу от экватора, охватывает циклоны, влияющие на Мадагаскар, Африку и прилегающие регионы.

SP

Южная часть Тихого океана. Этот бассейн, расположенный к югу от экватора, имеет отношение к циклонам, затрагивающим Австралию и острова южной части Тихого океана.

ErrorAdditionalInfo

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

Имя Тип Описание
info

Дополнительные сведения.

type

string

Дополнительный тип сведений.

ErrorDetail

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

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

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

code

string

Код ошибки.

details

ErrorDetail[]

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

message

string

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

target

string

Целевой объект ошибки.

ErrorResponse

Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа об ошибках OData.).

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

JsonFormat

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

Значение Описание
json

формат обмена данными для объектов JavaScript