1. 接口描述
接口请求域名: weilingwith.tencentcloudapi.com 。
查询设备绑定的空间层级关系
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSpaceRelationByDeviceId。 |
Version | 是 | String | 公共参数,本接口取值:2023-04-27。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
DeviceId | 是 | String | 设备id 示例值:"ad655ba1-975a-4238-94d7-5d2015d1cf1f" |
WorkspaceId | 是 | String | 工作空间id 示例值:"1016" |
ApplicationToken | 是 | String | 应用token 示例值:"GUsHDOIP614sDxEIiliCx7GIKTqyONoX" |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | SpaceRelationRes | 空间层级关系出参 示例值: { "SpaceRelation": { "Children": [ { "Children": [ { "Children": [], "ElementId": "bdbbf537-d6c4-4b1e-80ae-e0bcaab8b06f", "ElementName": "test_no_100", "Level": 9, "ParentSpaceCode": "000162002", "SpaceCode": "00016200200000003" } ], "ElementId": "f3c5ffa5-05e3-4c26-a447-0edf71aa9783", "ElementName": "1F", "Level": 7, "ParentSpaceCode": "000162", "SpaceCode": "000162002" } ], "ElementId": "377a53a6-c5a7-445d-a3b7-c2d721f95408", "ElementName": "小智新设备挂接0628", "Level": 6, "ParentSpaceCode": "", "SpaceCode": "000162" } } |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询设备绑定的空间层级关系示例-prod
查询设备绑定的空间层级关系示例-prod
输入示例
POST / HTTP/1.1
Host: weilingwith.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSpaceRelationByDeviceId
<公共请求参数>
{
"DeviceId": "3049938c-3048-4fef-a2e8-2843ede35edb",
"WorkspaceId": "1133",
"ApplicationToken": "Sl5ZDmVuHzhN52o8n1KWagl7sLdrLfN7"
}
输出示例
{
"Response": {
"RequestId": "9565acba-fb0e-4ec7-be20-ab274b105fd9",
"Result": {
"SpaceRelation": {
"Children": [
{
"Children": [
{
"Children": [],
"ElementId": "3425fbe2-3d6c-471f-9527-b878f35d1f03",
"ElementName": "",
"Level": 8,
"ParentSpaceCode": "000218048",
"SpaceCode": "00021804800000470"
}
],
"ElementId": "57e7c90c-e3e2-46e0-b9ee-8084c1889620",
"ElementName": "7F",
"Level": 7,
"ParentSpaceCode": "000218",
"SpaceCode": "000218048"
}
],
"ElementId": "306fc545-fc98-4513-ae6e-751f990ae61a",
"ElementName": "BHDA-1",
"Level": 6,
"ParentSpaceCode": "",
"SpaceCode": "000218"
}
}
}
}
示例2 查询指定空间下设备与构件绑定关系列表
查询指定空间下设备与构件绑定关系列表成功响应示例
输入示例
POST / HTTP/1.1
Host: weilingwith.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSpaceRelationByDeviceId
<公共请求参数>
{
"DeviceId": "ad655ba1-975a-4238-94d7-5d2015d1cf1f",
"WorkspaceId": "1016",
"ApplicationToken": "GUsHDOIP614sDxEIiliCx7GIKTqyONoX"
}
输出示例
{
"Response": {
"RequestId": "30b9a52a-1ed8-4d97-b17d-2459b938ca3a",
"Result": {
"SpaceRelation": {
"Children": [
{
"Children": [
{
"Children": [],
"ElementId": "bdbbf537-d6c4-4b1e-80ae-e0bcaab8b06f",
"ElementName": "test_no_100",
"Level": 9,
"ParentSpaceCode": "000162002",
"SpaceCode": "00016200200000003"
}
],
"ElementId": "f3c5ffa5-05e3-4c26-a447-0edf71aa9783",
"ElementName": "1F",
"Level": 7,
"ParentSpaceCode": "000162",
"SpaceCode": "000162002"
}
],
"ElementId": "377a53a6-c5a7-445d-a3b7-c2d721f95408",
"ElementName": "小智新设备挂接0628",
"Level": 6,
"ParentSpaceCode": "",
"SpaceCode": "000162"
}
}
}
}
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 | 未查询到构件信息 |