CreateTicket - Quick BI

Membuat tiket untuk penyematan pihak ketiga.

Deskripsi operasi

Untuk informasi penggunaan selengkapnya, silakan merujuk ke Solusi Peningkatan Keamanan Kontrol Izin Data Penyematan Laporan dan Pengiriman Parameter.

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

quickbi-public:CreateTicket

create

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
WorksId	string	Yes	ID laporan yang akan disematkan. Saat ini mendukung dashboard, spreadsheet, layar data, pengambilan data self-service, analisis ad-hoc, dan entri data.	a206f5f3-****-e9b17c835b03
CmptId	string	No	ID komponen. Ini adalah ID komponen dalam dashboard yang disebutkan di atas; jenis karya lain tidak mendukung parameter ini.Referensi API untuk mendapatkan ID komponen: QueryWorksBloodRelationship.	0fc6a275c7f64f17b1****a306ce0f31
TicketNum	integer	No	Jumlah tiket. Setiap kali tiket digunakan, jumlah tiket berkurang sebanyak 1. Nilai default: 1 Nilai yang direkomendasikan: 1 Nilai maksimum: 99999	1
UserId	string	No	UserId Quick BI, bukan ID akun Alibaba Cloud Anda.Anda dapat memanggil antarmuka QueryUserInfoByAccount untuk mendapatkan UserId. Contoh UserId: fe67f61a35a94b7da1a34ba174a7**. Catatan** Hanya salah satu dari UserId dan AccountName yang perlu diisi. Jika keduanya tidak diisi, sistem akan secara default mengikat Owner laporan tersebut, dan laporan akan diakses menggunakan identitas pengguna tersebut. Jika Anda perlu mengonfigurasi izin tingkat baris, silakan merujuk ke Izin Tingkat Baris.	46e537466****92704c8
AccountName `deprecated`	string	No	Nama akun pengguna. Jika pengguna adalah akun primary Alibaba Cloud wangwu, formatnya adalah [Primary Account], contohnya wangwu. Jika pengguna adalah akun RAM zhangsan@aliyun.cn, formatnya adalah [Primary Account: Sub-Account], contohnya wangwu:zhangsan. Catatan** Hanya salah satu dari UserId dan AccountName yang perlu diisi. Jika keduanya tidak diisi, sistem akan secara default mengikat Owner laporan tersebut, dan laporan akan diakses menggunakan identitas pengguna tersebut. Jika Anda perlu mengonfigurasi izin tingkat baris, silakan merujuk ke Izin Tingkat Baris.	test
AccountType `deprecated`	integer	No	Jenis akun pengguna. 1: Akun Alibaba Cloud 3: Akun self-built Quick BI 4: DingTalk 5: Sub-akun RAM 9: WeCom 10: Feishu Catatan Jika AccountName tidak kosong, maka AccountType juga tidak boleh kosong.	1
ExpireTime	integer	No	Waktu kedaluwarsa Unit: menit Default: 240	200
WatermarkParam	string	No	Parameter watermark untuk laporan. Tidak boleh melebihi 50 karakter. Ketika jenis laporan adalah layar besar (large screen), pengiriman parameter watermark tidak didukung.	ticket embed
GlobalParam	string	No	Parameter global untuk kondisi filter laporan. Berupa string dalam format JsonArray. Catatan Jika Anda perlu menggunakan kemampuan parameter global, silakan hubungi Quick BI Operations Manager.	[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]}]

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	string	Nilai tiket yang dihasilkan.	ccd3428c-**-**-a608-26bae29dffee
Success	boolean	Menunjukkan apakah permintaan berhasil. Rentang nilai: true: Permintaan berhasil false: Permintaan gagal	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": "ccd3428c-****-****-a608-26bae29dffee",
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message
400	Authorize3rdTicket.BindedWorks.Mismatch	The report bound by the ticket mismatches the actual report.
400	Authorize3rdTicket.Expired	Ticket [%s] has expired.
400	Authorize3rdTicket.HasNo.LoginToken	The request [%s] has no token.
400	Authorize3rdTicket.NotExist	Ticket %s does not exist.
400	Authorize3rdTicket.Num.Exceed	The number of tickets %s is invalid.
400	Authorize3rdTicket.Num.HasNoLeft	There is no ticket number left, please generate new ticket.
400	Report.NotExist.Error	This work does not exist. It may have been deleted. Work ID is %s.
400	Authorize3Rd.Report.Unauthorized	The report is not enabled for third party embedding.
400	Cube.Not.Exist	The Cube does not exist.
400	Datasource.NotFound.Error	The specified data source does not exist: %s.
400	Report.NotExist	The dashboard does not exist.
400	Organization.Workspace.Inconformity	The workspace does not match the organization.
400	Parameter.Length.Exceed	Parameter length exceeds maximum limit: [%s].
400	GlobalParam.Restricted.Use	The global parameter function is restricted in your version.
400	Authorize3rdTicket.Unsupport.ScreenWatermark	Screen embed does not support watermark parameters.
400	NoPermissionTo.Operate.Object	You are not authorized to operate the objects.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.