V2.1 Enable Device


启用设备。

该 API 支持在 EnOS 2.1.0 及以上环境中使用。

操作权限


使用此 API 前，确保服务账号已被授予包含下列服务和操作权限的策略。有关授权服务账号的更多信息，参见 管理服务账号。


需授权的服务

所需操作权限

设备管理服务

Full Access

请求格式

POST https://{apigw-address}/connect-service/v2.1/devices?action=enable

请求参数（URI）

备注

以下非必需字段中，必须提供 assetId 或 productKey + deviceKey 的组合，用于指定设备。

名称

位置（Path/Query）

必需/可选

数据类型

描述

orgId

Query

必需

String

资产所属的组织 ID。如何获取 orgId 信息>>

assetId

Query

可选（见上述注解）

String

资产 ID。如何获取 assetId 信息>>

productKey

Query

可选（见上述注解）

String

设备的 product key，需与 deviceKey 一起使用。如何获取设备的三元组信息>>

deviceKey

Query

可选（见上述注解）

String

设备的 device key，需与 productKey 一起使用。如何获取设备的三元组信息>>

错误码

代码

错误信息

描述

11721

  • Device is inactive

  • Device is offline

  • Deivce is online

  • Device not found

  • 设备已启用，设备状态为未激活。

  • 设备已启用，设备状态为离线。

  • 设备已启用，设备状态为在线。

  • 用于指定设备的 assetId、productKey 或 deviceKey 不存在。

示例

请求示例

url:https://{apigw-address}/connect-service/v2.1/devices?action=enable&orgId=yourOrgId&assetId=yourAssetId
method: POST

返回示例

{
    "code": 0,
    "msg": "OK",
    "requestId": "06dd8ea3-cb9e-4628-8f93-d36c416bcd3a",
    "data": null
}

SDK 示例


你可以在 Github 上获取接入服务的 SDK 示例：