トラフィック分析時系列データのクエリ
操作説明
StartTimeとEndTimeを指定しない場合、API は過去 24 時間のデータを返します。StartTimeとEndTimeを指定した場合、API は指定された期間のデータを返します。- API は、
StartTimeとEndTimeの間のスパンに基づいて、異なる時間の粒度を返します。3 時間以下のスパンの場合、1 分粒度のデータを返します。
3 時間を超え 12 時間以下のスパンの場合、5 分粒度のデータを返します。
12 時間を超え 1 日以下のスパンの場合、15 分粒度のデータを返します。
1 日を超え 10 日以下のスパンの場合、1 時間粒度のデータを返します。
10 日を超え 31 日以下のスパンの場合、1 日粒度のデータを返します。
クエリ期間中のアクセス数が多いため、データ分析はサンプリングされる場合があります。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
esa:DescribeSiteTimeSeriesData |
none |
*Site
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| SiteId |
string |
任意 |
サイト ID。 ListSites インターフェイスを呼び出すことでサイト ID を取得します。 このパラメーターが空の場合、ユーザーレベルのデータがクエリされます。 |
1150376036***** |
| StartTime |
string |
任意 |
データ取得の開始時刻。 日付形式は ISO8601 表記に従い、UTC+0 時間を使用します。形式は yyyy-MM-ddTHH:mm:ssZ です。 |
2023-04-08T16:00:00Z |
| EndTime |
string |
任意 |
データ取得の終了時刻。 日付形式は ISO8601 表記に従い、UTC+0 時間を使用します。形式は yyyy-MM-ddTHH:mm:ssZ です。 説明
終了時刻は開始時刻より後である必要があります。 |
2023-04-09T16:00:00Z |
| Interval |
string |
任意 |
データクエリの時間粒度 (秒単位)。 単一クエリの最大時間スパンに応じて、このパラメーターは 60 (1 分)、300 (5 分)、3600 (1 時間)、および 86400 (1 日) の値をサポートします。詳細については、「サポートされているクエリ時間の粒度」をご参照ください。 |
300 |
| Fields |
array<object> |
必須 |
クエリメトリック。 |
|
|
object |
任意 |
クエリメトリック。 |
||
| FieldName |
string |
任意 |
クエリメトリック値。 説明
特定のディメンションについては、「データ分析フィールドの説明」をご参照ください。 |
Traffic |
| Dimension |
array |
任意 |
クエリディメンション。 |
|
|
string |
任意 |
クエリディメンション。 説明
特定のディメンションについては、「データ分析フィールドの説明」をご参照ください。 |
ALL |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| Data |
array<object> |
返されるデータ。 |
|
|
array<object> |
返されるデータ。 |
||
| FieldName |
string |
クエリメトリック値。 |
Traffic |
| DimensionName |
string |
クエリディメンション。 |
ALL |
| DimensionValue |
string |
クエリディメンション値。 |
ALL |
| DetailData |
array<object> |
返されるデータ。 |
|
|
object |
返されるデータ。 |
||
| TimeStamp |
string |
タイムスライスの開始タイムスタンプ。 |
2023-04-08T16:00:00Z |
| Value |
any |
値。 |
123 |
| SummarizedData |
array<object> |
集計されたクエリデータ。 |
|
|
object |
|||
| FieldName |
string |
クエリ対象の集計メトリックの値。 |
Traffic |
| DimensionName |
string |
クエリ対象の集計データのディメンション。 |
ALL |
| DimensionValue |
string |
クエリ対象の集計ディメンションの値。 |
ALL |
| AggMethod |
string |
使用された集計方法。 |
sum |
| Value |
any |
集計された値。 |
12345 |
| RequestId |
string |
リクエスト ID。 |
04F0F334-1335-436C-A1D7-6C044FE7**** |
| StartTime |
string |
データ取得の開始時刻。 日付形式は ISO8601 表記に従い、UTC+0 を使用します。形式は yyyy-MM-ddTHH:mm:ssZ です。 |
2023-04-08T16:00:00Z |
| EndTime |
string |
データ取得の終了時刻。 日付形式は ISO8601 表記に従い、UTC+0 を使用します。形式は yyyy-MM-ddTHH:mm:ssZ です。 |
2023-04-09T16:00:00Z |
| Interval |
integer |
データの粒度 (秒単位)。 |
300 |
| SamplingRate |
number |
サンプリングレート (%)。 |
100 |
例
成功レスポンス
JSONJSON
{
"Data": [
{
"FieldName": "Traffic",
"DimensionName": "ALL",
"DimensionValue": "ALL",
"DetailData": [
{
"TimeStamp": "2023-04-08T16:00:00Z",
"Value": "123"
}
]
}
],
"SummarizedData": [
{
"FieldName": "Traffic",
"DimensionName": "ALL",
"DimensionValue": "ALL",
"AggMethod": "sum",
"Value": "12345"
}
],
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
"StartTime": "2023-04-08T16:00:00Z",
"EndTime": "2023-04-09T16:00:00Z",
"Interval": 300,
"SamplingRate": 100
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParameter.TimeRange | The specified time range exceeds the limit. Adjust it and try again. | |
| 400 | TooManyRequests | Too many requests.Please try again later. | |
| 400 | InvalidEndTime.Mismatch | The specified EndTime is earlier than the StartTime. | |
| 400 | InvalidParameter | Parameter verification failed. Check your configurations and try again. | |
| 400 | QuotaCheckFailed.Function | The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature. | |
| 400 | InvalidParameter.Field | The specified Field is invalid. | |
| 400 | InvalidParameter.Dimension | The specified Dimension is invalid. | |
| 400 | InvalidTime.Malformed | Specified start time or end time is malformed. | |
| 400 | TooManyDimensions | Too many query dimensions specified. Delete some and try again. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。