ListPortalMenus で BI ポータルメニュー階層リストを取得 - Quick BI

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

quickbi-public:ListPortalMenus

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DataPortalId	string	必須	BI ポータルの ID。	0d173abb53e84c8ca7495429163b****
UserId	string	任意	Quick BI のユーザー ID。このパラメーターを渡すと、ユーザーが権限を持つメニューのみがリストに表示されます。	1234567***

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	75912036-5527-4B7E-9265-B481D6651AC2
Result	string	ポータルメニューリストの詳細を階層化した JSON 文字列。有効な値は次のとおりです： menuType：メニューのタイプ。 0：ダッシュボード 1：外部リンク 2：ワークブック 4：ディレクトリフォルダ 5：フォーム入力 6：セルフサービスデータ取得 menuId：メニュー ID uri：メニューに関連付けられたリソースの ID または URL showOnlyWithAccess：権限がある場合のみ表示 menuName：メニューの表示名 dependentPermisson：メニューに関連付けられたレポートリソースに権限があるかどうか children：サブメニュー	[{"children":[{"children":[{"children":[{"menuId":"54kqgoa**","menuName":"报表菜单","menuType":0,"showOnlyWithAccess":true,"dependentPermisson":false,"uri":"e5da4a3f-d7f9-4262-a39e-a840043c"},{"menuId":"pg1n135","menuName":"目录菜单","menuType":4,"showOnlyWithAccess":false,"dependentPermisson":true}],"menuId":"23a7d5d8-e55a-4737-b6a1-3c585505","menuName":"pop三级菜单","menuType":4,"showOnlyWithAccess":true,"dependentPermisson":true}],"menuId":"80764f3c-affd-45a1-aaa1-bb039d8a","menuName":"pop二级菜单","menuType":4,"showOnlyWithAccess":false,"dependentPermisson":true}],"menuId":"277f968a-22ff-4ce6-83f0-a82950f4**","menuName":"pop一级菜单","menuType":4,"showOnlyWithAccess":false,"dependentPermisson":true}]
Success	boolean	リクエストが成功したかどうかを示します。有効な値は次のとおりです： true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "75912036-5527-4B7E-9265-B481D6651AC2",
  "Result": "[{\"children\":[{\"children\":[{\"children\":[{\"menuId\":\"54kqgoa****\",\"menuName\":\"报表菜单\",\"menuType\":0,\"showOnlyWithAccess\":true,\"dependentPermisson\":false,\"uri\":\"e5da4a3f-d7f9-4262-a39e-a840043c****\"},{\"menuId\":\"pg1n135****\",\"menuName\":\"目录菜单\",\"menuType\":4,\"showOnlyWithAccess\":false,\"dependentPermisson\":true}],\"menuId\":\"23a7d5d8-e55a-4737-b6a1-3c585505****\",\"menuName\":\"pop三级菜单\",\"menuType\":4,\"showOnlyWithAccess\":true,\"dependentPermisson\":true}],\"menuId\":\"80764f3c-affd-45a1-aaa1-bb039d8a****\",\"menuName\":\"pop二级菜单\",\"menuType\":4,\"showOnlyWithAccess\":false,\"dependentPermisson\":true}],\"menuId\":\"277f968a-22ff-4ce6-83f0-a82950f4****\",\"menuName\":\"pop一级菜单\",\"menuType\":4,\"showOnlyWithAccess\":false,\"dependentPermisson\":true}]",
  "Success": true
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。