特定の課金リージョンにおけるドメイン名の使用量データを照会します。
操作説明
ユーザーごとの呼び出し周波数: 1 秒の時間に 10 回。
使用量データには、トラフィック、帯域幅、リクエスト数の 3 つのカテゴリが含まれ、それぞれバイト、ビット/s、リクエスト数で測定されます。
サポートされているクエリの時間の粒度:
単一クエリの時間スパンの最大値に応じて、リクエストパラメーター Interval は異なる時間の粒度をサポートします。クエリ可能な既存データの対応する時間の有効値とデータ遅延は次のとおりです。
| 時間の粒度 | クエリあたりの時間スパンの最大値 | クエリ可能な既存データの時間の有効値 | データ遅延 |
| 5 分 | 3 日 | 93 日 | 15 分 |
| 1 時間 | 31 日 | 186 日 | 通常 3 ~ 4 時間 |
| 1 日 | 366 日 | 366 日 | 通常 4 時間、最大 24 時間 |
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dcdn:DescribeDcdnDomainUsageData |
get |
*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 |
必須 |
クエリ対象データのタイプ。有効な値:
説明
acc は、Area パラメーターに基づくパラメータークエリをサポートしていません。 |
bps |
| Type |
string |
任意 |
リクエストのタイプ。有効な値:
デフォルト値: all。 |
dynamic |
| DataProtocol |
string |
任意 |
クエリ対象データのプロトコル。有効な値:
デフォルト値: all。 |
all |
| Area |
string |
任意 |
リージョンコード。有効な値:
デフォルト値: CN。 |
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 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| DomainName |
string |
クエリされたアクセラレーションドメイン名。 |
example.com |
| EndTime |
string |
クエリされたデータの終了時刻。 時間は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ フォーマットです。時間は協定世界時 (UTC) です。 |
2015-12-10T22:00:00Z |
| StartTime |
string |
クエリされたデータの開始時刻。 時間は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ フォーマットです。時間は協定世界時 (UTC) です。 |
2015-12-10T20:00:00Z |
| Type |
string |
返される使用量タイプ。 |
bps |
| Area |
string |
返される使用量リージョン。 |
CN |
| RequestId |
string |
リクエスト ID。 |
B955107D-E658-4E77-B913-E0AC3D31693E |
| DataInterval |
string |
各 Record の時間間隔 (秒単位)。 |
/ |
| UsageDataPerInterval |
object |
||
| DataModule |
array<object> |
各時間間隔のトラフィックデータ。 |
|
|
object |
|||
| TimeStamp |
string |
タイムスライスの開始時刻。 時間は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ フォーマットです。時間は協定世界時 (UTC) です。 |
2015-12-10T21:30:00Z |
| PeakTime |
string |
ピーク帯域幅に達した時間。この値は、Field が bps に設定されている場合にのみ有効です。それ以外の場合、値は TimeStamp と同じです。 |
2015-12-10T21:30:00Z |
| Value |
string |
使用量。 |
4233041** |
| SpecialValue |
string |
特別な使用量。 説明
このパラメーターは、特別なケースでの使用量をマークするために使用されます。特別な課金が含まれていない場合は、このパラメーターを無視できます。 |
4233041** |
例
成功レスポンス
JSONJSON
{
"DomainName": "example.com",
"EndTime": "2015-12-10T22:00:00Z",
"StartTime": "2015-12-10T20:00:00Z",
"Type": "bps",
"Area": "CN",
"RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
"DataInterval": "/",
"UsageDataPerInterval": {
"DataModule": [
{
"TimeStamp": "2015-12-10T21:30:00Z",
"PeakTime": "2015-12-10T21:30:00Z",
"Value": "4233041**",
"SpecialValue": "4233041**"
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | パラメーターが無効です。 |
| 400 | InvalidStartTime.Malformed | The specified StartTime parameter is invalid. | 有効な開始時刻の日付形式を指定してください。日付形式は ISO 8601 標準に従い、協定世界時 (UTC) の時間を使用し、yyyy-MM-ddTHH:mm:ssZ の形式で指定します。 |
| 400 | InvalidEndTime.Malformed | The specified EndTime is invalid. | 有効な終了時間のフォーマットを指定してください。日付形式は ISO 8601 標準に従い、協定世界時 (UTC) を使用します。フォーマットは yyyy-MM-ddTHH:mm:ssZ です。 |
| 400 | InvalidTime.Malformed | Specified StartTime or EndTime is malformed. | 開始時刻または終了時刻のフォーマットが正しくありません。日付形式は ISO 8601 標準に従い、協定世界時 (UTC) の時間を使用し、yyyy-MM-ddTHH:mm:ssZ の形式で指定します。 |
| 400 | InvalidParameterField | The specified Field is invalid. | Field パラメーターが無効です。 |
| 400 | InvalidParameterType | The specified Type is invalid. | Type パラメーターが無効です。値を確認して、再試行してください。 |
| 400 | InvalidEndTime.Mismatch | The specified EndTime is earlier than the StartTime. | 終了時刻が開始時刻より前です。時間の設定を確認してください。 |
| 400 | InvalidTimeSpan | The time span exceeds the limit. | 時間スパンが制限を超えています。API ドキュメントを参照し、有効なクエリ時間スパンを設定してください。 |
| 400 | InvalidParameterInterval | The specified Interval is invalid. | Interval パラメーターが無効です。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。