接口请求域名: trro.intl.tencentcloudapi.com 。
用于创建设备
默认接口请求频率限制:100次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateDevice。 |
| Version | 是 | String | 公共参数,本接口取值:2022-03-25。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ProjectId | 是 | String | 创建设备所归属的项目ID |
| DeviceId | 是 | String | 创建设备ID,项目内需要唯一,由小写英文字母、数字和下划线构成,长度不超过18 |
| DeviceName | 是 | String | 创建设备名称,长度小于24, 可包含中文、数字、英文字母和下划线 |
| DeviceType | 是 | String | 设备类型,field为现场设备(受控设备),remote为远端设备(操控设备),不填默认为field |
| DeviceToken | 是 | String | 设备认证口令,由大小写英文字母和数字构成,须为16位 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: trro.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDevice
<公共请求参数>
{
"ProjectId": "f3glr49r2nwpey5c",
"DeviceId": "test2",
"DeviceName": "test_device",
"DeviceType": "field",
"DeviceToken": "abcd1234abcd1234"
}
{
"Response": {
"RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
文档反馈