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 |
タイトル |
説明 |
| 組織のユーザー管理 | 組織のユーザー管理 | |
| CheckOrganizationMember | CheckOrganizationMember | ユーザーが組織のメンバーであるかどうかを確認します。 |
| AddUser | 組織メンバーの追加 | 組織にメンバーを 1 人追加します。 |
| BatchAddFeishuUsers | Feishu ユーザーの一括追加 | Feishu ユーザーを一括で追加します。 |
| UpdateUser | UpdateUser | 組織内の特定のメンバーの情報を更新します。 |
| QueryUserList | QueryUserList | 組織のメンバーを一覧表示します。 |
| QueryUserInfoByUserId | QueryUserInfoByUserId | ユーザー ID でユーザー情報を照会します。 |
| QueryUserInfoByAccount | QueryUserInfoByAccount | Alibaba Cloud ID または Alibaba Cloud アカウント名でユーザー情報を照会します。 |
| ロール管理 | ロール管理 | |
| ListWorkspaceUserRolesByUserId | ListWorkspaceUserRolesByUserId | ユーザーのすべてのワークスペースのロールを照会します。 |
| ListOrganizationRoles | 組織のロールリストの取得 | 組織レベルでカスタムロールのリストを取得します。 |
権限管理
|
API |
タイトル |
説明 |
| レポート共有の権限付与管理 | レポート共有の権限付与管理 | |
| AddWorksAuthorization | AddWorksAuthorization | ワークに権限を追加します。 |
| データポータルメニューの権限付与管理 | データポータルメニューの権限付与管理 | |
| ListPortalMenuAuthorization | ListPortalMenuAuthorization | BI ポータル内のメニューの権限詳細リストを取得します。 |
| ListWhitePortalMenu | ListWhitePortalMenu | BI ポータルメニューのホワイトリストを取得します。 |
| 行レベルの権限管理 | 行レベルの権限管理 | |
| SetDataLevelPermissionRuleConfig | 単一データセットの行および列の権限設定 | 単一データセットの行および列の権限を設定します (追加および更新)。 |
| AddDataLevelPermissionRuleUsers | AddDataLevelPermissionRuleUsers | 指定されたユーザーおよびユーザーグループを行レベルの権限ルールに追加します。 |
| AddDataLevelPermissionWhiteList | AddDataLevelPermissionWhiteList | 指定されたデータセットの行レベルおよび列レベルの権限のホワイトリストを変更します。 |
| DeleteDataLevelRuleConfig | DeleteDataLevelRuleConfig | 行レベルの権限ルールを削除します。 |
| DeleteDataLevelPermissionRuleUsers | DeleteDataLevelPermissionRuleUsers | 行レベルの権限ルールから指定されたユーザーおよびユーザーグループを削除します。 |
| UpdateDataLevelPermissionStatus | UpdateDataLevelPermissionStatus | データセットの行レベルおよび列レベルの権限ステータスを更新します。 |
| SetDataLevelPermissionExtraConfig | SetDataLevelPermissionExtraConfig | 行および列の権限の追加設定を行います。 |
| QueryDatasetSwitchInfo | QueryDatasetSwitchInfo | 指定されたデータセットの行レベル権限のスイッチステータスを取得します。 |
リソース管理
|
API |
タイトル |
説明 |
| レポートリソース管理 | レポートリソース管理 | |
| UpdateEmbeddedStatus | UpdateEmbeddedStatus | レポートの埋め込みステータスを変更し、埋め込みを有効または無効にします。 |
| QueryWorksByOrganization | 組織配下のすべてのワークの照会 | 組織全体のすべてのワークを照会します。ワークの種類を指定するオプションも利用できます。 |
| QueryReadableResourcesListByUserIdV2 | ユーザーが閲覧権限を持つワークのリストの照会 (新) | ユーザーが閲覧権限を持つワークのリストを照会します (新)。 |
| QueryEmbeddedStatus | QueryEmbeddedStatus | レポートで埋め込みが有効になっているかどうかを照会します。 |
| データセットリソース管理 | データセットリソース管理 | |
| UpdateDataSource | UpdateDataSource | データソースの設定を変更します。 |
| CreateDataset | CreateDataset | 物理テーブルからデータセットを作成します。 |
| CheckDatasetExisted | CheckDatasetExisted | 指定した CubeId を持つデータセットが存在するかどうかを確認します。 |
| CreateCubeBySql | CreateCubeBySql | カスタム SQL ステートメントからデータセットを作成します。 |
| AddDataSource | AddDataSource | データソースを追加します。 |
| UpdateCubeBySql | UpdateCubeBySql | カスタム SQL ステートメントに基づくデータセットを更新します。 |
| QueryLastAccelerationEngineJob | QueryLastAccelerationEngineJob | データセット ID に基づいて最新のアクセラレーションタスクを照会します。 |
| QueryDatasetInfo | QueryDatasetInfo |
テーブルがカスタム SQL テーブルかどうかを示します。有効な値： * true：カスタム SQL テーブル * false：非カスタム SQL テーブル |
| QueryDatasetDetailInfo | QueryDatasetDetailInfo | 指定したデータセットの詳細を取得します。詳細には、データソース、ディレクトリ、データセットモデルが含まれます。 |
| QueryDatasetList | QueryDatasetList | 指定したワークスペース内のデータセットを照会します。結果は作成時刻の降順でソートされます。 |
| ListAccelerationOfWorkspace | ListAccelerationOfWorkspace | ワークスペース内のアクセラレーションタスクに関する情報を取得します。 |
| QueryAccelerationLogByCubeId | QueryAccelerationLogByCubeId | 指定したデータセットのアクセラレーションタスクの実行ログを照会します。 |
| ワークスペース管理 | ワークスペース管理 | |
| CreateWorkspace | CreateWorkspace | ワークスペースを作成します。 |
| AddUserToWorkspace | ワークスペースへのメンバーの追加 | 指定したワークスペースにメンバーを追加します。 |
| QueryOrganizationWorkspaceList | 組織配下のワークスペースリストの取得 | 現在の組織内のワークスペースを一覧表示します。 |
| ホームページ管理 | ホームページ管理 | |
| ListCollections | ListCollections | ユーザーがお気に入りにしたワークのコレクションを取得します。 |
| サブスクリプション管理 | サブスクリプション管理 | |
| GetMailTaskList | GetMailTaskList | 追跡タスクのリストを取得します。注：呼び出し元の AccessKey (AK) に他のユーザーの追跡タスクを閲覧する権限がない場合、この操作では、呼び出し元がアクセスを許可されているタスクのみが返されます。 |
データ管理
|
API |
タイトル |
説明 |
| データサービス | データサービス | |
| QueryData | QueryData | DataService Studio API を呼び出してデータをクエリします。 |
| QueryDataService | データサービス API のクエリ | データサービスで作成された API を呼び出し、データをクエリします。 |
埋め込み分析
|
API |
タイトル |
説明 |
| レポートの埋め込み | レポートの埋め込み | |
| CreateTicket | レポート埋め込みチケットの生成 | サードパーティ埋め込み用のチケットを生成します。 |
| DeleteTicket | 埋め込みチケットの削除 | サードパーティ埋め込みチケットを削除します。 |
| DelayTicketExpireTime | DelayTicketExpireTime | レポートに埋め込まれたチケットの有効期限を更新します。 |
| UpdateTicketNum | UpdateTicketNum | 免除埋め込みレポート用の、指定されたチケットのチケット数を更新します。 |
| QueryTicketInfo | QueryTicketInfo | 免除埋め込みレポート用の、指定されたチケットの詳細を取得します。 |
統計分析
|
API |
タイトル |
説明 |
| リソース分析 | リソース分析 | |
| QueryAuditLog | 監査ログ情報の照会 | 監査ログ情報を照会します。 |
SmartQ
|
API |
タイトル |
説明 |
| SmartQ 埋め込み | SmartQ 埋め込み | |
| CreateTicket4Copilot | SmartQ 埋め込みチケットの生成 | Copilot を埋め込むためのチケットを生成します。 |
| SmartQ 管理 | SmartQ 管理 | |
| ModifyDashboardNl2sqlStatus | ModifyDashboardNl2sqlStatus | 複数のダッシュボードの Q-Assistant ステータスを変更します。 |
| QueryDashboardNl2sql | QueryDashboardNl2sql | ダッシュボードの質問リソース情報を照会します。 |
| SmartqAuthorize | スマートクエリ権限の一括管理 | スマートクエリの権限を一括で管理します。 |
| QueryLlmCubeWithThemeListByUserId | ユーザーが質問権限を持つデータセットと分析テーマの確認 | ユーザーが質問権限を持つデータセットと分析テーマを確認します。 |
| QuerySmartqPermissionByCubeId | ユーザーが特定のスマートクエリデータセットに対する権限を持っているかどうかの確認 | スマートクエリデータセットに対するユーザーの権限を照会します。 |
| QueryDatasetSmartqStatus | データセットでスマートクエリが有効になっているかどうかの確認 | データセットでスマートクエリが有効になっているかどうかを確認します。 |
| SmartqQueryAbility | スマートクエリ | スマートクエリを実行します。 |
その他
|
API |
タイトル |
説明 |
| AddShareReport | データワークの共有設定の追加 | データワークの共有設定を追加します。 |
| AddUserGroupMember | ユーザーグループへの組織メンバーの追加 | 指定されたユーザーグループに組織メンバーを追加します。 |
| AddUserGroupMembers | ユーザーグループへのユーザーの一括追加 | 指定されたユーザーグループにユーザーを一括で追加します。 |
| AddUserTagMeta | 組織メンバーのタグメタデータの追加 | 組織メンバーのタグメタデータを追加します。 |
| AddWorkspaceUsers | ワークスペースへのメンバーの一括追加 | ワークスペースにメンバーを一括で追加します。 |
| AllotDatasetAccelerationTask | データセット高速化タスクの割り当て | データセットに対して Quick エンジンによる収集の高速化をトリガーします。 |
| AuthorizeMenu | BI ポータルメニュー権限付与のスキップ | BI ポータルのメニューの一括権限付与は自動的にスキップされます。 |
| CancelAuthorizationMenu | BI ポータルメニュー権限付与の一括キャンセル | ポータルメニュー ID に基づき、指定されたユーザーおよびユーザーグループの権限を取り消します。 |
| CancelCollection | データワークのお気に入り登録の解除 | ユーザーのお気に入りからデータワークを削除します。 |
| CancelReportShare | データワークの共有のキャンセル | データワークの共有設定を削除します。 |
| ChangeVisibilityModel | BI ポータルメニューの可視性モードの変更 | BI ポータルメニューの可視性モードと、メニューを権限を持つユーザーにのみ表示するかどうかを設定します。 |
| CheckReadable | データワークの閲覧権限の確認 | ユーザーがダッシュボードやワークブックなどのデータワークを閲覧する権限を持っているかどうかを照会します。 |
| CreateUserGroup | ユーザーグループの作成 | ユーザーグループを作成します。親ユーザーグループを指定できます。 |
| DataSetBlood | データセット配下のデータワーク情報の照会 | 指定されたデータセット配下のデータワーク情報を照会します。 |
| DataSourceBlood | 指定されたデータソース配下のデータセット情報の照会 | 指定されたデータソース配下のデータセット情報を照会します。 |
| DeleteUser | 組織ユーザーの削除 | 指定された組織ユーザーを削除します。 |
| DeleteUserFromWorkspace | ワークスペースメンバーの削除 | 指定されたワークスペースからメンバーを削除します。 |
| DeleteUserGroup | ユーザーグループの削除 | 組織内のユーザーグループを削除します。 |
| DeleteUserGroupMember | ユーザーグループからのメンバーの削除 | 指定されたユーザーグループから指定されたメンバーを削除します。 |
| DeleteUserGroupMembers | ユーザーグループからのメンバーの一括削除 | ユーザーグループから指定されたユーザーを一括で削除します。 |
| DeleteUserTagMeta | 組織メンバーのタグメタデータの削除 | 組織メンバーのタグメタデータを削除します。 |
| GetDataSourceConnectionInfo | データソース接続情報の取得 | データソースの接続情報を取得します。 |
| GetMailTaskStatus | メールタスクのステータスの取得 | 組織内のメールタスクの実行ステータスを確認します。 |
| GetUserGroupInfo | キーワードによるユーザーグループ情報の取得 | ユーザーグループ名のキーワードに基づいてユーザーグループ情報を検索します。 |
| GetWorksEmbedList | 埋め込みレポートの取得 | 埋め込みレポートのリストを照会します。 |
| ListApiDatasource | API データソースのリスト表示 | API データソースを照会します。 |
| ListByUserGroupId | ユーザーグループIDによるユーザーグループ情報の一括照会 | ユーザーグループIDによってユーザーグループ情報を一括で照会します。 |
| ListCubeDataLevelPermissionConfig | データセットの行列レベル権限設定のリスト表示 | 指定されたデータセットの行および列の権限設定のリストを取得します。 |
| ListDataLevelPermissionWhiteList | データセットの行および列の権限ホワイトリストの取得 | 権限のタイプに基づいて、データセットの行および列の権限のホワイトリストを取得します。 |
| ListDataSource | データソースのリスト表示 | 指定されたワークスペース配下のすべてのデータソースを照会します。 |
| ListFavoriteReports | ホームダッシュボードのお気に入りレポート一覧 | ユーザーがお気に入り登録したレポートのリストを取得します。 |
| ListOrganizationRoleUsers | 組織ロール配下のユーザーリストの取得 | 指定された組織ロール配下のユーザーリストを取得します。 |
| ListPortalMenus | BI ポータルメニューのリスト表示 | 特定の BI ポータル配下のメニューの階層リストを取得します。 |
| ListRecentViewReports | 最近閲覧したレポートのリスト表示 | 指定されたユーザーのホームページダッシュボードに表示される、最も頻繁に閲覧されたレポートと閲覧履歴のリストを取得します。 |
| ListSharedReports | 共有されたレポートのリスト表示 | 指定されたユーザーのホームページに表示される、権限が付与されたデータワークのリストを取得します。 |
| ListUserGroupsByUserId | ユーザーIDによるユーザーグループのリスト表示 | ユーザーIDに基づいて、ユーザーが所属するすべてのユーザーグループを照会します。 |
| ListWorkspaceRoleUsers | ワークスペースロール配下のユーザーリストの取得 | 指定されたワークスペースロール配下のユーザーリストを取得します。 |
| ListWorkspaceRoles | ワークスペースロールのリスト表示 | ワークスペースロールのリストを取得します。 |
| ManualRunMailTask | メールタスクの手動実行 | メールタスクを手動で実行します。 |
| ModifyApiDatasourceParameters | API データソースパラメーターの変更 | 指定された API データソースの設定を変更します。 |
| ModifyCopilotEmbedConfig | インテリジェントクエリの埋め込み設定の変更 | インテリジェントクエリの埋め込み設定を変更します。 |
| QueryApprovalInfo | 承認情報の照会 | 承認者に基づいて承認フロー情報を取得します。 |
| QueryComponentPerformance | コンポーネントのパフォーマンスログの照会 | コンポーネントのパフォーマンスログを照会します。 |
| QueryCopilotEmbedConfig | インテリジェントクエリの埋め込み設定リストの取得 | インテリジェントクエリの埋め込み設定リストを取得します。 |
| QueryCubeOptimization | データセットの最適化提案の照会 | データセットの最適化に関する提案を照会します。 |
| QueryCubePerformance | データセットのパフォーマンスログの照会 | データセットのパフォーマンスログを照会します。 |
| QueryDataRange | データ範囲カタログリストの取得 | データ範囲カタログリストを取得します。 |
| QueryDataServiceList | データサービス API リストの照会 | データサービス API のリストを照会します。 |
| QueryEmbeddedInfo | 埋め込み情報の照会 | 組織内の埋め込みに関する設定 (埋め込み可能な最大数と現在の数を含む) を取得します。 |
| QueryOrganizationRoleConfig | 組織ロール設定の照会 | 指定された組織ロールの設定を取得します。 |
| QueryReadableResourcesListByUserId | ユーザーが閲覧可能なリソースリストの照会 | スペース内で共有する権限が付与されているデータワークを含め、ユーザーが閲覧権限を持つデータワークのリストを照会します。 |
| QueryReportPerformance | レポートのパフォーマンスログの照会 | レポートのパフォーマンスログを照会します。 |
| QueryShareList | データワークの共有記録の照会 | データワークが共有されているオブジェクトのリストを照会し、有効期間内の共有設定のみを返します。 |
| QuerySharesToUserList | ユーザーへの共有リストの照会 | ユーザーに権限が付与されているデータワークのリストを照会します。 |
| QueryUserGroupListByParentId | 親ユーザーグループIDによる子ユーザーグループリストの照会 | 指定された親ユーザーグループ配下の子ユーザーグループに関する情報を取得します。 |
| QueryUserGroupMember | ユーザーグループメンバーリストの照会 | ユーザーグループ配下のメンバーのリストを取得します。 |
| QueryUserRoleInfoInWorkspace | ワークスペースメンバーのプリセットロールの照会 | 指定されたワークスペースメンバーのプリセットワークスペースロール情報を取得します。 |
| QueryUserTagMetaList | ユーザータグのメタデータリストの照会 | 組織内のメンバータグのメタデータリストを照会します。 |
| QueryUserTagValueList | ユーザータグ値のリストの照会 | 特定のユーザータグ値のリストを照会します。 |
| QueryWorks | データワーク情報の照会 | 指定されたデータワークに関する情報を照会します。 |
| QueryWorksBloodRelationship | データワークの血統の照会 | データワークの血統 (各コンポーネントが参照するデータセットやクエリフィールド情報を含む) を取得します。現在サポートされているデータワークは、ダッシュボード、ワークブック、およびセルフサービスデータ取得のみです。 |
| QueryWorksByWorkspace | ワークスペースによるデータワークの照会 | 組織配下のワークスペース内のすべてのデータワークを照会します。データワークのタイプを指定できます。 |
| QueryWorkspaceRoleConfig | ワークスペースロール設定の照会 | 指定されたワークスペースロールの設定情報を取得します。 |
| QueryWorkspaceUserList | ワークスペース配下のメンバー一覧の照会 | 指定されたワークスペース配下のメンバーのリストを照会します。 |
| ResultCallback | 承認結果のコールバック | コールバックインターフェースをカスタマイズして、Quick BI の承認プロセスの結果を受信できます。 |
| SaveFavorites | データワークをお気に入りに追加 | ユーザーのお気に入りにデータワークを追加します。 |
| SetDataLevelPermissionWhiteList | 行および列の権限のホワイトリスト設定 | 指定された行および列の権限のホワイトリストを設定します。 |
| SmartqAuthTransfer | 指定されたユーザーの質問回数の権限を他のユーザーに同期 | 指定されたユーザーの質問回数の権限を他のユーザーに同期します。 |
| UpdateUserGroup | ユーザーグループの更新 | 組織内の指定されたユーザーグループに関する情報を更新します。 |
| UpdateUserTagMeta | ユーザータグメタデータの更新 | 組織メンバーのタグのメタデータを更新します。 |
| UpdateUserTagValue | 組織メンバーのタグ値の更新 | 組織メンバーのタグ値を更新します。 |
| UpdateWorkspaceUserRole | ワークスペースメンバーのロールの変更 | ワークスペース配下の指定されたメンバーのロールを変更します。既存のロールは上書きされます。 |
| UpdateWorkspaceUsersRole | ワークスペースメンバーのロールの一括更新 | ワークスペースメンバーのロール情報を一括で更新します。既存のロールは上書きされます。 |
| WithdrawAllUserGroups | すべてのユーザーグループからの脱退 | ユーザーをすべてのユーザーグループから脱退させます。このプロセスは元に戻すことができません。この操作を実行する際は注意してください。 |