腾讯云 BI 数据结构-API 文档-文档中心-腾讯云

ApplyEmbedTokenInfo

申请Token延期

被如下接口引用：ApplyEmbedInterval。

名称	类型	描述
Result	Boolean	申请结果注意：此字段可能返回 null，表示取不到有效值。示例值：false

BaseStateAction

列表查询返回的每条记录的操作属性

被如下接口引用：DescribeDatasourceList。

名称	类型	必选	描述
ShowEdit	Boolean	否	编辑是否可见注意：此字段可能返回 null，表示取不到有效值。示例值：true
IsEdit	Boolean	否	编辑是否可点击注意：此字段可能返回 null，表示取不到有效值。示例值：true
EditText	String	否	编辑按钮的文本注意：此字段可能返回 null，表示取不到有效值。示例值：编辑
EditTips	String	否	编辑不可用时的提示文本注意：此字段可能返回 null，表示取不到有效值。示例值：编辑提示
ShowDel	Boolean	否	删除是否可见注意：此字段可能返回 null，表示取不到有效值。示例值：true
IsDel	Boolean	否	删除是否可点击注意：此字段可能返回 null，表示取不到有效值。示例值：true
DelText	String	否	删除按钮的文本注意：此字段可能返回 null，表示取不到有效值。示例值：删除
DelTips	String	否	删除不可用时的提示文本注意：此字段可能返回 null，表示取不到有效值。示例值：删除提示
ShowCopy	Boolean	否	复制是否可见注意：此字段可能返回 null，表示取不到有效值。示例值：true
ShowView	Boolean	否	是否可见注意：此字段可能返回 null，表示取不到有效值。示例值：true
ShowRename	Boolean	否	是否可重命名注意：此字段可能返回 null，表示取不到有效值。示例值：true

CorpUserListData

企业用户列表

被如下接口引用：DescribeUserProjectList。

名称	类型	描述
List	Array of UserIdAndUserName	列表注意：此字段可能返回 null，表示取不到有效值。示例值：1
Total	Integer	总数示例值：1
TotalPages	Integer	页数示例值：1

Data

数据

被如下接口引用：CreateProject。

名称	类型	描述
Id	Integer	项目Id 示例值：1

DataId

数据ID

被如下接口引用：CreateUserRole, CreateUserRoleProject。

名称	类型	描述
Id	Integer	数据id 注意：此字段可能返回 null，表示取不到有效值。示例值：1

DatasourceInfo

数据源详情

被如下接口引用：DescribeDatasourceList。

名称	类型	描述
Id	Integer	数据库ID 示例值：1
DbName	String	数据库名称示例值：1
ServiceType	String	域类型，1、腾讯云，2、本地注意：此字段可能返回 null，表示取不到有效值。示例值：1
SourceName	String	数据库别名示例值：1
DbType	String	数据库驱动示例值：1
DbHost	String	HOST 示例值：1
DbPort	Integer	端口示例值：1
DbUser	String	用户名示例值：1
Charset	String	数据库编码示例值：1
CreatedAt	String	创建时间示例值：1
UpdatedAt	String	修改时间示例值：1
CreatedUser	String	创建人注意：此字段可能返回 null，表示取不到有效值。示例值：1
Catalog	String	catalog值注意：此字段可能返回 null，表示取不到有效值。示例值：presto catalog
ConnectType	String	连接类型注意：此字段可能返回 null，表示取不到有效值。示例值：JDBC
ProjectId	String	项目id 注意：此字段可能返回 null，表示取不到有效值。示例值：1101
Desc	String	数据源描述注意：此字段可能返回 null，表示取不到有效值。示例值：数据源建表信息
Status	String	数据源状态注意：此字段可能返回 null，表示取不到有效值。示例值：SUCESS
SourcePlat	String	来源平台注意：此字段可能返回 null，表示取不到有效值。示例值：1
ExtraParam	String	扩展参数注意：此字段可能返回 null，表示取不到有效值。示例值：{"xx":"sasd"}
AddInfo	String	额外信息注意：此字段可能返回 null，表示取不到有效值。示例值：1
ProjectName	String	项目名字注意：此字段可能返回 null，表示取不到有效值。示例值：bi项目
EngineType	String	引擎类型注意：此字段可能返回 null，表示取不到有效值。示例值：1
Manager	String	数据源负责人注意：此字段可能返回 null，表示取不到有效值。示例值：1
OperatorWhitelist	String	特定操作人员白名单注意：此字段可能返回 null，表示取不到有效值。示例值：1
VpcId	String	数据源的vpc信息注意：此字段可能返回 null，表示取不到有效值。示例值：1
UniqVpcId	String	数据源的uniqVpc信息注意：此字段可能返回 null，表示取不到有效值。示例值：11
RegionId	String	数据源的地域信息注意：此字段可能返回 null，表示取不到有效值。示例值：gz
StateAction	BaseStateAction	操作属性注意：此字段可能返回 null，表示取不到有效值。示例值：add
UpdatedUser	String	更新人注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsna
PermissionList	Array of PermissionGroup	权限列表注意：此字段可能返回 null，表示取不到有效值。
AuthList	Array of String	权限值列表注意：此字段可能返回 null，表示取不到有效值。示例值：["bi_datasource_read","bi_datasource_write"]
DataOrigin	String	第三方数据源标识注意：此字段可能返回 null，表示取不到有效值。示例值：1
DataOriginProjectId	String	第三方项目id 注意：此字段可能返回 null，表示取不到有效值。示例值：1101
DataOriginDatasourceId	String	第三方数据源id 注意：此字段可能返回 null，表示取不到有效值。示例值：110101
ClusterId	String	集群id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
DbTypeName	String	数据源名称注意：此字段可能返回 null，表示取不到有效值。示例值：Mysql
UseVPC	Boolean	开启vpc 注意：此字段可能返回 null，表示取不到有效值。示例值：true

DatasourceInfoData

数据源详情列表

被如下接口引用：DescribeDatasourceList。

名称	类型	描述
List	Array of DatasourceInfo	数据源详情列表注意：此字段可能返回 null，表示取不到有效值。示例值：{"Id": 1}
Total	Integer	总数注意：此字段可能返回 null，表示取不到有效值。示例值：1
TotalPages	Integer	总页数注意：此字段可能返回 null，表示取不到有效值。示例值：1

EmbedTokenInfo

报表嵌出数据结构-强鉴权

被如下接口引用：CreateEmbedToken。

名称	类型	描述
Id	Integer	信息标识注意：此字段可能返回 null，表示取不到有效值。示例值：1
BIToken	String	令牌注意：此字段可能返回 null，表示取不到有效值。示例值：1
ProjectId	String	项目Id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
CreatedUser	String	创建人注意：此字段可能返回 null，表示取不到有效值。示例值：1
CreatedAt	String	创建时间注意：此字段可能返回 null，表示取不到有效值。示例值：1
UpdatedUser	String	更新人注意：此字段可能返回 null，表示取不到有效值。示例值：1
UpdatedAt	String	更新时间注意：此字段可能返回 null，表示取不到有效值。示例值：1
PageId	String	页面Id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
ExtraParam	String	备用注意：此字段可能返回 null，表示取不到有效值。示例值：{"xxx":"sas"}
Scope	String	嵌出类型注意：此字段可能返回 null，表示取不到有效值。示例值：page
ExpireTime	Integer	过期时间，分钟为单位，最大240 注意：此字段可能返回 null，表示取不到有效值。示例值：1
UserCorpId	String	使用者企业Id(仅用于多用户) 注意：此字段可能返回 null，表示取不到有效值。示例值：1101
UserId	String	使用者Id(仅用于多用户) 注意：此字段可能返回 null，表示取不到有效值。示例值：12012
TicketNum	Integer	访问次数限制，限制范围1-99999，为空则不设置访问次数限制注意：此字段可能返回 null，表示取不到有效值。示例值：1
GlobalParam	String	全局参数注意：此字段可能返回 null，表示取不到有效值。示例值：1
Intention	String	embed表示页面看板嵌出，chatBIEmbed表示ChatBI嵌出注意：此字段可能返回 null，表示取不到有效值。示例值：share
TokenType	Integer	100 无绑定用户 200 单用户单token 300 单用户多token 注意：此字段可能返回 null，表示取不到有效值。示例值：100
TokenNum	Integer	token 数注意：此字段可能返回 null，表示取不到有效值。示例值：11
SingleUserMultiToken	Boolean	是否单用户多token 注意：此字段可能返回 null，表示取不到有效值。示例值：true

ErrorInfo

自定义错误信息对象

被如下接口引用：ApplyEmbedInterval, CreateDatasource, CreateDatasourceCloud, CreateEmbedToken, CreateProject, CreateUserRole, CreateUserRoleProject, DeleteDatasource, DeleteProject, DeleteUserRole, DeleteUserRoleProject, DescribeDatasourceList, DescribePageWidgetList, DescribeProjectInfo, DescribeProjectList, DescribeUserProjectList, DescribeUserRoleList, DescribeUserRoleProjectList, ExportScreenPage, ModifyDatasource, ModifyDatasourceCloud, ModifyProject, ModifyUserRole, ModifyUserRoleProject。

名称	类型	描述
ErrorTip	String	错误说明字段注意：此字段可能返回 null，表示取不到有效值。示例值：错误提示
ErrorMessage	String	原始异常信息注意：此字段可能返回 null，表示取不到有效值。示例值：错误提示消息
ErrorLevel	String	错误等级字段 ERROR WARN INFO 注意：此字段可能返回 null，表示取不到有效值。示例值：INFO
DocLink	String	指引文档链接注意：此字段可能返回 null，表示取不到有效值。示例值：文档链接说明
FAQ	String	快速指引说明注意：此字段可能返回 null，表示取不到有效值。示例值：常见问题
ReservedField	String	预留字段1 注意：此字段可能返回 null，表示取不到有效值。示例值：1

IdDTO

仅包含id的对象

被如下接口引用：CreateDatasource, CreateDatasourceCloud。

名称	类型	必选	描述
Id	Integer	是	请求id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
AccessKey	String	否	key 注意：此字段可能返回 null，表示取不到有效值。示例值：dsasasddaqwdsdaads
ProjectId	Integer	否	id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
TranId	String	否	事务id 注意：此字段可能返回 null，表示取不到有效值。示例值：dwedffdssdsd
TranStatus	Integer	否	事务状态注意：此字段可能返回 null，表示取不到有效值。示例值：1

PageScreenListVO

页面截图列表

被如下接口引用：ExportScreenPage。

名称	类型	描述
PicType	String	图片导出类型。base64；url 注意：此字段可能返回 null，表示取不到有效值。示例值："base64"
List	Array of PageScreenVO	图片列表注意：此字段可能返回 null，表示取不到有效值。
TranId	String	异步事务id 注意：此字段可能返回 null，表示取不到有效值。示例值：edwewddfsddadadda
TranStatus	Integer	事务状态 1: 处理中; 2: 处理成功; 3 处理失败(错误内容见外层Msg) 注意：此字段可能返回 null，表示取不到有效值。示例值：1

PageScreenVO

页面截图信息

被如下接口引用：ExportScreenPage。

名称	类型	描述
Content	String	截图base64或 url 注意：此字段可能返回 null，表示取不到有效值。示例值：{"widgetId": "dsdda","pageId":"1101"}
WidgetId	String	组件Id 注意：此字段可能返回 null，表示取不到有效值。示例值：dsdadd

PermissionComponent

商业版本权限单元

被如下接口引用：DescribeDatasourceList。

名称	类型	必选	描述
ModuleId	String	否	权限值注意：此字段可能返回 null，表示取不到有效值。示例值：bi_datasource_read
IncludeType	String	否	可见/可用注意：此字段可能返回 null，表示取不到有效值。示例值：usable
UpgradeVersionType	String	否	目标升级版本注意：此字段可能返回 null，表示取不到有效值。示例值：v1
Tips	String	否	补充信息注意：此字段可能返回 null，表示取不到有效值。示例值：请升级到基础版或者专业版
TipsKey	String	否	补充信息的key值注意：此字段可能返回 null，表示取不到有效值。示例值：basic

PermissionGroup

商业化版本权限分组

被如下接口引用：DescribeDatasourceList。

名称	类型	必选	描述
ModuleGroup	String	否	分组名注意：此字段可能返回 null，表示取不到有效值。示例值：bi_datasource
Components	Array of PermissionComponent	否	权限列表注意：此字段可能返回 null，表示取不到有效值。

Project

项目信息描述

被如下接口引用：DescribeProjectInfo, DescribeProjectList。

名称	类型	描述
Id	Integer	项目ID 示例值：1
Logo	String	项目Logo 注意：此字段可能返回 null，表示取不到有效值。示例值：https://www.cloud.tencent***/logo.png
Name	String	项目名称注意：此字段可能返回 null，表示取不到有效值。示例值：项目名称
ColorCode	String	logo底色注意：此字段可能返回 null，表示取不到有效值。示例值：#ffffff
CreatedUser	String	创建人注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
CreatedAt	String	创建时间注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
MemberCount	Integer	成员个数注意：此字段可能返回 null，表示取不到有效值。示例值：1
PageCount	Integer	页面个数注意：此字段可能返回 null，表示取不到有效值。示例值：1
LastModifyName	String	最后修改报表、简报名称注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
Source	String	"" 注意：此字段可能返回 null，表示取不到有效值。示例值：saas
Apply	Boolean	"" 注意：此字段可能返回 null，表示取不到有效值。示例值：false
UpdatedUser	String	"" 注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
UpdatedAt	String	"" 注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
CorpId	String	"" 注意：此字段可能返回 null，表示取不到有效值。示例值："corp123"
Mark	String	"" 注意：此字段可能返回 null，表示取不到有效值。示例值：备注
Seed	String	"" 注意：此字段可能返回 null，表示取不到有效值。示例值："x12738"
AuthList	Array of String	项目内权限列表注意：此字段可能返回 null，表示取不到有效值。示例值：["bi_project_read","bi_project_write"]
PanelScope	String	默认看板注意：此字段可能返回 null，表示取不到有效值。示例值：page
IsExternalManage	Boolean	是否被托管注意：此字段可能返回 null，表示取不到有效值。示例值：true
ManagePlatform	String	托管平台名称注意：此字段可能返回 null，表示取不到有效值。示例值：saas
ConfigList	Array of ProjectConfigList	定制化参数注意：此字段可能返回 null，表示取不到有效值。

ProjectConfigList

定制化查询

被如下接口引用：DescribeProjectInfo, DescribeProjectList。

名称	类型	必选	描述
ModuleGroup	String	否	模块组注意：此字段可能返回 null，表示取不到有效值。示例值：1
Components	Array of ProjectConfigResult	否	内容注意：此字段可能返回 null，表示取不到有效值。

ProjectConfigResult

定制化查询

被如下接口引用：DescribeProjectInfo, DescribeProjectList。

名称	类型	必选	描述
ModuleId	String	否	配置名称注意：此字段可能返回 null，表示取不到有效值。示例值：bi_datasource_read
IncludeType	String	否	配置方式注意：此字段可能返回 null，表示取不到有效值。示例值：usable
Params	String	否	额外参数注意：此字段可能返回 null，表示取不到有效值。示例值：{"xx":""}

ProjectListData

项目列表数据

被如下接口引用：DescribeProjectList。

名称	类型	描述
List	Array of Project	数组注意：此字段可能返回 null，表示取不到有效值。
Total	Integer	总数注意：此字段可能返回 null，表示取不到有效值。示例值：1
TotalPages	Integer	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1

UserIdAndUserName

用户ID和用户名

被如下接口引用：CreateUserRole, CreateUserRoleProject, DescribeUserProjectList。

名称	类型	必选	描述
UserId	String	否	用户ID 示例值：1101
UserName	String	否	用户名示例值：zhangsan
CorpId	String	否	企业ID 注意：此字段可能返回 null，表示取不到有效值。示例值：10201
Email	String	否	电子邮箱注意：此字段可能返回 null，表示取不到有效值。示例值：2***2123@qq.com
LastLogin	Timestamp ISO8601	否	最后一次登录时间注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
Status	Integer	否	停启用状态注意：此字段可能返回 null，表示取不到有效值。示例值：1
FirstModify	Integer	否	首次登陆是否修改密码注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
PhoneNumber	String	否	手机号码注意：此字段可能返回 null，表示取不到有效值。示例值：+861****797
AreaCode	String	否	手机区号注意：此字段可能返回 null，表示取不到有效值。示例值：bj
CreatedUser	String	否	创建人注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
CreatedAt	Timestamp ISO8601	否	创建时间注意：此字段可能返回 null，表示取不到有效值。示例值：2023-10-12 15:12:56
UpdatedUser	String	否	更改人注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
UpdatedAt	Timestamp ISO8601	否	更改时间注意：此字段可能返回 null，表示取不到有效值。示例值：2023-10-12 15:12:56
GlobalUserName	String	否	全局角色注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
Mobile	String	否	手机号注意：此字段可能返回 null，表示取不到有效值。示例值：1329****797
AppId	String	否	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1
AppUserId	String	否	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1
AppUserAliasName	String	否	1 注意：此字段可能返回 null，表示取不到有效值。示例值：1
AppUserName	String	否	1 注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsna
InValidateAppRange	Boolean	否	1 注意：此字段可能返回 null，表示取不到有效值。示例值：true

UserInfo

用户ID和用户名

被如下接口引用：CreateUserRole, CreateUserRoleProject。

名称	类型	必选	描述
UserId	String	否	用户ID 示例值：11010
UserName	String	否	用户名示例值：zhangsan
Email	String	否	邮箱注意：此字段可能返回 null，表示取不到有效值。示例值：123123***@qq.com
PhoneNumber	String	否	手机号注意：此字段可能返回 null，表示取不到有效值。示例值：+86213***323
AreaCode	String	否	手机号区号注意：此字段可能返回 null，表示取不到有效值。示例值：086
AppUserId	String	否	企微账号id 注意：此字段可能返回 null，表示取不到有效值。示例值：1101
AppUserName	String	否	企微账号名称注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan

UserRoleListData

用户角色信息

被如下接口引用：DescribeUserRoleList, DescribeUserRoleProjectList。

名称	类型	描述
Total	Integer	总数注意：此字段可能返回 null，表示取不到有效值。示例值：1
TotalPages	Integer	总页数注意：此字段可能返回 null，表示取不到有效值。示例值：1
List	Array of UserRoleListDataUserRoleInfo	列表注意：此字段可能返回 null，表示取不到有效值。

UserRoleListDataRoleInfo

用户角色列表角色信息

被如下接口引用：DescribeUserRoleList, DescribeUserRoleProjectList。

名称	类型	描述
RoleName	String	角色名字注意：此字段可能返回 null，表示取不到有效值。示例值：项目管理员
RoleId	Integer	角色ID 注意：此字段可能返回 null，表示取不到有效值。示例值：1101
ProjectId	Integer	项目ID 注意：此字段可能返回 null，表示取不到有效值。示例值：1101
ProjectName	String	项目名字注意：此字段可能返回 null，表示取不到有效值。示例值：项目名称
ScopeType	Integer	是否为全局角色（0 不是 1 是）注意：此字段可能返回 null，表示取不到有效值。示例值：1
ModuleCollection	String	角色key 注意：此字段可能返回 null，表示取不到有效值。示例值：bi_datasource_read

UserRoleListDataUserRoleInfo

用户角色信息

被如下接口引用：DescribeUserRoleList, DescribeUserRoleProjectList。

名称	类型	描述
Id	Integer	业务ID 示例值：1
RoleList	Array of UserRoleListDataRoleInfo	角色列表注意：此字段可能返回 null，表示取不到有效值。
RoleIdList	Array of Integer	角色ID列表注意：此字段可能返回 null，表示取不到有效值。示例值：[1101,112210]
UserId	String	用户ID 示例值：1101
UserName	String	用户名示例值：zhangsan
CorpId	String	企业ID 示例值：12102
Email	String	邮箱注意：此字段可能返回 null，表示取不到有效值。示例值：2133****32@qq.com
CreatedUser	String	创建人注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan
CreatedAt	String	创建时间注意：此字段可能返回 null，表示取不到有效值。示例值：2024-10-23 21:32:45
UpdatedUser	String	更新人注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan1
UpdatedAt	String	更新时间注意：此字段可能返回 null，表示取不到有效值。示例值：2024-10-23 21:32:45
LastLogin	Timestamp ISO8601	最后一次登录时间注意：此字段可能返回 null，表示取不到有效值。示例值：zhangsan1
Status	Integer	账号状态注意：此字段可能返回 null，表示取不到有效值。示例值：1
PhoneNumber	String	手机号码注意：此字段可能返回 null，表示取不到有效值。示例值：+8631***321
AreaCode	String	手机号区号注意：此字段可能返回 null，表示取不到有效值。示例值：086
RootAccount	Boolean	是否为主账号注意：此字段可能返回 null，表示取不到有效值。示例值：true
CorpAdmin	Boolean	是否为企业管理员注意：此字段可能返回 null，表示取不到有效值。示例值：true
AppUserId	String	企微用户id 注意：此字段可能返回 null，表示取不到有效值。示例值：1101
AppUserAliasName	String	昵称注意：此字段可能返回 null，表示取不到有效值。示例值：biemc
AppUserName	String	应用用户名注意：此字段可能返回 null，表示取不到有效值。示例值：fsa
InValidateAppRange	Boolean	是否在可见范围内注意：此字段可能返回 null，表示取不到有效值。示例值：true
AppOpenUserId	String	用户openid 注意：此字段可能返回 null，表示取不到有效值。示例值：10012

WidgetListVO

页面组件信息

被如下接口引用：DescribePageWidgetList。

名称	类型	描述
CorpId	String	uin 注意：此字段可能返回 null，表示取不到有效值。示例值：110101
ProjectId	String	项目id 注意：此字段可能返回 null，表示取不到有效值。示例值：21012
PageId	String	页面id 注意：此字段可能返回 null，表示取不到有效值。示例值：1321
WidgetList	Array of WidgetVO	组件数组注意：此字段可能返回 null，表示取不到有效值。

WidgetVO

组件信息

被如下接口引用：DescribePageWidgetList。

名称	类型	描述
WidgetId	String	组件Id 注意：此字段可能返回 null，表示取不到有效值。示例值：bar_dsjusda
WidgetName	String	组件name 注意：此字段可能返回 null，表示取不到有效值。示例值：柱状图

数据结构

本页目录：

ApplyEmbedTokenInfo

BaseStateAction

CorpUserListData

Data

DataId

DatasourceInfo

DatasourceInfoData

EmbedTokenInfo

ErrorInfo

IdDTO

PageScreenListVO

PageScreenVO

PermissionComponent

PermissionGroup

Project

ProjectConfigList

ProjectConfigResult

ProjectListData

UserIdAndUserName

UserInfo

UserRoleListData

UserRoleListDataRoleInfo

UserRoleListDataUserRoleInfo

WidgetListVO

WidgetVO