调用QueryWorks查询数据作品信息_智能商业分析 Quick BI(Quick BI)-阿里云帮助中心

查询指定数据作品信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
quickbi-public:QueryWorks	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
WorksId	string	是	报表 ID	abcd****

返回参数

名称	类型	描述	示例值
	object
Success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败	true
RequestId	string	请求 ID。	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	作品详情信息。
WorksId	string	作品 ID。	95296e95-ca89-4c7d-8af9-dedf0ad0****
WorkType	string	查询作品的类型，填空为查询所有类型。取值范围： DATAPRODUCT：数据门户 PAGE：仪表板 FULLPAGE：全屏仪表板 REPORT：电子表格 dashboardOfflineQuery：自助取数	PAGE
WorkName	string	作品名称。	测试报表
WorkspaceId	string	作品所属工作空间的 ID。	87c6b145-090c-43e1-9426-8f93be23****
WorkspaceName	string	作品所属工作空间名称。	测试空间
Directory	object	作品所属目录。
Id	string	所属目录 ID。	83d37ba6-d909-48a2-a517-f4d05c3a****
Name	string	目录名称。	测试目录
PathId	string	所属目录 ID 的层级结构，以『/』分隔。	83d37ba6-d909-48a2-a517-f4d05c3a****
PathName	string	所属目录名称的层级结构，以『/』分隔。	测试目录
SecurityLevel	string	作品协同授权的安全策略。取值： 0：私密 12：授权指定成员 1 或 11：授权所有空间成员说明若您使用旧版权限，则返回值为 1。若您使用新版权限，则返回值为 11。	0
Auth3rdFlag	integer	第三方嵌入状态。取值范围： 0：暂未开通嵌入 1：已开通嵌入	0
Description	string	作品备注。	备注
OwnerId	string	作品所有者在 Quick BI 的 UserID。	9187a612aa474e2a8ac1414d5529****
OwnerName	string	作品所有者的阿里云账户名。	张三
ModifyName	string	作品修改者的阿里云账户名。	张三
GmtCreate	string	作品创建的毫秒级时间戳。	1496651577000
GmtModify	string	作品修改的毫秒级时间戳。	1496651577000
Status	integer	报表状态。取值范围： 0：未发布 1：已发布 2：已修改未发布 3：已下线	0
PublicFlag	boolean	是否公开	true
PublicInvalidTime	long	报表公开的截止日期	1721366354000

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "WorksId": "95296e95-ca89-4c7d-8af9-dedf0ad0****",
    "WorkType": "PAGE",
    "WorkName": "测试报表",
    "WorkspaceId": "87c6b145-090c-43e1-9426-8f93be23****",
    "WorkspaceName": "测试空间",
    "Directory": {
      "Id": "83d37ba6-d909-48a2-a517-f4d05c3a****",
      "Name": "测试目录",
      "PathId": "83d37ba6-d909-48a2-a517-f4d05c3a****",
      "PathName": "测试目录"
    },
    "SecurityLevel": "0",
    "Auth3rdFlag": 0,
    "Description": "备注",
    "OwnerId": "9187a612aa474e2a8ac1414d5529****",
    "OwnerName": "张三",
    "ModifyName": "张三",
    "GmtCreate": "1496651577000",
    "GmtModify": "1496651577000",
    "Status": 0,
    "PublicFlag": true,
    "PublicInvalidTime": 1721366354000
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Invalid.Works.Empty	This work does not exist. It may have been deleted. Work ID is %s.	作品不存在，可能已经被删除。作品ID:%s。
400	Internal.System.Error	An internal system error occurred.	系统内部异常。
400	Resource.NotBelongTo.CurrentOrganization	The resource does not belong to the current organization.	该资源不属于当前组织。

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

变更历史

变更时间	变更内容概要	操作
2024-06-27	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情