ListPlaylistItems API リファレンス - LIVE

操作説明

この操作を呼び出す前に、AddPlaylistItems 操作を呼び出してプレイリストにアイテムを追加する必要があります。

QPS 制限

この操作には、ユーザーあたり 10 クエリ/秒 (QPS) の制限があります。この制限を超えると、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:ListPlaylistItems

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-shanghai
ProgramId	string	必須	プレイリストの ID。この ID は、AddPlaylistItems 操作の応答に含まれる ProgramId パラメーターから取得できます。	445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramItemIds	string	任意	プレイリストアイテムの ID。複数の ID をコンマ (,) で区切ります。このパラメーターを指定すると、指定したアイテムの情報のみが返されます。このパラメーターを空のままにすると、プレイリスト内のすべてのアイテムの情報が返されます。	c10f3d63-eacf-4fbf-bd48-a07a6ba7**,c09f3d63-eacf-4fbf-bd48-a07a6ba7**

レスポンスフィールド

フィールド	型	説明	例
	object
Total	integer	プレイリストアイテムの数。	1
RequestId	string	リクエスト ID。	5c6a2a0d-f228-4a64-af62-20e91b9****
ProgramItems	array<object>	プレイリストアイテムのリスト。
	object
Index	integer	オーケストレーションインデックス。	1
ResourceType	string	リソースのタイプ。	vod
ProgramItemId	string	プレイリストアイテムの ID。	c10f3d63-eacf-4fbf-bd48-a07a6ba7****
ProgramId	string	プレイリストの ID。この ID は、プレイリストの編集、削除、クエリ、開始、または停止を行う際にリクエストパラメーターとして使用できます。	445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramItemName	string	プレイリストアイテムの名前。	playlistItem1
ResourceValue	string	リソースの ID。	asdfasdf8as9df8sa9df89****

例

成功レスポンス

JSONJSON

{
  "Total": 1,
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b9****",
  "ProgramItems": [
    {
      "Index": 1,
      "ResourceType": "vod",
      "ProgramItemId": "c10f3d63-eacf-4fbf-bd48-a07a6ba7****",
      "ProgramId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
      "ProgramItemName": "playlistItem1",
      "ResourceValue": "asdfasdf8as9df8sa9df89****"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidProgramId.Malformed	%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.

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

変更履歴

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