Weather - Get Daily Historical Records

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 1.1

Służy do pobierania danych klimatologii, takich jak poprzednie dzienne rekordy temperatury, opady i opady śniegu w danej lokalizacji.

Interfejs Get Daily Historical Records API jest żądaniem HTTP GET , które zwraca dane klimatologii, takie jak ostatnie dzienne rekordy temperatury, opady i opady śniegu w danej lokalizacji współrzędnych. Dostępność danych rekordów będzie się różnić w zależności od lokalizacji. Ogólnie rzecz biorąc, dane historyczne mogą być dostępne nawet w ciągu ostatnich 5 do 40 lat, w zależności od lokalizacji.

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

Z parametrami opcjonalnymi:

GET https://atlas.microsoft.com/weather/historical/records/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 wynosi od 1 do 31 dni kalendarzowych, dlatego należy określić data rozpoczęcia i data zakończenia, która nie przekracza maksymalnie 31 dni (tj. startDate=2012-01-01&endDate=2012-01-01-31).
query	query	True	number[]	Odpowiednie zapytanie określone jako ciąg rozdzielany przecinkami składające 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 wynosi od 1 do 31 dni kalendarzowych, dlatego należy określić data rozpoczęcia i data zakończenia, która nie przekracza maksymalnie 31 dni (tj. startDate=2012-01-01&endDate=2012-01-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ń identyfikatora Entra firmy Microsoft w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki.

Odpowiedzi

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

Zabezpieczenia

AADToken

Są to przepływy protokołu Microsoft Entra OAuth 2.0 . Po połączeniu z kontrolą dostępu opartą na rolach platformy Azure można użyć jej do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu 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ęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń stanowi 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 w celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać z poziomu interfejsu API zarządzania usługami Maps .

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 poziomu 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 skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków 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ółużytkowany 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.

Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do wszystkich interfejsów API REST. Innymi słowy, ten klucz może służyć 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 klucz mógł być bezpiecznie przechowywany.

Typ: apiKey
W: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji list 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 AZURE SDK lub interfejsów API REST.

Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure oraz szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej bezpieczny 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 SAS.

Typ: apiKey
W: header

Przykłady

Successful Daily Historical Records Request

Przykładowe żądanie

HTTP

GET https://atlas.microsoft.com/weather/historical/records/daily/json?api-version=1.1&query=39.952583,-75.165222&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": 18.3,
          "unit": "C",
          "unitType": 17,
          "year": 1951
        },
        "minimum": {
          "value": -19.4,
          "unit": "C",
          "unitType": 17,
          "year": 1984
        },
        "average": {
          "value": -0.6,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "maximum": {
          "value": 48,
          "unit": "mm",
          "unitType": 3,
          "year": 1978
        }
      },
      "snowfall": {
        "maximum": {
          "value": 12.19,
          "unit": "cm",
          "unitType": 4,
          "year": 1978
        }
      }
    },
    {
      "date": "2012-01-21T00:00:00-04:00",
      "temperature": {
        "maximum": {
          "value": 16.7,
          "unit": "C",
          "unitType": 17,
          "year": 1959
        },
        "minimum": {
          "value": -21.1,
          "unit": "C",
          "unitType": 17,
          "year": 1985
        },
        "average": {
          "value": -2.2,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "maximum": {
          "value": 33.5,
          "unit": "mm",
          "unitType": 3,
          "year": 1979
        }
      },
      "snowfall": {
        "maximum": {
          "value": 34.29,
          "unit": "cm",
          "unitType": 4,
          "year": 2014
        }
      }
    },
    {
      "date": "2012-01-22T00:00:00-04:00",
      "temperature": {
        "maximum": {
          "value": 21.1,
          "unit": "C",
          "unitType": 17,
          "year": 1906
        },
        "minimum": {
          "value": -21.7,
          "unit": "C",
          "unitType": 17,
          "year": 1984
        },
        "average": {
          "value": -0.3,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "maximum": {
          "value": 26.2,
          "unit": "mm",
          "unitType": 3,
          "year": 1987
        }
      },
      "snowfall": {
        "maximum": {
          "value": 22.35,
          "unit": "cm",
          "unitType": 4,
          "year": 1987
        }
      }
    }
  ]
}

Definicje

Nazwa	Opis
DailyHistoricalRecords
DailyHistoricalRecordsResult
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żna go użyć 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ą.
WeatherUnitYear
WeatherUnitYearMax	Zwracane wartości temperatury.
WeatherUnitYearMaxMinAvg	Zwracane wartości temperatury.

DailyHistoricalRecords

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.
precipitation	WeatherUnitYearMax	Maksymalna ilość opadów (odpowiednik cieczy), która spadła.
snowfall	WeatherUnitYearMax	Maksymalne opady śniegu.
temperature	WeatherUnitYearMaxMinAvg	Wartość temperatury.

DailyHistoricalRecordsResult

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

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

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żna go użyć 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. Przykładowe jednostki systemu cesarskiego to Fahrenheit i mile.
metric	string	Zwracanie danych w jednostkach metryk. 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 zwracanej wartości.
unitType	UnitType	Wartość identyfikatora liczbowego skojarzona z wyświetlanym typem jednostki. Można go użyć 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ść.

WeatherUnitYear

Nazwa	Typ	Opis
unit	string	Typ jednostki dla zwracanej wartości.
unitType	integer	Wartość identyfikatora liczbowego skojarzona z wyświetlanym typem jednostki. Można go użyć 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ść.
year	integer	Rok, w których wystąpiła wartość.

WeatherUnitYearMax

Zwracane wartości temperatury.

Nazwa	Typ	Opis
maximum	WeatherUnitYear	Maksymalna temperatura w okresie.

WeatherUnitYearMaxMinAvg