プロダクションスタジオの構成情報をクエリします。
操作説明
CreateCaster 操作を呼び出してプロダクションスタジオを作成し、その後この操作を呼び出してプロダクションスタジオの構成情報をクエリします。
QPS 制限
この操作の単一ユーザー QPS 制限は、1 秒あたり 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 |
ユーザーコールバック URL。 |
http://learn.aliyundoc.com/呼び出しBackLive |
| 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://ドメイン/app1/ストリーム1","rtmp://ドメイン/app2/ストリーム2"] |
| 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/イメージ.jpg |
| UrgentLiveStreamUrl |
string |
スタンバイライブストリームの URL。 |
rtmp://demo.aliyundoc.com |
| UrgentMaterialId |
string |
スタンバイビデオのメディアライブラリアセット ID。 |
98646538-bcf9-4aef-bd4a-e6bb76588**** |
| AudioMixerMode |
string |
例
成功レスポンス
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****",
"AudioMixerMode": ""
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidCasterId.Malformed | %s, please check and try again later. | CasterId パラメーターが無効です。パラメーターを確認して、再試行してください。 |
| 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. | プロダクションスタジオが存在しません。構成を確認して、再試行してください。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。