DescribeCasterConfig - ApsaraVideo Live

Mengkueri konfigurasi studio produksi.

Deskripsi operasi

Panggil operasi CreateCaster untuk membuat studio produksi, lalu panggil operasi ini untuk mengkueri konfigurasinya.

Batas QPS

Operasi ini memiliki batas permintaan per detik (QPS) sebesar 15 panggilan per pengguna. Jika batas tersebut dilampaui, panggilan API Anda akan dikenai throttle, yang dapat memengaruhi bisnis Anda. Rencanakan panggilan Anda secara sesuai.

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:DescribeCasterConfig

get

*Caster

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah.	cn-shanghai
CasterId	string	Yes	ID studio produksi. Jika Anda membuat studio produksi dengan memanggil operasi CreateCaster, gunakan nilai CasterId yang dikembalikan dalam respons. Jika Anda membuat studio produksi di konsol, buka halaman LIVE console > Production Studio > Cloud Production Studio untuk melihat ID-nya. Catatan Nama studio produksi dalam daftar pada halaman Cloud Production Studio adalah ID studio produksi tersebut.	LIVEPRODUCER_POST-cn-0pp1czt****

Elemen respons

Element	Type	Description	Example
	object	Konfigurasi studio produksi.
AutoSwitchUrgentConfig	string	Konfigurasi untuk alih otomatis ke video cadangan. `eofThres`: Durasi dalam detik setelah sistem secara otomatis beralih ke video cadangan jika aliran terputus.	{"eofThres":3}
AutoSwitchUrgentOn	string	Menunjukkan apakah alih otomatis ke video cadangan diaktifkan. true: Diaktifkan. false: Dinonaktifkan.	true
CallbackUrl	string	Alamat webhook.	http://learn.aliyundoc.com/callBackLive
CasterId	string	ID studio produksi.	LIVEPRODUCER_POST-cn-0pp1czt****
CasterName	string	Nama studio produksi.	coco-caster10
ChannelEnable	integer	Menunjukkan apakah channel diaktifkan. Nilai yang valid: 0: Dinonaktifkan. 1: Diaktifkan.	1
Delay	number	Penundaan aliran. Satuan: detik. 0: Penundaan dinonaktifkan. Nilai lebih besar dari 0: Penundaan diaktifkan.	0
DomainName	string	Domain streaming.	example.com
ProgramEffect	integer	Flag carousel. Nilai yang valid: 0: Tidak efektif. 1: Efektif.	0
ProgramName	string	Nama carousel.	program_name
RecordConfig	object	Jika parameter ini kosong, fitur perekaman dinonaktifkan.
OnDemand	integer	Perekaman on-demand. Nilai yang valid: 0: Dinonaktifkan. 1: Callback HTTP. 2: Perekaman on-demand berdasarkan parameter stream ingest. 7: Perekaman dinonaktifkan secara default.	0
OssBucket	string	Lokasi penyimpanan.	liveBucket****
OssEndpoint	string	Titik akhir OSS tempat lokasi penyimpanan berada.	oss-cn-shanghai.aliyundoc.com
RecordFormat	object
RecordFormat	array<object>	Konfigurasi format perekaman.
	object	Informasi durasi perekaman.
CycleDuration	integer	Durasi perekaman.	3600
Format	string	Format perekaman.	M3U8
OssObjectPrefix	string	Nama file rekaman.	record/{liveApp**}/{liveStream**}
SliceOssObjectPrefix	string	Nama segmen.	record/{liveApp**}/{liveStream}/{UnixTimestamp**}
RequestId	string	ID permintaan.	97df6b7f-3490-47d2-ac50-8833e1b64597
SideOutputUrl	string	URL output bypass kustom dari studio produksi.	rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5**
SideOutputUrlList	string	Daftar URL output bypass kustom untuk studio produksi.	["rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"]
SyncGroupsConfig	object
SyncGroup	array<object>	Konfigurasi penyimpanan.
	array<object>	Konfigurasi penyimpanan.
HostResourceId	string	ID resource studio produksi.	28768383240243****
Mode	integer	Mode caching untuk halaman statis. Nilai yang valid: 0: Mode Standar. 1: Mode Kuat. 2: Tanpa caching.	0
ResourceIds	object
ResourceId	array	Daftar ID sumber daya cloud yang kelompok sumber dayanya ingin Anda ubah. Anda dapat menentukan 1 hingga 50 ID resource.
	string	Daftar ID sumber daya cloud yang kelompok sumber dayanya ingin Anda ubah. Anda dapat menentukan 1 hingga 50 ID resource.	1
TranscodeConfig	object	Konfigurasi transkoding.
CasterTemplate	string	Template transkoding untuk studio produksi. Nilai yang valid: lp_ld: Definisi rendah. lp_sd: Definisi standar. lp_hd: Definisi tinggi. lp_ud: Resolusi ultra-tinggi. lp_ld_v: Definisi rendah vertikal. lp_sd_v: Definisi standar vertikal. lp_hd_v: Definisi tinggi vertikal. lp_ud_v: Resolusi ultra-tinggi vertikal.	lp_hd
LiveTemplateIds	object
LocationId	array	Konfigurasi transkoding streaming langsung.
	string	Konfigurasi transkoding streaming langsung. Nilai yang valid: lsd: Definisi standar. lld: Definisi rendah. lud: Resolusi ultra-tinggi. lhd: Template transkoding adaptif definisi tinggi. daobo-lsd: Definisi standar. daobo-lld: Definisi rendah. daobo-lud: Resolusi ultra-tinggi. daobo-lhd: Definisi tinggi.	lld
CustomParams	object	Konfigurasi kustom
video	object	Parameter video
fps	integer	Laju frame video	300
bitrate	integer	Bitrate video	300
width	integer	Lebar video dalam piksel (px).	1080
height	integer	Tinggi video dalam piksel (px).	720
UrgentImageId	string	ID aset citra cadangan di pustaka aset media.	a089175eb5f4427684fc0715159a****
UrgentImageUrl	string	URL aset citra cadangan.	http://learn.aliyundoc.com/AppName/image.jpg
UrgentLiveStreamUrl	string	URL aliran live cadangan.	rtmp://demo.aliyundoc.com
UrgentMaterialId	string	ID aset video cadangan di pustaka aset media.	98646538-bcf9-4aef-bd4a-e6bb76588****

Contoh

Respons sukses

JSONformat

{
  "AutoSwitchUrgentConfig": "{\"eofThres\":3}",
  "AutoSwitchUrgentOn": "true",
  "CallbackUrl": "http://learn.aliyundoc.com/callBackLive",
  "CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
  "CasterName": "coco-caster10",
  "ChannelEnable": 1,
  "Delay": 0,
  "DomainName": "example.com",
  "ProgramEffect": 0,
  "ProgramName": "program_name",
  "RecordConfig": {
    "OnDemand": 0,
    "OssBucket": "liveBucket****",
    "OssEndpoint": "oss-cn-shanghai.aliyundoc.com",
    "RecordFormat": {
      "RecordFormat": [
        {
          "CycleDuration": 3600,
          "Format": "M3U8",
          "OssObjectPrefix": "record/{liveApp****}/{liveStream****}",
          "SliceOssObjectPrefix": "record/{liveApp****}/{liveStream****}/{UnixTimestamp****}"
        }
      ]
    }
  },
  "RequestId": "97df6b7f-3490-47d2-ac50-8833e1b64597",
  "SideOutputUrl": "rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****",
  "SideOutputUrlList": "[\"rtmp://domain/app1/stream1\",\"rtmp://domain/app2/stream2\"]",
  "SyncGroupsConfig": {
    "SyncGroup": [
      {
        "HostResourceId": "28768383240243****",
        "Mode": 0,
        "ResourceIds": {
          "ResourceId": [
            "1"
          ]
        }
      }
    ]
  },
  "TranscodeConfig": {
    "CasterTemplate": "lp_hd",
    "LiveTemplateIds": {
      "LocationId": [
        "lld"
      ]
    },
    "CustomParams": {
      "video": {
        "fps": 300,
        "bitrate": 300,
        "width": 1080,
        "height": 720
      }
    }
  },
  "UrgentImageId": "a089175eb5f4427684fc0715159a****",
  "UrgentImageUrl": "http://learn.aliyundoc.com/AppName/image.jpg",
  "UrgentLiveStreamUrl": "rtmp://demo.aliyundoc.com",
  "UrgentMaterialId": "98646538-bcf9-4aef-bd4a-e6bb76588****"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidCasterId.Malformed	%s
401	IllegalOperation	%s
500	InternalError	%s
404	InvalidCaster.NotFound	%s

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.