腾讯云 BI 数据接入

一、1. 接口描述

项目信息

默认接口请求频率限制：100次/秒。

二、2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeProjectList。
Version	是	String	公共参数，本接口取值：2022-01-05。
Region	否	String	公共参数，此参数为可选参数。
PageSize	否	Integer	页容，初版默认20，将来可能根据屏幕宽度动态变化示例值：1
PageNo	否	Integer	页标示例值：1
Keyword	否	String	检索模糊字段示例值：1
AllPage	否	Boolean	是否全部展示，如果是ture，则忽略分页示例值：false
ModuleCollection	否	String	角色信息示例值：bi_read
ModuleIdList.N	否	Array of String	moduleId集合示例值：[“111”]

三、3. 输出参数

参数名称	类型	描述
ErrorInfo	ErrorInfo	自定义错误信息对象注意：此字段可能返回 null，表示取不到有效值。
Extra	String	额外信息注意：此字段可能返回 null，表示取不到有效值。示例值：返回为空
Msg	String	接口信息注意：此字段可能返回 null，表示取不到有效值。示例值：成功
Data	ProjectListData	数据注意：此字段可能返回 null，表示取不到有效值。示例值：{"List":""}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

四、示例1 项目列表数据接口

项目列表数据接口

五、输入示例

POST / HTTP/1.1
Host: bi.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProjectList
<公共请求参数>
{
"PageSize": 1,
"PageNo": 1,
"Keyword": "demo",
"AllPage": true
}

六、输出示例

{
"Response": {
"ErrorInfo": {
"ErrorTip": "",
"ErrorLevel": "INFO",
"DocLink": "数据不存在",
"FAQ": "",
"ReservedField": ""
},
"Extra": "",
"Msg": "成功",
"Data": {
"List": [
{
"Id": 1,
"Logo": "http://www.cloud.com***/logo.png",
"Name": "bi项目",
"ColorCode": "#666",
"CreatedUser": "张三",
"CreatedAt": "张三",
"MemberCount": 0,
"PageCount": 0,
"LastModifyName": "张三",
"Source": "",
"Apply": true,
"UpdatedUser": "张三",
"UpdatedAt": "张三",
"CorpId": "10010101",
"Mark": "说明备注",
"Seed": "",
"AuthList": [
"10101"
],
"PanelScope": "scope",
"IsExternalManage": true,
"ManagePlatform": "saas",
"ConfigList": [
{
"ModuleGroup": "project",
"Components": [
{
"ModuleId": "10101",
"IncludeType": "useable",
"Params": ""
}
]
}
]
}
],
"Total": 1,
"TotalPages": 1
},
"RequestId": "dfjksak10w1qdsk2312"
}
}

七、腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便你从同一入口查询及使用腾讯云提供的所有 API 服务。

八、API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

九、SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

·Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

十、命令行工具

·Tencent Cloud CLI 3.0

十一、6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError.Internal	内部错误。
MissingParameter.MissingParam	必填参数缺失。
UnauthorizedOperation.Authorize	权限错误。
UnauthorizedOperation.Inactive	用户未启用。
UnauthorizedOperation.UserNotExist	用户不存在。