Retrieve AI Caption Rule Lists via DescribeLiveAIProduceRules - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Mengkueri daftar aturan caption.

Deskripsi operasi

This operation queries a list of caption rules. Before you call this operation, ensure that the parameters are correctly configured.

Penting

The real-time caption feature is in invitational preview. Each user can add a maximum of 300 caption templates.

QPS limit

The queries per second (QPS) limit for a single user is 60. Exceeding this limit results in API call throttling, which can affect your business. We recommend that you call this operation at a reasonable rate.

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

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID Wilayah.	cn-shanghai
Domain	string	No	Nama domain pemutaran utama.	demo.aliyundoc.com
App	string	No	Nama aplikasi tempat aliran berada.	AppName
SuffixName	string	No	Sufiks caption. Catatan Atur parameter ini ke nilai SubtitleName yang ditentukan untuk templat caption.	sub01
RulesId	string	No	ID aturan caption.	445409ec-7eaa-461d-8f29-4bec****
PageNumber	string	No	Nomor halaman. Nilai valid: 1 hingga 100.	1
PageSize	string	No	Jumlah entri per halaman. Nilai valid: 1 hingga 100.	100

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The request ID.	5c6a2a0df228-4a64- af62-20e91b96****
RuleInfoList	object
RuleInfo	array<object>	The list of caption rules.
	object	The caption rule object.
Domain	string	The streaming domain.	demo.aliyundoc.com
App	string	The name of the application to which the stream belongs.	App Name
SubtitleName	string	The name of the caption template.	sub1
IsLazy	boolean	Indicates whether the rule is triggered by stream pulling.	true
RulesId	string	The ID of the caption rule.	72fba656-2cc2-40fd-923c-2a10c3b9****
LiveTemplate	string	The specifications of the output captions.	lp_ld
GmtModifyTime	string	The last modification time. This is a UNIX timestamp.	1715594344000
SuffixName	string	The caption suffix.	test0506
StudioName	string	The name of the virtual background template.	test0708
Description	string	The description of the rule.	live AI subtitle template

Contoh

Respons sukses

JSONformat

{
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b96****",
  "RuleInfoList": {
    "RuleInfo": [
      {
        "Domain": "demo.aliyundoc.com",
        "App": "App Name",
        "SubtitleName": "sub1",
        "IsLazy": true,
        "RulesId": "72fba656-2cc2-40fd-923c-2a10c3b9****",
        "LiveTemplate": "lp_ld",
        "GmtModifyTime": "1715594344000",
        "SuffixName": "test0506",
        "StudioName": "test0708",
        "Description": "live AI subtitle template"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	MissingParameter	%s.
400	InvalidParameter	%s.
400	IncorrectSubtitleStatus.%s	%s.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.