1. 接口描述
接口请求域名: bi.tencentcloudapi.com 。
项目信息
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
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 | 角色信息 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ErrorInfo | ErrorInfo | 自定义错误信息对象 注意:此字段可能返回 null,表示取不到有效值。 |
Extra | String | 额外信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
Msg | String | 接口信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
Data | ProjectListData | 数据 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 项目列表数据接口
项目列表数据接口
输入示例
POST / HTTP/1.1
Host: bi.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProjectList
<公共请求参数>
{
"PageSize": 1,
"PageNo": 1,
"Keyword": "abc",
"AllPage": true
}
输出示例
{
"Response": {
"ErrorInfo": {
"ErrorTip": "abc",
"ErrorLevel": "abc",
"DocLink": "abc",
"FAQ": "abc",
"ReservedField": "abc"
},
"Extra": "abc",
"Msg": "abc",
"Data": {
"List": [
{
"Id": 1,
"Logo": "abc",
"Name": "abc",
"ColorCode": "abc",
"CreatedUser": "abc",
"CreatedAt": "abc",
"MemberCount": 0,
"PageCount": 0,
"LastModifyName": "abc",
"Source": "abc",
"Apply": true,
"UpdatedUser": "abc",
"UpdatedAt": "abc",
"CorpId": "abc",
"Mark": "abc",
"Seed": "abc",
"AuthList": [
"abc"
],
"PanelScope": "abc",
"IsExternalManage": true,
"ManagePlatform": "abc",
"ConfigList": [
{
"ModuleGroup": "abc",
"Components": [
{
"ModuleId": "abc",
"IncludeType": "abc",
"Params": "abc"
}
]
}
]
}
],
"Total": 1,
"TotalPages": 1
},
"RequestId": "abc"
}
}
5. 开发者资源
腾讯云 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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.Internal | 内部错误。 |
MissingParameter.MissingParam | 必填参数缺失。 |
UnauthorizedOperation.Authorize | 权限错误。 |
UnauthorizedOperation.Inactive | 用户未启用。 |
UnauthorizedOperation.UserNotExist | 用户不存在。 |