Weather - Get Minute Forecast

Använd för att få en minut-för-minut-prognos för de kommande 120 minuterna i intervall på 1, 5 och 15 minuter.

API:et Get Minute Forecast är en HTTP-begäran GET som returnerar prognoser minut för minut för en viss plats under de kommande 120 minuterna. Användare kan begära väderprognoser i intervall på 1, 5 och 15 minuter. Svaret kommer att innehålla information som typen av nederbörd (inklusive regn, snö eller en blandning av båda), starttid och nederbördsintensitetsvärde (dBZ). Mer information finns i Begära väderprognosdata minut för minut.

GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query={query}
GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query={query}&interval={interval}&language={language}

URI-parametrar

Name I Obligatorisk Typ Description
format
path True

JsonFormat

Önskat format för svaret. Endast json format stöds.

api-version
query True

string

Versionsnummer för Azure Maps API.

query
query True

number[]

Den tillämpliga frågan som anges som en kommaavgränsad sträng som består av latitud följt av longitud, t.ex. "47.641268,-122.125679".

interval
query

integer

Anger tidsintervall i minuter för den returnerade väderprognosen. Värden som stöds är

  • 1 – Hämta prognos för 1-minutersintervall. Returneras som standard.
  • 5 – Hämta prognoser för 5-minutersintervall.
  • 15 – Hämta prognoser för 15 minuters intervall.
language
query

string

Språk där sökresultat ska returneras. Bör vara en av IETF-språktaggar som stöds, skiftlägesokänsliga. När data på angivet språk inte är tillgängliga för ett visst fält används standardspråket.

Mer information finns i Språk som stöds .

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-id

string

Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID säkerhetsmodell. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från konto-API:et för Azure Maps hanteringsplan. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar.

Svar

Name Typ Description
200 OK

MinuteForecastResult

OK

Other Status Codes

ErrorResponse

Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden. När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan ha åtkomstkontroll för specifika API:er och omfång.

Kommentarer

  • Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API :et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra ID konfigurationer. * Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

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

Scopes

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Det här är en delad nyckel som etableras när du Skapa ett Azure Maps konto i Azure Portal eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som huvudnyckel i det konto som de har utfärdats i.

För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Type: apiKey
In: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett säkrare sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

Successfully retrieve minute-by-minute forecasts for a given location

Sample Request

GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query=47.632346,-122.138874&interval=15

Sample Response

{
  "summary": {
    "briefPhrase60": "Rain ending in 25 min",
    "shortPhrase": "Rain ending in 25 min",
    "briefPhrase": "Rain ending in 25 min",
    "longPhrase": "Rain ending in 25 min",
    "iconCode": 12
  },
  "intervalSummaries": [
    {
      "startMinute": 0,
      "endMinute": 24,
      "totalMinutes": 25,
      "shortPhrase": "Rain ending in %minute_value min",
      "briefPhrase": "Rain ending in %minute_value min",
      "longPhrase": "Rain ending in %minute_value min",
      "iconCode": 12
    },
    {
      "startMinute": 25,
      "endMinute": 119,
      "totalMinutes": 95,
      "shortPhrase": "No precip for %MINUTE_VALUE min",
      "briefPhrase": "No precipitation for at least %MINUTE_VALUE min",
      "longPhrase": "No precipitation for at least %MINUTE_VALUE min",
      "iconCode": 7
    }
  ],
  "intervals": [
    {
      "startTime": "2019-11-14T15:18:00-08:00",
      "minute": 0,
      "dbz": 23,
      "shortPhrase": "Light Rain",
      "threshold": "LIGHT",
      "color": {
        "red": 8,
        "green": 98,
        "blue": 2,
        "hex": "#086202"
      },
      "simplifiedColor": {
        "red": 35,
        "green": 190,
        "blue": 39,
        "hex": "#23BE27"
      },
      "precipitationType": "Rain",
      "iconCode": 12,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T15:33:00-08:00",
      "minute": 15,
      "dbz": 18,
      "shortPhrase": "Light Rain",
      "threshold": "LIGHT",
      "color": {
        "red": 32,
        "green": 133,
        "blue": 9,
        "hex": "#208509"
      },
      "simplifiedColor": {
        "red": 35,
        "green": 190,
        "blue": 39,
        "hex": "#23BE27"
      },
      "precipitationType": "Rain",
      "iconCode": 12,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T15:48:00-08:00",
      "minute": 30,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:03:00-08:00",
      "minute": 45,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:18:00-08:00",
      "minute": 60,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:33:00-08:00",
      "minute": 75,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:48:00-08:00",
      "minute": 90,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T17:03:00-08:00",
      "minute": 105,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    }
  ]
}

Definitioner

Name Description
ColorValue
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

ForecastInterval
IconCode

Numeriskt värde som representerar en bild som visar iconPhrase. Mer information finns i Vädertjänster i Azure Maps.

IntervalSummary
JsonFormat

Önskat format för svaret. Endast json format stöds.

MinuteForecastResult
MinuteForecastSummary

Frassammanfattningar för hela prognosperioden.

PrecipitationType

Anger typen av nederbörd ("Rain" "Snow" "Ice" eller "Mix"). Om dbz är noll finns inte precipitationType i svaret.

ColorValue

Name Typ Description
blue

integer

Blå komponent i RGB-värdet

green

integer

Grön komponent i RGB-värdet.

hex

string

Hexadecimalt färgvärde.

red

integer

Röd komponent i RGB-värdet.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

ForecastInterval

Name Typ Description
cloudCover

integer

Procent som representerar molntäcke.

color

ColorValue

Den fullständiga spektrumfärgen som mappar till dBZ (decibel i förhållande till Z). Om dbz är noll finns inte färg i svaret.

dbz

number

En enhet som representerar prognostiserad nederbördsintensitet.

iconCode

IconCode

Numeriskt värde som representerar en bild som visar iconPhrase. Mer information finns i Vädertjänster i Azure Maps.

minute

integer

Den första minuten för intervallet.

precipitationType

PrecipitationType

Anger typen av nederbörd ("Rain" "Snow" "Ice" eller "Mix"). Om dbz är noll finns inte precipitationType i svaret.

shortPhrase

string

En kort fras som beskriver nederbördsvillkoret för intervallet.

simplifiedColor

ColorValue

Bandfärgen som mappar till nederbördstypen och tröskelvärdet. Om dbz är noll finns det inte i svaret.

startTime

string

Datum och tid för början av intervallet i ISO 8601-format, till exempel 2019-10-27T19:39:57-08:00.

threshold

string

Nyckel som anger tröskelvärdet. Tillsammans med precipitationType kan användas för att fastställa den förenkladeColor. Om dbz är noll finns det inte i svaret.

IconCode

Numeriskt värde som representerar en bild som visar iconPhrase. Mer information finns i Vädertjänster i Azure Maps.

Name Typ Description
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

23

Integer

24

Integer

25

Integer

26

Integer

27

Integer

28

Integer

29

Integer

3

Integer

30

Integer

31

Integer

32

Integer

33

Integer

34

Integer

35

Integer

36

Integer

37

Integer

38

Integer

39

Integer

4

Integer

40

Integer

41

Integer

42

Integer

43

Integer

44

Integer

5

Integer

6

Integer

7

Integer

8

Integer

9

Integer

IntervalSummary

Name Typ Description
briefPhrase

string

Kort sammanfattningsfras. Fraslängden är cirka 60 tecken.

endMinute

integer

Den sista minuten som sammanfattningen gäller för.

iconCode

IconCode

Numeriskt värde som representerar en bild som visar iconPhrase. Mer information finns i Vädertjänster i Azure Maps.

longPhrase

string

Lång sammanfattningsfras. Fraslängden är över 60 tecken.

shortPhrase

string

Kort sammanfattningsfras. Fraslängden är cirka 25 tecken.

startMinute

integer

Den första minut som sammanfattningen gäller för.

totalMinutes

integer

Det antal minuter som sammanfattningen gäller för.

JsonFormat

Önskat format för svaret. Endast json format stöds.

Name Typ Description
json

string

Datautbytesformat för JavaScript-objektnotation

MinuteForecastResult

Name Typ Description
intervalSummaries

IntervalSummary[]

Sammanfattningsinformation för varje intervall i prognosen. Sammanfattningarna delar upp varje potentiellt intervall där nederbörden startar och stoppas.

intervals

ForecastInterval[]

Prognosdata för varje intervall i prognosen.

summary

MinuteForecastSummary

Frassammanfattningar för hela prognosperioden.

MinuteForecastSummary

Frassammanfattningar för hela prognosperioden.

Name Typ Description
briefPhrase

string

Sammanfattningsfras för de kommande 120 minuterna. Fraslängden är cirka 60 tecken.

briefPhrase60

string

Sammanfattningsfras för de kommande 60 minuterna. Fraslängden är cirka 60 tecken.

iconCode

IconCode

Numeriskt värde som representerar en bild som visar iconPhrase. Mer information finns i Vädertjänster i Azure Maps.

longPhrase

string

Lång sammanfattningsfras för de kommande 120 minuterna. Fraslängden är över 60 tecken.

shortPhrase

string

Kort sammanfattningsfras för de kommande 120 minuterna. Fraslängden är cirka 25 tecken.

PrecipitationType

Anger typen av nederbörd ("Rain" "Snow" "Ice" eller "Mix"). Om dbz är noll finns inte precipitationType i svaret.

Name Typ Description
Ice

string

Ice

Mix

string

Mix

Rain

string

Regn

Snow

string

Snö