1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
租户全局范围的项目列表,与用户查看范围无关.
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ListProjects。 |
Version | 是 | String | 公共参数,本接口取值:2025-08-06。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProjectIds.N | 否 | Array of String | 项目id列表 示例值:["2916098084817846272"] |
ProjectName | 否 | String | 项目名或项目唯一标识名,支持模糊搜索 示例值:jian_pro1 |
Status | 否 | Integer | 项目状态,可选值:0(禁用)、1(正常) 示例值:1 |
ProjectModel | 否 | String | 项目模式,可选值:SIMPLE、STANDARD 示例值:SIMPLE |
PageNumber | 否 | Integer | 请求的数据页数,用于翻页 示例值:1 |
PageSize | 否 | Integer | 每页显示的条数,默认为 10 条 示例值:10 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | ProjectBrief | 项目列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 正常调用
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListProjects
<公共请求参数>
{
"ProjectName": "jian_pro1",
"Status": 1
}
输出示例
{
"Response": {
"Data": {
"Items": [
{
"CreateTime": "2025-08-28T17:23:10+08:00",
"CreatorUin": "100028579606",
"Description": "default",
"DisplayName": "jian_pro1",
"ProjectId": "2916098084817846272",
"ProjectModel": "SIMPLE",
"ProjectName": "jian_pro1",
"ProjectOwnerUin": null,
"Status": 1
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 1,
"TotalPageNumber": 1
},
"RequestId": "6abbd6f0-20ce-4f38-84f3-bb2c6d615f62"
}
}
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: 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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
OperationDenied.UserNotInWhitelistError | 用户不在白名单。 |