拉取设备的设备类型列表

最近更新时间:2024-03-12 02:07:42

我的收藏

1. 接口描述

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

拉取设备的设备类型列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDeviceTypeList。
Version String 公共参数,本接口取值:2023-04-27。
Region String 公共参数,详见产品支持的 地域列表
WorkspaceId Integer 工作空间id
示例值:1016
ApplicationToken String 应用token
示例值:xxx
Flag Integer 默认0只拉取设备列表关联的设备类型列表;1拉取空间下所有的设备类型列表
示例值:0

3. 输出参数

参数名称 类型 描述
Result DeviceTypeSet 设备的设备类型列表
示例值:{"Set": [{"Code": "w0301006","IsSubsystem": 0,"Name": "烟感报警器","ParentCode": "0301","ParentName": "火灾自动报警及联动系统"}]}}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 设备列表类型查询结果

成功响应

输入示例

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

{
    "WorkspaceId": 1016,
    "ApplicationToken": "YzenL5LdGoxQM5gqJfCCoMDeGqUSsY78"
}

输出示例

{
    "Response": {
        "RequestId": "7be5626c-d9f9-4883-b4c4-3d77ba2fe281",
        "Result": {
            "Set": [
                {
                    "Code": "w0301006",
                    "IsSubsystem": 0,
                    "Name": "烟感报警器",
                    "ParentCode": "0301",
                    "ParentName": "火灾自动报警及联动系统"
                }
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.TokenNotFound 未找到该token信息
InvalidParameter.TokenFieldNotFound 未找到token字段
InvalidParameterValue.InvalidWorkspaceId 错误的工作空间Id