指定された課金リージョンにおける特定のドメイン名のリソース使用量データを照会します。
操作説明
1 アカウントあたり、毎秒最大 10 回この操作を呼び出すことができます。
Interval パラメーターでサポートされる時間の粒度、既存データが利用可能な最大期間、およびデータ遅延は、クエリごとの最大時間範囲によって異なり、次の表で説明するとおりです。
| 時間の粒度 | クエリごとの最大時間範囲 | 利用可能な既存データ | データ遅延 |
| 5 分 | 3 日間 | 93 日間 | 15 分 |
| 1 時間 | 31 日間 | 186 日間 | 4 時間 |
| 1 日 | 90 日間 | 366 日間 | 翌日の 04:00 |
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cdn:DescribeDomainUsageData |
none |
*Domain
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| DomainName |
string |
任意 |
高速化ドメイン名。 各リクエストで最大 100 個のドメイン名を指定できます。 複数のドメイン名はコンマ (,) で区切ります。 説明
このパラメーターを空のままにすると、ご利用の Alibaba Cloud アカウント内のすべての高速化ドメイン名の使用量データが返されます。 |
example.com |
| StartTime |
string |
必須 |
照会する時間範囲の開始時刻。 時刻は yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準で指定する必要があります。 時刻は UTC である必要があります。 説明
データは 5 分ごとに収集されます。 |
2015-12-10T20:00:00Z |
| EndTime |
string |
必須 |
照会する時間範囲の終了時刻。 時刻は yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準で指定する必要があります。 時刻は UTC である必要があります。 説明
終了時刻は開始時刻より後である必要があります。 指定できる最大時間範囲は 31 日間です。 |
2015-12-10T22:00:00Z |
| Field |
string |
必須 |
照会するデータのタイプ。 有効値:
説明
このパラメーターを 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 |
コンテンツのタイプ。 |
static |
| Area |
string |
データが収集された課金リージョンの ID。 |
CN |
| DataInterval |
string |
返されたデータエントリ間の時間間隔。 単位:秒。 |
300 |
| UsageDataPerInterval |
object |
||
| DataModule |
array<object> |
各間隔で収集されたリソース使用量。 |
|
|
object |
各間隔で収集されたリソース使用量に関する情報。 |
||
| Value |
string |
リソース使用量。 |
423304182 |
| TimeStamp |
string |
返されたデータのタイムスタンプ。 説明
TimeStamp は、各間隔で返されたデータのタイムスタンプを示します。 |
2015-12-10T21:30:00Z |
| PeakTime |
string |
リクエストの Field パラメーターが bps に設定されている場合のピーク帯域幅値の時刻。 それ以外の場合、このパラメーターは TimeStamp パラメーターと同じ値を返します。 |
2015-12-10T21:30:00Z |
| SpecialValue |
string |
特定のシナリオでのリソース使用量。 説明
SpecialValue は、特定のシナリオでのデータ使用量を示します。 特別な課金項目が指定されていない場合は、このパラメーターを無視してください。 |
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"
}
]
}
}
エラーレスポンス
JSONJSON
http://cdn.aliyuncs.com?Action=DescribeDomainUsageData&DomainName=example.com
&StartTime=2015-12-10T20:00:00Z
&EndTime=2015-12-10T22:00:00Z
&Field=bps
&Area=EU
&<公共请求参数>
エラーコード
|
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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。