tencent cloud

Data Types
Download PDF
Last updated: 2025-11-13 21:02:48
Data Types
Last updated: 2025-11-13 21:02:48
Download PDF

ApplyEmbedTokenInfo

Token deferral request

Used by actions: ApplyEmbedInterval.

Name Type Description
Result Boolean Request result.
Note: This field may return null, indicating that no valid values can be obtained.

BaseStateAction

Operation attributes of every record returned by a list query

Used by actions: DescribeDatasourceList.

Name Type Required Description
ShowEdit Boolean No Whether the edit button is visible.
Note: This field may return null, indicating that no valid values can be obtained.
IsEdit Boolean No Whether the edit button is clickable.
Note: This field may return null, indicating that no valid values can be obtained.
EditText String No Edit button text.
Note: This field may return null, indicating that no valid values can be obtained.
EditTips String No Edit-disabled hint.
Note: This field may return null, indicating that no valid values can be obtained.
ShowDel Boolean No Whether the deletion button is visible.
Note: This field may return null, indicating that no valid values can be obtained.
IsDel Boolean No Whether the deletion button is clickable.
Note: This field may return null, indicating that no valid values can be obtained.
DelText String No Delete button text.
Note: This field may return null, indicating that no valid values can be obtained.
DelTips String No Delete-disabled hint.
Note: This field may return null, indicating that no valid values can be obtained.
ShowCopy Boolean No Whether the copy button is visible.
Note: This field may return null, indicating that no valid values can be obtained.
ShowView Boolean No Whether it is visible.
Note: This field may return null, indicating that no valid values can be obtained.
ShowRename Boolean No Whether renaming is allowed.
Note: This field may return null, indicating that no valid values can be obtained.

CorpUserListData

Enterprise user list

Used by actions: DescribeUserProjectList.

Name Type Description
List Array of UserIdAndUserName List.
Note: This field may return null, indicating that no valid values can be obtained.
Total Integer Total number.
TotalPages Integer Number of pages.

Data

Data

Used by actions: CreateProject.

Name Type Description
Id Integer Project ID.
EditUrl String url
Note: This field may return null, indicating that no valid values can be obtained.

DataId

Data ID

Used by actions: CreateUserRole, CreateUserRoleProject.

Name Type Description
Id Integer Data ID.
Note: This field may return null, indicating that no valid values can be obtained.

DatasourceInfo

Data source details

Used by actions: DescribeDatasourceList.

Name Type Description
Id Integer Database ID.
DbName String Database name.
ServiceType String Domain type. Valid values: 1: Tencent Cloud; 2: local.
Note: This field may return null, indicating that no valid values can be obtained.
SourceName String Database alias.
DbType String Database driver.
DbHost String HOST
DbPort Integer Port.
DbUser String Username.
Charset String Database encoding.
CreatedAt String Creation time.
UpdatedAt String Modification time.
CreatedUser String Creator.
Note: This field may return null, indicating that no valid values can be obtained.
Catalog String Catalog value.
Note: This field may return null, indicating that no valid values can be obtained.
ConnectType String Connection type.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId String Project ID.
Note: This field may return null, indicating that no valid values can be obtained.
Desc String Data source description.
Note: This field may return null, indicating that no valid values can be obtained.
Status String Data source status.
Note: This field may return null, indicating that no valid values can be obtained.
SourcePlat String Source platform.
Note: This field may return null, indicating that no valid values can be obtained.
ExtraParam String Extension parameter.
Note: This field may return null, indicating that no valid values can be obtained.
AddInfo String Additional information.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectName String Project name.
Note: This field may return null, indicating that no valid values can be obtained.
EngineType String Engine type.
Note: This field may return null, indicating that no valid values can be obtained.
Manager String Data source owner.
Note: This field may return null, indicating that no valid values can be obtained.
OperatorWhitelist String Operation personnel allowlist.
Note: This field may return null, indicating that no valid values can be obtained.
VpcId String VPC information of the data source.
Note: This field may return null, indicating that no valid values can be obtained.
UniqVpcId String uniqVpc information of the data source.
Note: This field may return null, indicating that no valid values can be obtained.
RegionId String Data source region information.
Note: This field may return null, indicating that no valid values can be obtained.
StateAction BaseStateAction Operation attributes.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedUser String Updater.
Note: This field may return null, indicating that no valid values can be obtained.
PermissionList Array of PermissionGroup Permission list.
Note: This field may return null, indicating that no valid values can be obtained.
AuthList Array of String Permission value list.
Note: This field may return null, indicating that no valid values can be obtained.
DataOrigin String Third-party data source identifier.
Note: This field may return null, indicating that no valid values can be obtained.
DataOriginProjectId String Third-party project ID.
Note: This field may return null, indicating that no valid values can be obtained.
DataOriginDatasourceId String Third-party data source ID.
Note: This field may return null, indicating that no valid values can be obtained.
ClusterId String Cluster ID.
Note: This field may return null, indicating that no valid values can be obtained.
DbTypeName String Data source name.
Note: This field may return null, indicating that no valid values can be obtained.
UseVPC Boolean Enable VPC.
Note: This field may return null, indicating that no valid values can be obtained.
Owner String Associated person ID.
Note: This field may return null, indicating that no valid values can be obtained.
OwnerName String Associated person name.
Note: This field may return null, indicating that no valid values can be obtained.

DatasourceInfoData

Data source details list

Used by actions: DescribeDatasourceList.

Name Type Description
List Array of DatasourceInfo Data source details list.
Note: This field may return null, indicating that no valid values can be obtained.
Total Integer Total number.
Note: This field may return null, indicating that no valid values can be obtained.
TotalPages Integer Total number of pages.
Note: This field may return null, indicating that no valid values can be obtained.

EmbedTokenInfo

Report embedding data structure with strong authentication

Used by actions: CreateEmbedToken.

Name Type Description
Id Integer Information identifier.
Note: This field may return null, indicating that no valid values can be obtained.
BIToken String Token.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId String Project ID.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedUser String Creator.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedAt String Creation time.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedUser String Updater.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedAt String Update time.
Note: This field may return null, indicating that no valid values can be obtained.
PageId String Page ID.
Note: This field may return null, indicating that no valid values can be obtained.
ExtraParam String Backup.
Note: This field may return null, indicating that no valid values can be obtained.
Scope String Embedding type.
Note: This field may return null, indicating that no valid values can be obtained.
ExpireTime Integer Expiration time (in minutes), with a maximum value of 240.
Note: This field may return null, indicating that no valid values can be obtained.
UserCorpId String User enterprise ID (only used for multi-user).
Note: This field may return null, indicating that no valid values can be obtained.
UserId String User ID (only used for multi-user).
Note: This field may return null, indicating that no valid values can be obtained.
TicketNum Integer Access count limit (range: 1–99999). Leave empty to disable access restrictions.
Note: This field may return null, indicating that no valid values can be obtained.
GlobalParam String Global parameter.
Note: This field may return null, indicating that no valid values can be obtained.
Intention String "embed" indicates page dashboard embedding, and "chatBIEmbed" indicates ChatBI embedding.
Note: This field may return null, indicating that no valid values can be obtained.
TokenType Integer 100: no bound user.
200: single token per user.
300: multiple tokens per user.
Note: This field may return null, indicating that no valid values can be obtained.
TokenNum Integer Number of tokens.
Note: This field may return null, indicating that no valid values can be obtained.
SingleUserMultiToken Boolean Whether it is multiple tokens per user.
Note: This field may return null, indicating that no valid values can be obtained.
ConfigParam String Embedded display configurations: Currently for ChatBI embedding scenarios; TableFilter represents data table list filtering, SqlView represents SQL view feature.
Note: This field may return null, indicating that no valid values can be obtained.

ErrorInfo

Custom error information object

Used by actions: ApplyEmbedInterval, CreateDatasource, CreateDatasourceCloud, CreateEmbedToken, CreateProject, CreateUserRole, CreateUserRoleProject, DeleteDatasource, DeleteProject, DeleteUserRole, DeleteUserRoleProject, DescribeDatasourceList, DescribePageWidgetList, DescribeProjectInfo, DescribeProjectList, DescribeUserProjectList, DescribeUserRoleList, DescribeUserRoleProjectList, ExportScreenPage, ModifyDatasource, ModifyDatasourceCloud, ModifyProject, ModifyUserRole, ModifyUserRoleProject.

Name Type Description
ErrorTip String Error description field.
Note: This field may return null, indicating that no valid values can be obtained.
ErrorMessage String Original exception message.
Note: This field may return null, indicating that no valid values can be obtained.
ErrorLevel String Error level field.
ERROR
WARN
INFO
Note: This field may return null, indicating that no valid values can be obtained.
DocLink String Documentation link.
Note: This field may return null, indicating that no valid values can be obtained.
FAQ String Quick start guide.
Note: This field may return null, indicating that no valid values can be obtained.
ReservedField String Reserved field 1.
Note: This field may return null, indicating that no valid values can be obtained.

IdDTO

Object containing only ID

Used by actions: CreateDatasource, CreateDatasourceCloud.

Name Type Required Description
Id Integer Yes Request ID.
Note: This field may return null, indicating that no valid values can be obtained.
AccessKey String No key
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId Integer No id
Note: This field may return null, indicating that no valid values can be obtained.
TranId String No Transaction ID.
Note: This field may return null, indicating that no valid values can be obtained.
TranStatus Integer No Transaction status.
Note: This field may return null, indicating that no valid values can be obtained.

PageScreenListVO

Screenshot list

Used by actions: ExportScreenPage.

Name Type Description
PicType String Image export type. Valid values: Base64, and URL.
Note: This field may return null, indicating that no valid values can be obtained.
List Array of PageScreenVO Image list.
Note: This field may return null, indicating that no valid values can be obtained.
TranId String Async transaction ID.
Note: This field may return null, indicating that no valid values can be obtained.
TranStatus Integer Transaction status.
1: processing; 2: processing successful; 3: processing failed (error content in outer Msg).
Note: This field may return null, indicating that no valid values can be obtained.

PageScreenVO

Page screenshot information

Used by actions: ExportScreenPage.

Name Type Description
Content String Screenshot Base64 or URL.
Note: This field may return null, indicating that no valid values can be obtained.
WidgetId String Component ID.
Note: This field may return null, indicating that no valid values can be obtained.

PermissionComponent

Business edition permission unit

Used by actions: DescribeDatasourceList.

Name Type Required Description
ModuleId String No Permission value.
Note: This field may return null, indicating that no valid values can be obtained.
IncludeType String No Visible/Available.
Note: This field may return null, indicating that no valid values can be obtained.
UpgradeVersionType String No Target upgrade version.
Note: This field may return null, indicating that no valid values can be obtained.
Tips String No Supplemental information.
Note: This field may return null, indicating that no valid values can be obtained.
TipsKey String No Key for supplementary information.
Note: This field may return null, indicating that no valid values can be obtained.

PermissionGroup

Commercial version permission grouping

Used by actions: DescribeDatasourceList.

Name Type Required Description
ModuleGroup String No Group name.
Note: This field may return null, indicating that no valid values can be obtained.
Components Array of PermissionComponent No Permission list.
Note: This field may return null, indicating that no valid values can be obtained.

Project

Project description

Used by actions: DescribeProjectInfo, DescribeProjectList.

Name Type Description
Id Integer Project ID.
Logo String Project logo.
Note: This field may return null, indicating that no valid values can be obtained.
Name String Project name.
Note: This field may return null, indicating that no valid values can be obtained.
ColorCode String Background color of the logo.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedUser String Creator.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedAt String Creation time.
Note: This field may return null, indicating that no valid values can be obtained.
MemberCount Integer Number of members.
Note: This field may return null, indicating that no valid values can be obtained.
PageCount Integer Number of pages.
Note: This field may return null, indicating that no valid values can be obtained.
LastModifyName String Last modified report and dashboard names.
Note: This field may return null, indicating that no valid values can be obtained.
Source String ""
Note: This field may return null, indicating that no valid values can be obtained.
Apply Boolean ""
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedUser String ""
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedAt String ""
Note: This field may return null, indicating that no valid values can be obtained.
CorpId String ""
Note: This field may return null, indicating that no valid values can be obtained.
Mark String ""
Note: This field may return null, indicating that no valid values can be obtained.
Seed String ""
Note: This field may return null, indicating that no valid values can be obtained.
AuthList Array of String Permission list in the project.
Note: This field may return null, indicating that no valid values can be obtained.
PanelScope String Default dashboard.
Note: This field may return null, indicating that no valid values can be obtained.
IsExternalManage Boolean Whether it is managed.
Note: This field may return null, indicating that no valid values can be obtained.
ManagePlatform String Management platform name.
Note: This field may return null, indicating that no valid values can be obtained.
ConfigList Array of ProjectConfigList Customization parameter.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedUserName String Creator.
Note: This field may return null, indicating that no valid values can be obtained.
Owner String Associated person ID.
Note: This field may return null, indicating that no valid values can be obtained.
OwnerName String Associated person.
Note: This field may return null, indicating that no valid values can be obtained.
NormalCount Integer Number of dashboard pages.
Note: This field may return null, indicating that no valid values can be obtained.
FreeCount Integer Number of free canvas pages.
Note: This field may return null, indicating that no valid values can be obtained.
AdhocCount Integer Number of ad-hoc analysis pages.
Note: This field may return null, indicating that no valid values can be obtained.
BriefingCount Integer Number of pages in the briefing
Note: This field may return null, indicating that no valid values can be obtained.

ProjectConfigList

Customized query

Used by actions: DescribeProjectInfo, DescribeProjectList.

Name Type Required Description
ModuleGroup String No Module group.
Note: This field may return null, indicating that no valid values can be obtained.
Components Array of ProjectConfigResult No Content.
Note: This field may return null, indicating that no valid values can be obtained.

ProjectConfigResult

Customized query

Used by actions: DescribeProjectInfo, DescribeProjectList.

Name Type Required Description
ModuleId String No Configuration name.
Note: This field may return null, indicating that no valid values can be obtained.
IncludeType String No Configuration mode.
Note: This field may return null, indicating that no valid values can be obtained.
Params String No Additional parameters.
Note: This field may return null, indicating that no valid values can be obtained.

ProjectListData

Project list data

Used by actions: DescribeProjectList.

Name Type Description
List Array of Project Array.
Note: This field may return null, indicating that no valid values can be obtained.
Total Integer Total number.

Note: This field may return null, indicating that no valid values can be obtained.
TotalPages Integer 1
Note: This field may return null, indicating that no valid values can be obtained.

UserGroupDTO

User group

Used by actions: DescribeUserRoleList, DescribeUserRoleProjectList.

Name Type Required Description
Id Integer No id
Note: This field may return null, indicating that no valid values can be obtained.
GroupName String No User group name.
Note: This field may return null, indicating that no valid values can be obtained.
ParentId Integer No Parent node ID.
Note: This field may return null, indicating that no valid values can be obtained.
IsDefault Integer No Whether it is default.
Note: This field may return null, indicating that no valid values can be obtained.
AdminUserId String No Administrator user ID.
Note: This field may return null, indicating that no valid values can be obtained.
Description String No Description.
Note: This field may return null, indicating that no valid values can be obtained.
Location Integer No Location.
Note: This field may return null, indicating that no valid values can be obtained.

UserIdAndUserName

User ID and username

Used by actions: DescribeUserProjectList.

Name Type Required Description
UserId String No User ID.
UserName String No Username.
CorpId String No Enterprise ID.
Note: This field may return null, indicating that no valid values can be obtained.
Email String No Email.
Note: This field may return null, indicating that no valid values can be obtained.
LastLogin Timestamp ISO8601 No Last login time.
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer No Enabled/Disabled status.
Note: This field may return null, indicating that no valid values can be obtained.
FirstModify Integer No Whether to change the password during the first-time login.
Note: This field may return null, indicating that no valid values can be obtained.
PhoneNumber String No Mobile number.
Note: This field may return null, indicating that no valid values can be obtained.
AreaCode String No Telephone country code.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedUser String No Creator.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedAt Timestamp ISO8601 No Creation time.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedUser String No Modifier.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedAt Timestamp ISO8601 No Change time.
Note: This field may return null, indicating that no valid values can be obtained.
GlobalUserName String No Global role.
Note: This field may return null, indicating that no valid values can be obtained.
GlobalUserCode String No Global role code.
Note: This field may return null, indicating that no valid values can be obtained.
Mobile String No Mobile number.

Note: This field may return null, indicating that no valid values can be obtained.
AppId String No 1
Note: This field may return null, indicating that no valid values can be obtained.
AppUserId String No 1
Note: This field may return null, indicating that no valid values can be obtained.
AppUserAliasName String No 1
Note: This field may return null, indicating that no valid values can be obtained.
AppUserName String No 1
Note: This field may return null, indicating that no valid values can be obtained.
InValidateAppRange Boolean No 1
Note: This field may return null, indicating that no valid values can be obtained.
EmailActivationStatus Integer No -1: No activation required. 0: Inactivated. 1: Activated. Null value represents pending binding.
Note: This field may return null, indicating that no valid values can be obtained.
Id Integer No 1
Note: This field may return null, indicating that no valid values can be obtained.

UserInfo

User ID and username

Used by actions: CreateUserRole, CreateUserRoleProject.

Name Type Required Description
UserId String No User ID.
UserName String No Username.
Email String No Email.
Note: This field may return null, indicating that no valid values can be obtained.
PhoneNumber String No Mobile number.

Note: This field may return null, indicating that no valid values can be obtained.
AreaCode String No Telephone country code.
Note: This field may return null, indicating that no valid values can be obtained.
AppUserId String No WeCom account ID.
Note: This field may return null, indicating that no valid values can be obtained.
AppUserName String No WeCom account name.
Note: This field may return null, indicating that no valid values can be obtained.

UserRoleListData

User role information

Used by actions: DescribeUserRoleList, DescribeUserRoleProjectList.

Name Type Description
Total Integer Total number.
Note: This field may return null, indicating that no valid values can be obtained.
TotalPages Integer Total number of pages.
Note: This field may return null, indicating that no valid values can be obtained.
List Array of UserRoleListDataUserRoleInfo List.
Note: This field may return null, indicating that no valid values can be obtained.

UserRoleListDataRoleInfo

Role information of the user role list

Used by actions: DescribeUserRoleList, DescribeUserRoleProjectList.

Name Type Description
RoleName String Role Name.
Note: This field may return null, indicating that no valid values can be obtained.
RoleId Integer Role ID.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId Integer Project ID.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectName String Project name.
Note: This field may return null, indicating that no valid values can be obtained.
ScopeType Integer Whether it is a global role (0: no; 1: yes).
Note: This field may return null, indicating that no valid values can be obtained.
ModuleCollection String Role key.
Note: This field may return null, indicating that no valid values can be obtained.

UserRoleListDataUserRoleInfo

User role information

Used by actions: DescribeUserRoleList, DescribeUserRoleProjectList.

Name Type Description
Id Integer Business ID.
RoleList Array of UserRoleListDataRoleInfo This API is used to obtain the role list.
Note: This field may return null, indicating that no valid values can be obtained.
RoleIdList Array of Integer Role ID list.
Note: This field may return null, indicating that no valid values can be obtained.
UserId String User ID.
UserName String Username.
CorpId String Enterprise ID.
Email String Email.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedUser String Creator.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedAt String Creation time.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedUser String Updater.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedAt String Update time.
Note: This field may return null, indicating that no valid values can be obtained.
LastLogin Timestamp ISO8601 Last login time.
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer Account status.
Note: This field may return null, indicating that no valid values can be obtained.
PhoneNumber String Mobile number.
Note: This field may return null, indicating that no valid values can be obtained.
AreaCode String Telephone country code.
Note: This field may return null, indicating that no valid values can be obtained.
RootAccount Boolean Whether it is the root account.
Note: This field may return null, indicating that no valid values can be obtained.
CorpAdmin Boolean Whether it is an enterprise administrator.
Note: This field may return null, indicating that no valid values can be obtained.
AppUserId String WeCom user ID.
Note: This field may return null, indicating that no valid values can be obtained.
AppUserAliasName String Nickname.
Note: This field may return null, indicating that no valid values can be obtained.
AppUserName String Application username.
Note: This field may return null, indicating that no valid values can be obtained.
InValidateAppRange Boolean Whether it is within the visible range.
Note: This field may return null, indicating that no valid values can be obtained.
AppOpenUserId String User openID.
Note: This field may return null, indicating that no valid values can be obtained.
EmailActivationStatus Integer Activation status of email.
Note: This field may return null, indicating that no valid values can be obtained.
UserGroupList Array of UserGroupDTO User group information.
Note: This field may return null, indicating that no valid values can be obtained.

WidgetListVO

Page component information

Used by actions: DescribePageWidgetList.

Name Type Description
CorpId String uin
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId String Project ID.
Note: This field may return null, indicating that no valid values can be obtained.
PageId String Page ID.
Note: This field may return null, indicating that no valid values can be obtained.
WidgetList Array of WidgetVO Component array.
Note: This field may return null, indicating that no valid values can be obtained.

WidgetVO

Component information

Used by actions: DescribePageWidgetList.

Name Type Description
WidgetId String Component ID.
Note: This field may return null, indicating that no valid values can be obtained.
WidgetName String Component name.
Note: This field may return null, indicating that no valid values can be obtained.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback