ListPortalMenus - Quick BI - Alibaba Cloud Documentation Center

Gets a hierarchical list of menus under a specific BI portal.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
quickbi-public:ListPortalMenus	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DataPortalId	string	Yes	The ID of the BI portal.	0d173abb53e84c8ca7495429163b****
UserId	string	No	The user ID in the Quick BI. When passed in, the list displays only the menus that the user has permissions on.	1234567***

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	75912036-5527-4B7E-9265-B481D6651AC2
Result	string	A JSON string that levels the details of the portal menu list. Valid values: menuType: the type of the menu. 0: dashboard 1: outer chain 2: workbook 4: directory folder 5: form filling 6: self-service data retrieval menuId: menu ID uri: ID or URL of the resource associated with the menu showOnlyWithAccess: Authorized Only Visible menuName: menu display name dependentPermisson: whether the report resource associated with the menu has permissions children: submenu	\[{"children":\[{"children":\[{"children":\[{"menuId":"54kqgoa\\\\","menuName":"Report menu","menuType":0,"showOnlyWithAccess":true,"dependentPermisson":false,"uri":"e5da4a3f-d7f9-4262-a39e-a840043c\\\\"},{\\\\ "menu1nId":"pName" 135 "Directory menu","menuType":4,"showOnlyWithAccess":false,"dependentPermisson":true}],"menuId":"23a7d5d8-e55a-4737-b6a1-3c585505\\\\","menuName":"pop level -3 menu","menuType":4,"showOnlyWithAccess":true,"dependentPermisson":true}],"menuId":"80764 f3c-affd-45a1-aaa1-bb039d8a\\\\","menuName":"pop menu","menuType":4,"showOnlyWithAccess":false,"dependentPermisson":true}],"menuId":"277 f968a-22 ff-4ce6-83f0-a82950f4\\\\","menuName":"pop menu","menuType":4,"showOnlyWithAccess":false,"dependentPermisson":true}]
Success	boolean	Indicates whether the request is successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "75912036-5527-4B7E-9265-B481D6651AC2",
  "Result": "\\[{\"children\":\\[{\"children\":\\[{\"children\":\\[{\"menuId\":\"54kqgoa\\*\\*\\*\\*\",\"menuName\":\"Report menu\",\"menuType\":0,\"showOnlyWithAccess\":true,\"dependentPermisson\":false,\"uri\":\"e5da4a3f-d7f9-4262-a39e-a840043c\\*\\*\\*\\*\"},{\\*\\*\\*\\* \"menu1nId\":\"pName\" 135 \"Directory menu\",\"menuType\":4,\"showOnlyWithAccess\":false,\"dependentPermisson\":true}],\"menuId\":\"23a7d5d8-e55a-4737-b6a1-3c585505\\*\\*\\*\\*\",\"menuName\":\"pop level -3 menu\",\"menuType\":4,\"showOnlyWithAccess\":true,\"dependentPermisson\":true}],\"menuId\":\"80764 f3c-affd-45a1-aaa1-bb039d8a\\*\\*\\*\\*\",\"menuName\":\"pop menu\",\"menuType\":4,\"showOnlyWithAccess\":false,\"dependentPermisson\":true}],\"menuId\":\"277 f968a-22 ff-4ce6-83f0-a82950f4\\*\\*\\*\\*\",\"menuName\":\"pop menu\",\"menuType\":4,\"showOnlyWithAccess\":false,\"dependentPermisson\":true}]\n",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Instance.Expired	Your instance has expired.	Your instance has expired.
400	Instance.Not.Exist	The specified instance does not exist.	The specified instance does not exist.
400	Access.Forbidden	Access forbidden. Your instance version or access key is not allowed to call the API operation.	-
400	Invalid.Organization	The specified organizational unit does not exist.	The specified organizational unit does not exist.
400	User.Not.In.Organization	The specified user is not in the organizational unit.	The specified user is not in the organizational unit.
400	Invalid.Parameter	An error occurred while verifying parameters.	An error occurred while verifying parameters.
400	System.Param.empty	This error code has been discarded.	-
400	Invalid.Parameter.Error	The parameter is invalid:%s.	invalid parameter: ${0}.
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
400	Invalid.Param.Error	The parameter is invalid.	The parameter is invalid.
400	Invalid.User.Admin	You are not an administrator of this organization.	Only organization administrators can perform this operation.
400	UserInfo.Error	The personal information is invalid.	The personal information is invalid.
400	ApiUser.Not.Exists	The specified user does not exist.	The specified user does not exist.

For a list of error codes, visit the Service error codes.