接口请求域名： bi.intl.tencentcloudapi.com 。
项目详情接口
默认接口请求频率限制：100次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeProjectInfo。 |
| Version | 是 | String | 公共参数，本接口取值：2022-01-05。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Id | 是 | Integer | 项目Id |
| DefaultPanelType | 否 | Integer | 默认看板 枚举值：
|
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ErrorInfo | ErrorInfo | 自定义错误信息对象 注意：此字段可能返回 null，表示取不到有效值。 |
| Extra | String | "" 注意：此字段可能返回 null，表示取不到有效值。 |
| Msg | String | "" 注意：此字段可能返回 null，表示取不到有效值。 |
| Data | Project | 项目详情 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
展示项目详情接口示例
POST / HTTP/1.1
Host: bi.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProjectInfo
<公共请求参数>
{
"Id": 1982493789748932,
"DefaultPanelType": 1982493789748932
}
{
"Response": {
"ErrorInfo": {
"ErrorTip": "",
"ErrorLevel": "INFO",
"DocLink": "",
"FAQ": "",
"ReservedField": ""
},
"Extra": "ext",
"Msg": "成功",
"Data": {
"Id": 1,
"Logo": "https://cloud.tencetn****/logo.png",
"Name": "测试项目",
"ColorCode": "#fff",
"CreatedUser": "zhangsan",
"CreatedAt": "zhangsan",
"MemberCount": 0,
"PageCount": 0,
"LastModifyName": "zhangsan",
"Source": "sas",
"Apply": true,
"UpdatedUser": "zhangsan",
"UpdatedAt": "zhangsan",
"CorpId": "1010",
"Mark": "Mark",
"Seed": "Seed",
"AuthList": [
"110101"
],
"PanelScope": "page",
"IsExternalManage": true,
"ManagePlatform": "saas",
"ConfigList": [
{
"ModuleGroup": "page",
"Components": [
{
"ModuleId": "1101",
"IncludeType": "usable",
"Params": ""
}
]
}
]
},
"RequestId": "RequestId-123"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| MissingParameter.MissingParam | 必填参数缺失。 |
| UnauthorizedOperation.Authorize | 权限错误。 |
| UnauthorizedOperation.UserNotExist | 用户不存在。 |
| UnsupportedOperation.BIError | 默认业务异常。 |
文档反馈