批量新增设备

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

我的收藏

本页目录：

1. 接口描述

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

单个/批量新增设备

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：BatchCreateDevice。
Version	是	String	公共参数，本接口取值：2023-04-27。
Region	是	String	公共参数，详见产品支持的地域列表。
WorkspaceId	是	Integer	工作空间Id 示例值：1016
AddDeviceSet.N	是	Array of AddDeviceInfo	设备信息项示例值：{"ProductId": 200022,"ParentWID": "xxx-aaa","KeySource": 0,"SN": "test"}
ApplicationToken	是	String	应用token 示例值：xxx

3. 输出参数

参数名称	类型	描述
Result	BatchCreateDeviceRes	批量新增设备返回结果示例值：{"FailSet": [],"SuccessSet": [{"ParentWID": "","ProductId": 2000054,"SN": "atest","WID": "75c83fbd-4862-4c4e-8091-18ccba3e2419"}]}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 批量添加设备

成功响应

输入示例

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

{
    "WorkspaceId": 0,
    "AddDeviceSet": [
        {
            "ProductId": 0,
            "ParentWID": "abc",
            "KeySource": 0,
            "SN": "abc"
        }
    ],
    "ApplicationToken": "abc"
}

输出示例

{
    "Response": {
        "RequestId": "27e1d3a2-5f8a-415b-9af4-41eb1751a68d",
        "Result": {
            "FailSet": [],
            "SuccessSet": [
                {
                    "ParentWID": "",
                    "ProductId": 2000054,
                    "SN": "atest2",
                    "WID": "279ac171-ae22-4d75-a421-25b6012049e4"
                }
            ]
        }
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.DBError	操作DB失败
InternalError.ManagerSrvFailed	manager服务操作失败
InternalError.UnknownError	未知错误
InvalidParameter	参数错误。
InvalidParameterValue.InvalidWorkspaceId	错误的工作空间Id
LimitExceeded.DeviceLimitExceeded	设备数量超过限制
MissingParameter	缺少参数错误。