ListPortalMenus接口用于获取具体数据门户下的分层菜单列表。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListPortalMenus |
要执行的操作。取值:ListPortalMenus。 |
DataPortalId | String | 是 | 0d173abb53e84c8ca7495429163b**** |
数据门户的ID。 |
UserId | String | 否 | 1234567*** |
Quick BI中的用户ID。传入时列表仅展示用户有权限的菜单。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 75912036-5527-4B7E-9265-B481D6651AC2 |
请求ID。 |
Result | String | [{"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}] |
分级门户菜单列表详情的JSON字符串。取值范围:
|
Success | Boolean | true |
是否请求成功。取值范围:
|
示例
请求示例
http(s)://quickbi-public.aliyuncs.com/?Action=ListPortalMenus
&DataPortalId=0d173abb53e84c8ca7495429163b****
&UserId=1234567***
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListPortalMenusResponse>
<RequestId>75912036-5527-4B7E-9265-B481D6651AC2</RequestId>
<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}]</Result>
<Success>true</Success>
</ListPortalMenusResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"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
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | Instance.Expired | Your instance has expired. | 您的购买实例已经过期。 |
500 | Instance.Not.Exist | The specified instance does not exist. | 暂未匹配到您的购买实例。 |
500 | Access.Forbidden | Access forbidden. Your instance version or access key is not allowed to call the API operation. | 访问被禁止,您的实例版本或者 AccessKey不允许调用该 API。 |
500 | Invalid.Organization | The specified organizational unit does not exist. | 该组织不存在。 |
500 | User.Not.In.Organization | The specified user is not in the organizational unit. | 该用户不在组织中。 |
500 | Invalid.Parameter | An error occurred while verifying parameters. | 参数验证失败。 |
500 | System.Param.empty | This error code has been discarded. | 错误码已废弃。 |
500 | Invalid.Parameter.Error | The parameter is invalid:%s. | 无效参数%s。 |
500 | Internal.System.Error | An internal system error occurred. | 系统内部异常。 |
访问错误中心查看更多错误码。