1. 接口描述
接口请求域名： weilingwith.tencentcloudapi.com 。
查询建筑信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeBuildingProfile。 |
| Version | 是 | String | 公共参数，本接口取值：2023-04-27。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| BuildingId | 是 | String | 建筑id 示例值："2e374df6-7ba7-45d2-a44d-2a92bb2a6668" |
| WorkspaceId | 是 | String | 项目空间id 示例值："1016" |
| ApplicationToken | 是 | String | 应用token 示例值："0VGYLwQaH4ejNnwSMIfYtl0zlstprsdZ" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | BuildingProfileRes | 查询建筑信息出参 示例值：{ "BuildingProfile": { "Address": "广东省,深圳市,南山区测试建筑", "BuildingId": "2e374df6-7ba7-45d2-a44d-2a92bb2a6668", "BuildingName": "测试建筑", "Latitude": 22.533192, "Longitude": 113.93048, "SpaceCode": "000003" } } |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询建筑信息
查询建筑信息成功响应
输入示例
POST / HTTP/1.1
Host: weilingwith.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBuildingProfile
<公共请求参数>
{
"BuildingId": "2e374df6-7ba7-45d2-a44d-2a92bb2a6668",
"WorkspaceId": "1016",
"ApplicationToken": "0VGYLwQaH4ejNnwSMIfYtl0zlstprsdZ"
}输出示例
{
"Response": {
"RequestId": "9d3442d1-0df1-48ef-beba-872e07b2b1dd",
"Result": {
"BuildingProfile": {
"Address": "广东省,深圳市,南山区测试建筑",
"BuildingId": "2e374df6-7ba7-45d2-a44d-2a92bb2a6668",
"BuildingName": "测试建筑",
"Latitude": 22.533192,
"Longitude": 113.93048,
"SpaceCode": "000003"
}
}
}
}示例2 查询建筑信息示例-prod
查询建筑信息示例-prod
输入示例
POST / HTTP/1.1
Host: weilingwith.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBuildingProfile
<公共请求参数>
{
"BuildingId": "9e98dc3920df4230b431404222fefe37",
"WorkspaceId": "1124",
"ApplicationToken": "Sl5ZDmVuHzhN52o8n1KWagl7sLdrLfN7"
}输出示例
{
"Response": {
"RequestId": "966d76de-83dc-4d6a-bd17-75505fe0af7e",
"Result": {
"BuildingProfile": {
"Address": "陕西省,西安市,碑林区rvm",
"BuildingId": "9e98dc3920df4230b431404222fefe37",
"BuildingName": "rvm",
"Latitude": 34.212498,
"Longitude": 108.88995,
"SpaceCode": "000147"
}
}
}
}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 | 未查询到构件信息 |
