ディレクトリごとのネットワークトラフィック量やアクセス数などのモニタリングデータをクエリします。
操作説明
この操作は、ホワイトリストに登録されているユーザーのみが利用できます。ご利用のワークロードの 1 日のピーク帯域幅が 10 Gbit/s に達した場合、チケットを送信してホワイトリストへの登録を申請できます。
1 つのアカウントで、1 秒あたり最大 6,000 回この API オペレーションを呼び出すことができます。
ディレクトリごとのデータ収集は、ご利用の Alibaba Cloud アカウント内の指定されたドメイン名でのみ利用可能です。ご利用の Alibaba Cloud アカウント内のすべてのドメイン名で有効にすることはできません。
ドメイン名に属するファイルの平均サイズは 1 MB より大きい必要があります。
1 つのドメイン名に指定できるディレクトリの数は 100 を超えることはできません。ディレクトリの数が 100 を超えると、データ精度が低下します。
StartTime または EndTime を設定しない場合、過去 24 時間以内に収集されたデータがクエリされます。StartTime と EndTime の両方を設定した場合、指定された期間内のデータがクエリされます。
過去 30 日以内に収集されたデータをクエリできます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cdn:DescribeDomainPathData |
get |
*Domain
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| PageNumber |
integer |
任意 |
返されるページ番号。ページは 1 から始まります。 |
1 |
| PageSize |
integer |
任意 |
各ページに返すエントリ数。有効な値:1~1000 の整数。 |
20 |
| Path |
string |
任意 |
クエリするパス。複数のパスはスラッシュ (/) で区切ります。このパラメーターを設定しない場合、すべてのパスがクエリされます。値をディレクトリに設定する場合、末尾にスラッシュ (/) を付ける必要があります。 説明
あいまい一致はサポートされていません。ディレクトリに基づいてデータを収集する場合は、特定のディレクトリ (例: directory/path/) を指定できます。この場合、帯域幅データは directory/path/ に基づいて収集されます。 |
/path/ |
| StartTime |
string |
任意 |
yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 形式で時刻を指定します。時刻は協定世界時 (UTC) である必要があります。例:2016-10-20T04:00:00Z。 |
2016-10-20T04:00:00Z |
| EndTime |
string |
任意 |
クエリする期間の終了時刻。yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 形式で時刻を指定します。時刻は協定世界時 (UTC) である必要があります。開始時刻と終了時刻の間隔は 30 日未満である必要があります。例:2016-10-21T04:00:00Z。 |
2016-10-21T04:00:00Z |
| DomainName |
string |
必須 |
高速化ドメイン名。 説明
各呼び出しで指定できるドメイン名は 1 つだけです。 |
example.com |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| EndTime |
string |
データがクエリされた期間の終了時刻。 |
2017-09-30T17:00:00Z |
| StartTime |
string |
データがクエリされた期間の開始時刻。 |
2017-09-30T16:00:00Z |
| PageSize |
integer |
ページごとに返されるエントリ数。 |
20 |
| PageNumber |
integer |
返されたページのページ番号。ページは 1 から始まります。 |
1 |
| TotalCount |
integer |
返されたエントリの総数。 |
2 |
| DomainName |
string |
高速化ドメイン名。 |
example.com |
| DataInterval |
string |
時間間隔。単位:秒。 |
300 |
| PathDataPerInterval |
object |
||
| UsageData |
array<object> |
各時間間隔で収集された帯域幅の値のリスト。 |
|
|
object |
|||
| Path |
string |
パス。 |
/path/ |
| Time |
string |
時点。 |
2017-09-30T16:00:00Z |
| Acc |
integer |
URL へのアクセス数。 |
10 |
| Traffic |
integer |
ネットワークトラフィック量。単位:バイト。 |
346 |
| RequestId |
string |
リクエスト ID。 |
DE81639B-DAC1-4C76-AB72-F34B836837D5 |
例
成功レスポンス
JSONJSON
{
"EndTime": "2017-09-30T17:00:00Z",
"StartTime": "2017-09-30T16:00:00Z",
"PageSize": 20,
"PageNumber": 1,
"TotalCount": 2,
"DomainName": "example.com",
"DataInterval": "300",
"PathDataPerInterval": {
"UsageData": [
{
"Path": "/path/",
"Time": "2017-09-30T16:00:00Z",
"Acc": 10,
"Traffic": 346
}
]
},
"RequestId": "DE81639B-DAC1-4C76-AB72-F34B836837D5"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidPageSize.Malformed | PageSize must be of type Integer | |
| 400 | InvalidPageSize.ExceedsMaximum | PageSize should be less than or equal to 1000 | |
| 400 | InvalidPageSize.ExceedsMinimum | PageSize should be greater than or equal to 1 | |
| 400 | InvalidPath.Malformed | Path must be of type String | |
| 400 | InvalidStartTime.Malformed | StartTime must be of type String | |
| 400 | InvalidEndTime.Malformed | EndTime must be of type String | |
| 400 | InvalidDomainName.Malformed | DomainName must be of type String | |
| 400 | MissingParameter | DomainName is required | |
| 400 | InvalidDomainName.TooShort | DomainName should be at least 1 chars long | |
| 400 | InvalidPageNumber.Malformed | PageNumber must be of type Integer | |
| 400 | InvalidPageNumber.ExceedsMinimum | PageNumber should be greater than or equal to 1 | |
| 400 | InvalidTime.OverRange | Specified StartTime or EndTime is over range |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。