接口请求域名： bi.intl.tencentcloudapi.com 。
项目信息
默认接口请求频率限制：100次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeProjectList。 |
| Version | 是 | String | 公共参数，本接口取值：2022-01-05。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| PageSize | 否 | Integer | 页容，初版默认20，将来可能根据屏幕宽度动态变化 |
| PageNo | 否 | Integer | 页标 |
| Keyword | 否 | String | 检索模糊字段 |
| AllPage | 否 | Boolean | 是否全部展示，如果是ture，则忽略分页 |
| ModuleCollection | 否 | String | 角色信息 |
| ModuleIdList.N | 否 | Array of String | moduleId集合 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ErrorInfo | ErrorInfo | 自定义错误信息对象 注意：此字段可能返回 null，表示取不到有效值。 |
| Extra | String | 额外信息 注意：此字段可能返回 null，表示取不到有效值。 |
| Msg | String | 接口信息 注意：此字段可能返回 null，表示取不到有效值。 |
| Data | ProjectListData | 数据 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
项目列表数据接口
POST / HTTP/1.1
Host: bi.intl.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 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.Internal | 内部错误。 |
| MissingParameter.MissingParam | 必填参数缺失。 |
| UnauthorizedOperation.Authorize | 权限错误。 |
| UnauthorizedOperation.Inactive | 用户未启用。 |
| UnauthorizedOperation.UserNotExist | 用户不存在。 |
文档反馈