特定の課金リージョンにおけるドメイン名の使用量データをクエリします。
操作説明
単一ユーザーによるこの操作の呼び出し頻度は、1 秒あたり最大 10 回です。
サポートされる時間の粒度(Interval パラメーターで指定)は、単一クエリの最大時間範囲に依存します。以下の表に、各時間の粒度に対応するクエリ可能な時間範囲およびデータ遅延を示します。
| 時間の粒度 | 単一クエリの最大時間範囲 | クエリ可能な既存データ範囲 | データ遅延 |
| 5 分 | 3 日間 | 93 日間 | 15 分 |
| 1 時間 | 7 日間 | 186 日間 | 通常 3~4 時間 |
| 1 日 | 31 日間 | 366 日間 | 通常 4 時間(最大 24 時間を超えない) |
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cdn:DescribeDomainUsageData |
none |
*Domain
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| DomainName |
string |
任意 |
クエリ対象の高速化ドメイン名です。カンマ (,) で区切ることにより、複数のドメイン名を指定できます。1 回のクエリで最大 100 個のドメイン名を指定できます。 説明
このパラメーターを指定しない場合、アカウントに関連付けられたすべての高速化ドメイン名の使用量データがマージされた結果が返されます。 |
example.com |
| StartTime |
string |
必須 |
クエリ対象の時間範囲の開始時刻です。 ISO 8601 標準(yyyy-MM-ddTHH:mm:ssZ 形式)で時刻を指定してください。時刻は協定世界時 (UTC) でなければなりません。 説明
データの時間の粒度は 5 分です。 |
2015-12-10T20:00:00Z |
| EndTime |
string |
必須 |
クエリ対象の時間範囲の終了時刻です。 ISO 8601 標準(yyyy-MM-ddTHH:mm:ssZ 形式)で時刻を指定してください。時刻は協定世界時 (UTC) でなければなりません。 説明
終了時刻は開始時刻より後である必要があります。クエリ可能な最大時間範囲は 31 日間です。 |
2015-12-10T22:00:00Z |
| Field |
string |
必須 |
クエリ対象のデータ種別です。有効な値は以下のとおりです。
説明
地域別のリクエスト数はクエリできません。Field を acc に設定した場合、Area パラメーターはサポートされません。 |
bps |
| Type |
string |
任意 |
クエリ対象のコンテンツ種別です。有効な値は以下のとおりです。
|
static |
| DataProtocol |
string |
任意 |
クエリ対象のデータのプロトコルです。有効な値は以下のとおりです。
|
all |
| Area |
string |
任意 |
リージョン名です。有効な値は以下のとおりです。
|
CN |
| Interval |
string |
任意 |
クエリ対象のデータの時間の粒度(秒単位)です。有効な値は 300(5 分)、3600(1 時間)、86400(1 日)です。
|
300 |
パラメーターの組み合わせ
以下の表に、課金データとパラメーター値の対応関係を示します。操作の呼び出し方法については、リクエスト例をご参照ください。
| 課金データ | DataProtocol の値 | Type の値 | Field の値 | Area の値 |
| トラフィック | all または未指定 | all または未指定 | traf | CN、OverSeas、AP1、AP2、AP3、NA、SA、EU、MEAA |
| 帯域幅 | all または未指定 | all または未指定 | bps | CN、OverSeas、AP1、AP2、AP3、NA、SA、EU、MEAA |
| 静的 HTTPS リクエスト数 | https | static | acc | all |
| 動的 HTTP リクエスト数 | http | dynamic | acc | all |
| 動的 HTTPS リクエスト数 | https | dynamic | acc | all |
| 動的 QUIC リクエスト数 | quic | dynamic | acc | all |
| 静的 QUIC リクエスト数 | quic | static | acc | all |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
パラメーターのリストです。 |
||
| RequestId |
string |
リクエストの ID です。 |
B955107D-E658-4E77-B913-E0AC3D31693E |
| DomainName |
string |
高速化ドメイン名です。 |
example.com |
| StartTime |
string |
時間範囲の開始時刻です。 |
2015-12-10T20:00:00Z |
| EndTime |
string |
時間範囲の終了時刻です。 |
2015-12-10T22:00:00Z |
| Type |
string |
使用量データの種別です。 |
bps |
| Area |
string |
使用量データが収集されたリージョンです。 |
CN |
| DataInterval |
string |
データ項目間の時間間隔(秒単位)です。 |
300 |
| UsageDataPerInterval |
object |
||
| DataModule |
array<object> |
各時間間隔における使用量データです。 |
|
|
object |
各時間間隔における使用量データの詳細です。 |
||
| Value |
string |
使用量データです。 |
423304182 |
| TimeStamp |
string |
タイムスライスの開始時刻です。 説明
応答には複数の TimeStamp 値が含まれます。各値は 1 つのタイムスライスを表します。 |
2015-12-10T21:30:00Z |
| PeakTime |
string |
Field を bps に設定した場合、このパラメーターはピーク帯域幅のタイムスタンプを示します。それ以外の場合は、このパラメーターの値は TimeStamp の値と同じになります。 |
2015-12-10T21:30:00Z |
| SpecialValue |
string |
特殊な使用量データです。 説明
このパラメーターは、特別な状況下での使用量データをマークするために使用されます。特別な課金ルールが適用されていない場合は、このパラメーターを無視して構いません。 |
423304182 |
例
成功レスポンス
JSONJSON
{
"RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
"DomainName": "example.com",
"StartTime": "2015-12-10T20:00:00Z",
"EndTime": "2015-12-10T22:00:00Z",
"Type": "bps",
"Area": "CN",
"DataInterval": "300",
"UsageDataPerInterval": {
"DataModule": [
{
"Value": "423304182",
"TimeStamp": "2015-12-10T21:30:00Z",
"PeakTime": "2015-12-10T21:30:00Z",
"SpecialValue": "423304182"
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | |
| 400 | InvalidParameterType | The specified Type is invalid. | |
| 400 | InvalidParameterField | The specified Field is invalid. | |
| 400 | InvalidParameterStartTime | The parameter StartTime is invalid. | |
| 400 | InvalidParameterEndTime | The parameter EndTime is invalid. | |
| 400 | InvalidEndTime.Mismatch | Specified EndTime does not match the specified StartTime. | |
| 400 | InvalidIntervalParameter | The specified Interval is invalid. | |
| 400 | InvalidTimeSpan | The time span exceeds the limit. | |
| 400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | |
| 400 | InvalidTime.Malformed | Specified StartTime or EndTime is malformed. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。