API 標準および多言語対応の SDK
本製品 (quickbi-public/2022-01-01) の API は、RPC 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。
カスタム署名
署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。
はじめに
Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。
API セキュリティを確保するには、以下を作成し、設定する必要があります。
RAM ユーザー
RAM ユーザー用の AccessKey ペア
組織管理
|
API |
タイトル |
説明 |
| 組織ユーザー管理 | 組織ユーザー管理 | |
| DeleteUser | DeleteUser | 指定された組織ユーザーを削除します。 |
| CheckOrganizationMember | CheckOrganizationMember | ユーザーが組織のメンバーであるかどうかを確認します。 |
| AddUser | AddUser | 組織メンバーの追加 |
| BatchAddFeishuUsers | Lark ユーザーをバッチ追加します。 | Lark ユーザーをバッチで追加します。 |
| UpdateUser | 組織メンバー情報の更新。 | 組織内の指定されたメンバーの情報を更新します。 |
| QueryUserList | 組織メンバーリストの照会。 | 組織メンバーのリストを照会します。 |
| QueryUserInfoByUserId | ユーザー ID に基づいてユーザー情報を照会します。 | ユーザー ID に基づいてユーザー情報を照会します。 |
| QueryUserInfoByAccount | アカウントによるユーザー情報の照会。 | Alibaba Cloud ID または Alibaba Cloud アカウント名でユーザー情報を照会します。 |
| QueryUserByMobileAccount | バインドされたサードパーティアカウント ID で userId をクエリします。 | バインドされたサードパーティアカウント ID で UserId をクエリします。 |
| 組織ユーザーグループ管理 | 組織ユーザーグループ管理 | |
| UpdateUserGroup | UpdateUserGroup | 組織内の指定されたユーザーグループの情報を更新します。 |
| DeleteUserGroup | DeleteUserGroup | 組織内のユーザーグループを削除します。 |
| CreateUserGroup | CreateUserGroup | ユーザーグループを作成します。親ユーザーグループを指定できます。 |
| AddUserGroupMember | AddUserGroupMember | 指定されたユーザーグループに組織メンバーを追加します。 |
| AddUserGroupMembers | AddUserGroupMembers | 指定されたユーザーグループに一度にユーザーを追加します。 |
| DeleteUserGroupMember | DeleteUserGroupMember | 指定されたユーザーグループから指定されたメンバーを削除します。 |
| DeleteUserGroupMembers | DeleteUserGroupMembers | 指定されたユーザーをユーザーグループから一括で削除します。 |
| WithdrawAllUserGroups | WithdrawAllUserGroups | ユーザーをすべてのユーザーグループから退出させます。このプロセスは元に戻せません。この操作を実行する際は注意が必要です。 |
| GetUserGroupInfo | Get User Group Information by Keyword | ユーザーグループ名のキーワードに基づいてユーザーグループ情報を検索します。 |
| ListByUserGroupId | ListByUserGroupId | ユーザーグループ ID に基づいて、ユーザーグループ情報を一度にクエリします。 |
| ListUserGroupsByUserId | ListUserGroupsByUserId | ユーザー ID に基づいて、ユーザーが所属するすべてのユーザーグループを照会します。 |
| QueryUserGroupListByParentId | QueryUserGroupListByParentId | この操作を呼び出して、指定された親ユーザーグループ配下の子ユーザーグループの情報を取得できます。 |
| QueryUserGroupMember | Query User Group Member List | ユーザーグループ配下のメンバーリストを取得します。 |
| TransferUsergroup | ユーザーグループを移行します。 | ユーザーグループを移行します。 |
| ユーザータグ管理 | ユーザータグ管理 | |
| AddUserTagMeta | Add Organization Member Tag Metadata | 組織メンバーのタグメタデータを追加します。 |
| DeleteUserTagMeta | DeleteUserTagMeta | 組織メンバーのタグメタデータを削除します。 |
| UpdateUserTagValue | Update Organization Member Tag Value | 組織メンバーのタグ値を更新します。 |
| QueryUserTagMetaList | QueryUserTagMetaList | 組織内のメンバータグのメタデータリストを照会します。 |
| QueryUserTagValueList | QueryUserTagValueList | 特定のユーザー タグの値のリストを照会します。 |
| UpdateUserTagMeta | UpdateUserTagMeta | 組織メンバーのタグのメタデータを更新します。 |
| ListDynamicTag | 現在の組織の動的ラベルリストを取得します。 | 現在の組織の動的ラベルリストを取得します。 |
| ClearDynamicTagCache | 指定された動的タグのキャッシュを削除します。 | 単一の構成のキャッシュされたタグ値を削除します。 |
| ロール管理 | ロール管理 | |
| ListWorkspaceUserRolesByUserId | ListWorkspaceUserRolesByUserId | ユーザーのすべてのワークスペースロールを照会します。 |
| ListWorkspaceRoleUsers | ListWorkspaceRoleUsers | 指定されたワークスペースロール配下のユーザーリストを取得します。 |
| QueryWorkspaceRoleConfig | QueryWorkspaceRoleConfig | 指定されたワークスペースロールの構成情報を取得します。 |
| QueryOrganizationRoleConfig | QueryOrganizationRoleConfig | 指定された組織ロールの構成を取得します。 |
| ListWorkspaceRoles | ListWorkspaceRoles | ワークスペースのロールリストを取得します。 |
| ListOrganizationRoles | Get Organization Role List | 組織レベルのカスタムロールのリストを取得します。 |
| ListOrganizationRoleUsers | ListOrganizationRoleUsers | 指定された組織ロール配下のユーザーリストを取得します。 |
権限管理
|
API |
タイトル |
説明 |
| アクセス制御管理 | アクセス制御管理 | |
| IpWhiteListConfig | データセキュリティの IP ホワイトリストを設定します。 | データセキュリティの IP ホワイトリストを設定します。 |
| レポート共有認可管理 | レポート共有認可管理 | |
| AddShareReport | Add data work sharing configuration | データワークの共有設定を追加します。 |
| CancelReportShare | CancelReportShare | データ作業の共有権限を削除します。 |
| QuerySharesToUserList | QuerySharesToUserList | この操作を呼び出して、ユーザーに権限が付与された作業のリストを照会できます。 |
| QueryShareList | Query the Sharing Records of a Work | 作品が共有されているオブジェクトのリストを照会し、有効期間内の共有設定のみを返します。 |
| AddWorksAuthorization | AddWorksAuthorization | 作業に権限を付与します。 |
| DeleteAuthorizationByUserId | 指定されたユーザーの共同権限付与 Record を削除します。 | 指定されたユーザーの共同権限付与 Record を削除します。 |
| データポータルメニュー認可管理 | データポータルメニュー認可管理 | |
| AuthorizeMenu | AuthorizeMenu | BI ポータルメニューの一括権限付与は自動的にスキップされます。 |
| CancelAuthorizationMenu | Batch Cancel Data Portal Menu Authorization | ポータルメニュー ID に基づき、指定したユーザーおよびユーザーグループの権限を取り消します。 |
| ChangeVisibilityModel | ChangeVisibilityModel | BI ポータルのメニューの表示モードと、メニューに権限を持つユーザーのみが表示できるかどうかを変更します。 |
| ListPortalMenus | ListPortalMenus | 指定された BI ポータルの配下にあるメニューの階層リストを取得します。 |
| ListPortalMenuAuthorization | ListPortalMenuAuthorization | BI ポータルのメニューの権限付与の詳細リストを取得します。 |
| ListWhitePortalMenu | ListWhitePortalMenu | BI ポータルのメニューのホワイトリストを取得します。 |
| 行レベル権限管理 | 行レベル権限管理 | |
| SetDataLevelPermissionRuleConfig | Set Single Dataset Row and Column Permission Configuration Information | 単一データセットの行と列の権限構成情報 (追加および更新) を設定します。 |
| AddDataLevelPermissionRuleUsers | AddDataLevelPermissionRuleUsers | 指定されたユーザーとユーザーグループを行レベルの権限ルールに追加します。 |
| AddDataLevelPermissionWhiteList | AddDataLevelPermissionWhiteList | 指定されたデータセットの行レベルおよび列レベルの権限のホワイトリストを変更します。 |
| DeleteDataLevelRuleConfig | DeleteDataLevelRuleConfig | 行レベルの権限ルールを削除します。 |
| DeleteDataLevelPermissionRuleUsers | DeleteDataLevelPermissionRuleUsers | 行レベルの権限ルールから指定されたユーザーを削除します。 |
| UpdateDataLevelPermissionStatus | UpdateDataLevelPermissionStatus | データセットの行レベルおよび列レベルの権限ステータスを更新します。 |
| SetDataLevelPermissionExtraConfig | SetDataLevelPermissionExtraConfig | 行と列の権限に関する追加構成を設定します。 |
| SetDataLevelPermissionWhiteList | SetDataLevelPermissionWhiteList | 指定された行レベルの権限のホワイトリストを設定します。 |
| QueryDatasetSwitchInfo | QueryDatasetSwitchInfo | 指定されたデータセットの行レベルの権限スイッチのステータスを取得します。 |
| ListCubeDataLevelPermissionConfig | ListCubeDataLevelPermissionConfig | この操作を呼び出して、指定されたデータセットの行および列の権限設定のリストを取得できます。 |
| ListDataLevelPermissionWhiteList | Get Dataset Row and Column Permission Whitelist | 権限の種類に基づいて、データセットの行および列の権限のホワイトリストを取得します。 |
| 公開承認 | 公開承認 | |
| QueryApprovalInfo | QueryApprovalInfo | 承認者に基づいて承認フロー情報を取得します。 |
| ResultCallback | ResultCallback | 承認プロセスのコールバックインターフェイスをカスタマイズして、Quick BI の承認プロセスを処理できます。 |
リソース管理
|
API |
タイトル |
説明 |
| レポートリソース管理 | レポートリソース管理 | |
| UpdateEmbeddedStatus | UpdateEmbeddedStatus | レポートの埋め込みステータスを変更し、埋め込みを有効または無効にします。 |
| QueryWorksByOrganization | Query All Works Under the Organization | 組織全体のすべての作業をクエリします。作業のタイプを指定することもできます。 |
| QueryWorksByWorkspace | QueryWorksByWorkspace | 組織配下のワークスペース内のすべての作業を照会します。作業のタイプを指定できます。 |
| QueryReadableResourcesListByUserIdV2 | Query List of Works User Has Permission to View (New) | ユーザーが表示権限を持つ作業のリストを照会します。 |
| QueryReadableResourcesListByUserId | QueryReadableResourcesListByUserId | ユーザーが表示権限を持つ作品のリストを照会します。これには、スペース内で共有が許可されているレポートも含まれます。 |
| CheckReadable | CheckReadable | ユーザーがダッシュボードやワークブックなどのデータ作品を閲覧する権限を持っているかどうかを照会します。 |
| QueryEmbeddedInfo | QueryEmbeddedInfo | 組織内の埋め込み構成 (埋め込みの最大数や埋め込み数など) を取得します。 |
| QueryEmbeddedStatus | QueryEmbeddedStatus | レポートの埋め込みステータスを照会します。 |
| QueryWorks | データ作業情報の照会。 | 指定されたデータ作業の情報を照会します。 |
| QueryWorksBloodRelationship | QueryWorksBloodRelationship | データワークの血縁関係を取得します。これには、各コンポーネントが参照するデータセットやクエリフィールド情報が含まれます。現在、サポートされているデータワークは、ダッシュボード、ワークブック、セルフサービスデータ取得のみです。 |
| QueryComponentPerformance | QueryComponentPerformance | コンポーネントのパフォーマンスログを照会します。 |
| QueryReportPerformance | QueryReportPerformance | レポートのパフォーマンスログをクエリします。 |
| GetWorksEmbedList | Get Embedded Reports | 埋め込みレポートのリストを照会します。 |
| データセットリソース管理 | データセットリソース管理 | |
| UpdateDataSource | UpdateDataSource | データソースの構成を変更します。 |
| CreateDataset | CreateDataset | 物理テーブルからデータセットを作成します。 |
| CheckDatasetExisted | CheckDatasetExisted | 指定された CubeId を持つデータセットが存在するかどうかを確認します。 |
| CreateCubeBySql | カスタム SQL に基づいてデータセットを作成します。 | カスタム SQL ステートメントに基づいてデータセットを作成します。 |
| AddDataSource | AddDataSource | データソースを追加します。 |
| UpdateCubeBySql | カスタム SQL データセットを更新します。 | カスタム SQL データセットを更新します。 |
| QueryLastAccelerationEngineJob | QueryLastAccelerationEngineJob | データセット ID に基づいて最新の加速タスクを照会します。 |
| ListDataSource | ListDataSource | 指定されたワークスペース配下のすべてのデータソースを照会します。 |
| DataSetBlood | DataSetBlood | 指定されたデータセット配下にある作品の情報を照会します。 |
| DataSourceBlood | Query dataset information under the specified data source | 指定されたデータソース配下のデータセット情報を照会します。 |
| ModifyApiDatasourceParameters | ModifyApiDatasourceParameters | 指定された API データソースの構成を変更します。 |
| ListApiDatasource | ListApiDatasource | API データソースをクエリします。 |
| QueryDatasetInfo | QueryDatasetInfo | テーブルがカスタム SQL テーブルであるかどうかを示します。 有効な値は次のとおりです。 \\\\* true：カスタム SQL テーブル \\\\* false：カスタム SQL テーブル以外 |
| QueryDatasetDetailInfo | QueryDatasetDetailInfo | 指定されたデータセットの詳細 (データソース、ディレクトリ、データセットモデルなど) を取得します。 |
| QueryDatasetList | QueryDatasetList | 指定されたワークスペース内のデータセットを照会します。結果は作成時間の降順でソートされます。 |
| AllotDatasetAccelerationTask | AllotDatasetAccelerationTask | データセットに対して Quick エンジンのコレクション加速をトリガーします。 |
| QueryCubePerformance | QueryCubePerformance | データセットのパフォーマンスログをクエリします。 |
| QueryCubeOptimization | QueryCubeOptimization | データセットの最適化に関する提案をクエリします。 |
| GetDataSourceConnectionInfo | GetDataSourceConnectionInfo | データソース情報を取得 |
| ListAccelerationOfWorkspace | ListAccelerationOfWorkspace | ワークスペース内のアクセラレーションタスクに関する情報を取得します。 |
| QueryAccelerationLogByCubeId | QueryAccelerationLogByCubeId | 指定されたデータセットのアクセラレーションタスクの実行ログを照会します。 |
| ワークスペース管理 | ワークスペース管理 | |
| CreateWorkspace | CreateWorkspace | ワークスペースを作成します。 |
| AddUserToWorkspace | Add Member to Workspace | 指定されたワークスペースにメンバーを追加します。 |
| AddWorkspaceUsers | Batch Add Members to Workspace | ワークスペースにメンバーをバッチで追加します。 |
| DeleteUserFromWorkspace | Remove Workspace Member | 指定されたワークスペースからメンバーを削除します。 |
| UpdateWorkspaceUsersRole | Batch Update Workspace Member Roles | ワークスペースメンバーのロール情報を一括で更新します。既存のロールは上書きされます。 |
| UpdateWorkspaceUserRole | Modify Workspace Member Role | ワークスペース配下の指定されたメンバーのロールを変更します。既存のロールは上書きされます。 |
| QueryWorkspaceUserList | List Members Under a Workspace | 指定されたワークスペース配下のメンバーのリストを照会します。 |
| QueryOrganizationWorkspaceList | 組織内のワークスペースリストを取得します。 | 現在の組織内のワークスペースのリストを取得します。 |
| QueryUserRoleInfoInWorkspace | Query Preset Roles of Workspace Members | 指定されたワークスペースメンバーのプリセットワークスペースロール情報を取得します。 |
| お気に入り管理 | お気に入り管理 | |
| SaveFavorites | Add Work to Favorites | ユーザーのお気に入りの作業を追加します |
| CancelCollection | CancelCollection | ユーザーのコレクションから作品のお気に入り登録を解除します。 |
| ホームページ管理 | ホームページ管理 | |
| ListCollections | ListCollections | ユーザーがお気に入りに追加したワークのリストを取得します。 |
| ListFavoriteReports | Favorite Reports List on Home Dashboard | 概要 |
| ListRecentViewReports | ListRecentViewReports | この操作を呼び出すことで、指定されたユーザーのホームページダッシュボードに表示される、最も頻繁に閲覧された項目と閲覧履歴のリストを取得できます。 |
| ListSharedReports | ListSharedReports | この操作を呼び出すことで、指定されたユーザーのホームページに表示される、権限のある作品のリストを取得できます。 |
| サブスクリプション管理 | サブスクリプション管理 | |
| ManualRunMailTask | ManualRunMailTask | メールタスクの手動実行 |
| GetMailTaskStatus | GetMailTaskStatus | 組織内のメールタスクの実行ステータスを確認します。 |
| GetMailTaskList | GetMailTaskList | 追跡タスクのリストを取得します。注：呼び出し元の AccessKey (AK) に他のユーザーの追跡タスクを閲覧する権限がない場合、この操作は呼び出し元がアクセスを許可されているタスクのみを返します。 |
データ管理
|
API |
タイトル |
説明 |
| データサービス | データサービス | |
| QueryData | QueryData | DataService Studio で作成した API を呼び出します。 |
| QueryDataServiceList | QueryDataServiceList | データサービス API のリストを照会します。 |
| QueryDataService | Invoke Data Service API | データサービスで既に作成された API を呼び出します。 |
埋め込み分析
|
API |
タイトル |
説明 |
| レポート埋め込み | レポート埋め込み | |
| CreateTicket | 埋め込みレポートチケットを生成します。 | 埋め込みレポートアクセスに必須のチケットを生成します。 |
| DeleteTicket | Delete Embedded Ticket | サードパーティの埋め込みチケットを削除します。 |
| DelayTicketExpireTime | DelayTicketExpireTime | レポートに埋め込まれたチケットの有効期限を更新します。 |
| UpdateTicketNum | UpdateTicketNum | 認証フリーの埋め込みレポートで使用される、指定されたチケットの数を更新します。 |
| QueryTicketInfo | QueryTicketInfo | レポートに埋め込まれていない、指定されたチケットの詳細を取得します。 |
統計分析
|
API |
タイトル |
説明 |
| リソース分析 | リソース分析 | |
| QueryAuditLog | Query Audit Log Information | 監査ログ情報をクエリします。 |
AI チャット
|
API |
タイトル |
説明 |
| AI チャット埋め込み | AI チャット埋め込み | |
| CreateTicket4Copilot | Generate Smart Q Embedding Ticket | Copilot を埋め込むためのチケットを生成します。 |
| ModifyCopilotEmbedConfig | Modify Intelligent Query Embedding Configuration | インテリジェントクエリの埋め込み設定を変更します。 |
| QueryCopilotEmbedConfig | Get the List of Configurations for Activating XiaoQ Embedding | XiaoQ 埋め込みを有効化するための構成リストを取得します |
| QueryDataRange | Get Data Range Catalog List | データ範囲のカタログリストを取得します。 |
| AI チャット管理 | AI チャット管理 | |
| ModifyDashboardNl2sqlStatus | ModifyDashboardNl2sqlStatus | 複数のダッシュボードの Q-Assistant ステータスを変更します。 |
| QueryDashboardNl2sql | QueryDashboardNl2sql | ダッシュボードの質問リソース情報を照会します。 |
| SmartqAuthorize | Batch Management of Smart Q\\\\\\&A Authorizations | インテリジェント Q&A の権限を一括で管理します。 |
| QueryLlmCubeWithThemeListByUserId | Check which datasets and analysis themes the user has question authorization for | ユーザーが質問権限を持つデータセットと分析テーマを確認します。 |
| SmartqAuthTransfer | Synchronize the question count permissions of a specified user to other users | 指定されたユーザーの質問数の権限を他のユーザーに同期します。 |
| QuerySmartqPermissionByCubeId | Check if a user has permission for a specific smart question dataset | スマート Q&A データセットに対するユーザーの権限を照会します。 |
| QueryDatasetSmartqStatus | Check if the Dataset has Enabled Smart Query | データセットでインテリジェント Q&A が有効になっているかどうかを確認します。 |
| SmartqQueryAbility | スマート Q&A クエリ | スマート Q&A 機能を使用してデータのクエリを実行します。 |