プロデューサースタジオの使用量データを照会します。
操作説明
データクエリの最小値の粒度は 1 時間です。最大値のクエリ時間スパンは 31 日です。最大値の履歴クエリ有効値は過去 90 日です。
QPS 制限
この API オペレーションのシングルユーザー QPS 制限は 1 秒あたり 5 回の呼び出しです。制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。この操作を適切に呼び出してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:DescribeLiveProducerUsageData |
get |
*Domain
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョン ID。 |
cn-shanghai |
| Region |
string |
任意 |
ドメイン名が属するリージョン。このパラメーターが空の場合、デフォルトですべてのリージョンの統合データが返されます。バッチクエリがサポートされています。複数のリージョンはカンマ (,) で区切ります。 |
cn-shanghai |
| DomainName |
string |
任意 |
クラウドプロデューサースタジオのストリーミングドメイン名。
|
example.com |
| Instance |
string |
任意 |
照会するインスタンス。バッチクエリがサポートされています。複数のインスタンスはカンマ (,) で区切ります。 説明
このパラメーターが空の場合、デフォルトですべてのインスタンスの統合データが返されます。 |
a17d0184-462d-4630-b2a6-8c26dde2**** |
| Type |
string |
任意 |
プロデューサータイプ。バッチクエリがサポートされています。複数のタイプはカンマ (,) で区切ります。有効な値:
説明
このパラメーターが空の場合、デフォルトですべてのプロデューサータイプの統合データが返されます。 |
slidelive |
| SplitBy |
string |
任意 |
グループ化キー。ドメイン、リージョン、インスタンス、type のうち 1 つ以上を指定できます。複数の値はカンマ (,) で区切ります。指定されたフィールドが出力でグループ化されます。 説明
このパラメーターが空の場合、集計データのみが返されます。 |
type |
| StartTime |
string |
任意 |
開始時刻。時間は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ フォーマットで指定します。時間は協定世界時 (UTC) である必要があります。 |
2018-09-30T16:00:00Z |
| EndTime |
string |
任意 |
終了時刻。時間は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ フォーマットで指定します。時間は協定世界時 (UTC) である必要があります。 説明
終了時刻は開始時刻より後である必要があります。 |
2018-10-31T15:59:59Z |
| Interval |
string |
任意 |
照会するデータの時間の粒度。有効な値: 3600 (1 時間) および 86400 (1 日)。単位: 秒。 |
3600 |
| app |
string |
任意 |
ストリームが属するアプリケーションの名前。 |
liveApp**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| BillProducerData |
object |
||
| BillProducerDataItem |
array<object> |
プロデューサースタジオの使用量データ。 |
|
|
object |
|||
| DomainName |
string |
使用状況がクエリされるドメイン名。このパラメーターは、SplitBy を domain に設定した場合に返されます。 |
example.com |
| Instance |
string |
使用状況がクエリされるインスタンス。このパラメーターは、SplitBy を instance に設定した場合に返されます。 |
a17d0184-462d-4630-b2a6-8c26dde2**** |
| OutputHdDuration |
integer |
高解像度 (HD) 出力の期間。単位: 分。 |
6000 |
| OutputLdDuration |
integer |
低解像度 (LD) 出力の期間。単位: 分。 |
1001 |
| OutputSdDuration |
integer |
標準解像度 (SD) 出力の期間。単位: 分。 |
500 |
| Region |
string |
使用状況がクエリされるリージョン。このパラメーターは、SplitBy を region に設定した場合に返されます。 |
cn-shanghai |
| TimeStamp |
string |
タイムスライスの開始。 |
2018-09-30T00:00:00Z |
| TranHdDuration |
integer |
HD トランスコードの期間。単位: 分。 |
6777 |
| TranLdDuration |
integer |
LD トランスコードの期間。単位: 分。 |
111 |
| TranSdDuration |
integer |
SD トランスコードの期間。単位: 分。 |
666 |
| Type |
string |
プロダクションスタジオのタイプ。このパラメーターは、SplitBy を type に設定した場合に返されます。 |
slidelive |
| EndTime |
string |
終了時刻。時間は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ フォーマットに従います。時間は協定世界時 (UTC) で表示されます。 |
2018-09-30T16:00:00Z |
| RequestId |
string |
リクエスト ID。 |
C370DAF1-C838-4288-A1A0-9A87633D248E |
| StartTime |
string |
開始時刻。時間は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ フォーマットに従います。時間は協定世界時 (UTC) で表示されます。 |
2018-10-31T15:59:59Z |
例
成功レスポンス
JSONJSON
{
"BillProducerData": {
"BillProducerDataItem": [
{
"DomainName": "example.com",
"Instance": "a17d0184-462d-4630-b2a6-8c26dde2****",
"OutputHdDuration": 6000,
"OutputLdDuration": 1001,
"OutputSdDuration": 500,
"Region": "cn-shanghai",
"TimeStamp": "2018-09-30T00:00:00Z",
"TranHdDuration": 6777,
"TranLdDuration": 111,
"TranSdDuration": 666,
"Type": "slidelive"
}
]
},
"EndTime": "2018-09-30T16:00:00Z",
"RequestId": "C370DAF1-C838-4288-A1A0-9A87633D248E",
"StartTime": "2018-10-31T15:59:59Z"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | |
| 400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | |
| 400 | InvalidTime.Malformed | Specified StartTime or EndTime is malformed. | |
| 400 | InvalidEndTime.Mismatch | Specified end time does not math the specified start time. | |
| 400 | InvalidTimeSpan | The time span exceeds the limit. | |
| 400 | InvalidTime.ValueNotSupported | Specified Time is malformed. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。