すべてのプロダクト
Search
ドキュメントセンター

:DescribeDomainUsageData

最終更新日:Dec 14, 2025

指定された課金リージョンにおける特定のドメイン名のリソース使用量データを照会します。

操作説明

  • 1 アカウントあたり、毎秒最大 10 回この操作を呼び出すことができます。

  • Interval パラメーターでサポートされる時間の粒度、既存データが利用可能な最大期間、およびデータ遅延は、クエリごとの最大時間範囲によって異なり、次の表で説明するとおりです。

時間の粒度クエリごとの最大時間範囲利用可能な既存データデータ遅延
5 分3 日間93 日間15 分
1 時間31 日間186 日間4 時間
1 日90 日間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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cdn:DescribeDomainUsageData

none

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

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

必須

照会するデータのタイプ。 有効値:

  • bps:帯域幅

  • traf:トラフィック

  • acc:リクエスト

説明

このパラメーターを acc に設定した場合、Area パラメーターはサポートされません。

bps

Type

string

任意

照会するコンテンツのタイプ。 有効値:

  • static:静的コンテンツ

  • dynamic:動的コンテンツ

  • all (デフォルト):静的コンテンツと動的コンテンツの両方

static

DataProtocol

string

任意

照会するデータのプロトコル。 有効値:

  • http: HTTP

  • https: HTTPS

  • quic: QUIC

  • all (デフォルト):HTTP、HTTPS、QUIC

all

Area

string

任意

課金リージョン。 有効値:

  • CN (デフォルト):中国本土

  • OverSeas:中国本土以外

  • AP1:アジアパシフィック 1

  • AP2:アジアパシフィック 2

  • AP3:アジアパシフィック 3

  • NA:北米

  • SA:南米

  • EU:ヨーロッパ

  • MEAA:中東およびアフリカ

  • all:上記のすべての課金リージョン

CN

Interval

string

任意

データエントリの時間粒度。 単位:秒。 有効値:300 (5 分)、3600 (1 時間)、86400 (1 日)。

  • Interval300 に設定した場合、過去 6 か月間の使用量データを照会できます。 クエリごとに指定できる最大時間範囲は 3 日間です。

  • Interval3600 または 86400 に設定した場合、前年の使用量データを照会できます。

  • Interval パラメーターを空のままにすると、照会できる最大時間範囲は 1 か月です。 1〜3 日の時間範囲を指定した場合、返されるエントリ間の時間間隔は 1 時間です。 4 日以上の時間範囲を指定した場合、返されるエントリ間の時間間隔は 1 日です。

300

課金項目とパラメーター

次の表に、各課金項目のパラメーターを示します。 関連する操作の呼び出し方法の詳細については、リクエストの例をご参照ください。

課金項目DataProtocol の有効値Type の有効値Field の有効値Area の有効値
データ転送all または値なしall または値なしtrafCN、OverSeas、AP1、AP2、AP3、NA、SA、EU、MEAA
帯域幅all または値なしall または値なしbpsCN、OverSeas、AP1、AP2、AP3、NA、SA、EU、MEAA
静的コンテンツの HTTPS リクエストhttpsstaticaccall
動的コンテンツの HTTP リクエストhttpdynamicaccall
動的コンテンツの HTTPS リクエストhttpsdynamicaccall
動的コンテンツの QUIC リクエストquicdynamicaccall
静的コンテンツの QUIC リクエストquicstaticaccall

レスポンスフィールド

フィールド

説明

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.

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

変更履歴

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