All Products
Search
Document Center

ApsaraVideo Live:DescribeCasters

Last Updated:Jun 23, 2026

Mengkueri daftar studio produksi.

Deskripsi operasi

Buat studio produksi dengan memanggil operasi CreateCaster, lalu panggil operasi ini untuk mengkueri daftar studio produksi. Studio produksi dapat berada dalam status idle atau streaming.

Catatan

Batas QPS

Batas QPS pengguna tunggal untuk operasi ini adalah 15 panggilan per detik. Jika batas ini terlampaui, panggilan API akan dibatasi, yang dapat memengaruhi bisnis Anda. Panggil operasi ini sesuai kebutuhan.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

  • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

  • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

  • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

  • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

    • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

    • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

  • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

  • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeCasters

get

*Caster

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

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

RegionId

string

No

ID wilayah.

cn-shanghai

CasterId

string

No

ID studio produksi.

  • Jika Anda membuat studio produksi dengan memanggil operasi CreateCaster, periksa parameter CasterId yang dikembalikan oleh operasi CreateCaster.

  • Jika Anda membuat studio produksi di Konsol ApsaraVideo Live, buka Konsol ApsaraVideo Live > Studio Produksi > Studio Produksi Cloud untuk melihat ID.

Catatan
  • Nama studio produksi dalam daftar studio produksi pada halaman Studio Produksi Cloud adalah ID studio produksi.

  • Jika parameter ini dikosongkan, data gabungan dari semua studio produksi akan dikembalikan secara default.

LIVEPRODUCER_POST-cn-0pp1czt****

CasterName

string

No

Nama studio produksi.

liveCaster****

StartTime

string

No

Waktu mulai. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).

2016-06-29T09:00:00Z

EndTime

string

No

Waktu berakhir. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).

2016-06-29T11:00:00Z

PageNum

integer

No

Nomor halaman.

1

PageSize

integer

No

Jumlah entri per halaman. Nilai default: 100.

100

Status

integer

No

Status. Nilai valid:

  • 0: idle.

  • 1: streaming.

0

ChargeType

integer

No

Metode penagihan. Nilai valid:

  • 0: PrePaid (langganan).

  • 1: PostPaid (bayar sesuai pemakaian).

0

OrderByModifyAsc

string

No

Apakah akan mengurutkan studio produksi berdasarkan waktu modifikasi secara menaik.

Nilai valid: true (urutan menaik berdasarkan waktu modifikasi) | false (urutan menurun berdasarkan waktu modifikasi, yang merupakan nilai default).

Catatan

Jika parameter ini tidak ditentukan, nilai default adalah "false".

false

NormType

string

No

Tipe spesifikasi studio produksi. Nilai valid:

  • 1: Mode umum.

  • 3: mode daftar putar ringan.

  • 4: mode studio virtual.

  • 6: mode daftar putar (studio produksi mode daftar putar baru).

1

ResourceGroupId

string

No

ID kelompok sumber daya. Untuk informasi selengkapnya tentang kelompok sumber daya, lihat Apa itu kelompok sumber daya.

rg-aekzw******

Tag

array<object>

No

Daftar tag.

object

No

Daftar tag.

Key

string

No

Kunci tag.

TestKey

Value

string

No

Nilai tag.

TestValue

Elemen respons

Element

Type

Description

Example

object

Hasil kueri daftar studio produksi.

CasterList

object

Caster

array<object>

Daftar studio produksi.

array<object>

Informasi studio produksi.

CasterId

string

The ID of the production studio. This ID is used as a request parameter for other operations, such as querying stream URLs, starting a production studio, adding video resources, adding layouts, querying layouts, adding components, and adding playlists.

LIVEPRODUCER_POST-cn-0pp1czt****

CasterName

string

The name of the production studio.

liveCaster****

CasterTemplate

string

The resolution of the production studio. This parameter is required if the billing method is subscription.

  • lp_ld: Low definition.

  • lp_sd: Standard definition.

  • lp_hd: High definition.

  • lp_ud: Ultra-high definition.

  • lp_ld_v: Vertical low definition.

  • lp_sd_v: Vertical standard definition.

  • lp_hd_v: Vertical high definition.

  • lp_ud_v: Vertical ultra-high definition.

lp_ld

ChannelEnable

integer

Indicates whether the channel is enabled.

  • 0: No.

  • 1: Yes.

1

ChargeType

string

The billing method.

  • PrePaid: subscription.

  • PostPaid: pay-as-you-go.

PrePaid

CreateTime

string

The time when the production studio was created.

2017-08-30T12:02:57Z

Duration

string

The duration. The format is hh:mm:ss.

1:02:33

ExpireTime

string

The expiration time of the production studio.

2018-08-30T12:02:57Z

LastModified

string

The time when the production studio was last modified. For example, the time when the production studio was started, stopped, or configured.

2021-12-01T05:08:45Z

NormType

integer

The type of the production studio. Valid values:

  • 0: Playlist mode.

  • 1: Standard.

1

PurchaseTime

string

The time when the production studio was purchased.

2017-08-30T12:02:57Z

StartTime

string

The time when the production studio was started. This parameter is returned only when the production studio is in the In Production state.

2017-08-30T18:02:57Z

Status

integer

The status. Valid values:

  • 0: Idle.

  • 1: In Production.

1

ClientTokenId

string

A client-generated token that is used to ensure the idempotence of the request. The token must be unique among different requests and can contain a maximum of 64 ASCII characters.

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

Tags

object

tag

array<object>

The list of tags.

object

The tag.

TagKey

string

The tag key.

TestKey

TagValue

string

The tag value.

TestValue

ResourceGroupId

string

The ID of the resource group. For more information, see What is a resource group?.

rg-acfmz******

RequestId

string

ID permintaan.

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

Total

integer

Jumlah total studio produksi.

1

Contoh

Respons sukses

JSONformat

{
  "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
}

Kode kesalahan

HTTP status code

Error code

Error message

Description

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.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.