プロダクションスタジオの構成を照会します。
操作説明
CreateCaster 操作を呼び出して、プロダクションスタジオを作成します。次に、この操作を呼び出して構成を照会します。
QPS 制限
この操作には、ユーザーごとのクエリ/秒 (QPS) 制限が 15 呼び出しに設定されています。制限を超えると、API 呼び出しがスロットルされ、ビジネスに影響を与える可能性があります。呼び出しは計画的に行ってください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:DescribeCasterConfig |
get |
*Caster
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョン ID。 |
cn-shanghai |
| CasterId |
string |
必須 |
プロダクションスタジオの ID。
説明
クラウド プロダクション スタジオ ページのリストにあるプロダクションスタジオの名前は、プロダクションスタジオ ID です。 |
LIVEPRODUCER_POST-cn-0pp1czt**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
プロダクションスタジオの構成です。 |
||
| AutoSwitchUrgentConfig |
string |
スタンバイビデオへの自動スイッチオーバーの構成。 |
{"eofThres":3} |
| AutoSwitchUrgentOn |
string |
スタンバイビデオへの自動スイッチオーバーが有効かどうかを示します。
|
true |
| CallbackUrl |
string |
Webhook アドレス。 |
http://learn.aliyundoc.com/callBackLive |
| CasterId |
string |
プロダクションスタジオの ID。 |
LIVEPRODUCER_POST-cn-0pp1czt**** |
| CasterName |
string |
プロダクションスタジオの名前。 |
coco-caster10 |
| ChannelEnable |
integer |
チャンネルが有効かどうかを示します。有効な値：
|
1 |
| Delay |
number |
ストリーム遅延。単位：秒。
|
0 |
| DomainName |
string |
ストリーミング ドメイン。 |
example.com |
| ProgramEffect |
integer |
カルーセルフラグ。有効な値：
|
0 |
| ProgramName |
string |
カルーセルの名前。 |
program_name |
| RecordConfig |
object |
このパラメータが空の場合、録画機能は無効になっています。 |
|
| OnDemand |
integer |
オンデマンド録画。有効な値：
|
0 |
| OssBucket |
string |
ストレージの場所。 |
liveBucket**** |
| OssEndpoint |
string |
ストレージの場所が存在する OSS エンドポイント。 |
oss-cn-shanghai.aliyundoc.com |
| RecordFormat |
object |
||
| RecordFormat |
array<object> |
録画フォーマットの構成。 |
|
|
object |
録画時間情報。 |
||
| CycleDuration |
integer |
録画時間。 |
3600 |
| Format |
string |
録画フォーマット。 |
M3U8 |
| OssObjectPrefix |
string |
録画ファイルの名前。 |
record/{liveApp****}/{liveStream****} |
| SliceOssObjectPrefix |
string |
セグメントの名前。 |
record/{liveApp****}/{liveStream****}/{UnixTimestamp****} |
| RequestId |
string |
リクエスト ID。 |
97df6b7f-3490-47d2-ac50-8833e1b64597 |
| SideOutputUrl |
string |
プロダクションスタジオのカスタム バイパス出力 URL。 |
rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5**** |
| SideOutputUrlList |
string |
プロダクションスタジオのカスタム バイパス出力 URL のリスト。 |
["rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"] |
| SyncGroupsConfig |
object |
||
| SyncGroup |
array<object> |
ストレージ構成。 |
|
|
array<object> |
ストレージ構成。 |
||
| HostResourceId |
string |
プロダクションスタジオのリソース ID。 |
28768383240243**** |
| Mode |
integer |
静的ページのキャッシュモード。有効な値：
|
0 |
| ResourceIds |
object |
||
| ResourceId |
array |
リソースグループを変更する クラウドリソース の ID のリスト。1 ～ 50 個のリソース ID を指定できます。 |
|
|
string |
リソースグループを変更する クラウドリソース の ID のリスト。1 ～ 50 個のリソース ID を指定できます。 |
1 |
|
| TranscodeConfig |
object |
トランスコーディング構成。 |
|
| CasterTemplate |
string |
プロダクションスタジオのトランスコーディング テンプレート。有効な値：
|
lp_hd |
| LiveTemplateIds |
object |
||
| LocationId |
array |
ライブストリーム トランスコーディング構成。 |
|
|
string |
ライブストリーム トランスコーディング構成。有効な値：
|
lld |
|
| CustomParams |
object |
カスタム構成 |
|
| video |
object |
ビデオパラメータ |
|
| fps |
integer |
ビデオ フレームレート |
300 |
| bitrate |
integer |
ビデオ ビットレート |
300 |
| width |
integer |
ビデオの幅（ピクセル単位（px））。 |
1080 |
| height |
integer |
ビデオの高さ（ピクセル単位（px））。 |
720 |
| UrgentImageId |
string |
メディア アセット ライブラリにあるスタンバイ画像アセットの ID。 |
a089175eb5f4427684fc0715159a**** |
| UrgentImageUrl |
string |
スタンバイ画像アセットの URL。 |
http://learn.aliyundoc.com/AppName/image.jpg |
| UrgentLiveStreamUrl |
string |
スタンバイ ライブストリームの URL。 |
rtmp://demo.aliyundoc.com |
| UrgentMaterialId |
string |
メディア アセット ライブラリにあるスタンバイビデオ アセットの ID。 |
98646538-bcf9-4aef-bd4a-e6bb76588**** |
例
成功レスポンス
JSONJSON
{
"AutoSwitchUrgentConfig": "{\"eofThres\":3}",
"AutoSwitchUrgentOn": "true",
"CallbackUrl": "http://learn.aliyundoc.com/callBackLive",
"CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
"CasterName": "coco-caster10",
"ChannelEnable": 1,
"Delay": 0,
"DomainName": "example.com",
"ProgramEffect": 0,
"ProgramName": "program_name",
"RecordConfig": {
"OnDemand": 0,
"OssBucket": "liveBucket****",
"OssEndpoint": "oss-cn-shanghai.aliyundoc.com",
"RecordFormat": {
"RecordFormat": [
{
"CycleDuration": 3600,
"Format": "M3U8",
"OssObjectPrefix": "record/{liveApp****}/{liveStream****}",
"SliceOssObjectPrefix": "record/{liveApp****}/{liveStream****}/{UnixTimestamp****}"
}
]
}
},
"RequestId": "97df6b7f-3490-47d2-ac50-8833e1b64597",
"SideOutputUrl": "rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****",
"SideOutputUrlList": "[\"rtmp://domain/app1/stream1\",\"rtmp://domain/app2/stream2\"]",
"SyncGroupsConfig": {
"SyncGroup": [
{
"HostResourceId": "28768383240243****",
"Mode": 0,
"ResourceIds": {
"ResourceId": [
"1"
]
}
}
]
},
"TranscodeConfig": {
"CasterTemplate": "lp_hd",
"LiveTemplateIds": {
"LocationId": [
"lld"
]
},
"CustomParams": {
"video": {
"fps": 300,
"bitrate": 300,
"width": 1080,
"height": 720
}
}
},
"UrgentImageId": "a089175eb5f4427684fc0715159a****",
"UrgentImageUrl": "http://learn.aliyundoc.com/AppName/image.jpg",
"UrgentLiveStreamUrl": "rtmp://demo.aliyundoc.com",
"UrgentMaterialId": "98646538-bcf9-4aef-bd4a-e6bb76588****"
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidCasterId.Malformed | %s, please check and try again later. | |
| 401 | IllegalOperation | %s, please check and try again later. | |
| 500 | InternalError | %s, please try again later. | |
| 404 | InvalidCaster.NotFound | %s, please check and try again later. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。