华为云用户手册

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 device_id String 设备ID，用于唯一标识一个设备，在注册设备时由 物联网平台 分配获得。（生成规则为"product_id" + "_" + "node_id"拼接而成） 最小长度：0 最大长度：256 node_id String 设备标识码，通常使用IMEI、MAC地址或Serial No作为nodeId。 最小长度：0 最大长度：64 gateway_id String 网关ID，用于标识一个网关设备。当设备是直连设备时，gatewayId与设备的deviceId一致。当设备是非直连设备时，gatewayId为设备所关联的直连设备（即网关）的deviceId。 最小长度：0 最大长度：256 device_name String 设备名称。 最小长度：0 最大长度：256 node_type String 设备节点类型。 ENDPOINT：非直连设备。 GATEWAY：直连设备或网关。 UNKNOWN：未知。 description String 设备的描述信息。 最小长度：0 最大长度：2048 auth_info AuthInfo object 设备的接入认证信息。 product_id String 设备关联的产品ID，用于唯一标识一个产品模型。 product_name String 设备关联的产品名称。 最小长度：1 最大长度：255 protocol_type String 设备关联的产品协议类型。 create_time String 在物联网平台注册设备的时间。 最小长度：0 最大长度：128 provision_info ProvisionInfoBaseResp object 设备的发放信息。 表7 AuthInfo 参数 参数类型 描述 auth_type String 鉴权类型。支持秘钥认证接入(SECRET)和证书认证接入(CERTIFICATES)。使用秘钥认证接入方式(SECRET)填写secret字段，使用证书认证接入方式(CERTIFICATE)填写fingerprint字段，如果CA证书选择 云证书管理服务 的CA证书，不需要填写fingerprint字段，需要填写设备证书名称字段，不填写auth_type默认为秘钥认证接入方式(SECRET) secret String 设备秘钥，认证类型使用秘钥认证接入(SECRET)可填写该字段。注意：NB设备秘钥由于协议特殊性，只支持十六进制秘钥接入。 最小长度：8 最大长度：32 fingerprint String 证书指纹，认证类型使用证书认证接入(CERTIFICATES)可填写该字段，注册设备时不填写该字段则取第一次设备接入时的证书指纹。注意：指纹只能为40位十六进制字符串或者64位十六进制字符串。 device_cert_name String 设备证书名称，CA证书选择 云证书管理 服务的CA证书接入需要填写该字段。此名称会也即设备证书使用者的CommanName device_cert_validity Integer 生成设备证书的有效期。CA证书选择云证书管理服务的CA证书可填写该字段。 最小值：1 最大值：10 device_cert_id String 设备证书id，设备采用云证书管理服务的CA注册，云证书管理服务生成的设备证书的唯一实例ID secure_access Boolean 指设备是否通过安全协议方式接入，默认值为true。 true：通过安全协议方式接入。 false：通过非安全协议方式接入。 缺省值：true timeout Integer 设备验证码的有效时间，单位：秒，默认值：0 若设备在有效时间内未接入物联网平台并激活，则平台会删除该设备的注册信息。若设置为“0”，则表示设备验证码不会失效（建议填写为“0”）。 缺省值：0 表8 ProvisionInfoBaseResp 参数 参数类型 描述 access_point AccessPointResp object 发放区域。 app_info ApplicationResp object 所属应用。 cert_name String CA证书名称。设备认证类型为证书认证时返回。 最小长度：0 最大长度：256 allocation_status Integer 设备发放状态。 取值如下： 0：成功； 1：失败； 2：发放中； 3：未发放（默认）。 最小值：0 最大值：3 allocation_strategy_type String 策略类型。 取值如下： base：静态策略； certificates：证书策略； functions：自定义策略； nearby：就近策略； migrations: 指定迁移策略。 缺省值：base life_time Integer LWM2M设备导入的默认生命周期。 最小值：0 最大值：864000 init_config String 设备的初始化配置。 最小长度：1 最大长度：65535 表9 AccessPointResp 参数 参数类型 描述 access_point_id String 接入点id。 最小长度：1 最大长度：256 access_point_name String 接入点名称。 最小长度：1 最大长度：256 region_id String 华为云终端节点ID。节选自https://developer.huaweicloud.com/endpoint。 最小长度：1 最大长度：128 表10 ApplicationResp 参数 参数类型 描述 app_id String 应用id。 最小长度：1 最大长度：64 app_name String 应用名称。 最小长度：1 最大长度：256

URI PUT /v5/iotps/{project_id}/devices/{device_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度：1 最大长度：32 device_id 是 String 设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。（生成规则为"product_id" + "_" + "node_id"拼接而成） 最小长度：1 最大长度：128

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 device_name 否 String 设备名称。 最小长度：1 最大长度：256 description 否 String 设备的描述信息。 最小长度：1 最大长度：2048 product_id 否 String 设备关联的产品ID，用于唯一标识一个产品模型。 auth_info 否 AuthInfoWithoutSecret object 设备的接入认证信息。 provision_info 否 ProvisionInfoUpdateReq object 设备的发放信息。 表4 AuthInfoWithoutSecret 参数 是否必选 参数类型 描述 secure_access 否 Boolean 指设备是否通过安全协议方式接入，默认值为true。 true：通过安全协议方式接入。 false：通过非安全协议方式接入。 缺省值：true timeout 否 Integer 设备验证码的有效时间，单位：秒，默认值：0 若设备在有效时间内未接入物联网平台并激活，则平台会删除该设备的注册信息。若设置为“0”，则表示设备验证码不会失效（建议填写为“0”）。 最小值：0 最大值：2147483647 缺省值：0 表5 ProvisionInfoUpdateReq 参数 是否必选 参数类型 描述 life_time 否 Integer LWM2M设备导入的默认生命周期。 取值范围：0-604800。 最小值：0 最大值：604800

响应示例 状态码： 200 OK { "access_points" : [ { "access_point_id" : "DMP-CNNorth-1-1", "access_point_name" : "设备管理-北京一-1", "region_id" : "cn-north-1", "region_name" : "华北-北京一", "edition" : "Basic" }, { "access_point_id" : "DMP-CNNorth-4-1", "access_point_name" : "设备管理-北京四-1", "region_id" : "cn-north-4", "region_name" : "华北-北京四", "edition" : "Standard" }, { "access_point_id" : "DMP-CNNorth-4-1", "access_point_name" : "设备管理-北京四-1", "region_id" : "cn-north-4", "region_name" : "华北-北京四", "edition" : "Enterprise" } ]}

URI GET /v5/iotps/{project_id}/access-points 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度：1 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 authorizing_domain_id 否 String 授权租户的账户ID 最小长度：1 最大长度：128 region_id 否 String 区域ID，用于区分不同的区域。 最小长度：1 最大长度：64

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 access_points Array of AccessPointItem objects 接入点列表。 数组长度：0 - 100 表5 AccessPointItem 参数 参数类型 描述 access_point_id String 接入点id。 最小长度：1 最大长度：256 access_point_name String 接入点名称。 最小长度：1 最大长度：256 region_id String 华为云区域ID。节选自https://developer.huaweicloud.com/endpoint。 最小长度：1 最大长度：128 region_name String 华为云区 域名 称。节选自https://developer.huaweicloud.com/endpoint。 最小长度：1 最大长度：128 edition String 实例版本。Basic：基础版；Enterprise：企业版；Standard：基础版。 最小长度：1 最大长度：256

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 registration_group_devices Array of RegistrationGroupDevices objects 注册组信息。 数组长度：0 - 1000 page Page object 查询结果的分页信息。 表5 RegistrationGroupDevices 参数 参数类型 描述 device_id String 设备id，用于唯一标识一个设备 最小长度：1 最大长度：256 app_name String 应用名。 最小长度：1 最大长度：256 access_point_name String 接入点名称。 最小长度：1 最大长度：256 device_name String 设备名称。 最小长度：1 最大长度：256 status Integer 设备引导状态。 取值如下： 0：成功； 1：失败； 2：默认。 最小值：0 最大值：2 create_time String 在物联网平台注册设备的时间。 最小长度：0 最大长度：128 modify_time String 在物联网平台修改设备的时间。 最小长度：0 最大长度：128 表6 Page 参数 参数类型 描述 count Long 满足查询条件的记录总数，最大返回1000条记录。 最小值：0 最大值：1000 marker String 本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。 最小长度：0 最大长度：64

URI GET /v5/iotps/{project_id}/registration-groups/{registration_group_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 最小长度：1 最大长度：32 registration_group_id 是 String 注册组id，用于唯一标识一个注册组 最小长度：1 最大长度：256 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页查询时每页显示的记录数，默认值为10，取值范围为1-50的整数。 最小值：1 最大值：50 缺省值：10 marker 否 String 上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 缺省值：999999999999999999999999 最小长度：24 最大长度：24 device_id 否 String 设备ID，支持模糊查询。 最小长度：4 最大长度：128 device_name 否 String 设备名称。 最小长度：0 最大长度：256 status 否 String 设备引导状态。

响应示例 状态码： 200 OK { "registration_group_devices" : [ { "device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "app_name" : "ABC123456789", "access_point_name" : "d4922d8a-6c8e-4396-852c-164aefa668f", "device_name" : "dianadevice" } ], "page" : { "count" : 1, "marker" : "d4922d8a-6c8e-4396-852c-164aefa6638f" }}

状态码 状态码 编码 状态说明 200 OK 请求已成功。 202 Accept 任务提交成功，当前系统繁忙，下发的任务会延迟处理。 204 No Content 请求已成功，无内容返回。 300 multiple choices 被请求的资源存在多个可供选择的响应。 400 Bad Request 请求参数有误。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 服务器已经理解请求，但是拒绝执行它。 404 Not Found 资源不存在，资源未找到。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 服务内部错误。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。 父主题： 附录

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 registration_group_name String 注册组名称。 最小长度：1 最大长度：256 provision_info UpdateProvisionInfo object 修改设备发放信息结构体。 表6 UpdateProvisionInfo 参数 参数类型 描述 allocation_strategy_type String 策略类型。目前支持静态策略(base)，证书策略(certificates)和自定义策略(functions) 缺省值：functions certificate_id String 证书id。使用第三方上传CA，证书ID为设备发放服务生成的证书id，使用云证书CA，证书ID为云证书服务生成的证书ID。 最小长度：0 最大长度：256 func_urn String 函数的URN（Uniform Resource Name），唯一标识函数。 最小长度：1 最大长度：360 auth_type String 认证类型 init_config String 注册组的初始化配置。必须为json字符串 最小长度：1 最大长度：65535

请求示例 { "registration_group_name" : "test_group", "provision_info" : { "certificate_id" : "2b31ed520ebedb6e57", "allocation_strategy_type" : "functions", "func_urn" : "urn:fss:xxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test", "init_config" : "{\"properties\": \"khfkfj\"}" }}

URI PUT /v5/iotps/{project_id}/registration-groups/{registration_group_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 最小长度：1 最大长度：32 registration_group_id 是 String 注册组id，用于唯一标识一个注册组 最小长度：1 最大长度：256

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 registration_group_name 是 String 注册组名称。 最小长度：1 最大长度：256 provision_info 是 ProvisionInfo object 修改设备发放信息结构体。 表4 ProvisionInfo 参数 是否必选 参数类型 描述 allocation_strategy_type 是 String 策略类型。目前支持静态策略(base)，证书策略(certificates)和自定义策略(functions) 缺省值：functions certificate_id 否 String 证书id。使用第三方上传CA，证书ID为设备发放服务生成的证书id，使用云证书CA，证书ID为云证书服务生成的证书ID。 最小长度：0 最大长度：256 func_urn 否 String 函数的URN（Uniform Resource Name），唯一标识函数。 最小长度：1 最大长度：360 init_config 否 String 注册组的初始化配置。必须为json字符串 最小长度：1 最大长度：65535

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 authorizing_domain_id 否 String 授权租户的账户ID access_point_id 是 String 接入点id。 最小长度：1 最大长度：256 product_id 否 String 产品ID，用于唯一标识一个产品，在物联网平台的SP Portal上导入产品模型后由平台分配获得。使用自定义策略场景需要填该字段，非自定义策略不用填该字段 region_id 否 String 区域ID，用于区分不同的区域。 app_id 否 String 应用ID。此参数为非必选参数，用于兼容平台老用户存在多应用的场景。存在多应用的用户需要使用该接口时，可以携带该参数查询指定应用下的设备列表，不携带该参数则会查询该用户下所有设备列表。 最小长度：1 最大长度：256

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 device_id String 设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。（生成规则为"product_id" + "_" + "node_id"拼接而成） 最小长度：0 最大长度：256 node_id String 设备标识码，通常使用IMEI、MAC地址或Serial No作为nodeId。 最小长度：0 最大长度：64 gateway_id String 网关ID，用于标识一个网关设备。当设备是直连设备时，gatewayId与设备的deviceId一致。当设备是非直连设备时，gatewayId为设备所关联的直连设备（即网关）的deviceId。 最小长度：0 最大长度：256 device_name String 设备名称。 最小长度：0 最大长度：256 node_type String 设备节点类型。 ENDPOINT：非直连设备。 GATEWAY：直连设备或网关。 UNKNOWN：未知。 description String 设备的描述信息。 最小长度：0 最大长度：2048 auth_info AuthInfo object 设备的接入认证信息。 product_id String 设备关联的产品ID，用于唯一标识一个产品模型。 product_name String 设备关联的产品名称。 最小长度：1 最大长度：255 protocol_type String 设备关联的产品协议类型。 create_time String 在物联网平台注册设备的时间。 最小长度：0 最大长度：128 provision_info ProvisionInfoBaseResp object 设备的发放信息。 表5 AuthInfo 参数 参数类型 描述 auth_type String 鉴权类型。支持秘钥认证接入(SECRET)和证书认证接入(CERTIFICATES)。使用秘钥认证接入方式(SECRET)填写secret字段，使用证书认证接入方式(CERTIFICATE)填写fingerprint字段，如果CA证书选择云证书管理服务的CA证书，不需要填写fingerprint字段，需要填写设备证书名称字段，不填写auth_type默认为秘钥认证接入方式(SECRET) secret String 设备秘钥，认证类型使用秘钥认证接入(SECRET)可填写该字段。注意：NB设备秘钥由于协议特殊性，只支持十六进制秘钥接入。 最小长度：8 最大长度：32 fingerprint String 证书指纹，认证类型使用证书认证接入(CERTIFICATES)可填写该字段，注册设备时不填写该字段则取第一次设备接入时的证书指纹。注意：指纹只能为40位十六进制字符串或者64位十六进制字符串。 device_cert_name String 设备证书名称，CA证书选择云证书管理服务的CA证书接入需要填写该字段。此名称会也即设备证书使用者的CommanName device_cert_validity Integer 生成设备证书的有效期。CA证书选择云证书管理服务的CA证书可填写该字段。 最小值：1 最大值：10 device_cert_id String 设备证书id，设备采用云证书管理服务的CA注册，云证书管理服务生成的设备证书的唯一实例ID secure_access Boolean 指设备是否通过安全协议方式接入，默认值为true。 true：通过安全协议方式接入。 false：通过非安全协议方式接入。 缺省值：true timeout Integer 设备验证码的有效时间，单位：秒，默认值：0 若设备在有效时间内未接入物联网平台并激活，则平台会删除该设备的注册信息。若设置为“0”，则表示设备验证码不会失效（建议填写为“0”）。 缺省值：0 表6 ProvisionInfoBaseResp 参数 参数类型 描述 access_point AccessPointResp object 发放区域。 app_info ApplicationResp object 所属应用。 cert_name String CA证书名称。设备认证类型为证书认证时返回。 最小长度：0 最大长度：256 allocation_status Integer 设备发放状态。 取值如下： 0：成功； 1：失败； 2：发放中； 3：未发放（默认）。 最小值：0 最大值：3 allocation_strategy_type String 策略类型。 取值如下： base：静态策略； certificates：证书策略； functions：自定义策略； nearby：就近策略； migrations: 指定迁移策略。 缺省值：base life_time Integer LWM2M设备导入的默认生命周期。 最小值：0 最大值：864000 init_config String 设备的初始化配置。 最小长度：1 最大长度：65535 表7 AccessPointResp 参数 参数类型 描述 access_point_id String 接入点id。 最小长度：1 最大长度：256 access_point_name String 接入点名称。 最小长度：1 最大长度：256 region_id String 华为云终端节点ID。节选自https://developer.huaweicloud.com/endpoint。 最小长度：1 最大长度：128 表8 ApplicationResp 参数 参数类型 描述 app_id String 应用id。 最小长度：1 最大长度：64 app_name String 应用名称。 最小长度：1 最大长度：256

响应示例 状态码： 200 OK { "device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "node_id" : "ABC123456789", "gateway_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "device_name" : "dianadevice", "node_type" : "ENDPOINT", "description" : "watermeter device", "auth_info" : { "auth_type" : "SECRET", "secret" : "3b935a250c50dc2c6d481d048cefdc3c", "fingerprint" : "dc0f1016f495157344ac5f1296335cff725ef22f", "secure_access" : true, "timeout" : 300 }, "product_id" : "b640f4c203b7910fc3cbd446ed437cbd", "create_time" : "20190303T081011Z", "provision_info" : { "access_point" : { "access_point_id" : "cn-north-4", "access_point_name" : "cn-north-4" }, "region_id" : "cn-north-4", "allocation_status" : 0, "allocation_strategy_type" : "base" }}

请求示例 发放设备（非自定义策略） POST https://{endpoint}/v5/iotps/{project_id}/devices/d4922d8a-6c8e-4396-852c-164aefa6638f/allocation{ "access_point_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "region_id" : "cn-north-4", "app_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f"} 发放设备（自定义策略） POST https://{endpoint}/v5/iotps/{project_id}/devices/d4922d8a-6c8e-4396-852c-164aefa6638f/allocation{ "access_point_id":"d4922d8a-6c8e-4396-852c-164aefa6638f", "product_id": "98cabff1-0112-4e63-ba59-a505aea5ebef" "region_id":"cn-north-4", "app_id":"d4922d8a-6c8e-4396-852c-164aefa6638f"}

URI POST /v5/iotps/{project_id}/devices/{device_id}/allocation 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度：1 最大长度：32 device_id 是 String 设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。（生成规则为"product_id" + "_" + "node_id"拼接而成） 最小长度：1 最大长度：128

URI DELETE /v5/iotps/{project_id}/devices/{device_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度：1 最大长度：32 device_id 是 String 设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。（生成规则为"product_id" + "_" + "node_id"拼接而成） 最小长度：1 最大长度：128

请求示例 { "registration_group_name" : "test_group", "provision_info" : { "auth_type" : "SECRET", "register_group_secret" : "faertyhb5rthjk_3bnr224-vjbdsrhfjuASF", "allocation_strategy_type" : "base", "init_config" : "{\"properties\": \"khfkfj\"}" }}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 registration_group_name 是 String 注册组名称。 最小长度：1 最大长度：256 provision_info 是 AddProvisionInfo object 新增设备组，设备的发放信息。 表4 AddProvisionInfo 参数 是否必选 参数类型 描述 allocation_strategy_type 是 String 策略类型。目前支持静态策略(base)，证书策略(certificates)和自定义策略(functions) 缺省值：functions certificate_id 否 String 证书id。使用第三方上传CA，证书ID为设备发放服务生成的证书id，使用云证书CA，证书ID为云证书服务生成的证书ID。 最小长度：0 最大长度：256 func_urn 否 String 函数的URN（Uniform Resource Name），唯一标识函数。 最小长度：1 最大长度：360 auth_type 否 String 认证类型 register_group_secret 否 String 设备组密钥，设置该字段时平台将设备密钥置为指定值，若不设置则由平台自动生成。 最小长度：44 最大长度：172 init_config 否 String 注册组的初始化配置。必须为json字符串 最小长度：1 最大长度：65535

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 对设备执行的操作，当前仅支持： resetDeviceSecret：重置秘钥。应用服务器可调用此接口重置设备秘钥，携带指定秘钥时平台将设备秘钥重置为指定的秘钥，不携带秘钥时平台将自动生成一个新的随机秘钥返回。注意：NB设备秘钥由于协议特殊性，只支持十六进制秘钥接入。 triggerBootstrapDevice：重引导设备。应用服务器可调用此接口重引导设备，平台向设备下发重引导命令，通知已发放的设备重引导。注意：当前命令通道为同步命令通道。 reset_device_secret 否 ResetDeviceSecret object 表4 ResetDeviceSecret 参数 是否必选 参数类型 描述 secret 是 String 设备秘钥，设置该字段时平台将设备秘钥重置为指定值，若不设置则由平台自动生成。 最小长度：8 最大长度：32

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 reset_device_secret DeviceSecret object 表6 DeviceSecret 参数 参数类型 描述 device_id String 设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 最小长度：0 最大长度：256 secret String 设备秘钥。 最小长度：8 最大长度：32

URI DELETE /v5/iotps/{project_id}/registration-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 最小长度：1 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 registration_group_name 是 String 注册组名称。 最小长度：1 最大长度：256

请求示例 操作设备（重引导设备） POST https://{endpoint}/v5/iotps/{project_id}/devices/d4922d8a-6c8e-4396-852c-164aefa6638f/action{ "action" : "allocateDevice"} 操作设备（重置设备密钥） POST https://{endpoint}/v5/iotps/{project_id}/devices/d4922d8a-6c8e-4396-852c-164aefa6638f/action{ "action" : "resetDeviceSecret", "reset_device_secret" : { "secret" : "3b935a250c50dc2c6d481d048cefdc3c" }}

URI DELETE /v5/iotps/{project_id}/allocation-strategies/{strategy_type}/{strategy_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度：1 最大长度：32 strategy_type 是 String 策略类型。支持静态策略(base)、证书策略(certificates)、自定义策略(functions)多种策略类型。 缺省值：base strategy_id 是 String 策略ID。 最小长度：1 最大长度：36

URI POST /v5/iotps/{project_id}/devices/{device_id}/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度：1 最大长度：32 device_id 是 String 设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。（生成规则为"product_id" + "_" + "node_id"拼接而成） 最小长度：1 最大长度：128

错误码说明 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 IoTDP.100001 The resource size exceed the limit. 文件大小超出限制 请上传大小满足要求的文件 400 IoTDP.100002 The resource-suffix is wrong. 文件后缀错误 请确认文件类型是否正确，并上传文件类型满足要求的文件 400 IoTDP.100101 User not found. 用户不存在 请确认用户信息是否填写正确 400 IoTDP.100102 the user not available. 用户当前不可用 请确认用户状态是否可用 400 IoTDP.100104 password must meet complexity requirements. 密码复杂度不满足要求 请确认密码是否满足复杂度要求 400 IoTDP.100105 username already exists. 用户已存在 请确认用户是否已存在 400 IoTDP.100106 user need update password. 密码需要更新 请及时更新密码 400 IoTDP.100109 NO BEAR TYPE AUTHORIZATION HEADER 无头部凭证类型 请确认凭证是否有效 400 IoTDP.100110 WRONG TOKEN TYPE. 凭证类型错误 请确认凭证类型是否正确 400 IoTDP.100121 length of userId must not be empty and within 128. 用户ID长度不能为空且不大于128个字符 请确认用户信息是否正确 400 IoTDP.100202 Invalid input device name. 设备名称非法 请填写正确的设备名称 400 IoTDP.100203 Exceed device num of batch reg 超出批量注册设备数量限制 请检查模板内的设备数量是否超出限制 400 IoTDP.100204 Invalid input. The device already exists. 设备已存在 请确认设备信息填写是否正确 400 IoTDP.100205 LWM2M safety devices psk or bootstrapPsk is empty. LWM2M设备PSK填写错误 请确认设备秘钥是否填写正确 400 IoTDP.100206 Secret auth device cannot use certificates strategy. 密钥认证设备无法使用证书策略 请确认设备的策略类型和认证方式的正确性 400 IoTDP.100210 Device not exists. 设备不存在 请确认设备信息填写是否正确 400 IoTDP.100211 node id already exists. 设备标识码已存在 请确认设备信息填写是否正确 400 IoTDP.100212 Device cannot update. 设备信息不可更新 当前设备信息不可更新 400 IoTDP.100213 delete device on iothub failed. 删除设备失败 请联系服务管理员 400 IoTDP.100214 device reg template file is invalid. 设备注册模板不合法 请确认设备注册模板是否正确 400 IoTDP.100215 cert name is exist 证书名已存在 请确认证书信息是否正确 400 IoTDP.100216 certificate parsing error 证书解析失败 请确认证书内容是否正确 400 IoTDP.100217 certificate already exists 证书已存在 请更换证书 400 IoTDP.100218 certificate already use 证书正在使用，不可删除 当前证书不可删除 400 IoTDP.100219 cert's number exceeding the limit. 证书数量超出限制 请确认是否超出限制 400 IoTDP.100220 cert is not exist. 证书不存在 请确认证书信息是否正确 400 IoTDP.100221 certificate is not in the certificate center 证书在证书中心不存在 请联系服务管理员 400 IoTDP.100222 set hashvalue failed. input is invalid or hashflag not open. 设置hash值失败，输入无效或hash开关未打开 请确认设备证书hash是否正确或hash开关是否打开 400 IoTDP.100223 get cert from cert center failed。 从证书中心获取证书失败 请联系服务管理员 400 IoTDP.100224 response error from cert center. 证书中心返回失败 请联系服务管理员 400 IoTDP.100225 verify CA cert by certificate error. 证书校验失败 请确认证书是否正确 400 IoTDP.100226 cert commonName is null. 证书CommonName为空 请检查使用的证书的CommonName是否为空 400 IoTDP.100301 product not exist. 产品不存在 请确认产品信息是否填写正确 400 IoTDP.100302 the product has been used. 产品正在使用，不可删除 当前产品不可删除 400 IoTDP.100303 The product already exists. 产品已存在 请确认产品信息是否填写正确 400 IoTDP.100304 Private product install failed. 私有产品安装失败 请联系服务管理员 400 IoTDP.100305 Product install failed. 产品安装失败 请联系服务管理员 400 IoTDP.100306 Create product in iotdm error. 接入点创建产品失败 请联系服务管理员 400 IoTDP.100401 strategy case already exists. 策略实例已存在 请确认策略信息是否填写正确 400 IoTDP.100402 release task not exist. 发放任务不存在 请确认发放任务是否存在 400 IoTDP.100403 task cannot stop. 任务不能启动 请确认任务状态是否正常 400 IoTDP.100404 STRATEGY_NOT_EXIST. 策略不存在 请确认策略信息是否填写正确 400 IoTDP.100405 TASK_CANNOT_START. 任务不能启动 请确认任务状态是否正常 400 IoTDP.100406 access_point not exist. 接入点不存在 请填写正确的接入点信息 400 IoTDP.100407 strategy exceed limit:0-20. 策略数量超出限制 请确认是否超出限制 400 IoTDP.100408 access point not exist or not active. 接入点不存在或未激活 请填写正确的接入点信息 400 IoTDP.100410 strategy type is invalid. 策略类型无效 请填写正确的策略类型 400 IoTDP.100411 function urn not exist. 函数不存在 请填写正确的函数信息 400 IoTDP.100412 function urn is exist by this domain. 函数名已存在 请填写正确的函数信息 400 IoTDP.100413 strategy already used by device or register group. 策略实例使用中 请确认该策略实例是否已被设备或注册组使用 400 IoTDP.100414 there is no strategy matching device. 未匹配到策略实例 请确认是否存在能够被设备匹配到的策略实例 400 IoTDP.100415 there is no strategy of this type. 该策略类型无策略实例 请检查该策略类型是否存在可用的策略实例 400 IoTDP.100501 IoTHub server exception. 设备管理服务内部异常 请联系服务管理员 400 IoTDP.100502 Current access points have no available applications 当前接入点无可用应用 请联系服务管理员 400 IoTDP.100503 app info not right. 应用信息填写错误 请填写正确的应用信息 400 IoTDP.100505 Reset DeviceFingerprint is fail. 向 设备接入服务 重置设备证书指纹失败 请联系服务管理员 400 IoTDP.100701 ResourceManager Region server exception. 查询可用区域异常 请联系服务管理员 400 IoTDP.100702 ResourceManager Region AppCode is null or empty 查询可用区域异常 请联系服务管理员 400 IoTDP.100901 captcha is error 短信验证码校验失败 请确认短信验证码是否正确 400 IoTDP.100902 captcha is invalid 短信验证码已失效 请确认短信验证码的时效 400 IoTDP.100903 captcha's number exceeding the limit 验证码发送次数已达上限 请稍后重试 400 IoTDP.100906 address is null 服务与消息中心交互异常 请联系服务管理员 400 IoTDP.100907 build captcha fail 发送验证码失败 请联系服务管理员 400 IoTDP.100908 already has a captcha 验证码已发送 请查收已发送的验证码 400 IoTDP.100909 authorizing user not found. 授权租户不存在 请确认授权租户是否存在 400 IoTDP.100910 authorizing user not available. 授权租户状态不可用 请确认授权租户是否可用 400 IoTDP.100911 send captcha count exceeding the limit.try again in a minute 发送的验证码数量超过限制。请在一分钟后重试 请在一分钟后重试 400 IoTDP.102001 jwt token is illegal JWT凭证无效 请确认凭证是否有效 400 IoTDP.104601 device can't support bootstrap parameter,please change profile 设备不支持引导参数，请修改设备Profile 请修改设备Profile 400 IoTDP.104603 only allocated device can trigger bootstrap 已发放设备才能重引导 请确认设备是否已发放 400 IoTDP.104701 flow control user info is not exist 用户不存在流控信息 请确认用户是否存在流控信息 400 IoTDP.104702 flow control info is not exist 流控信息不存在 请确认是否已存在该流控信息 400 IoTDP.104703 consoleUser is not administrator account 用户不为流控管理员用户 请联系服务管理员 400 IoTDP.104704 consoleUser is exist 用户流控信息已存在 请确认用户是否已存在流控信息 400 IoTDP.104801 register_group is exist 注册组已存在 请确认注册组信息填写是否正确 400 IoTDP.104802 register_group not exist. 注册组不存在 请确认注册组是否存在 400 IoTDP.104803 register_group 's number exceeding the limit. 注册组数量已达上限 请确认注册组数量是否已达上限 400 IoTDP.104804 cert is used by register_group 证书已被注册组使用 请确认证书是否已被注册组关联 400 IoTDP.104805 only support functions 仅支持自定义策略 请确认策略类型是否正确 400 IoTDP.104806 register_group's cert is not exist 注册组关联的CA证书不存在 请确认注册组关联的证书是否存在 400 IoTDP.104807 initConfig is not json 初始化配置信息格式不为JSON 请确认填入的初始化配置信息格式是否正确 400 IoTDP.104901 cloudCertificates address is empty 服务与云证书服务交互异常 请联系服务管理员 400 IoTDP.104902 get cloud CA Certificates exceptions 向云证书服务获取CA证书失败 请联系服务管理员 400 IoTDP.104903 creat cloud device Certificates exceptions 向云证书服务创建设备证书失败 请联系服务管理员 400 IoTDP.104904 device cert name is exist 设备证书名已存在 请确认设备证书名填写是否正确 400 IoTDP.104905 delete cloud device Certificates exceptions 向云证书服务删除设备证书失败 请联系服务管理员 400 IoTDP.104906 device cert Validity is bad 设备证书有效期填写错误 请确认设备证书有效期是否符合要求 400 IoTDP.104907 device cert is not exist 设备证书不存在 请确认设备证书是否存在 400 IoTDP.105001 Authorization is not exist 授权关系不存在 请确认授权关系是否存在 400 IoTDP.105002 Authorization is existed 授权关系已存在 请确认授权关系是否已存在 400 IoTDP.105003 authorizee and authorizer are the same 授权租户和被授权租户不能相同 请确认授权租户和被授权租户填写是否正确 400 IoTDP.105004 authorizingDomainId and authorizingUserName is null 授权租户的账号名和账号ID均为空 请填写正确的账号名或账号ID 400 IoTDP.105005 Authorization is not enabled 授权关系不可用 请确认授权关系是否已启用 400 IoTDP.105006 authorized user is not allowed to modify 被授权用户不允许修改授权关系 请确认当前登录用户是否是授权用户 400 IoTDP.200001 Request parameter is invalid 参数无效 请确认输入参数是否正确 400 IoTDP.200007 request exceed limit 请求超出限制 请稍后尝试 401 IoTDP.100107 NO AUTHORIZATION HEADER HTTP头缺少鉴权信息 请确认头部鉴权信息是否填写正确 401 IoTDP.100108 INVALID AUTHORIZATION HEADER 头部鉴权信息非法 请确认头部鉴权信息是否填写正确 401 IoTDP.200003 sys bad request 系统内部错误 请联系服务管理员 403 IoTDP.100103 user and password not match. 用户名或用户密码不匹配 请填写正确的用户名和密码 403 IoTDP.100122 requested project not valid in IoTProvisioning. 请求的项目ID与服务开通的项目ID不匹配 请联系服务管理员 403 IoTDP.104420 project in token not match the requested project 请求的项目与用户token中携带的项目信息不匹配 请确认项目信息或token信息填写是否正确 403 IoTDP.104421 user in token not match user in request 权限错误 请检查权限是否正确 404 IoTDP.104437 agency not exist 委托不存在 请确认委托是否已建立 500 IoTDP.100201 Cannot fetch template file. 获取模板文件失败 请联系服务管理员 500 IoTDP.100230 push cert to iothub error. 发放证书失败 请联系服务管理员 500 IoTDP.100310 Product center server exception 产品中心服务不可用 请联系服务管理员 500 IoTDP.100409 Fail to query access point by device ip. 根据设备IP查询设备接入点失败 请联系服务管理员 500 IoTDP.100504 get app info from iothub error. 获取应用信息失败 请联系服务管理员 500 IoTDP.100601 Call APIG exception. 服务与APIG交互异常 请联系服务管理员 500 IoTDP.100703 ResourceManager Region Request, the domainId or accessPointId is null 查询可用区域参数错误 请联系服务管理员 500 IoTDP.102002 jwt token address is empty 服务与APIGW交互异常 请联系服务管理员 500 IoTDP.102003 jwt token getting exceptions 服务与APIGW交互异常 请联系服务管理员 500 IoTDP.102004 jwt public key analytical error 服务与APIGW交互异常 请联系服务管理员 500 IoTDP.102005 jwt token is invalid JWT凭证无效 请确认凭证是否有效 500 IoTDP.102006 jwt token is expired JWT凭证已失效 请确认JWT凭证的有效性 500 IoTDP.102010 get jwk error 服务与APIGW交互异常 请联系服务管理员 500 IoTDP.102011 get jwk exception 服务与APIGW交互异常 请联系服务管理员 500 IoTDP.102012 get jwk response error 服务与APIGW交互异常 请联系服务管理员 500 IoTDP.103000 invalid IAM service 服务与IAM交互异常 请联系服务管理员 500 IoTDP.103001 invalid token 不合法的token 请确认token填写正确 500 IoTDP.103002 empty token token为空 请确认token填写正确 500 IoTDP.103003 error token token错误 请确认token填写正确 500 IoTDP.104401 send get CA pem request error 服务与IAM交互异常 请联系服务管理员 500 IoTDP.104402 get CA pem response error 服务与IAM交互异常 请联系服务管理员 500 IoTDP.104403 send get iam signing pem request error 服务与IAM交互异常 请联系服务管理员 500 IoTDP.104404 send get iam signing pem request error 服务与IAM交互异常 请联系服务管理员 500 IoTDP.104411 verify token failed 校验token失败 请联系服务管理员 500 IoTDP.104412 resign token request failed 换取token失败 请联系服务管理员 500 IoTDP.104413 resign token response error 换取token失败 请联系服务管理员 500 IoTDP.104414 token does not have any user info token内无用户信息 请确认token填写正确 500 IoTDP.104415 token does not have any project info token内无项目信息 请确认token填写正确 500 IoTDP.104416 token does not have any domain info token内无账户信息 请确认token填写正确 500 IoTDP.104417 get token request failed 获取IAM token失败 请联系服务管理员 500 IoTDP.104418 get token response error 获取IAM token失败 请联系服务管理员 500 IoTDP.104419 response have no x-subject-token header 响应中无x-subject-token 请联系服务管理员 500 IoTDP.104431 send agency create request failed 创建委托失败 请联系服务管理员 500 IoTDP.104432 create agency failed 创建委托失败 请联系服务管理员 500 IoTDP.104433 send agency delete request failed 删除委托失败 请联系服务管理员 500 IoTDP.104434 send agency token get request failed 获取委托Token失败 请联系服务管理员 500 IoTDP.104435 get agency token failed 获取委托Token失败 请联系服务管理员 500 IoTDP.104436 query agency detail by id failed 查询委托Token失败 请联系服务管理员 500 IoTDP.104438 agency already expired 委托已过期 请重新创建委托 500 IoTDP.104441 query role list error 查询IAM系统角色失败 请联系服务管理员 500 IoTDP.104442 grant role to agency error 授予委托权限失败 请联系服务管理员 500 IoTDP.104443 query policy list error 获取委托权限失败 请联系服务管理员 500 IoTDP.104444 query agency roles list error 获取委托权限失败 请联系服务管理员 500 IoTDP.104445 could not find agency error 校验委托权限失败 请联系服务管理员 500 IoTDP.104501 function address is empty 服务与函数服务交互异常 请联系服务管理员 500 IoTDP.104502 function getting exceptions 调用函数服务失败 请联系服务管理员 500 IoTDP.104503 get function graph admin role error 获取函数服务管理员权限失败 请联系服务管理员 500 IoTDP.104504 get function graph policies error 获取函数服务/设备接入服务角色失败 请联系服务管理员 500 IoTDP.104505 get function graph agency roles error 创建函数服务委托角色失败 请联系服务管理员 500 IoTDP.104602 BootStrap error 重引导失败 请联系服务管理员 500 IoTDP.200002 System runtime exception. 系统内部错误 请联系服务管理员 500 IoTDP.200004 proxy host exception 内部网络配置错误 请联系服务管理员 500 IoTDP.200005 IOM Internal server error. 内部服务错误 请联系服务管理员 500 IoTDP.200006 sys iom disconnected exception 内部网络连接错误 请联系服务管理员

响应示例 状态码： 200 OK 示例 1 { "device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "node_id" : "ABC123456789", "gateway_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "device_name" : "dianadevice", "node_type" : "ENDPOINT", "description" : "watermeter device", "auth_info" : { "auth_type" : "SECRET", "secret" : "3b935a250c50dc2c6d481d048cefdc3c", "fingerprint" : "dc0f1016f495157344ac5f1296335cff725ef22f", "secure_access" : true, "timeout" : 300 }, "product_id" : "b640f4c203b7910fc3cbd446ed437cbd", "create_time" : "20190303T081011Z", "provision_info" : { "access_point" : { "access_point_id" : "cn-north-4", "access_point_name" : "cn-north-4", "region_id" : "cn-north-4" }, "allocation_status" : 0, "allocation_strategy_type" : "base", "life_time" : 84600 }} 示例 2 { "device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "node_id" : "ABC123456789", "gateway_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "device_name" : "dianadevice", "node_type" : "ENDPOINT", "description" : "watermeter device", "auth_info" : { "auth_type" : "SECRET", "secret" : "3b935a250c50dc2c6d481d048cefdc3c", "fingerprint" : "dc0f1016f495157344ac5f1296335cff725ef22f", "secure_access" : true, "timeout" : 300 }, "product_id" : "b640f4c203b7910fc3cbd446ed437cbd", "create_time" : "20190303T081011Z", "provision_info" : { "access_point" : { "access_point_id" : "cn-north-4", "access_point_name" : "cn-north-4", "region_id" : "cn-north-4" }, "allocation_status" : 0, "allocation_strategy_type" : "certificates", "life_time" : 84600 }} 示例 3 { "device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "node_id" : "ABC123456789", "gateway_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "device_name" : "dianadevice", "node_type" : "ENDPOINT", "description" : "watermeter device", "auth_info" : { "auth_type" : "SECRET", "secret" : "3b935a250c50dc2c6d481d048cefdc3c", "fingerprint" : "dc0f1016f495157344ac5f1296335cff725ef22f", "secure_access" : true, "timeout" : 300 }, "product_id" : "b640f4c203b7910fc3cbd446ed437cbd", "create_time" : "20190303T081011Z", "provision_info" : { "access_point" : { "access_point_id" : "cn-north-4", "access_point_name" : "cn-north-4", "region_id" : "cn-north-4" }, "allocation_status" : 0, "allocation_strategy_type" : "functions", "life_time" : 84600 }}