1. 接口描述
接口请求域名: mna.tencentcloudapi.com 。
新建设备记录
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AddDevice。 |
Version | 是 | String | 公共参数,本接口取值:2021-01-19。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
DeviceName | 是 | String | 新建设备的名称 示例值:dev1 |
Remark | 否 | String | 新建设备的备注 示例值:mobile |
DataKey | 否 | String | 新建设备的base64密钥字符串,非必选,如果不填写则由系统自动生成 示例值:dasdfrfwer32e4r |
Encrypted | 否 | Boolean | 是否设置预置密钥 示例值:true |
AccessScope | 否 | Integer | 接入环境。0:公有云网关;1:自有网关;2:公有云网关和自有网关。不填默认公有云网关。 具体含义: 公有云网关:即该设备只能接入公有云网关(就近接入) 自有网关:即该设备只能接入已经注册上线的自有网关(就近接入或固定ip接入) 公有云网关和自有网关:即该设备同时可以接入公有云网关和已经注册上线的自有网关(就近接入或固定ip接入) 示例值:0 |
LicensePayMode | 否 | Integer | license付费方式: 0,月度授权 1,永久授权 若不传则默认为月度授权 示例值:0 |
GroupName | 否 | String | 设备分组名称,非必选,预留参数,需要分组时传入GroupId 示例值:group-test |
GroupId | 否 | String | 设备分组ID,非必选,如果不填写则默认设备无分组 示例值:1a2b3c4d5e |
FlowTrunc | 否 | Integer | 设备无流量包处理方式,0: 按量付费,1: 截断加速 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DataKey | String | 经过加密算法加密后的base64格式密钥 示例值:dasdfrfwer32e4r |
DeviceId | String | 设备ID 示例值:xxx |
Signature | String | 签名字符串 注意:此字段可能返回 null,表示取不到有效值。 示例值:"xxxxx" |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 新建设备
输入示例
POST / HTTP/1.1
Host: mna.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddDevice
<公共请求参数>
{
"DeviceName": "xxx",
"Remark": "xxx",
"DataKey": "xxx",
"Encrypted": "false"
}
输出示例
{
"Response": {
"RequestId": "xxx",
"DeviceId": "mna-test1",
"DataKey": "xxx",
"Signature": "xxxx"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.ControlRequestError | 请求控制器发生错误。 |
InternalError.DuplicateDataKey | 设备密钥已存在。 |
InternalError.DuplicateDeviceName | 设备名已存在。 |
InternalError.UndefinedEncryptedKey | 预置密钥尚未创建。 |
InvalidParameterValue | 参数取值错误。 |