すべてのプロダクト
Search

このプロダクト

    ApsaraVideo Live:DescribeCasters

    ドキュメントセンター

    ApsaraVideo Live:DescribeCasters

    最終更新日:Jun 23, 2026

    プロダクションスタジオのリストを照会します。

    操作説明

    CreateCaster 操作を呼び出してプロダクションスタジオを作成した後、この操作を呼び出してプロダクションスタジオのリストをクエリします。プロダクションスタジオはアイドル状態またはストリーム配信状態のいずれかです。

    説明

    QPS 制限

    この操作のシングルユーザー QPS 制限は 1 秒あたり 15 回です。この制限を超えると、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:DescribeCasters

    get

    *Caster

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    リージョン ID。

    cn-shanghai
    CasterId

    string

    任意

    プロダクションスタジオ ID。

    • CreateCaster 操作を呼び出してプロダクションスタジオを作成した場合、CreateCaster 操作から返された CasterId パラメーターを確認してください。

    • ApsaraVideo Live コンソールでプロダクションスタジオを作成した場合、ApsaraVideo Live コンソール > プロダクションスタジオ > クラウドプロダクションスタジオで ID を確認してください。

    説明

    • クラウドプロダクションスタジオページのプロダクションスタジオリストにあるプロダクションスタジオ名がプロダクションスタジオ ID です。

    • このパラメーターを空のままにすると、デフォルトですべてのプロダクションスタジオの統合データが返されます。

    LIVEPRODUCER_POST-cn-0pp1czt****
    CasterName

    string

    任意

    プロダクションスタジオの名前。

    liveCaster****
    StartTime

    string

    任意

    開始時刻。フォーマット: yyyy-MM-ddTHH:mm:ssZ (協定世界時 (UTC))。

    2016-06-29T09:00:00Z
    EndTime

    string

    任意

    終了時間。フォーマット: yyyy-MM-ddTHH:mm:ssZ (協定世界時 (UTC))。

    2016-06-29T11:00:00Z
    PageNum

    integer

    任意

    ページ番号。

    1
    PageSize

    integer

    任意

    ページあたりのエントリ数。デフォルト値: 100。

    100
    Status

    integer

    任意

    ステータス。有効な値:

    • 0: アイドル。

    • 1: ストリーム配信中。

    0
    ChargeType

    integer

    任意

    課金方法。有効な値:

    • 0: PrePaid (サブスクリプション)。

    • 1: PostPaid (従量課金)。

    0
    OrderByModifyAsc

    string

    任意

    プロダクションスタジオを変更時間の昇順でソートするかどうかを指定します。

    有効な値: true (変更時間の昇順) | false (変更時間の降順、デフォルト値)。

    説明

    このパラメーターを指定しない場合、デフォルト値は "false" です。

    false
    NormType

    string

    任意

    プロダクションスタジオのスペックタイプ。有効な値:

    • 1: 汎用モード。

    • 3: 軽量プレイリストモード。

    • 4: 仮想スタジオモード。

    • 6: ニア VOD モード (新しいニア VOD モードプロダクションスタジオ)。

    1
    ResourceGroupId

    string

    任意

    リソースグループ ID。リソースグループの詳細については、リソースグループとはを参照してください。

    rg-aekzw******
    Tag

    array<object>

    任意

    タグのリスト。

    object

    任意

    タグのリスト。

    Key

    string

    任意

    タグキー。

    TestKey
    Value

    string

    任意

    タグ値。

    TestValue

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    プロダクションスタジオリストのクエリ結果。

    CasterList

    object

    Caster

    array<object>

    プロダクションスタジオのリスト。

    array<object>

    プロダクションスタジオの情報。

    CasterId

    string

    プロダクションスタジオの ID。この ID は、ストリーム URL の照会、プロダクションスタジオの起動、ビデオリソースの追加、レイアウトの追加、レイアウトの照会、コンポーネントの追加、プレイリストの追加などの他の操作のリクエストパラメーターとして使用されます。

    LIVEPRODUCER_POST-cn-0pp1czt****
    CasterName

    string

    プロダクションスタジオの名前。

    liveCaster****
    CasterTemplate

    string

    プロダクションスタジオの解像度。課金方法がサブスクリプションの場合、このパラメーターは必須です。

    • lp_ld： 低解像度。

    • lp_sd： 標準解像度。

    • lp_hd： 高解像度。

    • lp_ud： 超高解像度。

    • lp_ld_v： 縦長低解像度。

    • lp_sd_v： 縦長標準解像度。

    • lp_hd_v： 縦長高解像度。

    • lp_ud_v： 縦長超高解像度。

    lp_ld
    ChannelEnable

    integer

    チャンネルが有効かどうかを示します。

    • 0： いいえ。

    • 1： はい。

    1
    ChargeType

    string

    課金方法。

    • PrePaid： サブスクリプション。

    • PostPaid： 従量課金。

    PrePaid
    CreateTime

    string

    プロダクションスタジオの作成時刻。

    2017-08-30T12:02:57Z
    Duration

    string

    持続時間。形式は hh:mm:ss です。

    1:02:33
    ExpireTime

    string

    プロダクションスタジオの有効期限。

    2018-08-30T12:02:57Z
    LastModified

    string

    プロダクションスタジオの最終更新時刻。たとえば、プロダクションスタジオの起動、停止、設定変更などが行われた時刻です。

    2021-12-01T05:08:45Z
    NormType

    integer

    プロダクションスタジオのタイプ。有効な値：

    • 0： プレイリストモード。

    • 1： 標準。

    1
    PurchaseTime

    string

    プロダクションスタジオの購入時刻。

    2017-08-30T12:02:57Z
    StartTime

    string

    プロダクションスタジオの起動時刻。このパラメーターは、プロダクションスタジオが In Production ステータスの場合にのみ返されます。

    2017-08-30T18:02:57Z
    Status

    integer

    ステータス。有効な値：

    • 0： Idle。

    • 1： In Production。

    1
    ClientTokenId

    string

    べき等性を保証するためにクライアント側で生成されるトークン。このトークンは異なるリクエスト間で一意である必要があり、最大 64 文字の ASCII 文字を含めることができます。

    53200b81-b761-4c10-842a-a0726d97****

    Tags

    object

    tag

    array<object>

    タグのリスト。

    object

    タグ。

    TagKey

    string

    タグキー。

    TestKey
    TagValue

    string

    タグ値。

    TestValue
    ResourceGroupId

    string

    リソースグループの ID。詳細については、「リソースグループとは」をご参照ください。

    rg-acfmz******
    RequestId

    string

    リクエスト ID。

    5c6a2a0df228-4a64- af62-20e91b******
    Total

    integer

    プロダクションスタジオの総数。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "CasterList": {
    "Caster": [
      {
        "CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
        "CasterName": "liveCaster****",
        "CasterTemplate": "lp_ld",
        "ChannelEnable": 1,
        "ChargeType": "PrePaid",
        "CreateTime": "2017-08-30T12:02:57Z",
        "Duration": "1:02:33",
        "ExpireTime": "2018-08-30T12:02:57Z",
        "LastModified": "2021-12-01T05:08:45Z",
        "NormType": 1,
        "PurchaseTime": "2017-08-30T12:02:57Z",
        "StartTime": "2017-08-30T18:02:57Z",
        "Status": 1,
        "ClientTokenId": "53200b81-b761-4c10-842a-a0726d97****\n",
        "Tags": {
          "tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmz******"
      }
    ]
  },
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b******",
  "Total": 1
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidUserId.Malformed %s, please check userId.
    400 MissingParameter %s.
    400 InvalidParameter.Malformed There are invalid parameters: %s.
    400 InvalidParameter.Status %s, please check and try again.
    400 InvalidParameter.StartTime %s, please check and try again later.
    400 InvalidParameter.EndTime %s, please check and try again later.
    400 LiveServiceNotFound %s, please check and try again later.
    400 InvalidParameter.PageSize %s, please check and try again later.
    400 InvalidParameter.PageNum %s, please check and try again later.
    403 PermissionDenied %s, please check and try again later.

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

    変更履歴

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