Weather - Get Minute Forecast

Används för att få en minut-för-minut-prognos för de kommande 120 minuterna i intervaller om 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 intervaller om 1, 5 och 15 minuter. Svaret kommer att innehålla detaljer som typen av nederbörd (inklusive regn, snö eller en blandning av båda), starttid och värde för nederbördsintensitet (dBZ). Mer information finns i Begära väderprognosdata minut för minut.

GET {endpoint}/weather/forecast/minute/json?api-version=1.1&query={query}
GET {endpoint}/weather/forecast/minute/json?api-version=1.1&query={query}&interval={interval}&language={language}

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
path True

string (uri)

Azure Maps-tjänstens värdnamn. Använd https://atlas.microsoft.com för Azure publika molnet. För att rikta in dig på en specifik Azure Maps geografi eller ett suveränt moln, se Azure Maps geografisk omfattning.

format
path True

JsonFormat

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

api-version
query True

string

minLength: 1

Den API-version som ska användas för den här åtgärden.

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".

Väderinformation är i allmänhet tillgänglig för platser på land, vattendrag omgivna av land och områden i havet som ligger inom cirka 50 nautiska mil från en kustlinje.

interval
query

integer (int32)

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

  • 1 - Hämta prognos för 1-minutsintervaller. Returneras som standard.
  • 5 - Hämta prognoser för 5-minutersintervaller.
  • 15 - Hämta prognoser för 15-minutersintervaller.
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 med Microsoft Entra ID-säkerhetsmodellen. Detta unika ID för Azure Maps-kontot kan erhållas från Azure Maps Management Plane Account API. För mer information om hur man använder Microsoft Entra ID säkerhet i Azure Maps, se Hantera autentisering i Azure Maps.

Svar

Name Typ Description
200 OK

MinuteForecastResult

Begäran har slutförts.

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

AadToken

Dessa är Microsoft Entra OAuth 2.0 flöden. När den kombineras med Azure rollbaserad åtkomst kontroll kan den användas för att kontrollera åtkomst till Azure Maps REST-API:er. Azure:s rollbaserade åtkomstkontroller används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller delresurser. 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 till 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 få åtkomstkontroll för specifika API:er och omfång.

Note

  • Den här säkerhetsdefinitionen kräver användningen av x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hanterings-API:et.
  • Authorization URL är specifik för den offentliga Azure-molninstansen. Suveräna moln har unika auktoriserings-URL:er och Microsoft Entra ID-konfigurationer.
  • Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, 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.
  • Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
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-portalen 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:er. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de har utfärdats i.

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

Typ: apiKey
I: header

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från sas-åtgärden Lista på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, 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 till 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 mer säkert 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.

Typ: apiKey
I: header

Exempel

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

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
ColorValue

Färgvärdet representeras som RGB och hexadecimalt.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Detaljerna om felet.

ErrorResponse

Vanligt felsvar för alla Azure Resource Manager API:er för att returnera feldetaljer vid misslyckade operationer. (Detta följer även formatet för OData-felsvar.).

ForecastInterval

Prognosdata för ett specifikt intervall.

IconCode

Numeriskt värde som representerar en bild som motsvarar det aktuella väderförhållandet som beskrivs av egenskapen Phrase . För mer information, se Vädertjänster i Azure Maps. Kan vara NULL.

IntervalSummary

Sammanfattningsinformation för ett prognosintervall.

JsonFormat

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

MinuteForecastResult

Minut för minut väderprognos.

MinuteForecastSummary

Frassammanfattningar för hela prognosperioden.

PrecipitationType

Anger typen av nederbörd. Giltiga värden är Regn, Snö, Is eller Blandning. Den här egenskapen ingår i svaret när dBZ är större än noll.

ColorValue

Färgvärdet representeras som RGB och hexadecimalt.

Name Typ Description
blue

integer (int32)

Blå komponent i RGB-värdet

green

integer (int32)

Grön komponent i RGB-värdet.

hex

string

Hexadecimalt färgvärde.

red

integer (int32)

Röd komponent i RGB-värdet.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

Ytterligare information.

type

string

Ytterligare informationstyp.

ErrorDetail

Detaljerna om felet.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Vanligt felsvar för alla Azure Resource Manager API:er för att returnera feldetaljer vid misslyckade operationer. (Detta följer även formatet för OData-felsvar.).

Name Typ Description
error

ErrorDetail

Felobjektet.

ForecastInterval

Prognosdata för ett specifikt intervall.

Name Typ Description
cloudCover

integer (int32)

Procent som representerar molntäcke.

color

ColorValue

Färgen med hela spektrumet som mappar till dBZ (decibel i förhållande till Z). Om dBZ är noll finns det ingen färg i svaret.

dbz

number (double)

En enhet som representerar prognostiserad nederbördsintensitet.

iconCode

IconCode

Numeriskt värde som representerar en bild som motsvarar det aktuella väderförhållandet som beskrivs av egenskapen Phrase . För mer information, se Vädertjänster i Azure Maps. Kan vara NULL.

minute

integer (int32)

Första minuten för paus.

precipitationType

PrecipitationType

Anger typen av nederbörd. Giltiga värden är Regn, Snö, Is eller Blandning. Den här egenskapen ingår i svaret när dBZ är större än noll.

shortPhrase

string

En kort fras som beskriver nederbördstillståndet för intervallet.

simplifiedColor

ColorValue

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

startTime

string (date-time)

Datum och tid för starten 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 simplifiedColor. Om dBZ är noll finns det inte i svaret.

IconCode

Numeriskt värde som representerar en bild som motsvarar det aktuella väderförhållandet som beskrivs av egenskapen Phrase . För mer information, se Vädertjänster i Azure Maps. Kan vara NULL.

Värde Description
1

Sunny

2

Mestadels soligt

3

Delvis soligt

4

Tillfälliga moln

5

Disigt solsken

6

Mestadels molnigt

7

Cloudy

8

Trist (mulet)

11

Dimma

12

Showers

13

Mestadels molnigt med duschar

14

Delvis soligt med skurar

15

Thunderstorms

16

Mestadels molnigt med åskväder

17

Delvis soligt med åskväder

18

Regn

19

Flurries

20

Mestadels molnigt med flurries

21

Delvis soligt med flurries

22

Snow

23

Mestadels molnigt med snö

24

Is

25

Slask

26

Underkylt regn

29

Regn och snö

30

Hot

31

Kall

32

Windy

33

Klar

34

Mestadels klart

35

Delvis molnigt

36

Tillfälliga moln (natt)

37

Disigt månsken

38

Mestadels molnigt (natt)

39

Delvis molnigt med duschar

40

Mestadels molnigt med skurar (natt)

41

Delvis molnigt med åskväder

42

Mestadels molnigt med åska (natt)

43

Mestadels molnigt med stormbyar (natt)

44

Mestadels molnigt med snö (natt)

IntervalSummary

Sammanfattningsinformation för ett prognosintervall.

Name Typ Description
briefPhrase

string

Kort sammanfattande fras. Fraslängden är cirka 60 tecken.

endMinute

integer (int32)

Den sista minuten som sammanfattningen gäller.

iconCode

IconCode

Numeriskt värde som representerar en bild som motsvarar det aktuella väderförhållandet som beskrivs av egenskapen Phrase . För mer information, se Vädertjänster i Azure Maps. Kan vara NULL.

longPhrase

string

Lång sammanfattande fras. Fraslängden är 60+ tecken.

shortPhrase

string

Kort sammanfattande fras. Fraslängden är cirka 25 tecken.

startMinute

integer (int32)

Den första minuten som sammanfattningen gäller.

totalMinutes

integer (int32)

Antalet minuter som sammanfattningen gäller för.

JsonFormat

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

Värde Description
json

JavaScript-objekt notationens datautbytesformat

MinuteForecastResult

Minut för minut väderprognos.

Name Typ Description
intervalSummaries

IntervalSummary[]

Sammanfattande information för varje intervall i prognosen. Sammanfattningarna bryter ner varje potentiellt intervall där nederbörden börjar och slutar.

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

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

briefPhrase60

string

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

iconCode

IconCode

Numeriskt värde som representerar en bild som motsvarar det aktuella väderförhållandet som beskrivs av egenskapen Phrase . För mer information, se Vädertjänster i Azure Maps. Kan vara NULL.

longPhrase

string

Lång sammanfattande fras för de kommande 120 minuterna. Fraslängden är 60+ tecken.

shortPhrase

string

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

PrecipitationType

Anger typen av nederbörd. Giltiga värden är Regn, Snö, Is eller Blandning. Den här egenskapen ingår i svaret när dBZ är större än noll.

Värde Description
Ice

Is

Mix

Mix

Rain

Regn

Snow

Snow