Weather - Get Daily Historical Records

リファレンス

Service:: Maps

API Version:: 1.1

過去の毎日の記録的な気温、降水量、降雪などの気候データを特定の場所で取得するには、を使用します。

Get Daily Historical Records API は、過去 1 日の記録温度、降水量、降雪などの気候データを特定の座標位置で返す HTTP GET 要求です。レコードデータの可用性は、場所によって異なります。一般に、履歴データは、場所に応じて、過去 5 年から 40 年以上前まで利用できる場合があります。

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

With optional parameters:

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

URI パラメーター

名前	/	必須	型	説明
format	path	True	JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
api-version	query	True	string	Azure Maps API のバージョン番号。
endDate	query	True	string date	ISO 8601 形式の終了日 (2019-10-28 など)。サポートされる日付範囲は 1 から 31 カレンダー日であるため、startDate と endDate を指定してください。これは、最大 31 日を超えないようにしてください (つまり、startDate=2012-01-01&endDate=2012-01-31)。
query	query	True	number[]	緯度の後に経度 (例: "47.641268,-122.125679" など) で構成されるコンマ区切り文字列として指定された該当するクエリ。
startDate	query	True	string date	ISO 8601 形式の開始日 (2019-10-27 など)。サポートされる日付範囲は 1 から 31 カレンダー日であるため、startDate と endDate を指定してください。これは、最大 31 日を超えないようにしてください (つまり、startDate=2012-01-01&endDate=2012-01-31)。
unit	query		WeatherDataUnit	メトリック単位またはインペリアル単位のいずれかでデータを返すように指定します。既定値はメトリックです。

要求ヘッダー

名前	必須	型	説明
x-ms-client-id		string	Microsoft Entra ID セキュリティモデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーンアカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、次の記事を参照してください。

応答

名前	型	説明
200 OK	DailyHistoricalRecordsResult	OK
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

AADToken

これらは OAuth 2.0 フロー Microsoft Entraです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタムロールを使用して、任意のユーザー、グループ、またはサービスプリンシパルにアクセス権 Azure Mapsを付与できます。

シナリオを実装するには、認証の概念を表示することをお勧めします。要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。

メモ

このセキュリティ定義では、ヘッダーを使用して、x-ms-client-idアプリケーションがアクセスを要求しているリソースAzure Maps示す必要があります。これは、 Maps 管理 API から取得できます。

Authorization URLは、Azure パブリッククラウドインスタンスに固有です。ソブリンクラウドには、固有の承認 URL とMicrosoft Entra ID構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。 * Azure Maps Web SDK を使用すると、複数のユースケースに対してアプリケーションを構成ベースで設定できます。

Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。

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

Scopes

名前	説明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

これは、Azure portalでAzure Maps アカウントを作成するとき、または PowerShell、CLI、Azure SDK、または REST API を使用するときにプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。つまり、このキーは、発行されたアカウントのマスターキーとして使用できます。

公開されているアプリケーションの場合は、機密クライアントアプリケーションのアプローチを使用して、キーを安全に格納できるように、Azure Maps REST API にアクセスすることをお勧めします。

Type: apiKey
In: query

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して、Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。

このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンをきめ細かく制御できます。つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。

公開されているアプリケーションの場合、 Map アカウントリソースで許可される配信元の特定の一覧を構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。

Type: apiKey
In: header

例

Successful Daily Historical Records Request

Sample Request

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

Sample Response

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

定義

名前	説明
DailyHistoricalRecords
DailyHistoricalRecordsResult
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
UnitType	表示される単位の種類に関連付けられている数値 ID 値。単位変換に使用できます。詳細については、Azure Mapsの Weather サービスに関するページを参照してください。
WeatherDataUnit	メトリック単位またはインペリアル単位のいずれかでデータを返すように指定します。既定値はメトリックです。
WeatherUnit	天気に関連する特定の単位の特定の値。
WeatherUnitYear
WeatherUnitYearMax	返される温度値。
WeatherUnitYearMaxMinAvg	返される温度値。

DailyHistoricalRecords

名前	型	説明
date	string	ISO 8601 形式で表示されている現在の観測値の日付と時刻 (例: 2019-10-27T19:39:57-08:00)。
precipitation	WeatherUnitYearMax	落下した沈殿の最大量 (液体相当)。
snowfall	WeatherUnitYearMax	最大降雪量。
temperature	WeatherUnitYearMaxMinAvg	温度の値。

DailyHistoricalRecordsResult

名前	型	説明
nextLink	string	は、返される機能の次のページへのリンクです。最後のページの場合は、このフィールドはありません。
results	DailyHistoricalRecords[]	要求された各日の履歴レコード。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

JsonFormat

応答の目的の形式。サポートされているのは json 形式のみです。

名前	型	説明
json	string	JavaScript オブジェクト表記データ交換形式

UnitType

表示される単位の種類に関連付けられている数値 ID 値。単位変換に使用できます。詳細については、Azure Mapsの Weather サービスに関するページを参照してください。

名前	型	説明
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

メトリック単位またはインペリアル単位のいずれかでデータを返すように指定します。既定値はメトリックです。

名前	型	説明
imperial	string	データをインペリアル単位で返します。帝国システムの単位の例としては、華氏とマイルがあります。
metric	string	メトリック単位でデータを返します。メートル法の単位の例としては、摂氏とキロメートルがあります。

WeatherUnit

天気に関連する特定の単位の特定の値。

名前	型	説明
unit	string	戻り値の単位の型。
unitType	UnitType	表示される単位の種類に関連付けられている数値 ID 値。単位変換に使用できます。詳細については、Azure Mapsの Weather サービスに関するページを参照してください。
value	number	丸められた値。

WeatherUnitYear

名前	型	説明
unit	string	戻り値の単位の型。
unitType	integer	表示される単位の種類に関連付けられている数値 ID 値。単位変換に使用できます。詳細については、Azure Mapsの Weather サービスに関するページを参照してください。
value	number	丸められた値。
year	integer	値が発生した年。

WeatherUnitYearMax

返される温度値。

名前	型	説明
maximum	WeatherUnitYear	期間の最大温度。

WeatherUnitYearMaxMinAvg