有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

接口请求域名: weilingwith.tencentcloudapi.com 。

查询指定空间设备编号列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSpaceDeviceIdList。
Version String 公共参数,本接口取值:2023-04-27。
Region String 公共参数,详见产品支持的 地域列表
ElementIds.N Array of String 构件id列表
示例值:["377a53a6-c5a7-445d-a3b7-c2d721f95408"]
IsCascade Boolean 是否级联
示例值:true
WorkspaceId String 项目空间id
示例值:"1016"
PageNumber Integer 页码
示例值:1
PageSize Integer 页容量
示例值:10
ApplicationToken String 应用token
示例值:"GUsHDOIP614sDxEIiliCx7GIKTqyONoX"

3. 输出参数

参数名称 类型 描述
Result SpaceDeviceIdListRes 设备ID列表
示例值:{ "DeviceIds": [ "2b538c57-933f-4820-b1d0-4df70d64aee3", "ad655ba1-975a-4238-94d7-5d2015d1cf1f", "5a1a0b73-7aa3-4699-a893-21846e7853ec", "0a198d6e-40f0-499f-bf99-7a959b7f4ef2" ] }
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询指定空间设备编号列表

查询指定空间设备编号列表成功响应示例

输入示例

POST / HTTP/1.1
Host: weilingwith.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSpaceDeviceIdList
<公共请求参数>

{
    "ElementIds": [
        "377a53a6-c5a7-445d-a3b7-c2d721f95408"
    ],
    "IsCascade": true,
    "WorkspaceId": "1016",
    "PageNumber": 1,
    "PageSize": 10,
    "ApplicationToken": "GUsHDOIP614sDxEIiliCx7GIKTqyONoX"
}

输出示例

{
    "Response": {
        "RequestId": "1c3e7242-f4fb-4000-b8ae-0724b481693d",
        "Result": {
            "DeviceIds": [
                "2b538c57-933f-4820-b1d0-4df70d64aee3",
                "ad655ba1-975a-4238-94d7-5d2015d1cf1f",
                "5a1a0b73-7aa3-4699-a893-21846e7853ec",
                "0a198d6e-40f0-499f-bf99-7a959b7f4ef2"
            ]
        }
    }
}

示例2 查询指定空间设备编号列表示例-prod

查询指定空间设备编号列表示例-prod

输入示例

POST / HTTP/1.1
Host: weilingwith.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSpaceDeviceIdList
<公共请求参数>

{
    "ElementIds": [
        "306fc545-fc98-4513-ae6e-751f990ae61a"
    ],
    "IsCascade": true,
    "WorkspaceId": "1133",
    "PageNumber": 1,
    "PageSize": 10,
    "ApplicationToken": "Sl5ZDmVuHzhN52o8n1KWagl7sLdrLfN7"
}

输出示例

{
    "Response": {
        "RequestId": "51ddc6c7-0ee6-4d0d-b95a-dda432859da7",
        "Result": {
            "DeviceIds": [
                "675a9490-dd66-4ac7-b39b-c74977899a1a",
                "14dfa61a-762b-4785-bd39-cd709c6cf3d9",
                "840e3fe7-4eb4-4a64-9036-02ba94956e06",
                "3247728f-15d2-48a2-a0fc-d07a6a6023f0",
                "90f965da-5ed9-469c-bace-7ecd09e2693c",
                "1635422d-5de3-4e38-9f68-94b43fd78185",
                "35bc7027-567a-48d2-a3ee-63c57be9ae9f",
                "749287c4-c48f-42f4-b083-838c1b2fef09",
                "50a294f4-9289-43d0-aa27-efc31c7405ac",
                "3049938c-3048-4fef-a2e8-2843ede35edb"
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.BIMAppInternalError BIM服务内部错误
InvalidParameterValue.InvalidElementIdOrProjectId 项目id或构件id取值错误
ResourceNotFound.ElementNotFound 未查询到构件信息