Tüm Ürünler
Search
Belge Merkezi

Quick BI:API'ye genel bakış

Son Güncelleme:Oct 01, 2026

API standartları ve çok dilli hazır SDK'lar

Bu ürünün OpenAPI'si (quickbi-public/2022-01-01), RPC imzalama yöntemini kullanır. Geliştiriciler için yaygın programlama dillerine yönelik SDK'ları kapsülledik. Geliştiriciler, bu ürünün OpenAPI'sini teknik ayrıntılarla uğraşmadan doğrudan çağırabilmek için SDK'yı indirebilir. Mevcut SDK ihtiyaçlarınızı karşılamıyorsa, kendi imzanızı oluşturmak üzere imzalama mekanizmasını kullanarak entegrasyon yapabilirsiniz. Kendi imzanızı oluşturma sürecinin ayrıntıları oldukça karmaşık olduğundan, bu işlem yaklaşık 5 iş günü sürebilir. Bu nedenle, DingTalk hizmet grubumuza (147535001692) katılmanızı ve uzman rehberliği altında imzalama entegrasyonu gerçekleştirmenizi öneririz.

API'yi kullanmadan önce, istemci araçları (SDK ve CLI gibi) aracılığıyla API'ye etkili bir şekilde erişebilmek için kimlik hesabınızı ve erişim anahtarınızı (AccessKey) hazırlamanız gerekir. Ayrıntılar için bkz. AccessKey Alma.

Özel imzalama senaryoları

İş senaryonuzun özel gereksinimleri varsa ve API'yi kendi imzanızı oluşturarak entegre etmeniz gerekiyorsa, profesyonel rehberlik almak ve verimli bir entegrasyon sağlamak için öncelikle teknik destek ekibimizle (DingTalk hizmet grubu: 147535001692) iletişime geçmenizi öneririz.

Hesap ve güvenlik hazırlığı

Alibaba Cloud hesapları, tüm kaynaklar üzerinde tam yönetici izinlerine sahiptir. Bir AccessKey ele geçirildiğinde, ilişkili tüm kaynaklar yetkisiz erişim riskiyle karşı karşıya kalır. Güvenliği sağlamak için, yalnızca API erişim izinlerine sahip bir RAM kullanıcısı oluşturmanız ve bunun AccessKey'ini yapılandırmanız; ayrıca en az ayrıcalık ilkesine (PoLP) dayalı olarak RAM ilkelerini yapılandırmanız önerilir. Alibaba Cloud hesabını yalnızca Alibaba Cloud hesabı izinlerinin açıkça gerekli olduğu belirli senaryolarda kullanın.

API kataloğu

API

Başlık

Açıklama

AddDataLevelPermissionRuleUsers AddDataLevelPermissionRuleUsers. Belirtilen kullanıcıları ve kullanıcı gruplarını satır düzeyi izin kuralına ekler.
AddDataLevelPermissionWhiteList AddDataLevelPermissionWhiteList. Belirtilen bir veri kümesinin satır düzeyi ve sütun düzeyi izinleri için beyaz listeyi değiştirir.
AddDataSource AddDataSource. Bir veri kaynağı ekler.
AddShareReport Bir veri çalışması için paylaşım yapılandırması ekleme. Bir veri çalışması için paylaşım yapılandırması ekler.
AddUser Kuruluş üyesi ekleme. Bir kuruluş üyesi ekler.
AddUserGroupMember AddUserGroupMember. Belirtilen bir kullanıcı grubuna bir kuruluş üyesi ekler.
AddUserGroupMembers AddUserGroupMembers. Belirtilen bir kullanıcı grubuna tek seferde kullanıcı ekler.
AddUserTagMeta Kuruluş üyesi etiket meta verilerini ekleme. Kuruluş üyesi etiket meta verilerini ekler.
AddUserToWorkspace Çalışma Alanına Üye Ekleme. Belirtilen bir çalışma alanına üye ekler.
AddWorksAuthorization AddWorksAuthorization. Bir çalışma için yetkilendirme ekler.
AddWorkspaceUsers Bir çalışma alanına toplu olarak üye ekleme. Bir çalışma alanına toplu olarak üye ekler.
AllotDatasetAccelerationTask AllotDatasetAccelerationTask. Veri kümeleri için Quick motorunun toplama hızlandırmasını tetikler.
AuthorizeMenu AuthorizeMenu. BI portalı menüsünün toplu yetkilendirmesi otomatik olarak atlanır.
BatchAddFeishuUsers Lark kullanıcılarını toplu ekleme. Lark kullanıcılarını toplu olarak ekler.
CancelAuthorizationMenu Veri Portalı Menü Yetkilendirmesini Toplu İptal Etme. Portal menü kimliğine göre, belirtilen kullanıcılar ve kullanıcı grupları için yetkilendirme kayıtlarını iptal eder.
CancelCollection CancelCollection. Kullanıcının koleksiyonundan veri çalışmalarını kaldırır.
CancelReportShare CancelReportShare. Bir veri çalışması için paylaşım yetkilendirmesini siler.
ChangeVisibilityModel ChangeVisibilityModel. BI portalı menüsünün görünürlük modunu ve menünün yalnızca yetkilendirme ile görünür olup olmadığını değiştirir.
CheckDatasetExisted CheckDatasetExisted. Belirtilen CubeId değerine sahip bir veri kümesinin var olup olmadığını kontrol eder.
CheckOrganizationMember CheckOrganizationMember. Bir kullanıcının bir kuruluşun üyesi olup olmadığını kontrol eder.
CheckReadable CheckReadable. Bir kullanıcının panolar ve çalışma kitapları gibi veri çalışmalarını görüntüleme izinlerine sahip olup olmadığını sorgular.
ClearDynamicTagCache Belirtilen bir dinamik etiketin önbelleğini silme. Tek bir yapılandırma için önbelleğe alınmış etiket değerini siler.
CreateCubeBySql Özel SQL tabanlı veri kümesi oluşturma. Özel bir SQL ifadesine dayalı olarak bir veri kümesi oluşturur.
CreateDataset CreateDataset. Fiziksel bir tablodan veri kümesi oluşturur.
CreateTicket Gömülü rapor bileti oluşturma. Gömülü rapor erişimi için gerekli bir bilet oluşturur.
CreateTicket4Copilot Smart Q Gömme Bileti Oluşturma. Copilot'ı gömmek için bir bilet oluşturur.
CreateUserGroup Kullanıcı grubu oluşturma. Bir kullanıcı grubu oluşturur. Bir üst kullanıcı grubu belirtebilirsiniz.
CreateWorkspace CreateWorkspace. Bir çalışma alanı oluşturur.
DataSetBlood DataSetBlood. Belirtilen veri kümesine ait çalışma bilgilerini sorgular.
DataSourceBlood Belirtilen veri kaynağı altındaki veri kümesi bilgilerini sorgulama. Belirtilen veri kaynağı altındaki veri kümesi bilgilerini sorgular.
DelayTicketExpireTime DelayTicketExpireTime. Rapora gömülü biletin sona erme süresini günceller.
DeleteAuthorizationByUserId Belirtilen bir kullanıcının iş birliği yetkilendirme kaydını silme. Belirtilen bir kullanıcının iş birliği yetkilendirme kaydını siler.
DeleteDataLevelPermissionRuleUsers DeleteDataLevelPermissionRuleUsers. Satır düzeyi izin kuralından belirtilen kullanıcıları siler.
DeleteDataLevelRuleConfig DeleteDataLevelRuleConfig. Bir satır düzeyi izin kuralını siler.
DeleteTicket Gömülü Bileti Sil. Üçüncü taraf gömülü bileti siler.
DeleteUser Kuruluş Kullanıcısını Silme. Belirtilen kuruluş kullanıcısını siler.
DeleteUserFromWorkspace Çalışma Alanı Üyesini Kaldırma. Belirtilen çalışma alanından bir üyeyi siler.
DeleteUserGroup DeleteUserGroup. Bir kuruluştaki kullanıcı grubunu siler.
DeleteUserGroupMember Kullanıcı grubu üyesini silme. Belirtilen bir kullanıcı grubundan belirtilen bir üyeyi siler.
DeleteUserGroupMembers DeleteUserGroupMembers. Belirtilen kullanıcıları toplu olarak kullanıcı gruplarından kaldırır.
DeleteUserTagMeta DeleteUserTagMeta. Bir kuruluş üyesinin etiket meta verilerini siler.
GetDataSourceConnectionInfo GetDataSourceConnectionInfo. Veri kaynağı bilgilerini getirir.
GetMailTaskList GetMailTaskList. İzleme görevlerinin bir listesini getirir. Not: Çağrı yapanın AccessKey (AK) değerinin diğer kullanıcıların izleme görevlerini görüntüleme yetkisi yoksa, bu işlem yalnızca çağrı yapanın erişim yetkisine sahip olduğu görevleri döndürür.
GetMailTaskStatus GetMailTaskStatus. Bir kuruluş içindeki posta görevlerinin çalışma durumunu sorgular.
GetUserGroupInfo Anahtar kelimeye göre kullanıcı grubu bilgilerini alma. Kullanıcı grubu adı anahtar kelimesine göre kullanıcı grubu bilgilerini arar.
GetWorksEmbedList Gömülü raporları alma. Gömülü raporların listesini sorgular.
IpWhiteListConfig Veri güvenliği için IP beyaz listesini yapılandırma. Veri güvenliği için IP beyaz listesini yapılandırır.
ListAccelerationOfWorkspace Bir çalışma alanındaki hızlandırma motoru görev bilgilerini getirme. Bir çalışma alanının yönetim sayfasından hızlandırma motoru görev bilgilerini getirir.
ListApiDatasource API veri kaynağı listesini sorgulama. API veri kaynaklarının listesini sorgular.
ListAuthConfigByResource Bir kaynağın işbirliğine dayalı yetkilendirme kayıtlarını sorgular. Bir kaynağın işbirliğine dayalı yetkilendirme kayıtlarını sorgular.
ListByUserGroupId Kullanıcı gruplarını toplu olarak sorgulama. Kullanıcı grubu kimliklerine göre kullanıcı gruplarının bilgilerini toplu olarak sorgular.
ListCollections ListCollections. Bir kullanıcının favorilerine eklediği çalışmaların listesini getirir.
ListCubeDataLevelPermissionConfig ListCubeDataLevelPermissionConfig. Belirtilen bir veri kümesinin satır ve sütun izin yapılandırmalarının listesini getirir.
ListDataLevelPermissionWhiteList Veri kümesi satır ve sütun izni beyaz listesi. Belirtilen izin türüne göre bir veri kümesi için satır düzeyi veya sütun düzeyi izinlerin beyaz listesini getirir.
ListDataSource ListDataSource. Belirtilen çalışma alanı altındaki tüm veri kaynaklarını sorgular.
ListDynamicTag Mevcut kuruluşun dinamik etiket listesi. Mevcut kuruluşun dinamik etiket listesini getirir.
ListFavoriteReports Ana Panodaki Favori Raporlar Listesi. Genel bakış.
ListOrganizationRoles Kuruluş rol listesi. Kuruluş düzeyindeki özel rollerin listesini getirir.
ListOrganizationRoleUsers ListOrganizationRoleUsers. Belirtilen kuruluş rolü altındaki kullanıcı listesini getirir.
ListPortalMenuAuthorization ListPortalMenuAuthorization Bir BI portalındaki menülerin yetkilendirme ayrıntıları listesini getirir.
ListPortalMenus ListPortalMenus Belirli bir BI portalı altındaki menülerin hiyerarşik listesini alır.
ListRecentViewReports Ana sayfa panosundaki sık görüntülenen öğeleri ve ayak izi listesini getirme. Belirtilen bir kullanıcı için ana sayfa panosunda gösterilen sık görüntülenen öğeleri ve ayak izi listesini getirir.
ListSharedReports ListSharedReports. Belirtilen bir kullanıcının ana sayfasında görüntülenen yetkili çalışmaların listesini alır.
ListUserGroupsByUserId ListUserGroupsByUserId. Kullanıcı kimliğine göre bir kullanıcının ait olduğu tüm kullanıcı gruplarını sorgular.
ListWhitePortalMenu ListWhitePortalMenu. Bir BI portalı menüsünün beyaz listesini getirir.
ListWorkspaceRoles ListWorkspaceRoles. Çalışma alanı rollerinin listesini alır.
ListWorkspaceRoleUsers ListWorkspaceRoleUsers. Belirtilen çalışma alanı rolündeki kullanıcı listesini getirir.
ListWorkspaceUserRolesByUserId ListWorkspaceUserRolesByUserId. Bir kullanıcının tüm çalışma alanı rollerini sorgular.
ManualRunMailTask ManualRunMailTask. E-posta görevini manuel olarak çalıştırır.
ModifyApiDatasourceParameters ModifyApiDatasourceParameters. Belirtilen bir API veri kaynağının yapılandırmalarını değiştirir.
ModifyCopilotEmbedConfig Akıllı sorgu gömme yapılandırmasını değiştir. Akıllı sorgu gömme yapılandırmasını değiştirir.
ModifyDashboardNl2sqlStatus Birden fazla pano için Q-Assistant durumunu değiştirme. Birden fazla pano için Q-Assistant durumunu değiştirir.
QueryAccelerationLogByCubeId QueryAccelerationLogByCubeId. Belirtilen bir veri kümesi için hızlandırma görevlerinin çalıştırma günlüklerini sorgular.
QueryApprovalInfo QueryApprovalInfo. Onaylayıcıya göre onay akışı bilgilerini getirir.
QueryAuditLog Denetim Günlüğü Bilgilerini Sorgulama. Denetim günlüğü bilgilerini sorgular.
QueryComponentPerformance QueryComponentPerformance. Bileşen performans günlüklerini sorgular.
QueryCopilotEmbedConfig XiaoQ gömme özelliğini etkinleştirmeye yönelik yapılandırmaların listesi. XiaoQ gömme özelliğini etkinleştirmeye yönelik yapılandırmaların listesini getirir.
QueryCubeOptimization QueryCubeOptimization. Veri kümesi optimizasyon önerilerini sorgular.
QueryCubePerformance QueryCubePerformance. Bir veri kümesinin performans günlüklerini sorgular.
QueryDashboardNl2sql QueryDashboardNl2sql. Panonun soru kaynağı bilgilerini sorgular.
QueryData QueryData. Verileri sorgulamak için bir DataService Studio API'si çağırır.
QueryDataRange Veri aralığı katalog listesi. Veri aralığı katalog listesini getirir.
QueryDataService Veri Hizmeti API'sini Çağırma. Veri hizmetinde önceden oluşturulmuş bir API'yi çağırır.
QueryDataServiceList QueryDataServiceList. Veri hizmeti API listesini sorgular.
QueryDatasetDetailInfo QueryDatasetDetailInfo. Belirtilen bir veri kümesinin veri kaynağı, dizini ve veri kümesi modeli dahil olmak üzere ayrıntılarını getirir.
QueryDatasetInfo QueryDatasetInfo. Tablonun özel bir SQL tablosu olup olmadığını gösterir. Geçerli değerler: * true: özel SQL tablosu * false: özel olmayan SQL tablosu
QueryDatasetList Çalışma alanı veri kümesi listesini sorgulama. Belirtilen bir çalışma alanındaki veri kümeleri listesini, oluşturma zamanına göre azalan sırada sorgular.
QueryDatasetSmartqStatus Veri Kümesinde Akıllı Sorgunun Etkin Olup Olmadığını Kontrol Etme. Bir veri kümesi için Akıllı Soru-Cevap özelliğinin etkinleştirilip etkinleştirilmediğini kontrol eder.
QueryDatasetSwitchInfo QueryDatasetSwitchInfo. Belirtilen bir veri kümesi için satır düzeyi izin anahtarı durumunu getirir.
QueryEmbeddedInfo QueryEmbeddedInfo. Kuruluş içindeki maksimum gömme sayısı ve gömme sayısı da dahil olmak üzere gömme yapılandırmasını alır.
QueryEmbeddedStatus QueryEmbeddedStatus. Bir rapor için gömme özelliğinin etkinleştirilip etkinleştirilmediğini sorgular.
QueryLastAccelerationEngineJob QueryLastAccelerationEngineJob. Veri kümesi kimliğine göre en son hızlandırma görevini sorgular.
QueryLlmCubeWithThemeListByUserId Kullanıcının hangi veri kümeleri ve analiz temaları için sorgulama yetkisine sahip olduğunu kontrol eder. Kullanıcının hangi veri kümeleri ve analiz temaları için sorgulama yetkisine sahip olduğunu kontrol eder.
QueryOrganizationRoleConfig QueryOrganizationRoleConfig. Belirtilen kuruluş rolünün yapılandırmasını alır.
QueryOrganizationWorkspaceList Get workspace list in an organization Retrieves the list of workspaces in the current organization.
QueryReadableResourcesListByUserId QueryReadableResourcesListByUserId. Bir kullanıcının görüntüleme iznine sahip olduğu ve bir çalışma alanında paylaşımı yetkilendirilenler de dahil olmak üzere çalışmaların listesini sorgular.
QueryReadableResourcesListByUserIdV2 Kullanıcının görüntüleme iznine sahip olduğu çalışmaların listesini sorgulama (yeni) Kullanıcının görüntüleme iznine sahip olduğu çalışmaların listesini sorgular (yeni).
QueryReportPerformance QueryReportPerformance. Rapor performans günlüklerini sorgular.
QueryShareList Bir çalışmanın paylaşım kayıtlarını sorgulama. Bir çalışmanın paylaşıldığı nesnelerin listesini sorgular ve yalnızca geçerlilik süresi içinde olan paylaşım yapılandırmalarını döndürür.
QuerySharesToUserList QuerySharesToUserList. Bir kullanıcıya yetkilendirilen çalışmaların listesini sorgular.
QuerySmartqPermissionByCubeId Belirli bir Akıllı Soru-Cevap veri kümesi için kullanıcı iznini kontrol etme. Bir kullanıcının Akıllı Soru-Cevap veri kümesi üzerindeki izinlerini sorgular.
QueryTicketInfo QueryTicketInfo. Gömülü olmayan bir rapor için belirtilen bir biletin ayrıntılarını alır.
QueryUserByMobileAccount Bağlı üçüncü taraf hesap kimliğine göre kullanıcı kimliği sorgulama. Bağlı üçüncü taraf hesap kimliğine göre bir kullanıcı kimliğini sorgular.
QueryUserGroupListByParentId QueryUserGroupListByParentId. Belirtilen bir üst kullanıcı grubu altındaki alt kullanıcı gruplarının bilgilerini sorgular.
QueryUserGroupMember Kullanıcı grubu üye listesi sorgulama. Bir kullanıcı grubundaki üyelerin listesini getirir.
QueryUserInfoByAccount Hesaba göre kullanıcı bilgilerini sorgulama. Alibaba Cloud kimliği veya Alibaba Cloud hesap adıyla kullanıcı bilgilerini sorgular.
QueryUserInfoByUserId Kullanıcı kimliğine göre kullanıcı bilgilerini sorgulama. Kullanıcı kimliğine göre kullanıcı bilgilerini sorgular.
QueryUserList Kuruluş üye listesini sorgular. Kuruluş üyelerinin listesini sorgular.
QueryUserRoleInfoInWorkspace Çalışma Alanı Üyelerinin Önceden Ayarlanmış Rollerini Sorgulama. Belirtilen bir çalışma alanı üyesi için önceden ayarlanmış çalışma alanı rolü bilgilerini getirir.
QueryUserTagMetaList QueryUserTagMetaList. Bir kuruluştaki üye etiketlerinin meta veri listesini sorgular.
QueryUserTagValueList QueryUserTagValueList. Belirli kullanıcı etiketi değerlerinin listesini sorgular.
QueryWorks Veri çalışması bilgilerini sorgulama. Belirtilen bir veri çalışmasının bilgilerini sorgular.
QueryWorksBloodRelationship QueryWorksBloodRelationship. Bir veri çalışmasının, her bileşen tarafından başvurulan veri kümeleri ve sorgu alanı bilgileri dahil olmak üzere soy ağacı bilgilerini alır. Şu anda desteklenen veri çalışmaları yalnızca panoları, çalışma kitaplarını ve self-servis veri alma işlemlerini içerir.
QueryWorksByOrganization Bir kuruluştaki tüm çalışmaları sorgular. Bir kuruluştaki tüm çalışmaları sorgular. Çalışma türünü belirtebilirsiniz.
QueryWorksByWorkspace QueryWorksByWorkspace. Bir kuruluş altındaki çalışma alanında yer alan tüm çalışmaları sorgular. Çalışma türünü belirtebilirsiniz.
QueryWorkspaceRoleConfig QueryWorkspaceRoleConfig. Belirtilen bir çalışma alanı rolü için yapılandırma bilgilerini getirir.
QueryWorkspaceUserList Bir Çalışma Alanı Altındaki Üyeleri Listeleme. Belirtilen bir çalışma alanı altındaki üyelerin listesini sorgular.
ResultCallback ResultCallback. Quick BI onay süreçlerini işlemek için onay süreçlerine yönelik geri çağırma arayüzünü özelleştirir.
SaveFavorites Çalışmayı Favorilere Ekle. Bir çalışmayı kullanıcının favorilerine ekler.
SetDataLevelPermissionExtraConfig SetDataLevelPermissionExtraConfig Satır ve sütun izinleri için ek yapılandırmayı ayarlar.
SetDataLevelPermissionRuleConfig Tek Veri Kümesi Satır ve Sütun İzin Yapılandırma Bilgilerini Ayarlama. Tek bir veri kümesinin satır ve sütun izin yapılandırma bilgilerini ayarlar (ekleme ve güncelleme).
SetDataLevelPermissionWhiteList SetDataLevelPermissionWhiteList. Belirtilen satır düzeyi izinleri için beyaz listeyi ayarlar.
SmartqAuthorize Akıllı Soru-Cevap Yetkilendirmelerinin Toplu Yönetimi. Akıllı Soru-Cevap yetkilendirmelerini toplu olarak yönetir.
SmartqAuthTransfer Belirtilen bir kullanıcının kota izinlerini diğer kullanıcılara senkronize etme. Belirtilen bir kullanıcının kota izinlerini diğer kullanıcılara senkronize eder.
SmartqQueryAbility Akıllı Soru-Cevap sorgusu. Akıllı Soru-Cevap özelliğini kullanarak veri sorgular.
TransferUsergroup Kullanıcı grubu taşıma. Bir kullanıcı grubunu taşır.
UpdateAuthorizationAttributes Kaynak işbirlikçi yetkilendirmesinin izin özniteliklerini değiştirme. Kaynak işbirlikçi yetkilendirmesinin izin özniteliklerini değiştirir.
UpdateCubeBySql Özel bir SQL veri kümesini güncelleme. Özel bir SQL veri kümesini günceller.
UpdateDataLevelPermissionStatus UpdateDataLevelPermissionStatus. Bir veri kümesi için satır düzeyi ve sütun düzeyi izin durumunu günceller.
UpdateDataSource UpdateDataSource. Bir veri kaynağı yapılandırmasını değiştirir.
UpdateEmbeddedStatus UpdateEmbeddedStatus. Bir raporun gömme durumunu değiştirir, gömme özelliğini etkinleştirir veya devre dışı bırakır.
UpdateTicketNum UpdateTicketNum. Muafiyet gömülü raporu için kullanılan belirtilen biletin miktarını günceller.
UpdateUser Kuruluş üyesi bilgilerini güncelleme. Bir kuruluştaki belirtilen bir üyenin bilgilerini günceller.
UpdateUserGroup UpdateUserGroup. Bir kuruluştaki belirtilen bir kullanıcı grubunun bilgilerini günceller.
UpdateUserTagMeta UpdateUserTagMeta. Kuruluş üyesi etiketlerinin meta verilerini günceller.
UpdateUserTagValue Update Organization Member Tag Value Update the tag value of an organization member.
UpdateWorkspaceUserRole Çalışma alanı üyesi rolünü değiştirme. Belirtilen bir üyenin çalışma alanındaki rolünü değiştirir. Mevcut rolün üzerine yazılır.
UpdateWorkspaceUsersRole Çalışma alanı üyelerinin rollerini toplu olarak güncelleme. Çalışma alanı üyelerinin rollerini toplu olarak günceller. Mevcut rollerin üzerine yazılır.
WithdrawAllUserGroups WithdrawAllUserGroups. Kullanıcıyı tüm kullanıcı gruplarından çıkarır. Bu işlem geri alınamaz. Bu işlemi gerçekleştirirken dikkatli olun.