DescribeVodDomainSrcTrafficData - - Alibaba Cloud ドキュメントセンター

ApsaraVideo VOD の高速化ドメイン名の back-to-origin トラフィックデータを照会します。トラフィックの単位はバイトです。

操作説明

この操作は、中国 (上海) リージョンでのみ利用可能です。
ApsaraVideo VOD は、back-to-origin トラフィックデータを 90 日間保存し、その後削除します。
StartTime または EndTime パラメーターを設定しない場合、リクエストは過去 24 時間に収集されたデータを返します。StartTime と EndTime の両方のパラメーターを設定した場合、リクエストは指定された時間範囲内に収集されたデータを返します。
1 回のリクエストで最大 500 個のドメイン名を指定できます。複数のドメイン名はコンマ (,) で区切ります。1 回のリクエストで複数のドメイン名を指定した場合、集約結果が返されます。

時間の粒度

Interval パラメーターでサポートされる時間の粒度は、StartTime と EndTime を使用して指定されたクエリごとの時間範囲によって異なります。次の表に、履歴データが利用可能な期間とデータ遅延を示します。

時間の粒度	クエリごとの時間範囲 (日)	利用可能な履歴データ (日)	データ遅延
5 分	(0, 3]	93	15 分
1 時間	(3, 31]	186	4 時間
1 日	(31, 366]	366	翌日の 04:00

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vod:DescribeVodDomainSrcTrafficData

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DomainName	string	任意	高速化ドメイン名。1 回のリクエストで最大 500 個のドメイン名を指定できます。複数のドメイン名はコンマ (,) で区切ります。1 回のリクエストで複数のドメイン名を指定した場合、集約結果が返されます。このパラメーターを空のままにすると、デフォルトですべての高速化ドメイン名の back-to-origin トラフィックデータが照会されます。	example.com
StartTime	string	任意	照会する時間範囲の開始時刻。yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は UTC である必要があります。このパラメーターを空のままにすると、デフォルトで過去 24 時間に生成された back-to-origin トラフィックデータが照会されます。	2022-03-22T16:00:00Z
EndTime	string	任意	照会する時間範囲の終了時刻。終了時刻は開始時刻より後である必要があります。yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は UTC である必要があります。	2022-09-24T15:59:59Z
Interval	string	任意	返すデータエントリ間の時間間隔。単位：秒。有効な値： 300：5 分 3600：1 時間 86400：1 日説明 Interval パラメーターでサポートされる時間の粒度は、`StartTime` と `EndTime` を使用して指定されたクエリごとの時間範囲によって異なります。詳細については、このトピックの「時間の粒度」セクションをご参照ください。	300

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
EndTime	string	データが照会された時間範囲の終了時刻。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式で表されます。時刻は UTC で表示されます。	2022-09-23T15:59:59Z
StartTime	string	データが照会された時間範囲の開始時刻。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式で表されます。時刻は UTC で表示されます。	2022-08-29T16:00:00Z
RequestId	string	リクエスト ID。	25818875-5F78-4AF6-D7393642CA58****
DomainName	string	高速化ドメイン名。	example.com
TotalTraffic	string	総トラフィック量。単位：バイト。	5906662826
DataInterval	string	返されるエントリ間の時間間隔。単位：秒。	300
SrcTrafficDataPerInterval	object
DataModule	array<object>	各時間間隔で返される back-to-origin トラフィックの詳細。単位：バイト。
	object	各時間間隔で返される back-to-origin トラフィックの量。
Value	string	各時間間隔でのトラフィック値。	0
TimeStamp	string	返されたデータのタイムスタンプ。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式で表されます。時刻は UTC で表示されます。	2022-09-23T15:59:59Z
HttpsValue	string	オリジンの HTTPS リクエストによって生成されたトラフィック量。	0

例

成功レスポンス

JSONJSON

{
  "EndTime": "2022-09-23T15:59:59Z",
  "StartTime": "2022-08-29T16:00:00Z",
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "DomainName": "example.com",
  "TotalTraffic": "5906662826",
  "DataInterval": "300",
  "SrcTrafficDataPerInterval": {
    "DataModule": [
      {
        "Value": "0",
        "TimeStamp": "2022-09-23T15:59:59Z",
        "HttpsValue": "0"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingParameter	StartTime and EndTime can not be single.
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.
400	Abs.DomainName.Malformed	The size of DomainName is too big.
400	InvalidInterval.Malformed	Specified Interval is malformed.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。