SetCasterSceneConfig でシーンレイアウトを適用 - LIVE

シーンのすべての設定を行います。この操作は、シーンの以前の設定をすべてクリアし、レイアウト設定を含む新しい設定をシーンに適用します。

操作説明

この操作は、シーンのすべての構成を設定します。既存の構成をクリアし、指定されたシーンに新しいレイアウトを適用します。

QPS 制限

この API の 1 秒あたりのクエリ数（QPS）制限は、ユーザーあたり 1 秒あたり 10 回の呼び出しです。この制限を超える API 呼び出しはスロットルされ、ビジネスに影響を与える可能性があります。サービス中断を回避するために API 呼び出しを計画してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

live:SetCasterSceneConfig

update

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-shanghai
ComponentId	array	任意	コンポーネント ID のリスト。配列内のコンポーネントは下から上に順序付けられています。説明 N はコンポーネントの位置を指定します。たとえば、ComponentId.1 は最初のコンポーネント ID、ComponentId.2 は 2 番目のコンポーネント ID です。	[ "a2b8e671-2fe5-4642-a2ec-bf931826**", "a2b8e671-2fe5-4642-a2ec-28374657**"]
	string	任意	コンポーネント ID のリスト。配列内のコンポーネントは下から上に順序付けられています。説明 N はコンポーネントの位置を指定します。たとえば、ComponentId.1 は最初のコンポーネント ID、ComponentId.2 は 2 番目のコンポーネント ID です。	[ "a2b8e671-2fe5-4642-a2ec-bf931826**", "a2b8e671-2fe5-4642-a2ec-28374657**"]
CasterId	string	必須	プロダクションスタジオの ID。 CreateCaster 操作を呼び出してプロダクションスタジオを作成した場合は、レスポンスで返された CasterId 値を使用します。 ApsaraVideo Live コンソールでプロダクションスタジオを作成した場合は、[ApsaraVideo Live コンソール] の [プロダクションスタジオ] > [クラウドプロダクションスタジオ] ページに移動して ID を確認します。説明クラウドプロダクションスタジオページのリストにあるプロダクションスタジオの名前は、プロダクションスタジオ ID です。	80787064-1c94-4dc1-85ce-9409960a****
SceneId	string	必須	シーン ID。	242b4e2c-c30f-4442-85ba-2e3e4e3d****
LayoutId	string	任意	レイアウト ID。DescribeCasterLayouts 操作を呼び出してプロダクションスタジオのレイアウトリストをクエリする場合は、レスポンスで返された LayoutId 値を使用します。	0c6da077-f037-49e8-8440-3be13393****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	CF60DB6A-7FD6-426E-9288-122CC1A52FA7

例

成功レスポンス

JSONJSON

{
  "RequestId": "CF60DB6A-7FD6-426E-9288-122CC1A52FA7"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidCasterId.Malformed	%s, please check and try again later.
400	InvalidUserId.Malformed	%s, please check userId.
400	InvalidSceneId.Malformed	%s, please check and try again later.
400	InvalidCaptionResource	%s, please check and try again later.
400	IncorrectSceneStatus	%s, please check and try again later.
400	ComponentNumberExceed	%s, please check and try again later.
400	IncorrectSceneStatus.Idle	%s, please check and try again later.
400	IncorrectSceneStatus.ConfigError	%s, please check and try again later.
400	InvalidParameter.Malformed	There are invalid parameters: %s.
401	IllegalOperation	%s, please check and try again later.
412	ResourceInChannel.PreConditionFailed	%s, please try again later.
412	ResourceInChannel.Invalid	%s, please check and try again later.
500	InternalError	%s, please try again later.
404	InvalidCaster.NotFound	%s, please check and try again later.
404	InvalidScene.NotFound	%s, please check and try again later.
404	InvalidLayout.NotFound	%s, please check and try again later.
404	InvalidComponent.NotFound	%s, please check and try again later.
404	ResourceInChannel.NotFound	%s, please check and try again later.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。