EditPlaylist API によるライブプレイリスト項目の更新 - LIVE - Alibaba Cloud - ApsaraVideo Live

プレイリストを編集します。

操作説明

この操作は完全な編集を実行します。この操作を使用して、構成情報を編集したり、複数のプレイリストアイテムを置き換えたりすることができます。

QPS 制限

1 人のユーザーが 1 秒あたりに実行できる秒間クエリ数 (QPS) は 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:EditPlaylist

update

*Caster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-shanghai
ProgramId	string	必須	プレイリスト ID。 AddPlaylistItems 操作を呼び出してプレイリストアイテムを追加する場合、その呼び出しによって返される ProgramId 値を使用します。	445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramItems	string	必須	プレイリストアイテムのリスト。これは JSON 文字列です。詳細については、「InputProgramItem」をご参照ください。	[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f**"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c**"}]
ProgramConfig	string	任意	プレイリストの構成。詳細については、「ProgramConfig」をご参照ください。	[{"RepeatNumber":"0","ProgramName":"my program"}]

InputProgramItem

パラメーター	例	タイプ	説明
ItemName	item1	String	プレイリストアイテムの名前。
ResourceType	vod	String	リソースタイプ。有効な値は vod のみです。これは、ビデオオンデマンド (VOD) リソースを示します。
ResourceValue	5f8809f2-3352-4d1f-a8f7-86f9429f****	String	リソースの ID。

ProgramConfig

パラメーター	例	タイプ	説明
RepeatNumber	0	Integer	プレイリストの再生が終了した後に繰り返す回数。有効な値：0 (デフォルト)：プレイリストは繰り返されません。-1：プレイリストは無期限にループします。その他の正の整数：プレイリストを繰り返す回数。
ProgramName	myprogram	String	プレイリストの名前。

レスポンスフィールド

フィールド	型	説明	例
	object
CasterId	string	プロダクションスタジオの ID。この ID をリクエストパラメーターとして使用して、コールバックまたは仮想スタジオレイアウトを追加します。	0e94d1f4-1a65-445c-9dcf-de8b3b8d****
Items	object	追加されたプレイリストアイテムのリスト。
FailedItems	array<object>	追加に失敗したプレイリストアイテムのリスト。
	object	追加に失敗したプレイリストアイテムのリスト。
ItemId	string	プレイリストアイテムの ID。	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	プレイリストアイテムの名前。	item2
SuccessItems	array<object>	正常に追加されたプレイリストアイテムのリスト。
	object	正常に追加されたアイテムのリスト。
ItemId	string	プレイリストアイテムの ID。	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	プレイリストアイテムの名前。	item1
ProgramId	string	プレイリスト ID。この ID をリクエストパラメーターとして使用して、プレイリストを削除、クエリ、開始、または停止します。	445409ec-7eaa-461d-8f29-4bec2eb9****
RequestId	string	リクエスト ID。	5c6a2a0d-f228-4a64-af62-20e91b96****

例

成功レスポンス

JSONJSON

{
  "CasterId": "0e94d1f4-1a65-445c-9dcf-de8b3b8d****",
  "Items": {
    "FailedItems": [
      {
        "ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
        "ItemName": "item2"
      }
    ],
    "SuccessItems": [
      {
        "ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
        "ItemName": "item1"
      }
    ]
  },
  "ProgramId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidProgramId.Malformed	%s, please check and try again later.
400	PlayListIsEmpty	%s, please check and try again later.
400	MissInputParams	%s, please check and try again later.
400	InvalidCasterId.Malformed	%s, please check and try again later.
400	IncorrectPlaylistStatus.Inuse	%s, please check and try again later.
400	InvalidParameter.Malformed	There are invalid parameters: %s.
500	InternalError	%s, please try again later.
404	PlayListNotFound	%s, please check and try again later.
404	InvalidCaster.NotFound	%s, please check and try again later.

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

変更履歴

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