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

ApsaraVideo Live:DescribeDomainUsageData

最終更新日:Nov 08, 2024

指定された課金可能リージョンの特定のドメイン名のリソース使用状況データを照会します。

使用上の注意

  • 一度に最大100個のドメイン名のリソース使用量データを照会できます。 ドメイン名はコンマ (,) で区切ります。 DomainNameパラメーターを指定しない場合、Alibaba Cloudアカウント内のすべてのドメイン名のリソース使用量データが返されます。

  • リソース使用量データは、バイト単位で測定されるネットワークトラフィック、ビット /秒単位で測定される帯域幅、および要求の数を含む。

  • Intervalパラメーターを指定しない場合は、1回の呼び出しで最大31日間の過去12か月間のリソース使用量データを照会できます。 通話で1〜3日の時間範囲を指定した場合、返されるエントリ間の時間間隔は1時間です。 通話で3日を超える時間範囲を指定した場合、返されるエントリ間の時間間隔は1日です。

  • 次の表に、クエリごとの最大時間範囲、履歴データが使用可能な期間、およびIntervalパラメーターを指定した場合のデータ遅延を示します。

時間粒度

クエリあたりの最大時間範囲

利用可能な履歴データ

データ遅延

5 分

3 日

93日

15 minutes

1 時間

31日

186日

4時間

1 日

90 日間

366日

翌日04:00

QPS制限

この操作の呼び出し回数は、アカウントごとに、1 秒間で 10 回までとなっています。 この制限を超えるリクエストは削除され、サービスが中断されます。 この操作を呼び出す際は、この制限にご注意ください。 詳細については、「QPS制限」をご参照ください。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 利便性を考慮して、この操作は OpenAPI Explorer で呼び出すことが推奨されます。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター

タイプ

必須

説明

Action

String

必須

DescribeDomainUsageData

実行する操作です。 値をDescribeDomainUsageDataに設定します。

DomainName

String

任意

example.com

ドメイン名。

  • 複数のドメイン名をコンマ (,) で区切って指定できます。

  • このパラメーターを指定しない場合、Alibaba Cloudアカウント内のすべてのドメイン名のリソース使用量データが返されます。

StartTime

String

必須

2015-12-10T20:00:00Z

照会する期間の開始時刻です。 yyyy-MM-dd T HH:mm:ss Z形式のISO 8601標準で時刻を指定します。 時刻は UTC である必要があります。

EndTime

String

必須

2015-12-10T21:00:00Z

照会する期間の終了時刻を設定します。 yyyy-MM-dd T HH:mm:ss Z形式のISO 8601標準で時刻を指定します。 時刻は UTC である必要があります。

終了時刻は開始時刻よりも後の時刻にする必要があります。 指定できる最大期間は31日です。

タイプ

String

任意

all

照会するリソース使用量データのタイプ。

Fieldパラメーターをbpsまたはtrafに設定した場合の有効値:

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

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

  • all: すべての帯域幅またはトラフィック

Fieldパラメーターをreq_trafまたはreq_bpsに設定した場合の有効値:

  • push: ストリーム取り込み帯域幅またはトラフィック

  • push_proxy: ストリーム中継帯域幅またはトラフィック

フィールド

String

必須

traf

照会するリソース使用量データのカテゴリ。 有効な値:

  • bps: ストリーミング帯域幅

  • traf: ストリーミングトラフィック

  • req_traf: Typeパラメーターをpushに設定した場合はストリームインジェストトラフィック、Typeパラメーターをpush_proxyに設定した場合はストリームリレートラフィック

  • req_bps: Typeパラメーターをpushに設定した場合はストリーム取り込み帯域幅、Typeパラメーターをpush_proxyに設定した場合はストリーム中継帯域幅

地域

String

任意

CN

請求可能なリージョン。 有効な値:

  • CN: 中国本土

  • オーバーシーズ: 中国本土外

  • AP1: アジア太平洋1

  • AP2: アジア太平洋2

  • AP3: アジア太平洋3

  • NA: 北米

  • SA: 南アメリカ

  • EU: ヨーロッパ

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

  • all: すべての地域

説明

このパラメーターを指定しない場合、デフォルト値CNが使用されます。 Alibaba Cloudは、中国本土以外の以下の国と地域をサポートしています。

  • アジア太平洋1: 香港 (中国) 、マカオ (中国) 、台湾 (中国) 、日本、ベトナムとインドネシアを除く東南アジア。

  • アジア太平洋2: インドネシア、韓国、ベトナム。

  • アジア太平洋 3:オーストラリア (サービス終了) とニュージーランド。 北米:米国とカナダ。

  • 南米:ブラジル

  • ヨーロッパ:ウクライナ、イギリス、フランス、オランダ、スペイン、イタリア、スウェーデン、ドイツ。

  • 中東とアフリカ: 南アフリカ、オマーン、アラブ首長国連邦、クウェート。

DataProtocol

String

任意

all

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

  • http: HTTP

  • https: HTTPS

  • quic: QUIC

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

間隔

String

任意

300

返すデータエントリ間の時間間隔。 単位は秒です。 有効な値: 300 (5分) 、3600 (1時間) 、および86400 (1日) 。

説明

特定の時点 (T) での安定したリソース使用量データは、T + Nの時点およびその後に照会することができる。 Nは2時間である。

たとえば、12月21日の15:00:00に、12月21日の13:00:00以前の安定したリソース使用量データを取得できます。

レスポンスパラメーター

パラメーター

タイプ

説明

EndTime

String

2015-12-10T21:00Z

データが照会された期間の終了時刻を示します。 時間は、yyyy-MM-dd T hh:mm:ss Z形式のISO 8601標準に従います。 時刻は UTC で表示されます。

タイプ

String

all

リソース使用量データのタイプ。

StartTime

String

2015-12-10T20:00Z

データが照会された期間の開始時刻を示します。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。

RequestId

String

B955107D-E658-4E77-B913-E0AC3D31693E

リクエスト ID。

地域

String

CN

リソース使用量データが生成された課金可能リージョン。

DomainName

String

example.com

ドメイン名。

DataInterval

String

300

返されるエントリ間の時間間隔。 単位は秒です。

UsageDataPerInterval

DataModuleの配列

時間間隔ごとに収集されたリソース使用量データ。

DataModule

String

423304182

リソース使用量。

  • Fieldパラメーターの値がtrafまたはreq_trafの場合、返されるデータはバイト単位で測定されます。

  • Fieldパラメーターの値がbpsまたはreq_bpsの場合、返されるデータはビット /秒で測定されます。

  • Fieldパラメーターの値がaccの場合、返されるデータはcount単位で測定されます。

タイムスタンプ

String

2015-12-10T20:00:00Z

返されたデータのタイムスタンプ。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC 表示です。

リクエストの例

http://live.aliyuncs.com/?Action=DescribeDomainUsageData&DomainName=example.com
&StartTime=2015-12-10T20:00:00Z
&EndTime=2015-12-10T21:00:00Z
&タイプ=すべて
&エリア=CN
&<共通リクエストパラメーター> 

成功レスポンスの例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDomainUsageDataResponse>
    <DomainNam e>example.com</DomainName>
    <DataInterval>300</DataInterval>
    <UsageDataPerInterval>
        <DataModule>
            <タイムスタンプ> 2015-12-10T20:00:00Z</タイムスタンプ>
            <Value>423304182</Value>
        </DataModule>
        <DataModule>
            <タイムスタンプ> 2015-12-10T20:05:00Z</タイムスタンプ>
            <Value>454680793</Value>
        </DataModule>
        <DataModule>
            <タイムスタンプ> 2015-12-10T20:10:00Z</タイムスタンプ>
            <Value>501718342</Value>
        </DataModule>
        <DataModule>
            <タイムスタンプ> 2015-12-10T20:15:00Z</タイムスタンプ>
            <Value>434816025</Value>
        </DataModule>
    </UsageDataPerInterval>
    <RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId>
    <StartTime>2015-12-10T20:00Z</StartTime>
    <EndTime>2015-12-10T21:00Z</EndTime>
    <エリア> CN</エリア>
    <タイプ> すべて </タイプ>
</DescribeDomainUsageDataResponse> 

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DomainName" : "example.com" 、
  "DataInterval" : "300" 、
  "UsageDataPerInterval" : {
    "DataModule" : [ {
      "タイムスタンプ" : "2015-12-10T20:00:00Z" 、
      "値" : "423304182"
    }, {
      "タイムスタンプ" : "2015-12-10T20:05:00Z" 、
      "値" : "454680793"
    }, {
      "タイムスタンプ" : "2015-12-10T20:10:00Z" 、
      "値" : "501718342"
    }, {
      "タイムスタンプ" : "2015-12-10T20:15:00Z" 、
      "値" : "434816025"
    } ]
  },
  "RequestId" : "B955107D-E658-4E77-B913-E0AC3D31693E" 、
  "StartTime" : "2015-12-10T20:00Z" 、
  "EndTime" : "2015-12-10T21:00Z" 、
  "エリア" : "CN" 、
  "タイプ" : "すべて"
} 

エラーコード

HTTPステータスコード

エラーコード

エラーメッセージ

説明

400

InvaildParameter

無効なパラメーター

1つ以上のリクエストパラメーターが無効です。

400

InvalidStartTime.Malformed

指定された StartTime は不正です。

開始時刻の形式が無効です。 StartTimeパラメーターの値が有効かどうかを確認します。

400

InvalidEndTime.Malformed

指定された EndTime は不正です。

終了時刻の形式が無効です。 EndTimeパラメーターの値が有効かどうかを確認します。

400

InvalidStartTime.ValueNotSupported

パラメータ StartTime に指定された値はサポートされていません。

StartTimeパラメーターに指定された値が無効です。

400

InvalidTime. 不正

指定された Time が誤っています。

指定された時刻の形式が無効です。 指定された時間が有効かどうかを確認します。

400

InvalidParameterField

指定されたフィールドは無効です。

Fieldパラメーターの値が無効です。 有効な値を指定します。

400

InvalidParameterType

指定されたTypeは無効です。

Type パラメーターの値が無効です。 有効な値を指定します。

400

InvalidEndTime. ミスマッチ

指定された終了時間は、指定された開始時間を計算しません。

終了時刻が開始時刻と一致しません。 EndTimeパラメーターの値が一致するかどうかを確認します。

400

InvalidTimeSpan

タイムスパンが制限を超えています。

時間範囲が制限を超えています。 クエリする有効な時間範囲を設定します。

エラーコードの一覧については、「サービスエラーコード」をご参照ください。

特殊エラーコード

エラーコード

エラーメッセージ

HTTP ステータスコード

説明

Throttling

Request was denied due to request throttling.

503

トラフィックの抑制によりリクエストが拒否されました。

IllegalOperation

不正なドメイン、操作は許可されていません。

403

ドメイン名が無効です。

OperationDenied

アカウントがまだLiveサービスを開いていません。

403

ApsaraVideo Liveは有効化されていません。

OperationDenied

ライブサービスが中断されました。

403

ApsaraVideo Liveが中断されました。

InvalidDomain.NotFound

The domain provided does not belong to you.

404

ドメイン名が存在しないか、アカウントに属していません。

InvalidDomain.Offline

指定されたドメインはオフラインです。

404

ドメイン名は無効です。

ServiceBusy

指定されたドメインは設定中です。後で再試行してください。

403

ドメイン名は設定中です。 しばらくしてからもう一度お試しください。

InvalidDomain.Configure_failed

Failed to configure the provided domain.

500

ドメイン名の設定に失敗しました。

InvalidParameter

無効なパラメーター。Invalid Parameter.

400

1つ以上のパラメーターが無効です。

InvalidParameterProduct

無効なパラメータ製品。

400

Productパラメーターの値が無効です。

InvalidParameterArea

無効なパラメータ領域。

400

Areaパラメーターの値が無効です。

InvalidParameterField

パラメータフィールドが無効です。

400

Fieldパラメーターの値が無効です。

InvalidParameterStartTime

無効なパラメーターStartTime。

400

StartTimeパラメーターの値が無効です。

InvalidParameterEndTime

無効なパラメーターEndTime。

400

EndTimeパラメーターの値が無効です。

InvalidTimeRange

StartTimeとEndTimeの範囲は1か月未満です。

400

StartTimeパラメーターとEndTimeパラメーターで指定された時間範囲が31日を超えています。

InvalidParameterInterval

パラメータ間隔が無効です。

400

Intervalパラメーターの値が無効です。