すべてのプロダクト
Search

このプロダクト

    :DescribeDomainUsageData

    ドキュメントセンター

    :DescribeDomainUsageData

    最終更新日:Jan 27, 2026

    DescribeDomainUsageData 操作を呼び出して、特定の請求リージョンにある 1 つ以上のドメイン名の使用状況データを照会します。

    操作説明

    • この操作はドメイン名のバッチクエリをサポートしています。複数のドメイン名を照会するには、コンマ (,) で区切ります。一度に最大 100 個のドメイン名を照会できます。DomainName パラメーターを指定しない場合、この操作はアカウントに関連付けられているすべてのドメイン名のデータを返します。

    • 使用状況データには、トラフィック、帯域幅、リクエスト数が含まれます。単位はそれぞれバイト、bps、カウントです。

    • Interval パラメーターを指定しない場合、過去 1 年以内に生成されたデータを照会できます。1 回のクエリの最大時間範囲は 31 日間です。時間範囲が 1〜3 日の場合、データは 1 時間単位の粒度で返されます。時間範囲が 3 日を超える場合、データは 1 日単位の粒度で返されます。

    • Interval パラメーターを指定した場合、1 回のクエリの最大時間範囲、照会可能な履歴データの範囲、およびデータ遅延は次のとおりです。

    時間の粒度1 回のクエリの最大時間範囲照会可能な履歴データ範囲データ遅延
    5 分3 日93 日15 分
    1 時間31 日186 日4 時間
    1 日90 日366 日翌日の午前 4:00

    QPS 制限

    1 ユーザーあたりの 1 秒あたりのクエリ数 (QPS) 制限は 10 です。この制限を超えると、API 呼び出しはスロットリングされます。これはビジネスに影響を与える可能性があります。適宜、呼び出しを計画してください。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    live:DescribeDomainUsageData

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    リージョン ID。

    cn-shanghai
    DomainName

    string

    任意

    ライブストリーミングドメイン名。

    • 単一のドメイン名または複数のドメイン名を照会できます。複数のドメイン名を照会するには、コンマ (,) で区切ります。

    • このパラメーターを空のままにすると、操作はすべてのライブストリーミングドメイン名のマージされたデータを返します。

    example.com
    StartTime

    string

    必須

    照会する時間範囲の開始時刻。yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は UTC である必要があります。

    2015-12-10T20:00:00Z
    EndTime

    string

    必須

    照会する時間範囲の終了時刻。yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は UTC である必要があります。

    終了時刻は開始時刻より後である必要があります。時間範囲は 31 日を超えることはできません。

    2015-12-10T21:00:00Z
    Type

    string

    任意

    照会する使用状況データのタイプ。

    Field が bps または traf に設定されている場合、有効値は次のとおりです。

    • rts：リアルタイムストリーミング (RTS) の帯域幅またはトラフィック。

    • quic：QUIC の帯域幅またはトラフィック。

    Field が req_traf または req_bps に設定されている場合、有効値は次のとおりです。

    • push：アップストリーミングの帯域幅またはトラフィック。

    • push_proxy：リレーされたアップストリーミングの帯域幅またはトラフィック。

    all
    Field

    string

    必須

    照会する使用状況データのタイプ。有効値：

    • bps：再生帯域幅。

    • traf：トラフィック。

    • req_traf：Type が push に設定されている場合はアップストリーミングトラフィック、Type が push_proxy に設定されている場合はリレーされたアップストリーミングトラフィック。

    • req_bps：Type が push に設定されている場合はアップストリーミング帯域幅、Type が push_proxy に設定されている場合はリレーされたアップストリーミング帯域幅。

    traf
    Area

    string

    任意

    リージョン。有効値：

    • CN：中国本土。

    • OverSeas：中国本土以外のリージョン。

    • AP1：アジアパシフィック 1。

    • AP2：アジアパシフィック 2。

    • AP3：アジアパシフィック 3。

    • NA：北米。

    • SA：南米。

    • EU：ヨーロッパ。

    • MEAA：中東およびアフリカ。

    • all：すべてのリージョン。

    説明

    このパラメーターを指定しない場合、デフォルト値は CN です。リージョンは次のように定義されます：アジアパシフィック 1：香港 (中国)、マカオ (中国)、台湾 (中国)、日本、およびベトナムとインドネシアを除く東南アジア諸国。アジアパシフィック 2：インドネシア、韓国、ベトナム。アジアパシフィック 3：オーストラリア、ニュージーランド。北米：米国、カナダ。南米：ブラジル。ヨーロッパ：ウクライナ、イギリス、フランス、オランダ、スペイン、イタリア、スウェーデン、ドイツ。中東およびアフリカ：南アフリカ、オマーン、アラブ首長国連邦、クウェート。

    CN
    DataProtocol

    string

    任意

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

    • http：HTTP。

    • https：HTTPS。

    • quic：QUIC。

    • all (デフォルト)：上記のすべてのプロトコル。

    all
    Interval

    string

    任意

    照会するデータの時間の粒度 (秒単位)。この操作は、特定の粒度でデータを返すように強制します。有効値：300 (5 分)、3600 (1 時間)、86400 (1 日)。

    300
    説明

    特定の時刻 T のデータを照会する場合、その時刻の安定したデータは 2 時間後に利用可能になります。
    たとえば、12 月 21 日午後 1:00 のデータを照会する場合、12 月 21 日午後 3:00 に午後 1:00 以前の安定したデータを取得できます。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    EndTime

    string

    時間範囲の終了時刻。時刻は UTC で、形式は yyyy-MM-ddTHH:mm:ssZ です。

    2015-12-10T21:00Z
    Type

    string

    使用状況データのタイプ。

    all
    StartTime

    string

    時間範囲の開始時刻。時刻は UTC で、形式は yyyy-MM-ddTHH:mm:ssZ です。

    2015-12-10T20:00Z
    RequestId

    string

    リクエスト ID。

    B955107D-E658-4E77-B913-E0AC3D31693E
    Area

    string

    使用リージョン。

    CN
    DomainName

    string

    ライブストリーミングドメイン名。

    example.com
    DataInterval

    string

    データレコード間の時間間隔 (秒単位)。

    300
    UsageDataPerInterval

    object

    DataModule

    array<object>

    各レコードの使用状況データ。

    object

    Value

    string

    使用量の値。

    • Field が traf または req_traf に設定されている場合、単位はバイトです。

    • Field が bps または req_bps に設定されている場合、単位は bps です。

    • Field が acc に設定されている場合、単位はカウントです。

    423304182
    TimeStamp

    string

    タイムスライスの開始時刻。時刻は UTC で、形式は yyyy-MM-ddTHH:mm:ssZ です。

    2015-12-10T20:00:00Z

    ## 特別なエラーコード | エラーコード | エラーメッセージ | HTTP ステータスコード | 説明 | | --- | --- | --- | --- | | Throttling | 速度制限のためリクエストが拒否されました。 | 503 | リクエストレートが許容限度を超えたため、リクエストは拒否されました。 | | IllegalOperation | このドメインでは操作は許可されていません。 | 403 | 指定されたドメイン名は無効です。 | | OperationDenied | ApsaraVideo Live が有効化されていません。 | 403 | お客様のアカウントでは ApsaraVideo Live が有効化されていません。 | | OperationDenied | お客様の ApsaraVideo Live サービスは一時停止されています。 | 403 | お客様の ApsaraVideo Live サービスは一時停止されています。 | | InvalidDomain.NotFound | 指定されたドメインが見つかりませんでした。 | 404 | 指定されたドメイン名が存在しないか、お客様のアカウントに属していません。 | | InvalidDomain.Offline | 指定されたドメインは無効化されています。 | 404 | 指定されたドメイン名は無効化されています。 | | ServiceBusy | ドメインは設定中です。後でもう一度お試しください。 | 403 | 指定されたドメイン名は設定中です。後でもう一度お試しください。 | | InvalidDomain.Configure_failed | ドメインの設定に失敗しました。 | 500 | 指定されたドメイン名の設定に失敗しました。 | | InvalidParameter | 無効なパラメーターです。 | 400 | 1 つ以上のパラメーターが無効です。 | | InvalidParameterProduct | 無効な Product パラメーターです。 | 400 | Product パラメーターの値が無効です。 | | InvalidParameterArea | 無効な Area パラメーターです。 | 400 | Area パラメーターの値が無効です。 | | InvalidParameterField | 無効な Field パラメーターです。 | 400 | Field パラメーターの値が無効です。 | | InvalidParameterStartTime | 無効な StartTime パラメーターです。 | 400 | StartTime パラメーターの値が無効です。 | | InvalidParameterEndTime | 無効な EndTime パラメーターです。 | 400 | EndTime パラメーターの値が無効です。 | | InvalidTimeRange | 時間範囲は 31 日を超えることはできません。 | 400 | StartTime パラメーターと EndTime パラメーターで指定された時間範囲が 31 日を超えています。 | | InvalidParameterInterval | 無効な Interval パラメーターです。 | 400 | Interval パラメーターの値が無効です。 |

    例

    成功レスポンス

    JSONJSON

    {
  "EndTime": "2015-12-10T21:00Z",
  "Type": "all",
  "StartTime": "2015-12-10T20:00Z",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "Area": "CN",
  "DomainName": "example.com",
  "DataInterval": "300",
  "UsageDataPerInterval": {
    "DataModule": [
      {
        "Value": "423304182",
        "TimeStamp": "2015-12-10T20:00:00Z"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvaildParameter Invalid Parameter
    400 InvalidStartTime.Malformed Specified StartTime is malformed.
    400 InvalidEndTime.Malformed Specified EndTime is malformed.
    400 InvalidStartTime.ValueNotSupported The specified value of parameter StartTime is not supported.
    400 InvalidTime.Malformed Specified Time is malformed.
    400 InvalidParameterField The specified Field is invalid.
    400 InvalidParameterType The specified Type is invalid.
    400 InvalidEndTime.Mismatch Specified end time does not math the specified start time.
    400 InvalidTimeSpan The time span exceeds the limit.

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

    変更履歴

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