Queries the information about specified episode lists or all episode lists that belong to the current account.

Usage note

If the ProgramId is specified in the request, the server returns information about the specific program. If it is not specified, the server returns all the programs.

QPS limit

1人のユーザーが1秒あたり最大10件のクエリ (QPS) を実行できます。 Throttling is triggered when the number of calls per second exceeds the QPS limit. スロットルはビジネスに影響を与える可能性があります。 Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 ListPlaylist

実行する操作です。 値を

ListPlaylist.

ProgramId String 任意 c09f3d63-eacf-4fbf-bd48-a07a6ba7 ****

The IDs of the episode lists that you want to query. このパラメーターを設定すると、指定されたエピソードリストに関する情報のみが返されます。 If you do not set this parameter, the information about all episode lists that belong to the current account is returned.

ページ Integer 任意 1

返されるページ数。

PageSize Integer 任意 20

各ページで返されるエントリ数。

レスポンスパラメーター

パラメーター データ型 例 説明
ProgramList ProgramInfoの配列

照会されたエピソードリストに関する情報。

CasterId String casdfasdfasfdasdflkasjdflaj ****

エピソードリストが属するストリーミングパネルのID。

DomainName String example.com

メインのストリーミングドメイン。
ProgramId String c09f3d63-eacf-4fbf-bd48-a07a6ba7 ****

照会されたエピソードリストのID。

プログラム名 String playlist1

照会されたエピソードリストの名前。

RepeatNumber Integer 1

最初の再生が完了した後にエピソードリストが繰り返される回数。 設定可能な値は以下のとおりです。

  • 0: エピソードリストが1回だけ再生されることを示します。 これはデフォルト値です。
  • -1: エピソードリストがループモードで再生されることを示します。
  • 正の整数: 最初の再生が完了した後にエピソードリストが繰り返される回数を示します。
ステータス Integer 1

エピソードリストのステータス。 設定可能な値は以下のとおりです。

  • : 停止0
  • : 実行中1
RequestId String 5c6a2a0d-f228-4a64-af62-20e91b96 ****

リクエストの ID です。

Total Integer 1

照会されたエピソードリストの総数。

例

リクエストの例

http(s):// live.aliyuncs.com/?Action=ListPlaylist
&ProgramId=445409ec-7eaa-461d-8f29-4bec2eb9 ****
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

<ListPlaylistResponse>
      <ProgramList>
           <ステータス> 1</ステータス>
           <RepeatNumber>1</RepeatNumber>
          <DomainNam e>example.com</DomainName>
           <ProgramId>c09f3d63-eacf-4fbf-bd48-a07a6ba7 ****</ProgramId>
           <CasterId>casdfasdfasfdasdflkasjdflaj ****</CasterId>
           <ProgramName>playlist1</ProgramName>
      </プログラムリスト>
      <RequestId>5c6a2a0d-f228-4a64-af62-20e91b96 ****</RequestId>
      <合計> 1</合計>
</ListPlaylistResponse>

JSON 形式 

{
    "ProgramList":[{
        "ステータス":"1" 、
        "RepeatNumber":"1" 、
        "DomainName":"example.com" 、
        "ProgramId":"c09f3d63-eacf-4fbf-bd48-a07a6ba7 ****" 、
        "CasterId":"casdfasdfasfdasdflkasjdflaj ****" 、
        "ProgramName":"playlist1"
    }],
    "RequestId":"5c6a2a0d-f228-4a64-af62-20e91b96 ****" 、
    "合計":"1"
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。