Weather - Get Daily Historical Actuals

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 1.1

Służy do uzyskiwania danych dotyczących klimatologii, takich jak poprzednie codzienne obserwowane temperatury, opady, opady śniegu i głębokość śniegu.

Interfejs Get Daily Historical Actuals API to żądanie HTTP GET , które zwraca dane dotyczące klimatologii, takie jak ostatnie dzienne rzeczywiste obserwowane temperatury, opady, opady śniegu, głębokość śniegu i informacje o dniu dnia chłodzenia/ogrzewania dla dnia w danej lokalizacji współrzędnej. Dane są żądane dla określonego zakresu dat, do 31 dni w pojedynczym żądaniu interfejsu API. Ogólnie rzecz biorąc, dane historyczne mogą być dostępne aż do ostatnich 5 do 40 lat, w zależności od lokalizacji.

GET https://atlas.microsoft.com/weather/historical/actuals/daily/json?api-version=1.1&query={query}&startDate={startDate}&endDate={endDate}

Z parametrami opcjonalnymi:

GET https://atlas.microsoft.com/weather/historical/actuals/daily/json?api-version=1.1&query={query}&startDate={startDate}&endDate={endDate}&unit={unit}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
format	path	True	JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko `json` format.
api-version	query	True	string	Numer wersji interfejsu API usługi Azure Maps.
endDate	query	True	string date	Data zakończenia w formacie ISO 8601, na przykład 2019-10-28. Obsługiwany zakres dat to od 1 do 31 dni kalendarzowych, dlatego należy określić wartość startDate i endDate, która nie przekracza maksymalnie 31 dni (tj. startDate=2012-01-01&endDate=2012-01-31).
query	query	True	number[]	Odpowiednie zapytanie określone jako ciąg rozdzielany przecinkami składa się z szerokości geograficznej, po której następuje długość geograficzna, np. "47.641268,-122.125679".
startDate	query	True	string date	Data rozpoczęcia w formacie ISO 8601, na przykład 2019-10-27. Obsługiwany zakres dat to od 1 do 31 dni kalendarzowych, dlatego należy określić wartość startDate i endDate, która nie przekracza maksymalnie 31 dni (tj. startDate=2012-01-01&endDate=2012-01-31).
unit	query		WeatherDataUnit	Określa, aby zwracać dane w jednostkach metryk lub jednostkach imperialnych. Wartość domyślna to metryka.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-id		string	Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Microsoft Entra ID. Reprezentuje unikatowy identyfikator konta usługi Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania usługi Azure Maps. Aby użyć zabezpieczeń microsoft Entra ID w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DailyHistoricalActualsResult	OK
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy protokołu Microsoft Entra OAuth 2.0 . W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu oparte na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwagi

Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id , aby wskazać, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami .

Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów entra firmy Microsoft. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST. * Użycie zestawu Sdk sieci Web usługi Azure Maps umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Omówienie platformy tożsamości firmy Microsoft.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenia konta usługi Azure Maps w witrynie Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Przy użyciu tego klucza każda aplikacja może uzyskać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może być używany jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu do interfejsów API REST usługi Azure Maps, aby można było bezpiecznie przechowywać klucz.

Typ: apiKey
W: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego tokenu każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.

Typ: apiKey
W: header

Przykłady

Successful Daily Historical Actuals Request

Przykładowe żądanie

HTTP

GET https://atlas.microsoft.com/weather/historical/actuals/daily/json?api-version=1.1&query=40.78,-77.89&startDate=2012-01-20&endDate=2012-01-22

Przykładowa odpowiedź

Kod stanu:: 200

{
  "results": [
    {
      "date": "2012-01-20T00:00:00-04:00",
      "temperature": {
        "maximum": {
          "value": -6.1,
          "unit": "C",
          "unitType": 17
        },
        "minimum": {
          "value": -11.1,
          "unit": "C",
          "unitType": 17
        },
        "average": {
          "value": -8.6,
          "unit": "C",
          "unitType": 17
        }
      },
      "degreeDaySummary": {
        "heating": {
          "value": 27,
          "unit": "C",
          "unitType": 17
        },
        "cooling": {
          "value": 0,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "value": 10.9,
        "unit": "mm",
        "unitType": 3
      },
      "snowfall": {
        "value": 12.19,
        "unit": "cm",
        "unitType": 4
      },
      "snowDepth": {
        "value": 15.2,
        "unit": "cm",
        "unitType": 4
      }
    },
    {
      "date": "2012-01-21T00:00:00-04:00",
      "temperature": {
        "maximum": {
          "value": -1.7,
          "unit": "C",
          "unitType": 17
        },
        "minimum": {
          "value": -8.9,
          "unit": "C",
          "unitType": 17
        },
        "average": {
          "value": -5.3,
          "unit": "C",
          "unitType": 17
        }
      },
      "degreeDaySummary": {
        "heating": {
          "value": 24,
          "unit": "C",
          "unitType": 17
        },
        "cooling": {
          "value": 0,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "value": 0,
        "unit": "mm",
        "unitType": 3
      },
      "snowfall": {
        "value": 0.51,
        "unit": "cm",
        "unitType": 4
      },
      "snowDepth": {
        "value": 12.7,
        "unit": "cm",
        "unitType": 4
      }
    },
    {
      "date": "2012-01-22T00:00:00-04:00",
      "temperature": {
        "maximum": {
          "value": 0,
          "unit": "C",
          "unitType": 17
        },
        "minimum": {
          "value": -7.2,
          "unit": "C",
          "unitType": 17
        },
        "average": {
          "value": -3.6,
          "unit": "C",
          "unitType": 17
        }
      },
      "degreeDaySummary": {
        "heating": {
          "value": 22,
          "unit": "C",
          "unitType": 17
        },
        "cooling": {
          "value": 0,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "value": 0,
        "unit": "mm",
        "unitType": 3
      },
      "snowfall": {
        "value": 0,
        "unit": "cm",
        "unitType": 4
      },
      "snowDepth": {
        "value": 10.2,
        "unit": "cm",
        "unitType": 4
      }
    }
  ]
}

Definicje

Nazwa	Opis
DailyHistoricalActuals
DailyHistoricalActualsResult
DegreeDaySummary
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko `json` format.
UnitType	Wartość identyfikatora liczbowego skojarzona z wyświetlanym typem jednostki. Może być używany do tłumaczenia jednostkowego. Szczegółowe informacje można znaleźć w artykule Weather services in Azure Maps (Usługi pogodowe w usłudze Azure Maps ).
WeatherDataUnit	Określa, aby zwracać dane w jednostkach metryk lub jednostkach imperialnych. Wartość domyślna to metryka.
WeatherUnit	Określona wartość danej jednostki powiązanej z pogodą.
WeatherUnitMaxMinAvg	Zwracane wartości temperatury.

DailyHistoricalActuals

Nazwa	Typ	Opis
date	string	Data i godzina bieżącej obserwacji wyświetlanej w formacie ISO 8601, na przykład 2019-10-27T19:39:57-08:00.
degreeDaySummary	DegreeDaySummary	Podsumowanie informacji o dniu ogrzewania lub chłodzenia. Dni stopnia to miary tego, jak zimno lub ciepło jest lokalizacja. Dzień stopnia porównuje średnią (średnią wysokich i niskich) temperatur na zewnątrz zarejestrowanych dla lokalizacji do standardowej temperatury 65 stopni F/ 18 stopni C.
precipitation	WeatherUnit	Ilość opadów (odpowiednik płynu), który spadł.
snowDepth	WeatherUnit	Głębokość śniegu.
snowfall	WeatherUnit	Ilość śniegu, który spadł.
temperature	WeatherUnitMaxMinAvg	Wartości temperatury.

DailyHistoricalActualsResult

Nazwa	Typ	Opis
nextLink	string	Jest to link do następnej strony zwróconych funkcji. Jeśli jest to ostatnia strona, nie ma tego pola.
results	DailyHistoricalActuals[]	Wartości rzeczywiste historyczne dla każdego żądanego dnia.

DegreeDaySummary

Nazwa	Typ	Opis
cooling	WeatherUnit	Liczba stopni, o których średnia temperatura przekracza 65 stopni F/ 18 stopni C.
heating	WeatherUnit	Liczba stopni średniej temperatury poniżej 65 stopni F/ 18 stopni C.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

JsonFormat

Żądany format odpowiedzi. Obsługiwany jest tylko json format.

Nazwa	Typ	Opis
json	string	Format wymiany danych notacji obiektów JavaScript

UnitType

Wartość identyfikatora liczbowego skojarzona z wyświetlanym typem jednostki. Może być używany do tłumaczenia jednostkowego. Szczegółowe informacje można znaleźć w artykule Weather services in Azure Maps (Usługi pogodowe w usłudze Azure Maps ).

Nazwa	Typ	Opis
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

Określa, aby zwracać dane w jednostkach metryk lub jednostkach imperialnych. Wartość domyślna to metryka.

Nazwa	Typ	Opis
imperial	string	Zwraca dane w jednostkach imperialnych. Niektóre przykładowe jednostki systemu imperialnego to Fahrenheit i mile.
metric	string	Zwracanie danych w jednostkach metryk. Niektóre przykładowe jednostki systemu metryki to Stopnie Celsjusza i kilometr.

WeatherUnit

Określona wartość danej jednostki powiązanej z pogodą.

Nazwa	Typ	Opis
unit	string	Typ jednostki dla zwróconej wartości.
unitType	UnitType	Wartość identyfikatora liczbowego skojarzona z wyświetlanym typem jednostki. Może być używany do tłumaczenia jednostkowego. Szczegółowe informacje można znaleźć w artykule Weather services in Azure Maps (Usługi pogodowe w usłudze Azure Maps ).
value	number	Zaokrąglona wartość.

WeatherUnitMaxMinAvg

Zwracane wartości temperatury.

Nazwa	Typ	Opis
average	WeatherUnit	Średnia temperatura okresu.
maximum	WeatherUnit	Maksymalna temperatura okresu.
minimum	WeatherUnit	Minimalna temperatura okresu.

Udostępnij za pośrednictwem