1. 接口描述
接口请求域名： iss.tencentcloudapi.com 。
用于批量操作（启用，禁用，删除）设备
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：BatchOperateDevice。 |
| Version | 是 | String | 公共参数，本接口取值：2023-05-17。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| DeviceIds.N | 是 | Array of String | 设备 ID 数组（从获取设备列表接口ListDevices中获取） 示例值：['f8656fa3-e7fa-4cad-a4cc-****'] 取值可参考： 获取设备列表 |
| Cmd | 是 | String | 操作命令（enable：启用；disable：禁用；delete：删除；upgrade：固件升级；reset：恢复出厂设置；reboot：重启） 示例值：enable |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | BatchOperateDeviceData | 返回结果 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BatchOperateDevice
<公共请求参数>
{
"DeviceIds": [
"2fa25418-****-4dde-****-5c2d****6d58",
"552fbaba-****-4a79-****-8504f****a53",
"6e448c42-****-4e2e-****-cc4a****15b9",
"e9b0b611-****-42a2-****-b30****b1c25"
],
"Cmd": "enable"
}输出示例
{
"Response": {
"Data": {
"TaskId": "28bdf2f7-****-4507-****-35f0****7ecf5"
},
"RequestId": "e7d070d7-8d22-4bfe-9873-6ff0ea331310"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败 |
| InvalidParameterValue | 无效的参数值 |
| InvalidParameterValue.InvalidDeviceId | 无效的设备ID |
| InvalidParameterValue.UnSupportOperateCMD | 不支持的操作命令 |
| RegionError.ResourceUnreachable | 资源不可达，该资源不属于该地域 |