1つ以上の取り込みドメインの帯域幅データを照会します。

使用状況ノート

  • 帯域幅データの単位はビット /秒である。
  • カンマ (,) で区切って、複数の取り込みドメインの帯域幅データを照会できます。
  • If you do not set the StartTime parameter or the EndTime parameter, the data of the last 24 hours is queried. StartTimeパラメーターとEndTimeパラメーターを設定すると、指定された時間範囲のデータが照会されます。
  • 過去90日以内のデータを照会できます。

QPS limit

1人のユーザーが1秒あたり最大100クエリ (QPS) を実行できます。 Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. したがって、この操作のQPS制限を遵守することをお勧めします。 シングルユーザーの意味とQPSの詳細については、「ApsaraVideo LiveのAPI操作のQPS制限」をご参照ください。

デバッグ

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

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 DescribeLiveDomainPushBpsData

実行する操作です。 値を

DescribeLiveDomainPushBpsData.

DomainName String 任意 example.com

取り込みドメイン。

カンマ (,) で区切って、複数の取り込みドメインの帯域幅データを照会できます。

このパラメーターを設定しない場合、すべての取り込みドメインのマージされたデータが返されます。

StartTime String 任意 2017-12-10T20:00:00Z

クエリする時間範囲の先頭。 ISO 8601標準のyyyy-MM-dd T HH:mm:ss Z形式で時刻を指定します。 時間は UTC にする必要があります。

このパラメーターを設定しない場合、過去24時間のデータが返されます。

EndTime String 任意 2017-12-10T21:00:00Z

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

終了時刻は開始時刻よりも後の時刻にする必要があります。

間隔 String 任意 300

データが照会される間隔。 (単位：秒) 設定可能な値は以下のとおりです。

  • 300
  • 3600
  • 86400

デフォルト値は 300 です。 このパラメーターを設定しない場合、または無効な値を指定した場合は、デフォルト値が使用されます。

IspNameEn String 任意 alibaba

インターネットサービスプロバイダー (ISP) の名前。

ISPを照会するには、DescribeCdnRegionAndIsp操作を呼び出します。 このパラメーターを設定しない場合、すべてのISPのデータが返されます。

LocationNameEn String 任意 tianjin

データを照会するリージョンの名前。

リージョンを照会するには、DescribeCdnRegionAndIsp操作を呼び出します。 このパラメーターを設定しない場合、すべてのリージョンのデータが返されます。

レスポンスパラメーター

パラメーター データ型 例 説明
BpsDataPerInterval DataModuleの配列

間隔ごとに収集された帯域幅データ。

DataModule
BpsValue String 11288111

帯域幅。 単位：bit/s。

タイムスタンプ String 2017-12-10T20:00:00Z

返されたデータのタイムスタンプ。

DataInterval String 300

データが照会された間隔。

DomainName String example.com

取り込みドメイン。

EndTime String 2017-12-10T21:00:00Z

データが照会された時間範囲の終了。

RequestId String 3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F

リクエストの ID です。

StartTime String 2017-12-10T20:00:00Z

データが照会された時間範囲の開始。

例

リクエストの例

http(s):// live.aliyuncs.com/?Action=DescribeLivePushDomainBpsData
&DomainNam e=example.com
&StartTime=2017-12-10T20:00:00Z
&EndTime=2017-12-10T21:00:00Z
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

<DescribeLiveDomainPushBpsDataResponse>
      <BpsDataPerInterval>
            <DataModule>
                  <タイムスタンプ> 2017-12-10T20:00:00Z</タイムスタンプ>
                  <BpsValue>11288111</BpsValue>
            </DataModule>
            <DataModule>
                  <タイムスタンプ> 2017-12-10T20:05:00Z</タイムスタンプ>
                  <BpsValue>1288111</BpsValue>
            </DataModule>
      </BpsDataPerInterval>
      <DomainNam e>example.com</DomainName>
      <DataInterval>300</DataInterval>
      <RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>
      <StartTime>2017-12-10T20:00:00Z</StartTime>
      <EndTime>2017-12-10T21:00:00Z</EndTime>
</DescribeLiveDomainPushBpsDataResponse>

JSON 形式 

{
    "BpsDataPerInterval": {
        "DataModule": [
            {
                "タイムスタンプ": "2017-12-10T20:00:00Z" 、
                "BpsValue": "11288111"
            },
            {
                "タイムスタンプ": "2017-12-10T20:05:00Z" 、
                "BpsValue": "1288111"
            }
        ]
    },
    "DomainName": "example.com",
    "DataInterval": "300" 、
    "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F" 、
    "StartTime": "2017-12-10T20:00:00Z" 、
    "EndTime": "2017-12-10T21:00:00Z"
}

エラーコード

HttpCode エラーコード エラーメッセージ 説明
400 InvalidStartTime.Malformed 指定された StartTime は不正です。 開始時刻の形式が無効な場合に返されるエラーメッセージ。 StartTimeパラメーターの値が有効かどうかを確認します。
400 InvalidEndTime.Malformed 指定された EndTime は不正です。 終了時刻の形式が無効な場合に返されるエラーメッセージ。 EndTimeパラメーターの値が有効かどうかを確認します。
400 InvalidEndTime. ミスマッチ 指定された終了時間は、指定された開始時間を計算しません。 終了時刻が開始時刻より遅くない場合に返されるエラーメッセージ。 StartTimeパラメーターとEndTimeパラメーターの値が有効かどうかを確認します。

エラーコードリストについては、「API エラーセンター」をご参照ください。