QueryReadableResourcesListByUserId - 查询用户有权查看的作品列表

目前该API接口已标记为弃用,推荐使用替代API:quickbi-public(2022-01-01) - QueryReadableResourcesListByUserIdV2

查询用户有权查看的作品列表,包含空间下与分享授权的报表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
quickbi-public:QueryReadableResourcesListByUserIdlist
*全部资源
*

请求参数

名称类型必填描述示例值
UserIdstring

Quick BI 用户 ID。

de4bc5f9429141cc8091cdd1c15b****

返回参数

名称类型描述示例值
object
Successboolean

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败
true
RequestIdstring

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultarray<object>

用户有权限查看的作品列表。

Dataobject
CreateTimestring

创建时间的毫秒级时间戳。

1611023338000
Descriptionstring

作品备注。

备注
Directoryobject

作品所处的目录结构。

Idstring

所属目录 ID。

e4276ea5-b232-4fb1-8f0f-efcee4a2****
Namestring

所属目录名称。

测试目录
PathIdstring

目录 ID 的层级结构,以『/』分隔。

e4276ea5-b232-4fb1-8f0f-efcee4a2****
PathNamestring

目录名称的层级结构,以『/』分隔。

测试目录
ModifyNamestring

修改者的阿里云账户名。

李四
ModifyTimestring

修改时间的毫秒级时间戳。

1611023338000
OwnerIdstring

作品所有者的 Quick BI 的 UserID。

46e5374665ba4b679ee22e2a2927****
OwnerNamestring

所有者的阿里云账户名。

张三
SecurityLevelstring

作品协同授权的安全策略。取值:

  • 0:私密
  • 12:授权指定成员
  • 1 或 11:授权所有空间成员
说明
  • 若您使用旧版权限,则返回值为 1。
    • 若您使用新版权限,则返回值为 11。
    0
    Statusinteger

    报表状态。取值范围:

    • 0:未发布
    • 1:已发布
    • 2:已修改未发布
    • 3:已下线
    1
    ThirdPartAuthFlaginteger

    第三方嵌入状态。取值范围:

    • 0:暂未开通嵌入
    • 1:已开通嵌入
    1
    WorkNamestring

    作品名称。

    公司地区表
    WorkTypestring

    作品类型。取值范围:

    • DATAPRODUCT:数据门户
    • PAGE:仪表板(老)
    • FULLPAGE:全屏仪表板
    • REPORT:电子表格
    • DASHBOARD:仪表板(新)
    • DATAFORM:数据填报
    • dashboardOfflineQuery:自助取数
    • ANALYSIS:自助分析
    • SCREEN:数据大屏
    PAGE
    WorksIdstring

    作品 ID。

    03366b16-69ce-43c8-b782-56c2f6ec****
    WorkspaceIdstring

    作品所属工作空间 ID。

    89713491-cb4f-4579-b889-e82c35f1****
    WorkspaceNamestring

    作品所属工作空间名称。

    测试工作空间

    示例

    正常返回示例

    JSON格式

    {
      "Success": true,
      "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
      "Result": [
        {
          "CreateTime": 1611023338000,
          "Description": "备注",
          "Directory": {
            "Id": "e4276ea5-b232-4fb1-8f0f-efcee4a2****",
            "Name": "测试目录",
            "PathId": "e4276ea5-b232-4fb1-8f0f-efcee4a2****",
            "PathName": "测试目录"
          },
          "ModifyName": "李四",
          "ModifyTime": 1611023338000,
          "OwnerId": "46e5374665ba4b679ee22e2a2927****",
          "OwnerName": "张三",
          "SecurityLevel": 0,
          "Status": 1,
          "ThirdPartAuthFlag": 1,
          "WorkName": "公司地区表",
          "WorkType": "PAGE",
          "WorksId": "03366b16-69ce-43c8-b782-56c2f6ec****",
          "WorkspaceId": "89713491-cb4f-4579-b889-e82c35f1****",
          "WorkspaceName": "测试工作空间"
        }
      ]
    }

    错误码

    访问错误中心查看更多错误码。