Referensi API DescribeCasterConfig untuk Production Studio - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Mengueri konfigurasi studio produksi.

Deskripsi operasi

Panggil operasi CreateCaster untuk membuat studio produksi. Kemudian, panggil operasi ini untuk mengueri konfigurasinya.

Batas QPS

Operasi ini memiliki batas queries per second (QPS) sebesar 15 panggilan per pengguna. Jika Anda melebihi batas tersebut, panggilan API Anda akan dibatasi, yang dapat memengaruhi bisnis Anda. Rencanakan panggilan Anda dengan tepat.

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 konsol LIVE > Production Studio > Cloud Production Studio untuk melihat ID. Catatan Nama studio produksi dalam daftar pada halaman Cloud Production Studio adalah ID studio produksi.	LIVEPRODUCER_POST-cn-0pp1czt****

Elemen respons

Element	Type	Description	Example
	object	Konfigurasi studio produksi.
AutoSwitchUrgentConfig	string	Konfigurasi untuk peralihan otomatis ke video siaga. `eofThres`: Durasi dalam detik setelah sistem secara otomatis beralih ke video siaga jika aliran terganggu.	{"eofThres":3}
AutoSwitchUrgentOn	string	Menunjukkan apakah peralihan otomatis ke video siaga 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 saluran diaktifkan. Nilai yang valid: 0: Dinonaktifkan. 1: Diaktifkan.	1
Delay	number	Penundaan aliran. Unit: 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 berlaku. 1: Berlaku.	0
ProgramName	string	Nama carousel.	program_name
RecordConfig	object	Jika parameter ini kosong, fitur perekaman dinonaktifkan.
OnDemand	integer	Perekaman sesuai permintaan. Nilai yang valid: 0: Dinonaktifkan. 1: Callback HTTP. 2: Perekaman sesuai permintaan berdasarkan parameter ingest aliran. 7: Perekaman dinonaktifkan secara default.	0
OssBucket	string	Lokasi penyimpanan.	liveBucket****
OssEndpoint	string	Endpoint OSS tempat lokasi penyimpanan berada.	oss-cn-shanghai.aliyundoc.com
RecordFormat	object
RecordFormat	array<object>	The recording format configuration.
	object	The recording length information.
CycleDuration	integer	The recording length.	3600
Format	string	The recording format.	M3U8
OssObjectPrefix	string	The name of the recording file.	record/{liveApp**}/{liveStream**}
SliceOssObjectPrefix	string	The name of the segment.	record/{liveApp**}/{liveStream}/{UnixTimestamp**}
RequestId	string	ID permintaan.	97df6b7f-3490-47d2-ac50-8833e1b64597
SideOutputUrl	string	URL output bypass khusus dari studio produksi.	rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5**
SideOutputUrlList	string	Daftar URL output bypass khusus untuk studio produksi.	["rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"]
SyncGroupsConfig	object
SyncGroup	array<object>	Konfigurasi penyimpanan.
	array<object>	Konfigurasi penyimpanan.
HostResourceId	string	The resource ID of the production studio.	28768383240243****
Mode	integer	The caching mode for static pages. Valid values: 0: Standard mode. 1: Strong Mode. 2: No caching.	0
ResourceIds	object
ResourceId	array	The list of IDs of the cloud resources whose resource group you want to change. You can specify from 1 to 50 resource IDs.
	string	The list of IDs of the cloud resources whose resource group you want to change. You can specify from 1 to 50 resource IDs.	1
TranscodeConfig	object	Konfigurasi transkoding.
CasterTemplate	string	Templat transkoding untuk studio produksi. Nilai yang valid: lp_ld: Definisi rendah. lp_sd: Definisi standar. lp_hd: Definisi tinggi. lp_ud: Definisi ultra-tinggi. lp_ld_v: Definisi rendah vertikal. lp_sd_v: Definisi standar vertikal. lp_hd_v: Definisi tinggi vertikal. lp_ud_v: Definisi ultra-tinggi vertikal.	lp_hd
LiveTemplateIds	object
LocationId	array	The live stream transcoding configuration.
	string	The live stream transcoding configuration. Valid values: lsd: Standard definition. lld: Low definition. lud: Ultra-high definition. lhd: High-definition adaptive transcoding template. daobo-lsd: Standard definition. daobo-lld: Low definition. daobo-lud: Ultra-high definition. daobo-lhd: High definition.	lld
CustomParams	object	Konfigurasi khusus
video	object	Video parameters
fps	integer	Video frame rate	300
bitrate	integer	Video bitrate	300
width	integer	The video width in pixels (px).	1080
height	integer	The video height in pixels (px).	720
UrgentImageId	string	ID aset gambar siaga di pustaka aset media.	a089175eb5f4427684fc0715159a****
UrgentImageUrl	string	URL aset gambar siaga.	http://learn.aliyundoc.com/AppName/image.jpg
UrgentLiveStreamUrl	string	URL aliran langsung siaga.	rtmp://demo.aliyundoc.com
UrgentMaterialId	string	ID aset video siaga 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, please check and try again later.
401	IllegalOperation	%s, please check and try again later.
500	InternalError	%s, please try again later.
404	InvalidCaster.NotFound	%s, please check and try again later.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.