1. 接口描述
接口请求域名： weilingwith.tencentcloudapi.com 。
查询项目空间楼栋数量与建筑面积
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeWorkSpaceBuildingCountAndArea。 |
| Version | 是 | String | 公共参数，本接口取值：2023-04-27。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| WorkspaceIdList.N | 是 | Array of String | 工作空间ID列表 示例值： [ "1016", "1015", "1018" ] |
| ApplicationToken | 是 | String | 应用token 示例值："fquCgDi2QfNDMlNyQ5YPoMR2Zw4tQs2B" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | SpaceDataListStatsRes | 查询项目空间楼栋数量与建筑面积出参 示例值：{ "List": [ { "BuildingArea": 0, "BuildingCount": 2, "WorkspaceId": "1018", "WorkspaceName": "华北园区项目" }, { "BuildingArea": 202928.77732501808, "BuildingCount": 127, "WorkspaceId": "1016", "WorkspaceName": "华南园区项目" }, { "BuildingArea": 0, "BuildingCount": 8, "WorkspaceId": "1015", "WorkspaceName": "公共空间" } ] } |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询项目空间楼栋数量与建筑面积
查询项目空间楼栋数量与建筑面积成功响应示例
输入示例
POST / HTTP/1.1
Host: weilingwith.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWorkSpaceBuildingCountAndArea
<公共请求参数>
{
"WorkspaceIdList": [
"1016",
"1015",
"1018"
],
"ApplicationToken": "fquCgDi2QfNDMlNyQ5YPoMR2Zw4tQs2B"
}输出示例
{
"Response": {
"RequestId": "42569a1b-01e1-4064-9288-b89ad76d55b7",
"Result": {
"List": [
{
"BuildingArea": 0,
"BuildingCount": 2,
"WorkspaceId": "1018",
"WorkspaceName": "华北园区项目"
},
{
"BuildingArea": 202928.77732501808,
"BuildingCount": 127,
"WorkspaceId": "1016",
"WorkspaceName": "华南园区项目"
},
{
"BuildingArea": 0,
"BuildingCount": 8,
"WorkspaceId": "1015",
"WorkspaceName": "公共空间"
}
]
}
}
}示例2 查询项目空间楼栋数量与建筑面积示例-prod
查询项目空间楼栋数量与建筑面积-prod
输入示例
POST / HTTP/1.1
Host: weilingwith.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWorkSpaceBuildingCountAndArea
<公共请求参数>
{
"WorkspaceIdList": [
"1124",
"1133"
],
"ApplicationToken": "Sl5ZDmVuHzhN52o8n1KWagl7sLdrLfN7"
}输出示例
{
"Response": {
"RequestId": "94a7a0d6-b2d4-4da7-a39d-ed79489e09c2",
"Result": {
"List": [
{
"BuildingArea": 35990.08433069048,
"BuildingCount": 141,
"WorkspaceId": "1124",
"WorkspaceName": "测试空间"
},
{
"BuildingArea": 646560.2510985816,
"BuildingCount": 98,
"WorkspaceId": "1133",
"WorkspaceName": "体验项目空间"
}
]
}
}
}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.BIMAppInternalError | BIM服务内部错误 |
| InvalidParameterValue.InvalidElementIdOrProjectId | 项目id或构件id取值错误 |
| ResourceNotFound.ElementNotFound | 未查询到构件信息 |