Weather - Get Tropical Storm Forecast

  • Referensi
Service:
Maps
API Version:
1.1

Gunakan untuk mendapatkan daftar badai tropis yang diperkirakan oleh lembaga prakiraan cuaca nasional.

Get Tropical Storm Forecasts API adalah permintaan HTTP GET yang mengembalikan prakiraan badai tropis yang dikeluarkan pemerintah individu. Informasi tentang prakiraan badai tropis meliputi, lokasi, status, tanggal prakiraan dibuat, jendela, kecepatan angin, dan radii angin.

GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}
With optional parameters: 
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}

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
format
 path True

JsonFormat

Format respons yang diinginkan. Hanya json format yang didukung.
api-version
 query True

string

Nomor versi API Azure Maps.
basinId
 query True

basinId

Pengidentifikasi basin
govId
 query True

integer

int32

Id Badai Pemerintah
year
 query True

integer

int32

Tahun siklopis
details
 query

boolean

Jika benar, data ringkasan radii angin disertakan dalam respons
radiiGeometry
 query

boolean

Jika benar, data ringkasan radii angin dan detail geoJSON disertakan dalam respons
unit
 query

WeatherDataUnit

Menentukan untuk mengembalikan data di unit metrik atau unit kekaisaran. Nilai defaultnya adalah metrik.
windowGeometry
 query

boolean

Jika true, data geometri jendela (geoJSON) disertakan dalam respons

Header Permintaan

Nama Diperlukan Jenis Deskripsi
x-ms-client-id

string

Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan Microsoft Entra ID. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan Microsoft Entra ID di Azure Maps lihat artikel berikut untuk panduan.

Respons

Nama Jenis Deskripsi
200 OK

StormForecastResult

OK
Other Status Codes

ErrorResponse

Terjadi kesalahan tak terduga.

Keamanan

AADToken

Ini adalah alur OAuth 2.0 Microsoft Entra. Saat dipasangkan dengan kontrol akses berbasis peran Azure, kontrol akses tersebut dapat digunakan untuk mengontrol akses ke Azure Maps REST API. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa akun sumber daya atau sub-sumber daya Azure Maps. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin untuk Azure Maps REST API.

Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini menyediakan solusi untuk pemodelan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.

Catatan

  • Definisi keamanan ini memerlukan penggunaan x-ms-client-id header untuk menunjukkan sumber daya Azure Maps mana yang meminta akses aplikasi. Ini dapat diperoleh dari API manajemen Maps .

Authorization URL khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi Microsoft Entra ID. * Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API. * Penggunaan Azure Maps Web SDK memungkinkan penyiapan berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama Deskripsi
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Ini adalah kunci bersama yang disediakan saat Anda Create akun Azure Maps di portal Azure atau menggunakan PowerShell, CLI, Azure SDK, atau REST API.

Dengan kunci ini, aplikasi apa pun dapat mengakses semua REST API. Dengan kata lain, kunci ini dapat digunakan sebagai kunci master di akun tempat kunci tersebut diterbitkan.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan pendekatan aplikasi klien rahasia untuk mengakses Azure Maps REST API sehingga kunci Anda dapat disimpan dengan aman.

Type: apiKey
In: query

SAS Token

Ini adalah token tanda tangan akses bersama dibuat dari operasi Daftar SAS pada sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.

Dengan token ini, aplikasi apa pun berwenang untuk mengakses dengan kontrol akses berbasis peran Azure dan kontrol fine-grain ke kedaluwarsa, tarif, dan wilayah penggunaan untuk token tertentu. Dengan kata lain, Token SAS dapat digunakan untuk memungkinkan aplikasi mengontrol akses dengan cara yang lebih aman daripada kunci bersama.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah mengonfigurasi daftar spesifik asal yang diizinkan pada sumber daya akun Peta untuk membatasi penyalahgunaan penyalahgunaan dan memperbarui Token SAS secara teratur.

Type: apiKey
In: header

Contoh

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

Status code:
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
        }
      }
    }
  ]
}

Definisi

Nama Deskripsi
basinId

Pengidentifikasi basin
ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.
ErrorDetail

Detail kesalahan.
ErrorResponse

Respons kesalahan
GeoJsonGeometry

Objek geometri yang valid GeoJSON . Jenisnya harus salah satu dari tujuh jenis geometri GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon dan GeometryCollection. Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonGeometryCollection

Jenis objek yang valid GeoJSON GeometryCollection . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonLineString

Jenis geometri yang valid GeoJSON LineString . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonMultiLineString

Jenis geometri yang valid GeoJSON MultiLineString . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonMultiPoint

Jenis geometri yang valid GeoJSON MultiPoint . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonMultiPolygon

Jenis objek yang valid GeoJSON MultiPolygon . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonPoint

Jenis geometri yang valid GeoJSON Point . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonPolygon

Jenis geometri yang valid GeoJSON Polygon . Silakan merujuk ke RFC 7946 untuk detailnya.
JsonFormat

Format respons yang diinginkan. Hanya json format yang didukung.
LatLongPair

Lokasi yang direpresentasikan sebagai garis lintang dan bujur.
RadiusSector

Bearing 0–90 = NE quadrant; 90–180 = se quadrant; 180–270 = Kuadrian SW; 270–360 = Kuadrian NW.
StormForecast

Prakiraan badai yang dikeluarkan pemerintah
StormForecastResult

Daftar prakiraan yang dikeluarkan pemerintah
StormWindRadiiSummary

Ditampilkan ketika details=true atau radiiGeometry=true dalam permintaan.
UnitType

Nilai ID numerik yang terkait dengan jenis unit yang ditampilkan. Dapat digunakan untuk terjemahan unit. Silakan merujuk ke layanan Cuaca di Azure Maps untuk detailnya.
WeatherDataUnit

Menentukan untuk mengembalikan data dalam unit metrik atau unit kekaisaran. Nilai default adalah metrik.
WeatherUnit

Nilai spesifik unit tertentu yang terkait dengan cuaca.
WeatherWindow

Jendela prakiraan untuk badai

basinId

Pengidentifikasi basin

Nama Jenis Deskripsi
AL

string

Atlantic
CP

string

Pasifik Tengah
EP

string

Pasifik Timur
NI

string

Samudra Hindia Utara
NP

string

Pasifik Barat Laut
SI

string

Samudra Hindia Barat Daya
SP

string

Pasifik Selatan

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama Jenis Deskripsi
info

object

Info tambahan.
type

string

Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama Jenis Deskripsi
additionalInfo

ErrorAdditionalInfo[]

Info tambahan kesalahan.
code

string

Kode kesalahan.
details

ErrorDetail[]

Detail kesalahan.
message

string

Pesan kesalahan.
target

string

Target kesalahan.

ErrorResponse

Respons kesalahan

Nama Jenis Deskripsi
error

ErrorDetail

Objek kesalahan.

GeoJsonGeometry

Objek geometri yang valid GeoJSON . Jenisnya harus salah satu dari tujuh jenis geometri GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon dan GeometryCollection. Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
type

GeoJsonObjectType

Menentukan jenisnya GeoJSON . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonGeometryCollection

Jenis objek yang valid GeoJSON GeometryCollection . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
geometries GeoJsonGeometry[]:

Berisi daftar objek geometri yang valid GeoJSON . Perhatikan bahwa koordinat di GeoJSON dalam urutan x, y (bujur, lintang).
type string:

GeometryCollection

Menentukan jenisnya GeoJSON . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonLineString

Jenis geometri yang valid GeoJSON LineString . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
coordinates

number[]

Koordinat GeoJson LineString untuk geometri.
type string:

LineString

Menentukan jenisnya GeoJSON . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonMultiLineString

Jenis geometri yang valid GeoJSON MultiLineString . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
coordinates

number[]

Koordinat GeoJson MultiLineString untuk geometri.
type string:

MultiLineString

Menentukan jenisnya GeoJSON . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonMultiPoint

Jenis geometri yang valid GeoJSON MultiPoint . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
coordinates

number[]

Koordinat GeoJson MultiPoint untuk geometri.
type string:

MultiPoint

Menentukan jenisnya GeoJSON . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonMultiPolygon

Jenis objek yang valid GeoJSON MultiPolygon . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
coordinates

number[]

Berisi daftar objek yang valid GeoJSON Polygon . Perhatikan bahwa koordinat di GeoJSON dalam urutan x, y (bujur, lintang).
type string:

MultiPolygon

Menentukan jenisnya GeoJSON . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonPoint

Jenis geometri yang valid GeoJSON Point . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
coordinates

number[]

Position adalah array angka dengan dua elemen atau lebih. Dua elemen pertama adalah garis bujur dan lintang, tepatnya dalam urutan tersebut. Ketinggian/Elevasi adalah elemen ketiga opsional. Silakan merujuk ke RFC 7946 untuk detailnya.
type string:

Point

Menentukan jenisnya GeoJSON . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonPolygon

Jenis geometri yang valid GeoJSON Polygon . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama Jenis Deskripsi
coordinates

number[]

Koordinat GeoJson Polygon untuk jenis geometri.
type string:

Polygon

Menentukan jenisnya GeoJSON . Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

JsonFormat

Format respons yang diinginkan. Hanya json format yang didukung.

Nama Jenis Deskripsi
json

string

Format Pertukaran Data Notasi Objek JavaScript

LatLongPair

Lokasi yang direpresentasikan sebagai garis lintang dan bujur.

Nama Jenis Deskripsi
latitude

number

Properti garis lintang
longitude

number

Properti garis bujur

RadiusSector

Bearing 0–90 = NE quadrant; 90–180 = se quadrant; 180–270 = Kuadrian SW; 270–360 = Kuadrian NW.

Nama Jenis Deskripsi
beginBearing

number

Bearing, dalam derajat, dari awal kuadrian.
endBearing

number

Bearing, dalam derajat, dari akhir kuadrian.
range

number

Radius kuadran, dalam mil laut.

StormForecast

Prakiraan badai yang dikeluarkan pemerintah

Nama Jenis Deskripsi
dateTime

string

Tanggalwaktu perkiraan valid, ditampilkan dalam format ISO8601.
initializedDateTime

string

Tanggalwaktu prakiraan dibuat, ditampilkan dalam format ISO8601.
location

LatLongPair

Koordinat badai
maxWindGust

WeatherUnit

Kecepatan embusan angin maksimum yang terkait dengan badai. Mungkin NULL.
status

string

Kemungkinan nilai status meliputi:

  • Badai siklonic
  • Depresi mendalam
  • Depresi
  • Badai siklonic yang sangat parah
  • Kategori badai (1-5)
  • Siklon tropis intens
  • Badai tropis sedang
  • Siklon pasca-tropis
  • Potensi siklon tropis
  • Badai siklonic yang parah
  • Badai tropis yang parah
  • Subtropis
  • Badai super cyclonic
  • Siklon tropis
  • Kategori siklon tropis (1-5)
  • Depresi tropis
  • Gangguan tropis
  • Badai tropis
  • Topan
  • Siklon tropis yang sangat intens
  • Badai siklonic yang sangat parah
  • Topan yang sangat kuat
  • Topan kekerasan
sustainedWind

WeatherUnit

Kecepatan angin berkelanjutan maksimum yang terkait dengan badai. Mungkin NULL.
windRadiiSummary

StormWindRadiiSummary[]

Ditampilkan ketika details=true atau radiiGeometry=true dalam permintaan.
window

WeatherWindow

Berisi informasi tentang jendela prakiraan untuk badai selama periode waktu yang ditentukan (bukan seluruh kerujut). Jika windowGeometry=true dalam permintaan, objek ini akan menyertakan detail geoJSON untuk geometri jendela.

StormForecastResult

Daftar prakiraan yang dikeluarkan pemerintah

Nama Jenis Deskripsi
nextLink

string

adalah tautan ke halaman berikutnya dari fitur yang dikembalikan. Jika itu halaman terakhir, tidak ada bidang ini.
results

StormForecast[]

Daftar prakiraan yang dikeluarkan pemerintah

StormWindRadiiSummary

Ditampilkan ketika details=true atau radiiGeometry=true dalam permintaan.

Nama Jenis Deskripsi
dateTime

string

DateTime yang data ringkasan radii anginnya valid, ditampilkan dalam format ISO8601.
radiiGeometry GeoJsonGeometry:

Objek GeoJSON. Ditampilkan ketika radiiGeometry=true dalam permintaan. Menjelaskan garis besar kuadran radius angin.
radiusSectorData

RadiusSector[]

Berisi informasi yang diperlukan untuk merencanakan kuadran radius angin. Bearing 0–90 = NE quadrant; 90–180 = KUADRANT SE; 180–270 = Kuadrian SW; 270–360 = Kuadrian NW.
windSpeed

WeatherUnit

Kecepatan angin yang terkait dengan radiusSectorData.

UnitType

Nilai ID numerik yang terkait dengan jenis unit yang ditampilkan. Dapat digunakan untuk terjemahan unit. Silakan merujuk ke layanan Cuaca di Azure Maps untuk detailnya.

Nama Jenis Deskripsi
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

Menentukan untuk mengembalikan data dalam unit metrik atau unit kekaisaran. Nilai default adalah metrik.

Nama Jenis Deskripsi
imperial

string

Mengembalikan data dalam unit kekaisaran. Beberapa contoh unit sistem kekaisaran adalah Fahrenheit dan mil.
metric

string

Mengembalikan data dalam unit metrik. Beberapa contoh unit sistem metrik adalah Celcius dan kilometer.

WeatherUnit

Nilai spesifik unit tertentu yang terkait dengan cuaca.

Nama Jenis Deskripsi
unit

string

Jenis unit untuk nilai yang dikembalikan.
unitType

UnitType

Nilai ID numerik yang terkait dengan jenis unit yang ditampilkan. Dapat digunakan untuk terjemahan unit. Silakan merujuk ke layanan Cuaca di Azure Maps untuk detailnya.
value

number

Nilai yang dibulatkan.

WeatherWindow

Jendela prakiraan untuk badai

Nama Jenis Deskripsi
beginDateTime

string

DateTime awal jendela pergerakan, ditampilkan dalam format ISO8601.
beginStatus

string

Status badai di awal jendela.
endDateTime

string

DateTime akhir jendela pergerakan, ditampilkan dalam format ISO8601.
endStatus

string

Status badai di akhir jendela.
geometry GeoJsonGeometry:

Ditampilkan ketika windowGeometry=true dalam permintaan. Objek GeoJSON yang berisi koordinat yang menjelaskan jendela pergerakan selama jangka waktu yang ditentukan.
left

LatLongPair

Lokasi titik di sisi kiri jendela pada saat jangka waktu.
right

LatLongPair

Lokasi titik di sisi kanan jendela di akhir jangka waktu.