华为云用户手册

错误码 HTTP状态码 HTTP状态码描述 错误码 错误码描述 错误码中文描述 400 Bad Request IOTDA.000006 Invalid input data. 请求参数不合法 401 Unauthorized IOTDA.000002 The request is unauthorized. 鉴权失败 403 Forbidden IOTDA.021101 Request reached the maximum rate limit. 请求已经达到限制速率 IOTDA.021102 The request rate has reached the upper limit of the tenant, limit %s. 请求已经达到租户的限制速率

请求参数 名称 必选 类型 位置 说明 device_id 是 String Body 参数说明: 设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为"product_id" + "_" + "node_id"拼接而成。 取值范围: 长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。 取值范围: 长度1-128 sign_type 是 Integer Body 参数说明: 密码校验方式: 0 代表HMACSHA256校验时间戳时不会校验消息时间戳与平台时间是否一致，仅判断密码是否正确; 1 代表HMACSHA256校验时间戳时会先校验消息时间戳与平台时间是否一致，再判断密码是否正确。 取值范围: 大小0~1 timestamp 是 String Body 参数说明: 时间戳：为设备连接平台时的UTC时间，格式为YYYYMMDDHH，如UTC 时间2018/7/24 17:56:20 则应表示为2018072417。 取值范围: 固定长度10 password 是 String Body 参数说明: password的值为使用“HMACSHA256”算法以时间戳为密钥，对secret进行加密后的值。secret为注册设备时平台返回的secret。 取值范围: 固定长度64

请求示例 POST https://{endpoint}/v5/device-auth Content-Type: application/json { "device_id" : "60a87ffebaccd902c2f1abbb_0001", "sign_type" : 0, "timestamp" : "2019120219", "password" : "******" }

接口说明 设备鉴权接口，鉴权通过后建立设备与平台间才能处理业务连接。鉴权成功后平台返回access_token。调用属性上报、消息上报等其他接口时，都需要携带access_token信息。如果access_token超期，需要重新认证设备获取access_token。如果access_token未超期重复获取access_token，老的access_token在未超期前保留30s，30s之后失效。

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 200 IOTDA.014111 Command request timed out. Check whether the device returns a response within the specified time after receiving the request. 同步命令等待设备回复命令响应超时。 该接口为同步接口，需要设备在收到命令后回复命令响应请检查设备收到请求后是否在指定时间内返回响应给平台。 400 IOTDA.000006 Invalid input data. 请求参数不合法。 请排查请求参数是否符合华为云对应接口文档要求。 400 IOTDA.000008 Invalid input. The request format is invalid. For details, see the error message. 请求的格式不正确，如json非法，mediaType不正确等。 请排查该请求的请求格式是否正确。 400 IOTDA.000009 Invalid input. Invalid time format. 时间的格式不正确。 请排查请求参数中时间的格式是否与对应接口文档中的保持一致。 400 IOTDA.000010 Invalid input. The start time must be earlier than the end time. 请求中的开始时间大于结束时间。 请求中开始时间必须早于结束时间。 400 IOTDA.000011 Invalid input. The specified parameter 'pageNo' is out of range. 请求参数中pageNo超出范围。 请排查请求参数中的pageNo大小是否在对应接口文档限制范围之内。 400 IOTDA.000012 Invalid input. The specified parameter 'pageSize' is out of range. 请求参数中pageSize超出范围。 请排查请求参数中的pageSize大小是否在对应接口文档限制范围之内。 400 IOTDA.000013 Invalid input. The value of 'pageSize' multiplying 'pageNo' exceeds the upper limit. 查询范围超过最大限制。 请检查pageSize和pageNo参数的大小。 400 IOTDA.000014 Invalid input. The specified parameter 'nextToken' is out of range. 请求中nextToken参数超过范围。 请排查请求中的nextToken参数是否在对应接口文档的限制范围之内。 400 IOTDA.000017 Invalid input. The specified parameter 'limit' is out of range. 请求中limit参数超过范围。 请排查请中求的limit参数是否在对应接口文档的限制范围之内。 400 IOTDA.000018 Invalid input. The specified parameter 'marker' is out of range. 请求中marker参数超过范围。 请排查请求中的marker参数是否在对应接口文档的限制范围之内。 400 IOTDA.000030 Failed to register the resource in Stage. Please try again later. 注册资源失败。 请稍后重试或联系华为工程师分析解决。 400 IOTDA.000031 Failed to deregister the resource in Stage. Please try again later. 注销资源失败。 请稍后重试或联系华为工程师分析解决。 400 IOTDA.000032 Failed to update the resource in Stage. Please try again later. 修改资源失败。 请稍后重试或联系华为工程师分析解决。 400 IOTDA.001001 Invalid input for this application. 资源空间参数不合法。 请参考华为云文档创建资源空间的请求参数章节。 400 IOTDA.001004 AppId is not in request header. 该用户有多个资源空间的情况下未携带appId访问接口。 请携带对应的appId。 400 IOTDA.001011 Invalid input. The specified parameter 'app_id' is not carried. 未携带参数app_id。 请在请求参数中携带app_id。 400 IOTDA.001012 Invalid input. The appId already exists. 资源空间ID已存在。 请更换资源空间ID。 400 IOTDA.001013 Invalid input. The source and target instance IDs cannot be the same. 源实例ID与目的实例ID不能相同。 请检查实例ID是否正确。 400 IOTDA.004002 Invalid input. The tag_key %s cannot start with 'iot_'. 标签的tag_key不能以iot_开头。 请修改tag_key后进行操作。 400 IOTDA.004003 Invalid input. The tag_key %s does not exist. 不存在此tag_key的标签。 请确认传递的tag_key参数是否正确或是否存在该标签。 400 IOTDA.004004 Invalid input. This tag key %s already exists. 标签的tag_key重复。 请修改tag_key的值后再操作。 400 IOTDA.005002 Upgrade Failed. Invalid device version. 升级失败，设备版本号不合法。 请确认设备上报版本号是否为空。 400 IOTDA.005003 Upgrade failed. Verify device version failed. 升级失败， 版本号校验失败。 请将设备上报的版本号与软固件包的版本号保持一致。 400 IOTDA.005004 Upgrade failed. The current version cannot be upgraded to the target version. 升级失败，当前版本不能升级到目标版本。 请确认设备上报的版本号与软固件包支持的源版本号是否一致。 400 IOTDA.005005 Upgrade failed. Invalid update status. 升级失败, 更新状态非法。 请确认上报的更新状态是否正确。 400 IOTDA.005006 Upgrade Failed. ErrorCode: %s, description : %s. 升级失败。 请确认上报码流是否正确，ErrorCode可参考文档设备上报升级状态 。 400 IOTDA.005007 Upgrade failed. The format of the device data is invalid. 升级失败， 设备上报的数据格式不合法。 请查阅软固件升级 页面并对设备上报数据格式进行排查。 400 IOTDA.005008 Upgrade failed. Reported progress %d%% is invalid. 升级失败， 上报升级进度不在0-100之内。 请将上报升级进度约束在0-100之内。 400 IOTDA.005009 Upgrade failed. Invalid result_code. 升级失败, result_code不合法。 请查阅设备上报升级状态 页面“paras参数列表”部分并对参数result_code进行检查。 400 IOTDA.005010 Upgrade failed. Waiting for %s timed out. 升级失败，等待超时。 请设备及时回响应，由于设备没有及时回响应，导致任务超时失败。 400 IOTDA.005011 Upgrade failed. Send %s command failed. 升级失败，发送命令失败。 请联系华为工程师分析解决。 400 IOTDA.009002 The resource model does not exist. 资源模型不存在。 请确认请求参数中是否携带resource和event，或者notifyType。 400 IOTDA.009004 The subscription subject does not belong to the current application. 该订阅记录不属于当前应用。 请确认订阅记录和应用间的关系是否正确。 400 IOTDA.009005 Invalid request callback URL. 请求中的callbackurl地址不合法。 请求中的callbackurl参数格式可参考文档订阅推送相关问题 。 400 IOTDA.009006 The subscription subject already exists. 该订阅记录已经存在。 该订阅已存在，无需再重复订阅。 400 IOTDA.009007 The request channel is invalid. 请求中channel参数不合法。 请排查请求中的channel参数是否符合对应规则动作/订阅接口文档channel取值要求。 400 IOTDA.009009 The filter is invalid. filter不合法。 请联系华为工程师分析解决。 400 IOTDA.009010 The resource and event do not match. resource和event不匹配。 请排查请求中resource与event参数是否符合对应规则动作/订阅接口文档中的对应关系要求。 400 IOTDA.010000 Invalid input for this rule. 规则参数不合法。 请排查请求参数是否符合华为云文档要求。 400 IOTDA.010001 The rule name already exists. 规则名称已存在。 请换一个规则名称再重试。 400 IOTDA.010004 Invalid parameter in the rule condition. 规则条件不合法。 请求中SQL语句相关参数可参考文档SQL语句。 400 IOTDA.010005 Invalid parameter in the rule action. 规则动作参数不合法。 请排查请求中action参数是否符合华为云文档要求。 400 IOTDA.010006 Duplicate rule condition ID. 规则条件ID重复。 请重新命名规则条件ID后重试。 400 IOTDA.010007 Duplicate rule action ID. 规则动作ID重复。 请重新命名规则动作ID后重试。 400 IOTDA.010008 The device in the rule condition does not exist. 规则条件中对应的设备不存在。 请检查请求参数是否正确或设备在平台是否已经存在。 400 IOTDA.010009 The device in the rule action does not exist. 规则动作中对应的设备不存在。 请检查请求参数是否正确或设备在平台是否已经存在。 400 IOTDA.010010 The device information in the rule condition does not exist. 规则条件中对应的设备信息不存在。 请检查请求参数是否正确或设备在平台是否已经存在。 400 IOTDA.010011 The device information in the rule action does not exist. 规则动作中对应的设备信息不存在。 请检查请求参数是否正确或设备在平台是否已经存在。 400 IOTDA.010012 The tag in the rule condition does not exist. 规则条件中对应的标签不存在。 请检查请求参数是否正确或标签在平台是否已经存在。 400 IOTDA.010013 Invalid rule parameter. 规则参数不合法。 请对请求参数进行校验。 400 IOTDA.010014 Invalid input. The rule action of the DEVICE_ALARM type can be created only in the condition of the DEVICE_DATA type. DEVICE_ALARM类型的规则动作只允许创建在DEVICE_DATA类型的条件中。 请在创建的DEVICE_ALARM类型的规则动作时，将条件类型设置为DEVICE_DATA规则条件。 400 IOTDA.010015 Max rules (10) reached. 用户下规则数量超过上限。 请删除多余的规则后再注册。 400 IOTDA.010016 Invalid input. Only one DEVICE_ALARM rule can be created. DEVICE_ALARM类型规则只允许创建一个。 DEVICE_ALARM类型规则已存在，无需重复注册。 400 IOTDA.010017 Invalid input. The rule condition of the DEVICE_DATA type cannot contain both product_id and device_id. 在DEVICE_DATA类型的规则条件中不能同时存在product_id与device_id。 请确认DEVICE_DATA类型的规则条件中只存在device_id或product_id。 400 IOTDA.010018 Invalid input. Both device_id and product_id in the rule condition of the DEVICE_DATA type are empty. 在DEVICE_DATA类型的规则条件中product_id与device_id同时为空。 请确认DEVICE_DATA类型的规则条件中device_id或product_id仅有一个为空。 400 IOTDA.010019 The rule with the same condition already exists. 该规则条件的规则已经存在。 规则已存在， 无需重复注册。 400 IOTDA.010021 Invalid app_id. app_id不合法。 请确认请求中的app_id是否正确。 400 IOTDA.010022 The rule has no action and cannot be enabled. 该规则没有规则动作， 无法激活。 请通过修改规则的接口为该规则添加规则动作。 400 IOTDA.010023 Duplicate channeldetail in the rule action. 规则动作中的channeldetail重复。 规则已存在，无需重复注册或者删除无用规则后重试。 400 IOTDA.010024 Invalid input. Invalid address. 地址非法。 请排查请求参数是否符合华为云文档要求。 400 IOTDA.010025 Invalid input. Invalid username or password. 用户名或密码不合法。 请排查请求参数username与password是否符合华为云文档要求。 400 IOTDA.010026 Invalid input. The streamId or streamName is empty. 通道ID或通道名不存在。 请排查请求参数streamId与streamName是否符合华为云文档要求。 400 IOTDA.010027 Invalid input. Failed to query the channel. 查询通道失败。 请排查请求参数是否与实际云服务产品参数一致。 400 IOTDA.010028 Invalid input. Invalid log_group_id or log_stream_id. 日志组ID或日志流ID不合法。 请排查请求参数log_group_id与log_stream_id是否符合华为云文档要求。 400 IOTDA.010029 Invalid input. Invalid func_urn. 函数的URN不合法。 请排查请求参数func_urn是否符合华为云文档要求。 400 IOTDA.010030 Invalid input. Connect to the database failed. 流转数据库连接失败。 请排查请求数据库连接参数是否符合华为云文档要求。 400 IOTDA.010031 Invalid input. The table name does not exist. 流转数据库表格不存在。 请排查请求table_name是否符合华为云文档要求。 400 IOTDA.010032 Invalid input. The suffix of the krb_file file is .conf, and the suffix of the keytab_file file is .keytab in the request. 请求krb_file文件后缀名是.conf 并且 请求keytab_file文件后缀名是.keytab。 请排查请求krb_file与keytab_file是否符合华为云文档要求。 400 IOTDA.010033 Invalid input. The credential file does not exist. Kerberos服务凭证不存在。 请排查配置凭证文件是否符合华为云文档要求。 400 IOTDA.010034 Invalid input. Connect to the cloud service failed. 连接云服务失败。 请排查请求参数是否符合华为云文档要求。 400 IOTDA.010035 Invalid input. Max time range (24 hours) exceeded. 超出时间查询范围，最大范围是24小时。 请修改参数后重试。 400 IOTDA.010036 Invalid input. The query time dimension is invalid. 查询时间维度无效。 请修改参数后重试。 400 IOTDA.010038 Invalid input. Connect to database failed due to invalid database info. 动作中的数据库信息不合法。 请排查流转数据库信息是否符合华为云文档要求。 400 IOTDA.010039 Invalid input. Repeated column in the action database. 动作中存在多个转发字段流转到目标数据库的同一个字段。 请排查转存配置中的转发字段是否符合华为云文档要求。 400 IOTDA.010040 Invalid input. Column in the action does not match that in the database. 动作中目标存储字段和流转数据库中的字段不匹配。 请排查流转数据库是否存在转存配置中的目标存储字段。 400 IOTDA.010042 The number of rules in a project has reached the upper limit. 规则数量已经达到上限。 请删除多余的规则后重试。 400 IOTDA.010044 Invalid input. The stack policy already exists. 已存在相同积压策略配置。 积压策略配置已存在，无需重复创建或者删除对应配置后重试。 400 IOTDA.010045 Invalid input. The %s parameter is invalid. 积压策略配置参数不合法。 请排查对应积压策略配置参数是否符合华为云控制台输入要求。 400 IOTDA.010047 Invalid input. The flow control policy is duplicated. 已存在相同流控策略配置。 流控策略配置已存在，无需重复创建或者删除对应配置后重试。 400 IOTDA.010048 Invalid input. The %s parameter is invalid. 流控策略配置参数不合法。 请排查对应流控策略配置参数是否符合华为云控制台输入要求。 400 IOTDA.010050 Invalid input. Invalid address or the topic does not exist. 地址非法或者主题不存在。 请排查请求参数是否符合华为云文档要求。 400 IOTDA.013000 The product does not exist or does not belong to the application. 产品不存在或产品不在指定资源空间下。 请排查请求参数是否正确或产品是否已经在指定资源空间下注册(不指定资源空间时，会在默认资源空间下查找产品)。 400 IOTDA.013001 The serviceType of the product does not exist. 产品服务类型不存在。 请排查该产品是否有服务类型，若没有，可调用修改产品接口添加服务类型。 400 IOTDA.013002 The properties of deviceServiceCapability do not exist. 产品的属性不存在。 请排查该产品是否有属性信息，若没有，可调用修改产品接口添加属性。 400 IOTDA.013003 Operation not allowed. The product is unavailable. 未知的产品类型。 请排查设备是否关联产品， 若没有，可调用修改设备信息接口添加产品ID。 400 IOTDA.013005 The productName has been used in the same application. 该资源空间下产品名已被使用。 请更换产品名重新操作。 400 IOTDA.013008 The product ID has been used in the same application. 该资源空间下productId已被使用。 请更换productId后重试。 400 IOTDA.013010 Invalid input. The content in the product service capability is duplicate. Check the content %s. 产品模型内容有重复的命名信息。 产品模型内容定义重复，请检查。 400 IOTDA.013012 Invalid input. The size of product profile content has reached or exceeded limit. 产品模型内容大小超过了限制。 请将定义的产品模型内容限制在指定范围内。 400 IOTDA.013015 Invalid input. The number of content items %s in the product has reached the limit %s. 无效的输入，产品中的字段超过了限制。 检查产品中的字段数。 400 IOTDA.013501 Invalid input. Invalid topic_short_name. If the value of operation_type is not SUBSCRIBE, the value of topic_short_name cannot contain the number sign (#) or plus sign (+). topic_short_name参数不合法。 请排查请求参数是否符合华为云文档要求。 400 IOTDA.013502 Invalid input. The topic_short_name is duplicated under the same product. 相同产品下topic_short_name参数重复。 请重新填写topic_short_name后重试。 400 IOTDA.014001 Invalid input. The externalId parameter already exists. externalId参数已经存在。 请更换externalId参数后重试。 400 IOTDA.014002 Invalid input. The type of externalId must be String. externalId参数的类型必须是String类型。 请将externalId参数的类型改成String类型。 400 IOTDA.014008 Invalid input. Duplicated nodeId. nodeId已被使用。 请更换nodeId后再重试。 400 IOTDA.014009 Invalid input. Duplicated deviceName. 该资源空间下deviceName已被使用。 请更换deviceName后再重试。 400 IOTDA.014010 Invalid input. The secretDevice cannot be empty when authType is SECRET. 当authType是SECRET时, secretDevice不能为空。 请修改参数后重试。 400 IOTDA.014011 Invalid input. The secretEncryptionType cannot be empty when authType is MQTT. 当authType为MQTT时，secretEncryptionType不能为空。 请修改参数后重试。 400 IOTDA.014012 Invalid input. The pskDevice cannot be empty when authType is PSK. authType为PSK时，pskDevice不能为空。 请修改参数后重试。 400 IOTDA.014013 Invalid input. The SecureAccess (isSecure) must be true. isSecure参数值必须为true。 请将isSecure参数设置成true。 400 IOTDA.014017 Invalid input. The serviceType does not exist. serviceType参数不存在。 请检查serviceType参数与所属产品的serviceType是否相同。 400 IOTDA.014023 Gateway and sensor authentication types are inconsistent. 网关和子设备的认证类型不一致。 请保证网关和子设备的认证类型一致。 400 IOTDA.014025 Invalid input. Invalid serviceId. serviceId不合法。 请排查请求参数serviceId是否符合华为云文档要求。 400 IOTDA.014027 Invalid input. The initialization cannot be empty when mode is INITIALIZATION. mode为INITIALIZATION时initialization参数不能为空。 请联系华为工程师分析解决。 400 IOTDA.014028 Invalid input. The gateway is not online. 网关不在线。 请将网关设备接入后再重试。 400 IOTDA.014031 Invalid input. The device already exists. 设备已存在。 设备ID已存在，请更换参数后再重试，如deviceId。 400 IOTDA.014033 Invalid input. When the product protocol is CoAP, the password must be in hexadecimal format. 产品协议为CoAP时，密码必须为十六进制字符。 请将密码格式改为十六进制的字符。 400 IOTDA.014034 Invalid input. The serviceId or eventType does not match. serviceId或eventType不匹配。 请检查请求参数serviceId与eventType是否与profile中定义的相同。 400 IOTDA.014035 Invalid input. The size of extension_info has reached or exceeded 1 KB. extension_info字段大小超过1K。 请将extension_info参数的大小限制在1K以内。 400 IOTDA.014043 Invalid input. The gateway does not exist. 网关不存在。 请检查请求参数中的gateway_id是否已经在平台注册。 400 IOTDA.014051 Invalid input. The device does not exist or does not belong to the application. 设备不存在或者设备不在指定的资源空间下。 请排查请求参数是否有误并确认是否有在资源空间注册该设备。 400 IOTDA.014100 Invalid command status. 无效的命令状态。 请联系华为工程师解决。 400 IOTDA.014104 The device command cannot be canceled because it has been canceled, executed, or expired. 设备命令已被取消，到期或执行， 无法取消。 请联系华为工程师解决。 400 IOTDA.014105 Invalid parameter 'mode'. mode参数不合法。 请重新确认mode参数填写是否正确，mode值仅可以为null、PASSIVE或者ACTIVE。 400 IOTDA.014107 Invalid input. Invalid parameter 'lifeCycle'. lifeCycle参数不合法。 请联系华为工程师解决。 400 IOTDA.014108 Invalid parameter 'command_name'. command_name参数不合法。 请检查service_id,command_name参数是否与profile中的相一致。 400 IOTDA.014110 Invalid input. The format of parameter 'commandBody' is not JSON. commandBody参数格式不是json格式。 请确认请求中对应的参数paras是json格式。 400 IOTDA.014112 Send to device failed because the device does not subscribe to the topic. 发送到设备失败，设备没有订阅该主题。 请确认设备是否订阅正确的topic。 400 IOTDA.014113 Invalid input. The size of paras has exceeded the upper limit. paras参数大小超过最大值。 请减小请求中paras参数长度。 400 IOTDA.014114 The API does not support MQTT devices. 此接口不支持MQTT协议类型的设备。 请更换为NB设备或使用支持MQTT协议的接口。 400 IOTDA.014115 The API does not support NB-IoT devices. 此接口暂不支持NB-IoT设备。 对于NB-IoT设备，请使用下发异步设备命令接口。 400 IOTDA.014116 Invalid input. The size of request body has exceeded the upper limit. 下发的请求体大小超过最大值。 请减小下发的请求体大小。 400 IOTDA.014130 Invalid input. The messageId of the device is not unique. 请求下发给设备的message_id不唯一，与之前创建的message_id重复。 message_id需要确保唯一，请修改message_id参数。 400 IOTDA.014150 Invalid input. The topic has no permission. 非法的输入，该topic没有订阅的权限。 请检查topic参数，确保topic输入正确且该topic在产品中具备订阅权限或者全部权限。 400 IOTDA.014151 Invalid input. The topic-related parameters in the request are duplicate. 非法的输入， topic相关的参数重复。 请确保请求体中topic字段与topic_full_name字段只有一个被输入。 400 IOTDA.014201 Invalid input. The batch task name already exists. 该任务名已存在。 请更换任务名后重试。 400 IOTDA.014203 Invalid input. The document parameter is invalid. errorMsg : %s. 文档中的参数不合法。 请查阅创建批量任务 页面“请求参数”部分并对参数document进行检查。 400 IOTDA.014204 Invalid input. The targets and targets_filter cannot both be empty. targets和targets_filter参数不能全部为空。 请保证其中一个参数不为空。 400 IOTDA.014205 Invalid input. The key of targets_filter only supports %s. targets_filter参数的key只支持指定类型。 请查阅创建批量任务 页面“请求参数”部分并对参数targets_filter进行检查。 400 IOTDA.014207 Invalid input. The start time cannot be earlier than the current time, and the latest start time cannot exceed %s days. 开始时间不能早于当前时间，最晚启动事件不能超过指定天数。 请查阅创建批量任务 页面“请求参数”部分并对参数schedule_time进行检查。 400 IOTDA.014208 Invalid input. retry_count and retry_interval depend on each other and must be assigned at the same time. retry_count和retry_interval参数互相依赖，并且必须同时分配。 请保证retry_count和retry_interval参数同时不为空。 400 IOTDA.014209 Invalid input. The task cannot be stopped because it is completed or being stopped. 任务不能停止，因为任务已经完成或者正在停止中。 请确认任务是否处于已完成或停止状态。 400 IOTDA.014210 Invalid input. The parameter 'targets_filter' does not support multiple keys. targets_filter参数只支持一个key。 请排查请求参数是否符合华为云文档要求。 400 IOTDA.014216 Invalid input. The task cannot retry because the task has succeeded, stopped, being stopped or is waiting. 任务不能重试，因为任务已经成功、停止、正在停止或者等待中。 请确认任务是否处于成功、停止、正在停止或者等待中。 400 IOTDA.014219 Invalid input. The target is not in the task. 目标不在该任务中。 请确认该目标是否在该任务中。 400 IOTDA.014300 Operation not allowed. The number of certificates has reached the upper limit (%s). 证书数量达到上限。 证书数量已达到上限，请删除无用证书后重试，单租户下证书上限：100。 400 IOTDA.014301 Invalid certificate content. 证书内容不合法。 请检查证书内容是否符合X509格式要求，证书内容解析参考证书内容解析。 400 IOTDA.014302 Invalid input. The certificate (certificate_id: %s) already exists. 证书已存在。 您已上传相同内容证书，无需重复上传。 400 IOTDA.014303 Operation not allowed. Upload certificate failed. 证书上传失败。 请联系华为工程师分析解决。 400 IOTDA.014304 Operation not allowed. Delete certificate failed. 证书删除失败。 请联系华为工程师分析解决。 400 IOTDA.014305 Operation not allowed. Query certificate failed. 证书查询失败。 请联系华为工程师分析解决。 400 IOTDA.014307 Operation not allowed. The certificate failed to verify the verifyCode. 证书验证码校验失败。 校验证书的cn_name与当前CA证书的校验码不一致，请核对后重新生成校验证书认证。 400 IOTDA.014308 Operation not allowed. The certificate failed to verify the path. 校验证书路径失败。 校验证书路径与当前CA证书路径不一致，请确保两者是由同一个CA机构颁发。 400 IOTDA.014309 The certificate is expired or about to expire. The expiry date must be seven days later than current date. 证书即将过期或已过期。 请重新申请有效证书。 400 IOTDA.014310 The size of the certificate file cannot be larger than 1 MB and the file name must match the pattern ^[.a-zA-Z0-9_-]{1,255}$. 证书文件不能大于1MB且文件名必须符合^[.a-zA-Z0-9_-]{1,255}$正则。 请重新上传符合条件的证书。 400 IOTDA.014311 The certificate is in use and cannot be deleted. 该证书正在使用中无法删除。 请解除证书关联后再删除。 400 IOTDA.014312 Invalid input. The certificate scene does not exist. 证书场景不存在。 请确认请求参数是否正确。 400 IOTDA.014313 Invalid input. The certificate scene already exists. 证书场景已存在。 请确认请求参数是否正确。 400 IOTDA.014314 Invalid input. The server certificate does not exist. 服务器证书不存在。 请确认请求参数是否正确。 400 IOTDA.014315 Invalid input. The CA certificate does not exist. CA证书不存在。 请确认请求参数是否正确。 400 IOTDA.014316 Invalid input. Failed to parse the private key and certificate. 私钥与证书解析失败。 请检查私钥与证书是否合法是否匹配。 400 IOTDA.014602 Invalid input. The batch task file name already exists. 批量任务文件名已存在。 请更换文件名后重试。 400 IOTDA.014603 Invalid input. The size of the batch task file exceeds the upper limit. 批量任务文件的大小超过最大限制。 单个批量任务文件的大小最大限制为4M。 400 IOTDA.014604 Invalid input. The number of lines in the batch task file exceeds the upper limit. 批量任务文件行数超过最大限制。 单个批量文件行数最大限制为30000行。 400 IOTDA.014605 Invalid input. The resource-suffix of the batch task file is wrong. 批量任务文件后缀名错误。 请查阅上传批量任务文件页面“请求参数”部分并对参数file进行检查。 400 IOTDA.014606 Invalid input. Invalid batch task file name. 批量任务文件名不合法。 请查阅上传批量任务文件页面“请求参数”部分并对参数file进行检查。 400 IOTDA.014608 Invalid input. The content of batch task file is invalid. 批量任务文件内容不合法。 请排查请求参数是否符合华为云文档要求。 400 IOTDA.014900 Invalid input. The search SQL contains unknown field.%s. 搜索SQL语句包含不识别的字段名。 请检查搜索SQL语句，修正不合法的字段，然后重试。 400 IOTDA.014901 Invalid input.The SQL statement contains invalid parameters.%s. 搜索SQL语句包含不合法的参数，或者数据类型与运算符不匹配。 请检查搜索SQL语句，修正不合法的参数，然后重试。 400 IOTDA.014902 Invalid input.The search SQL is invalid.%s. 搜索SQL语法错误。 请检查搜索SQL语句，参考文档使用正确的语法，然后重试。 400 IOTDA.015100 Invalid input. proxy_name is already exists. 设备代理名已存在。 请更换参数proxy_name后再重试。 400 IOTDA.015300 Invalid input. template_name is already exists. 模板名已存在。 请更换参数template_name后再重试。 400 IOTDA.015305 Invalid input. The field [template_body.resources.device.product_id] does not exist. 指定的产品id不存在。 请排查请求参数是否有误并确认产品id是否存在。 400 IOTDA.016000 Invalid input, The queue name already exist in the same spUserName. 队列名称在该用户下已存在。 请更换队列名称后重试。 400 IOTDA.016004 Invalid queue name. 队列名称不合法。 请排查请求参数是否符合华为云文档要求。 400 IOTDA.016005 Invalid AMQP access configuration. amqp对接配置不合法。 请排查请求参数是否符合华为云文档要求。 400 IOTDA.016006 Invalid HTTP access configuration. http对接配置不合法。 请排查请求参数是否符合华为云文档要求。 400 IOTDA.016008 The integration configuration already exists. 对接配置已存在。 请排查请求参数是否符合华为云文档要求。 400 IOTDA.019304 Invalid input. Invalid obs info. obs信息无效。 请确认请求参数region_name、bucket_name、object_key是否正确。 400 IOTDA.019305 Invalid input. The format of the upgrade package is incorrect. 升级包格式不正确。 请参考华为云文档软固件包上传中升级包格式限制。 400 IOTDA.019306 Invalid input. The upgrade package size exceeds the limit. 升级包大小超过限制。 请参考华为云文档软固件包上传中升级包大小限制。 400 IOTDA.019702 The tunnel has already closed. 隧道已关闭。 隧道已关闭，请重新创建隧道。 400 IOTDA.019708 Failed to deliver tunnel information to the device. 下发隧道配置通知给设备失败。 请确认设备运行正常且订阅了接收隧道通知的主题。 400 IOTDA.021304 The number of device log configurations exceeds the upper limit. 设备日志配置数量超过用户最大配额。 请关闭部分设备设备日志收集，然后再重新开启。 400 IOTDA.021310 Invalid input. The authorizer name is duplicated. 自定义鉴权名称重复。 请确认是否已经创建了相同名称的自定义鉴权器。 401 IOTDA.000002 Authentication failed. 鉴权失败。 请排查请求中的鉴权参数是否携带正确。 401 IOTDA.000025 SP user authentication failed. SP Token鉴权失败。 请检查sp token是否正确。 401 IOTDA.000026 Stage user authentication failed. stage token鉴权失败。 请检查stage token是否正确。 401 IOTDA.001003 Incorrect AppId or secret. 资源空间与密钥不匹配。 请排查该密钥是否正确。 401 IOTDA.014032 Invalid input. The time does not match. 时间不匹配。 请联系华为工程师解决。 401 IOTDA.019704 Invalid tunnel access token. tunnel_access_token不合法。 请确认请求参数是否正确。 401 IOTDA.019705 The tunnel access token is expired. tunnel_access_token已过期。 请重新创建隧道后重试。 403 IOTDA.000004 Invalid access token. 非法token。 请排查请求中的token是否正常。 403 IOTDA.000005 Refresh access token failed. 刷新token失败。 请排查请求中的refreshToken是否正确。 403 IOTDA.000015 The account is frozen. 账户已被冻结。 联系账户负责人进行解冻。 403 IOTDA.000021 Operation not allowed. User not found by IAM token or the authorized user has not subscribed to IoTDA. 没有找到IAM Token所对应的用户信息或该用户没有订阅设备接入服务（IOTDA）。 请排查IAM Token所在用户是否订阅了设备接入服务(IOTDA)。 403 IOTDA.000022 Operation not allowed. The user does not have the permission. 该用户没有权限。 请排查该用户是否有权限访问。 403 IOTDA.000023 Request frequency reached the upper limit %s. 请求已经达到限制速率。 请降低请求频率, 该请求速率已达到限制。 403 IOTDA.000024 Operation not allowed. Only one token is allowed in the request header. 请求头只能放置一个Token域。 请删除多余的token头域。 403 IOTDA.000028 System is being maintained. The configuration cannot be modified. 系统正在维护，请稍后重试。 请稍后重试。 403 IOTDA.000033 Operation not allowed. The current instance does not support the parameter. 当前实例规格不支持此功能参数。 请排查请求参数是否符合华为云文档要求。 403 IOTDA.000034 Operation not allowed. The user does not have the permission. 该用户没有权限。 请排查该用户是否有权限访问。 403 IOTDA.001000 The application does not exist. 该资源空间不存在。 请确定是否已在平台创建资源空间并检查资源空间ID是否正确。 403 IOTDA.001002 Operation not allowed. You do not have the permissions required to access the application. 该应用没有权限访问。 请检查该应用是否已被授权。 403 IOTDA.001005 Operation not allowed. The parameter 'app_id' is not carried, and the authorized user has more than one application. Include the parameter 'app_id', or contact Huawei technical support engineers to merge application data. 该用户下有多个应用的情况下未携带appId访问接口。 请携带对应的appId或联系华为工程师合并应用数据。 403 IOTDA.001006 Operation not allowed. Application not found by authorized user or the authorized user has no application. 用户下没有资源空间或资源空间与用户不匹配。 请排查用户下是否有资源空间或是否有指定的资源空间。 403 IOTDA.001007 Operation not allowed. The application does not belong to the authorized user. 资源空间与用户信息不匹配。 请排查该用户下是否有指定的资源空间。 403 IOTDA.001008 Operation not allowed. The app name already exists. 资源空间名称已存在。 请更换资源空间名称。 403 IOTDA.001009 Operation not allowed. The maximum number of applications has been reached. 资源空间数量已达到上限。 该用户资源空间数量已达到上限，请删掉多余的资源空间后再注册。 403 IOTDA.001010 Operation not allowed. The default app cannot be deleted. 禁止删除默认资源空间。 请修改参数后重试。 403 IOTDA.001014 Operation not allowed. The application does not belong to the authorized instance. 资源空间与实例信息不匹配。 请排查该实例下是否有指定的资源空间。 403 IOTDA.003002 Operation not allowed. The group name already exists. 设备组名称已被使用。 请更换设备组名称后重试，该设备组名称已被使用。 403 IOTDA.003003 Operation not allowed. Max groups (1,000) reached. 设备组数量已达到最大上限1000个。 请删除多余设备组后重试，该设备组数量已达上限。 403 IOTDA.003004 Operation not allowed. Max group depths (5) reached. 该设备组深度已达上限（5），不允许再次注册子设备组。 请更换深度较小的父设备组的ID进行注册，该群组深度已达上限，不允许再注册子群组。 403 IOTDA.003005 Operation not allowed. The device already exists in the group. 该设备在设备组中已存在。 该设备在设备组中已存在，无需再次添加。 403 IOTDA.003006 Operation not allowed. The device does not exist in the group. 该设备在设备组中不存在。 该设备在设备组中不存在，无需删除。 403 IOTDA.003007 Operation not allowed. Max devices (20,000) reached for the group. 设备组中的设备数量达到最大限制20000。 请删除多余设备或更换群组。 403 IOTDA.003008 Operation not allowed. A device can be added to up to 10 groups. 一个设备最多只能添加到10个设备组中。 请将该设备从多余的群组中删除后重试，该设备所在群组已达到最大限制。 403 IOTDA.003009 Operation not allowed. The parent group contains child groups. Delete the child groups and try again. 该设备组为其他设备组的父设备组，若想删除此群组，需先删除其子设备组。 如需删除该设备组，请先删除该群组下的所有子设备组后再执行该操作。 403 IOTDA.003010 Operation not allowed. The group contains devices and cannot be deleted. 该群组下存在设备，禁止删除。 如需删除，请先确保该设备组下的设备无用，删除该设备组下的所有设备后再删除该设备组。 403 IOTDA.003011 Operation not allowed. The group and device do not belong to the same application. 群组和设备不属于同一个资源空间。 请使用相同资源空间下的群组和设备进行操作。 403 IOTDA.004001 Operation not allowed. Max bindable tags (10) reached for the device. 设备绑定的标签数量超过最大限制10。 请删除多余的标签再进行绑定，该设备已绑定标签数达到最大限制。 403 IOTDA.005000 Operation not allowed. Only one task can be started for a device at a time. 一个设备同时只能开启一个任务。 请手动操作任务结束或者等待当前任务完成后再开启另一个任务。 403 IOTDA.005001 Operation not allowed. The protocol of the device does not support upgrade. 该设备的协议类型不支持升级。 请提交工单 联系华为工程师分析解决。 403 IOTDA.009001 Max application subscription records reached. 应用订阅记录数达到上限。 请删除多余订阅记录，该应用订阅数量已达到上限。 403 IOTDA.009008 The maximum number of queries has been reached. 查询数量超过最大限制。 请排查请求参数是否符合华为云文档要求。 403 IOTDA.010003 The number of rules has reached the upper limit. 规则数量已达到上限。 请删除多余的规则后重试。 403 IOTDA.010037 The rule cannot be deleted because actions exist in the rule. 规则中已存在动作，不能删除规则。 请先删除规则动作，再删除规则。 403 IOTDA.010049 Operation not allowed. Total number of flow control policies exceeds the upper limit (4). 流控策略配置数量超过最大限制4。 请删除多余的流控策略配置后重新创建。 403 IOTDA.013004 Operation not allowed. You have no write permission. 您没有可写的权限。 请排查您的产品属性是否是可写的，若不是，可调用修改产品的接口将属性改成可写。 403 IOTDA.013006 The number of products in the application has reached the upper limit. 该资源空间下产品数量达到上限（1000）。 请删除无用的产品后重试。 403 IOTDA.013007 Operation not allowed. The product is in use and cannot be deleted. 产品已被使用，禁止删除。 删除产品需先删除该产品下设备，如需删除，请确保该产品没有关联设备，再重试删除操作。 403 IOTDA.013009 Operation not allowed. The value of default_value must be writable. default_value必须属于可写属性。 请通过修改产品的接口将该属性设置成可写。 403 IOTDA.013011 Operation not allowed. The number of assets properties has reached the upper limit (%s). 产品资产属性定义个数超过上限。 请删除无用的资产属性定义。 403 IOTDA.013013 Operation not allowed. The protocol type cannot be changed to CoAP. 产品协议类型不支持修改为CoAP。 请重新创建CoAP协议类型产品。 403 IOTDA.013503 Operation not allowed. The number of topics in a product exceeds the upper limit (%s). 一个产品下的主题数量超过最大限制。 请删除无用的主题后再重试。 403 IOTDA.014003 Operation not allowed. The number of frozen devices has reached the upper limit. 冻结设备的数量已达到上限。 请将非必须冻结的设备解冻后再次冻结该设备或联系华为工程师处理。 403 IOTDA.014004 Operation not allowed. This device is online. 该操作只允许设备在“离线”状态下执行。 请使设备调整为“离线”状态，再重试操作。 403 IOTDA.014005 Operation not allowed. This device is not active. 该操作只允许在设备激活后执行。 请先将设备激活。 403 IOTDA.014006 Operation not allowed. The secret cannot be reset. 密码无法被重置。 NB设备未使用密钥，无需重置密钥。 403 IOTDA.014007 Operation not allowed. The PSK cannot be reset. PSK无法被重置。 请修改参数后重试。 403 IOTDA.014015 Operation not allowed. The number of concurrent location service requests has exceeded the upper limit. 位置服务请求的并发超过上限。 请降低接口调用频率。 403 IOTDA.014016 Operation not allowed. The device is not online. 该操作只允许设备在线后执行。 请将设备接入后再重试。 403 IOTDA.014018 Operation not allowed. The device has been frozen and cannot be operated. 该设备是冻结状态，不允许操作。 请将设备解冻后再重试。 403 IOTDA.014019 Operation not allowed. The number of devices of the user has reached the upper limit. 用户下的设备数量达到上限。 请删除无用设备或联系华为工程师分析解决。 403 IOTDA.014020 Operation not allowed. The number of devices bound to this application has reached the upper limit. 资源空间下的设备数量超过最大上限。 请删除无用设备或联系华为工程师分析解决。 403 IOTDA.014021 Operation not allowed. The number of devices has reached the upper limit of the package. 套餐下的设备数量超过最大上限。 请删除无用设备或联系华为工程师分析解决。 403 IOTDA.014022 Operation not allowed. The number of license resources has reached the upper limit. 许可证资源数量已达到上限。 请联系华为工程师分析解决。 403 IOTDA.014024 Operation not allowed. The device already has an endpoint. 该网关已关联子设备，无法直接删除。 删除网关前，必须删除其关联的子设备，如需删除，请确保子设备无用或关联至其他网关，再重试网关删除操作。 403 IOTDA.014026 Operation not allowed. The number of non-security devices has reached the upper limit. 非安全设备的数量已达到上限。 请删除无用的非安全设备或联系华为工程师分析解决。 403 IOTDA.014029 Operation not allowed. The timeout parameter cannot be modified when the device has been activated. 设备激活后不能修改timeout参数。 取消timeout参数的修改或在未激活的设备下操作。 403 IOTDA.014036 Operation not allowed. The device service capabilities are not defined in the product. 该设备的产品未定义设备服务能力。 请使用修改产品接口将该产品添加设备服务能力。 403 IOTDA.014037 Operation not allowed. Max device depths (2 levels) reached. 该设备深度已达到上限（2）。 当前网关最多支持二级子设备。 403 IOTDA.014038 Operation not allowed. Only gateways or directly connected devices are supported. 该操作只支持网关或者直连设备。 请选择直连设备或者网关设备进行操作。 403 IOTDA.014039 Operation not allowed. The device has already been frozen. 该设备是冻结状态，无法操作。 请解冻设备后再进行操作。 403 IOTDA.014040 Operation not allowed. The device is not frozen and cannot be unfrozen. 该设备不是冻结状态，无法解冻。 只能对冻结状态的设备进行解冻操作。 403 IOTDA.014041 Operation not allowed. The device does not belong to the currently connected gateway. 该设备不属于当前连接的网关。 请选择当前连接网关下的子设备进行操作。 403 IOTDA.014101 The number of commands reached the upper limit. 该资源空间下的缓存命令数量达到上限。 请等待缓存命令下发后再下发新命令,或增大缓存命令数。 403 IOTDA.014106 Invalid CommandBody for the MQTT protocol. 适用于mqtt协议的CommandBody不正确。 命令下发接口参数必须为json格式，请确认下发的参数是否正确。 403 IOTDA.014109 Operation not allowed. The command status is not 'PENDING'. 不允许操作，命令的状态不是PENDING。 请联系华为工程师解决。 403 IOTDA.014133 Operation not allowed. The topic has no 'SUBSCRIBE' permission. 操作不允许，该主题没有SUBSCRIBE权限。 请联系华为工程师解决。 403 IOTDA.014202 Operation not allowed. The number of unfinished tasks has reached the upper limit (%s). 未完成的任务数量达到上限。 执行中的批量任务数量已经超出规格限制，请停止未完成任务再重试。 403 IOTDA.014206 Operation not allowed. The number of targets has reached the upper limit (%s). targets数量超过上限。 请排查请求参数是否符合华为云文档要求。 403 IOTDA.014217 Operation not allowed. The target cannot retry because the task of target has succeeded, is waiting or is processing. 目标不能重试，因为目标的任务已经成功、等待中或者正在执行中。 请确认该目标任务是否已经成功、等待中或者正在执行中。 403 IOTDA.014218 Operation not allowed. The target cannot stop because the task of target has succeeded, failed or stopped. 目标不能停止，因为目标的任务已经成功，失败或者停止。 请确认该目标任务是否已经成功，失败或者停止。 403 IOTDA.014220 Operation not allowed. The task type is not supported. 不支持该任务类型。 请确认任务类型是否支持该操作。 403 IOTDA.014221 Invalid input. The task cannot be deleted because it is not completed. 任务不能删除，因为任务没有完成。 请检查任务状态是否为成功，失败，部分成功或已停止。 403 IOTDA.014601 Operation not allowed. The number of batch task files of the current user exceeds the upper limit. 当前用户下的批量任务文件数达到上限。 请删除多余文件后重试。 403 IOTDA.014607 Operation not allowed. The batch task file is in use and cannot be deleted. 该批量任务文件正在使用，不能被删除。 请等待任务完成后再操作。 403 IOTDA.015101 Operation not allowed. The device already exists in the other device-proxy. 设备已存在于其他设备代理中，不允许添加到当前设备代理。 请更换代理设备后重试。 403 IOTDA.015102 Operation not allowed. The endpoint device is not allowed to be added to device-proxy. 子设备不允许添加至设备代理中。 子设备不允许添加至代理中，请更换设备后重试。 403 IOTDA.015104 Operation not allowed. The number of device-proxy has reached the upper limit (10). 设备代理数量已达到最大上限。 请删除多余代理设备后重试。 403 IOTDA.015303 Operation not allowed. The provisioning-template is associated by certificate. 模板被证书关联中，不允许删除。 请在设备CA证书中解除关联后重试。 403 IOTDA.015306 Operation not allowed. The number of provisioning-template has reached the upper limit (10). 模板数量达到上限。 请删除不需要的模板后重试。 403 IOTDA.016001 Operation not allowed, The number of queues exceeds the limit for each spUserName. 队列数量已达到用户最大配额。 单个租户只能创建100个AMQP队列。 403 IOTDA.016003 Operation not allowed. The queue is in use. 该队列已被使用。 请取消该队列相应的订阅后再进行操作。 403 IOTDA.016009 Operation not allowed. The number of queues exceeds the system limit. 队列数量已达到系统最大配额。 请联系华为工程师分析解决。 403 IOTDA.019303 Operation not allowed. The number of packages for the user has reached the upper limit. 用户下的升级包数量达到上限。 请删除无用升级包。 403 IOTDA.019701 Operation not allowed. The device does not belong to the authorized user. 设备不属于该用户。 设备不属于该用户，请确认设备ID是否正确。 403 IOTDA.019703 The open tunnel cannot be deleted. 处于打开状态的隧道不能被删除。 请先关闭设备隧道后再进行删除。 403 IOTDA.019706 Operation not allowed. The number of tunnels for a device has reached the upper limit. 单设备的隧道个数已达到限制值。 请删除老的设备隧道后再进行重试。 403 IOTDA.019707 Operation not allowed. The number of device tunnels for a user has reached the upper limit. 租户的设备隧道个数已达到限制值。 请删除老的设备隧道后再进行重试。 403 IOTDA.021311 Operation not allowed. The number of authorizer has reached the upper limit(10). 租户下的自定义鉴权数已经达到最大值。 请确认租户下的自定义鉴权数是否已经为10个。 403 IOTDA.021313 The function does not exist. 该函数在FunctionGraph不存在。 请确认该函数是否在FunctionGraph是否已经创建。 404 IOTDA.000016 Target not found. 未找到目标。 请联系华为工程师分析解决。 404 IOTDA.000029 Invalid input. The path does not exist. 请求路径不存在。 请检查请求路径是否正确。 404 IOTDA.003000 The group does not exist. 群组不存在。 请确认是否有该设备组或设备组参数是否携带正确。 404 IOTDA.003001 The parent group does not exist. 父级设备组不存在。 请确认是否有该设备组或设备组参数是否携带正确。 404 IOTDA.004000 The resource does not exist. 资源不存在。 请确认请求参数是否正确。如deviceId， resourceId等。 404 IOTDA.009003 The subscription subject cannot be found. 查询不到该订阅记录。 请确认请求中的参数是否与待操作的订阅匹配。 404 IOTDA.010002 The rule does not exist. 该规则不存在。 请确认平台是否存在该规则或请求参数是否正确。 404 IOTDA.010020 The rule action does not exist. 规则动作不存在。 请确认平台是否存在该规则动作或请求参数是否正确。 404 IOTDA.010043 The stack policy does not exist. 积压策略配置不存在。 请确认平台是否存在对应积压策略配置或请求参数是否正确。 404 IOTDA.010046 The flow control policy does not exist. 流控策略配置不存在。 请确认平台是否存在对应流控策略配置或请求参数是否正确。 404 IOTDA.013014 The product does not exist. 产品不存在。 请排查请求参数是否正确或产品是否已经在平台注册。 404 IOTDA.013500 The topic does not exist. 该主题不存在。 请联系华为工程师解。 404 IOTDA.014000 The device does not exist. 设备不存在。 请排查请求参数是否有误并确认是否有在平台注册该设备。 404 IOTDA.014014 The IMSI does not exist. IMSI参数值不能为空。 请输入非空IMSI值后重试。 404 IOTDA.014042 The device access information does not exist. 设备接入信息不存在。 请检查设备是否接入平台并激活。 404 IOTDA.014103 The device command does not exist. 设备命令不存在。 请确认请求参数是否正确。 404 IOTDA.014131 The message does not exist. 该消息不存在。 请联系华为工程师解决。 404 IOTDA.014200 The batch task does not exist. 该任务不存在。 请排查请求参数中的task_id是否有效。 404 IOTDA.014306 The certificate does not exist. 证书不存在。 目标证书id不存在，请确认请求参数是否正确。 404 IOTDA.014600 The batch task file does not exist. 批量任务不存在。 请确认请求参数是否正确。 404 IOTDA.015105 device-proxy not exist or does not belong to the application. 设备代理不存在或者代理不在指定的资源空间下。 请排查请求参数是否有误并确认是否有在资源空间注册该设备代理。 404 IOTDA.015301 provisioning-template does not exist. 指定模板不存在。 请排查请求参数是否有误并确认资源是否存在。 404 IOTDA.016002 The queue ID does not exist. 队列ID不存在。 请确认请求参数是否正确。 404 IOTDA.019300 The package does not exist. 升级包不存在。 请确认是否有该升级包或请求参数package_id是否携带正确。 404 IOTDA.019700 Invalid input. The tunnel does not exist. 隧道不存在。 请确认是否有隧道创建成功并且隧道ID填写正确。 404 IOTDA.021312 The authorizer does not exist. 该自定义鉴权不存在。 请确认该自定义鉴权是否已经创建。 405 IOTDA.000003 The request method is not supported. 不支持该请求方式。 请排查请求方式是否与文档中的保持一致。 405 IOTDA.000019 Method not allowed. http请求中的请求方法不正确。 请排查请求方式是否与文档中的保持一致。 406 IOTDA.000037 Invalid input. The Accept is missing or not supported in the request header. 请求头中缺少或携带了不支持的Accept。 请排查请求头中是否携带了正确的Accept。 409 IOTDA.014030 The version of the serviceId %s conflicts with another one. 该serviceId的版本号冲突。 请使用正确的版本号进行配置。 409 IOTDA.014047 Device status update conflicts occur. 设备状态更新冲突。 请检查是否重复发送请求或网关设备已下线。 415 IOTDA.000036 Invalid input. The Content-Type is missing or not supported in the request header. 请求头中缺少或携带了不支持的Content-Type。 请排查请求头中是否携带了正确的Content-Type。 429 IOTDA.014102 Congestion occurs. The network is under flow control. 发生拥堵， 并且当前网络受到流量控制。 请联系华为工程师解决。 500 IOTDA.000001 Internal server error. 服务器内部错误。 请联系华为工程师分析解决。 500 IOTDA.000007 The data in database is abnormal. 数据库中的数据不正常。 请联系华为工程师分析解决。 500 IOTDA.000020 Decrypt IAM token failed. IAM Token解析失败。 请联系华为工程师分析解决。 父主题： 附录

URI POST /v5/iot/{project_id}/batchtasks/{task_id}/retry 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 参数说明：批量任务ID，创建批量任务时由物联网平台分配获得。 取值范围：长度不超过24，只允许小写字母a到f、数字的组合。 project_id 是 String 参数说明：项目ID。获取方法请参见 获取项目ID 。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情 。 最小长度：1 最大长度：36 表3 请求Body参数 参数 是否必选 参数类型 描述 targets 否 Array of strings 执行批量任务的目标集合，最多支持100个目标，当task_type为firmwareUpgrade，softwareUpgrade时，此处填写device_id

请求示例 重新执行状态为失败，失败待重试和已停止的子任务 POST https://{endpoint}/v5/iot/{project_id}/batchtasks/{task_id}/retry { } 重新执行指定目标集合的子任务 POST https://{endpoint}/v5/iot/{project_id}/batchtasks/{task_id}/retry { "targets" : [ "e495cf17-ff79-4294-8f64-4d367919d665" ] }

响应示例 状态码： 200 OK { "targets" : [ { "target" : "e495cf17-ff79-4294-8f64-4d367919d665", "status" : "failure", "error_code" : "IOTDA.014219", "error_msg" : "Invalid input. The target is not in the task" }, { "target" : "e495cf17-ff79-4294-8f64-4d367919d677", "status" : "success" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 targets Array of BatchTargetResult objects 批量操作目标结果集合 表5 BatchTargetResult 参数 参数类型 描述 target String 执行批量任务的目标。 status String 目标的执行结果，为success或failure error_code String 操作失败的错误码 error_msg String 操作失败的错误描述

URI GET /v5/iot/{project_id}/devices/{device_id}/async-commands/{command_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明：项目ID。获取方法请参见 获取项目ID 。 device_id 是 String 参数说明：下发命令的设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。 command_id 是 String 参数说明：下发命令的命令id，用于唯一标识一个消息，在下发命令时由物联网平台分配获得。 取值范围：长度不超过100，只允许字母、数字、下划线（_）、连接符（-）的组合。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 device_id String 设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 command_id String 设备命令ID，用于唯一标识一条命令，在下发设备命令时由物联网平台分配获得。 service_id String 设备命令所属的设备服务ID，在设备关联的产品模型中定义。 command_name String 设备命令名称，在设备关联的产品模型中定义。 paras Object 设备执行的命令，Json格式，里面是一个个健值对，如果service_id不为空，每个健都是profile中命令的参数名（paraName）;如果service_id为空则由用户自定义命令格式。设备命令示例：{"value":"1"}，具体格式需要应用和设备约定。 expire_time Integer 物联网平台缓存命令的时长， 单位秒。 status String 下发命令的状态。 ·PENDING表示未下发,在物联网平台缓存着 ·EXPIRED表示命令已经过期，即缓存的时间超过设定的expire_time ·SENT表示命令正在下发 ·DELIVERED表示命令已送达设备 ·SUCCESSFUL表示命令已经成功执行 ·FAILED表示命令执行失败 ·TIMEOUT表示命令下发之后，没有收到设备确认或者响应结果一定时间后超时 result Object 设备命令执行的详细结果，由设备返回，Json格式。 created_time String 命令的创建时间，"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。 sent_time String 物联网平台发送命令的时间，如果命令是立即下发， 则该时间与命令创建时间一致， 如果是缓存命令， 则是命令实际下发的时间。"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。 delivered_time String 物联网平台将命令送达到设备的时间，"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串 send_strategy String 下发策略， immediately表示立即下发，delay表示缓存起来，等数据上报或者设备上线之后下发。 response_time String 设备响应命令的时间，"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情 。

响应示例 状态码： 200 OK { "device_id" : "c1224afb-e9f0-4916-8220-b6bab568e888", "command_id" : "b1224afb-e9f0-4916-8220-b6bab568e888", "service_id" : "Switch", "command_name" : "ON_OFF", "paras" : { "value" : "ON" }, "expire_time" : 0, "send_strategy" : "immediately", "created_time" : "20151212T121212Z", "status" : "DELIVERED", "result" : { "code" : 200 }, "sent_time" : "20151212T121212Z", "delivered_time" : "20151212T121212Z", "response_time" : "20151212T131312Z" }

响应示例 状态码： 200 OK { "devices" : [ { "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "app_name" : "testAPP01", "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", "fw_version" : "1.1.0", "sw_version" : "1.1.0", "product_id" : "b640f4c203b7910fc3cbd446ed437cbd", "product_name" : "Thermometer", "status" : "INACTIVE", "tags" : [ { "tag_key" : "testTagName", "tag_value" : "testTagValue" } ] } ], "page" : { "count" : 100, "marker" : "5c8f3d2d3df1f10d803adbda" } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 devices Array of QueryDeviceSimplify objects 设备信息列表。 page Page object 查询结果的分页信息。 表5 QueryDeviceSimplify 参数 参数类型 描述 app_id String 资源空间ID。 app_name String 资源空间名称。 device_id String 设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为"product_id" + "_" + "node_id"拼接而成。 node_id String 设备标识码，通常使用IMEI、MAC地址或Serial No作为node_id。 gateway_id String 网关ID，用于标识设备所属的父设备，即父设备的设备ID。当设备是直连设备时，gateway_id与设备的device_id一致。当设备是非直连设备时，gateway_id为设备所关联的父设备的device_id。 device_name String 设备名称。 node_type String 设备节点类型。 ENDPOINT：非直连设备。 GATEWAY：直连设备或网关。 UNKNOWN：未知。 description String 设备的描述信息。 fw_version String 设备的固件版本。 sw_version String 设备的软件版本。 device_sdk_version String 设备的sdk信息。 product_id String 设备关联的产品ID，用于唯一标识一个产品模型。 product_name String 设备关联的产品名称。 status String 设备的状态。 ONLINE：设备在线。 OFFLINE：设备离线。 ABNORMAL：设备异常。 INACTIVE：设备未激活。 FROZEN：设备冻结。 tags Array of TagV5DTO objects 设备的标签列表。 表6 TagV5DTO 参数 参数类型 描述 tag_key String 参数说明：标签键，在同一资源下标签键唯一。绑定资源时，如果设置的键已存在，则将覆盖之前的标签值。如果设置的键值不存在，则新增标签。 取值范围：长度不超过64，只允许中文、字母、数字、以及_.-等字符的组合。 tag_value String 参数说明：标签值。 取值范围：长度不超过128，只允许中文、字母、数字、以及_.-等字符的组合。 表7 Page 参数 参数类型 描述 count Long 满足查询条件的记录总数。 marker String 本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。

URI GET /v5/iot/{project_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明：项目ID。获取方法请参见 获取项目ID 。 表2 Query参数 参数 是否必选 参数类型 描述 product_id 否 String 参数说明：设备关联的产品ID，用于唯一标识一个产品模型，创建产品后获得。方法请参见 创建产品。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 gateway_id 否 String 参数说明：网关ID，用于标识设备所属的父设备，即父设备的设备ID。携带该参数时，表示查询该设备下的子设备，默认查询下一级子设备，如果需要查询该设备下所有各级子设备，请同时携带is_cascade_query参数为true；不携带该参数时，表示查询用户下所有设备。 取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。 is_cascade_query 否 Boolean 参数说明：是否级联查询，该参数仅在同时携带gateway_id时生效。默认值为false。 取值范围： true：表示查询设备ID等于gateway_id参数的设备下的所有各级子设备。 false：表示查询设备ID等于gateway_id参数的设备下的一级子设备。 缺省值：false node_id 否 String 参数说明：设备标识码，通常使用IMEI、MAC地址或Serial No作为node_id。 取值范围：长度不超过64，只允许字母、数字、下划线（_）、连接符（-）的组合。 device_name 否 String 参数说明：设备名称，资源空间下唯一，用于资源空间下唯一标识一个设备。 取值范围：长度不超过256，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 limit 否 Integer 参数说明：分页查询时每页显示的记录数。 取值范围：1-50的整数，默认值为10。 最小值：1 最大值：50 缺省值：10 marker 否 String 参数说明：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 取值范围：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。 缺省值：ffffffffffffffffffffffff offset 否 Integer 参数说明：表示从marker后偏移offset条记录开始查询。默认为0，取值范围为0-500的整数。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。 取值范围：0-500的整数，默认为0。 最小值：0 最大值：500 缺省值：0 start_time 否 String 参数说明：查询设备注册时间在startTime之后的记录，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。 end_time 否 String 参数说明：查询设备注册时间在endTime之前的记录，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。 app_id 否 String 参数说明：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，可以携带该参数查询指定资源空间下的设备列表，不携带该参数则会查询该用户下所有设备列表。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情 。

URI PUT /v5/iot/{project_id}/routing-rule/actions/{action_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明：项目ID。获取方法请参见 获取项目ID 。 action_id 是 String 参数说明：规则动作ID。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。

请求示例 修改指定规则动作， 推送到http服务器。 PUT https://{endpoint}/v5/iot/{project_id}/routing-rule/actions/{action_id} { "channel" : "HTTP_FORWARDING", "channel_detail" : { "http_forwarding" : { "url" : "http://host:port/callbackurltest" } } }

响应示例 状态码： 200 OK { "action_id" : "1a7ffc5c-d89c-44dd-8265-b1653d951ce0", "rule_id" : "1a7ffc5c-d89c-44dd-8265-b1653d951ce1", "app_id" : "1a7ffc5cd89c44dd8265b1653d951ce0", "channel" : "HTTP_FORWARDING", "channel_detail" : { "http_forwarding" : { "url" : "http://host:port/callbackurltest" } } }

请求示例 创建一个产品，名称为Thermometer，服务为temperature，包含属性temperature和命令reboot。 POST https://{endpoint}/v5/iot/{project_id}/products { "product_id" : "5ba24f5ebbe8f56f5a14f605", "name" : "Thermometer，", "device_type" : "Thermometer，", "protocol_type" : "MQTT", "data_format" : "json", "service_capabilities" : [ { "service_id" : "temperature，", "service_type" : "temperature", "properties" : [ { "property_name" : "temperature", "data_type" : "decimal", "required" : true, "enum_list" : null, "min" : "1", "max" : "100", "max_length" : 100, "step" : 0.1, "unit" : "centigrade", "method" : "RW", "description" : "force", "default_value" : { "color" : "red", "size" : 1 } } ], "commands" : [ { "command_name" : "reboot", "paras" : [ { "para_name" : "force", "data_type" : "string", "required" : false, "enum_list" : null, "min" : "1", "max" : "100", "max_length" : 100, "step" : 0.1, "unit" : "km/h", "description" : "force" } ], "responses" : [ { "response_name" : "ACK", "paras" : [ { "para_name" : "force", "data_type" : "string", "required" : false, "enum_list" : null, "min" : "1", "max" : "100", "max_length" : 100, "step" : 0.1, "unit" : "km/h", "description" : "force" } ] } ] } ], "description" : "temperature", "option" : "Mandatory" } ], "manufacturer_name" : "ABC", "industry" : "smartCity", "description" : "this is a thermometer produced by Huawei", "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka" }

响应示例 状态码： 201 Created { "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "app_name" : "testAPP01", "product_id" : "5ba24f5ebbe8f56f5a14f605", "name" : "Thermometer", "device_type" : "Thermometer", "protocol_type" : "MQTT", "data_format" : "json", "manufacturer_name" : "ABC", "industry" : "smartCity", "description" : "this is a thermometer produced by Huawei", "service_capabilities" : [ { "service_id" : "temperature", "service_type" : "temperature", "properties" : [ { "property_name" : "temperature", "required" : true, "data_type" : "decimal", "enum_list" : null, "min" : "1", "max" : "100", "max_length" : 100, "step" : 0.1, "unit" : "centigrade", "method" : "RW", "description" : "force", "default_value" : { "color" : "red", "size" : 1 } } ], "commands" : [ { "command_name" : "reboot", "paras" : [ { "para_name" : "force", "required" : false, "data_type" : "string", "enum_list" : null, "min" : "1", "max" : "100", "max_length" : 100, "step" : 0.1, "unit" : "km/h", "description" : "force" } ], "responses" : [ { "response_name" : "ACK", "paras" : [ { "para_name" : "force", "required" : false, "data_type" : "string", "enum_list" : null, "min" : "1", "max" : "100", "max_length" : 100, "step" : 0.1, "unit" : "km/h", "description" : "force" } ] } ] } ], "description" : "temperature", "option" : "Mandatory" } ], "create_time" : "20190303T081011Z" }

响应参数 状态码： 201 表10 响应Body参数 参数 参数类型 描述 app_id String 资源空间ID。 app_name String 资源空间名称。 product_id String 产品ID，用于唯一标识一个产品，在物联网平台创建产品后由平台分配获得。 name String 产品名称。 device_type String 设备类型。 protocol_type String 设备使用的协议类型。取值范围：MQTT，CoAP，HTTP，HTTPS，Modbus，ONVIF， OPC-UA，OPC-DA，Other。 data_format String 设备上报数据的格式，取值范围：json，binary。 manufacturer_name String 厂商名称。 industry String 设备所属行业。 description String 产品的描述信息。 service_capabilities Array of ServiceCapability objects 设备的服务能力列表。 create_time String 在物联网平台创建产品的时间，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。 表11 ServiceCapability 参数 参数类型 描述 service_id String 参数说明：设备的服务ID。注：产品内不允许重复。 取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-$等字符的组合。 service_type String 参数说明：设备的服务类型。 取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-$等字符的组合。 properties Array of ServiceProperty objects 参数说明：设备服务支持的属性列表。 取值范围：数组长度大小不超过500。 commands Array of ServiceCommand objects 参数说明：设备服务支持的命令列表。 取值范围：数组长度大小不超过500。 events Array of ServiceEvent objects 参数说明：设备服务支持的事件列表。目前暂未支持自定义事件，创建/修改产品时无需定义该字段。 取值范围：数组长度大小不超过500。 description String 参数说明：设备服务的描述信息。 取值范围：长度不超过128，只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ，、：；。￥$！【】’‘“”（）？…~/等字符的组合。 option String 参数说明：指定设备服务是否必选。目前本字段为非功能性字段，仅起到标识作用。 取值范围： Master：主服务 Mandatory：必选服务 Optional：可选服务 默认值为Optional。 缺省值：Optional 表12 ServiceProperty 参数 参数类型 描述 property_name String 参数说明：设备属性名称。注：设备服务内不允许重复。属性名称作为设备影子JSON文档中的key不支持特殊字符：点(.)、dollar符号($)、空char(十六进制的ASCII码为00)，如果包含了以上特殊字符则无法正常刷新影子文档。 取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 data_type String 参数说明：设备属性的数据类型。 取值范围：int，long，decimal，string，DateTime，jsonObject，enum，boolean，string list。 required Boolean 参数说明：设备属性是否必选。默认为false。 缺省值：false enum_list Array of strings 参数说明：设备属性的枚举值列表。 min String 参数说明：设备属性的最小值。 取值范围：长度1-16。 最小长度：1 最大长度：16 max String 参数说明：设备属性的最大值。 取值范围：长度1-16。 最小长度：1 最大长度：16 max_length Integer 参数说明：设备属性的最大长度。 step Double 参数说明：设备属性的步长。 unit String 参数说明：设备属性的单位。 取值范围：长度不超过16。 最大长度：16 method String 参数说明：设备属性的访问模式。 取值范围：RWE，RW，RE，WE，E，W，R。 R：属性值可读 W：属性值可写 E：属性值可订阅，即属性值变化时上报事件 description String 参数说明：设备属性的描述。 取值范围：长度不超过128，只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ，、：；。￥$！【】’‘“”（）？…~/等字符的组合。 default_value Object 参数说明：设备属性的默认值。如果设置了默认值，使用该产品创建设备时，会将该属性的默认值写入到该设备的设备影子预期数据中，待设备上线时将该属性默认值下发给设备。 表13 ServiceCommand 参数 参数类型 描述 command_name String 参数说明：设备命令名称。注：设备服务内不允许重复。 取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 paras Array of ServiceCommandPara objects 参数说明：设备命令的参数列表。 responses Array of ServiceCommandResponse objects 参数说明：设备命令的响应列表。 表14 ServiceCommandResponse 参数 参数类型 描述 response_name String 参数说明：设备命令响应名称。 取值范围：长度不超过128，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 paras Array of ServiceCommandPara objects 参数说明：设备命令响应的参数列表。 表15 ServiceEvent 参数 参数类型 描述 event_type String 参数说明：设备事件类型。注：设备服务内不允许重复。 取值范围：长度不超过32，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 paras Array of ServiceCommandPara objects 参数说明：设备事件的参数列表。 表16 ServiceCommandPara 参数 参数类型 描述 para_name String 参数说明：参数的名称。 取值范围：长度不超过32，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 data_type String 参数说明：参数的数据类型。 取值范围：int，long，decimal，string，DateTime，jsonObject，enum，boolean，string list。 required Boolean 参数说明：参数是否必选。默认为false。 缺省值：false enum_list Array of strings 参数说明：参数的枚举值列表。 min String 参数说明：参数的最小值。 取值范围：长度1-16。 最小长度：1 最大长度：16 max String 参数说明：参数的最大值。 取值范围：长度1-16。 最小长度：1 最大长度：16 max_length Integer 参数说明：参数的最大长度。 step Double 参数说明：参数的步长。 unit String 参数说明：参数的单位。 取值范围：长度不超过16。 最大长度：16 description String 参数说明：参数的描述。 取值范围：长度不超过128，只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ，、：；。￥$！【】’‘“”（）？…~/等字符的组合。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情 。 表3 请求Body参数 参数 是否必选 参数类型 描述 product_id 否 String 参数说明：产品ID，资源空间下唯一。用于资源空间下唯一标识一个产品。如果携带此参数，平台将产品ID设置为该参数值；如果不携带此参数，产品ID在物联网平台创建产品后由平台分配获得。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 name 是 String 参数说明：产品名称。 取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 device_type 是 String 参数说明：设备类型。 取值范围：长度不超过32，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 protocol_type 是 String 参数说明：设备使用的协议类型。 取值范围：MQTT，CoAP，HTTP，HTTPS，Modbus，ONVIF，OPC-UA，OPC-DA，Other。 data_format 是 String 参数说明：设备上报数据的格式。 取值范围： json：JSON格式 binary：二进制码流格式 默认值json。 缺省值：json service_capabilities 是 Array of ServiceCapability objects 参数说明：设备的服务能力列表。 取值范围：数组长度大小不超过500，内容大小不超过500k。 manufacturer_name 否 String 参数说明：厂商名称。 取值范围：长度不超过32，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 industry 否 String 参数说明：设备所属行业。 取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 description 否 String 参数说明：产品的描述信息。 取值范围：长度不超过128，只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ，、：；。￥$！【】’‘“”（）？…~/等字符的组合。 app_id 否 String 参数说明：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的产品归属到哪个资源空间下，否则创建的产品将会归属到默认资源空间下。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 表4 ServiceCapability 参数 是否必选 参数类型 描述 service_id 是 String 参数说明：设备的服务ID。注：产品内不允许重复。 取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-$等字符的组合。 service_type 是 String 参数说明：设备的服务类型。 取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-$等字符的组合。 properties 否 Array of ServiceProperty objects 参数说明：设备服务支持的属性列表。 取值范围：数组长度大小不超过500。 commands 否 Array of ServiceCommand objects 参数说明：设备服务支持的命令列表。 取值范围：数组长度大小不超过500。 events 否 Array of ServiceEvent objects 参数说明：设备服务支持的事件列表。目前暂未支持自定义事件，创建/修改产品时无需定义该字段。 取值范围：数组长度大小不超过500。 description 否 String 参数说明：设备服务的描述信息。 取值范围：长度不超过128，只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ，、：；。￥$！【】’‘“”（）？…~/等字符的组合。 option 否 String 参数说明：指定设备服务是否必选。目前本字段为非功能性字段，仅起到标识作用。 取值范围： Master：主服务 Mandatory：必选服务 Optional：可选服务 默认值为Optional。 缺省值：Optional 表5 ServiceProperty 参数 是否必选 参数类型 描述 property_name 是 String 参数说明：设备属性名称。注：设备服务内不允许重复。属性名称作为设备影子JSON文档中的key不支持特殊字符：点(.)、dollar符号($)、空char(十六进制的ASCII码为00)，如果包含了以上特殊字符则无法正常刷新影子文档。 取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 data_type 是 String 参数说明：设备属性的数据类型。 取值范围：int，long，decimal，string，DateTime，jsonObject，enum，boolean，string list。 required 否 Boolean 参数说明：设备属性是否必选。默认为false。 缺省值：false enum_list 否 Array of strings 参数说明：设备属性的枚举值列表。 min 否 String 参数说明：设备属性的最小值。 取值范围：长度1-16。 最小长度：1 最大长度：16 max 否 String 参数说明：设备属性的最大值。 取值范围：长度1-16。 最小长度：1 最大长度：16 max_length 否 Integer 参数说明：设备属性的最大长度。 step 否 Double 参数说明：设备属性的步长。 unit 否 String 参数说明：设备属性的单位。 取值范围：长度不超过16。 最大长度：16 method 是 String 参数说明：设备属性的访问模式。 取值范围：RWE，RW，RE，WE，E，W，R。 R：属性值可读 W：属性值可写 E：属性值可订阅，即属性值变化时上报事件 description 否 String 参数说明：设备属性的描述。 取值范围：长度不超过128，只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ，、：；。￥$！【】’‘“”（）？…~/等字符的组合。 default_value 否 Object 参数说明：设备属性的默认值。如果设置了默认值，使用该产品创建设备时，会将该属性的默认值写入到该设备的设备影子预期数据中，待设备上线时将该属性默认值下发给设备。 表6 ServiceCommand 参数 是否必选 参数类型 描述 command_name 是 String 参数说明：设备命令名称。注：设备服务内不允许重复。 取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 paras 否 Array of ServiceCommandPara objects 参数说明：设备命令的参数列表。 responses 否 Array of ServiceCommandResponse objects 参数说明：设备命令的响应列表。 表7 ServiceCommandResponse 参数 是否必选 参数类型 描述 response_name 是 String 参数说明：设备命令响应名称。 取值范围：长度不超过128，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 paras 否 Array of ServiceCommandPara objects 参数说明：设备命令响应的参数列表。 表8 ServiceEvent 参数 是否必选 参数类型 描述 event_type 是 String 参数说明：设备事件类型。注：设备服务内不允许重复。 取值范围：长度不超过32，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 paras 否 Array of ServiceCommandPara objects 参数说明：设备事件的参数列表。 表9 ServiceCommandPara 参数 是否必选 参数类型 描述 para_name 是 String 参数说明：参数的名称。 取值范围：长度不超过32，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 data_type 是 String 参数说明：参数的数据类型。 取值范围：int，long，decimal，string，DateTime，jsonObject，enum，boolean，string list。 required 否 Boolean 参数说明：参数是否必选。默认为false。 缺省值：false enum_list 否 Array of strings 参数说明：参数的枚举值列表。 min 否 String 参数说明：参数的最小值。 取值范围：长度1-16。 最小长度：1 最大长度：16 max 否 String 参数说明：参数的最大值。 取值范围：长度1-16。 最小长度：1 最大长度：16 max_length 否 Integer 参数说明：参数的最大长度。 step 否 Double 参数说明：参数的步长。 unit 否 String 参数说明：参数的单位。 取值范围：长度不超过16。 最大长度：16 description 否 String 参数说明：参数的描述。 取值范围：长度不超过128，只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ，、：；。￥$！【】’‘“”（）？…~/等字符的组合。

示例 Topic: $oc/devices/{device_id}/sys/properties/report 数据格式： { "services": [{ "service_id": "Temperature", "properties": { "value": 57, "value2": 60 }, "event_time": "20151212T121212Z" }, { "service_id": "Battery", "properties": { "level": 80, "level2": 90 }, "event_time": "20151212T121212Z" } ] }

Topic 上行：$oc/devices/{device_id}/sys/properties/report 数据上报的过程中，可以通过在topic后面携带?request_id来指定request_id。比如说消息上报：$oc/devices/{device_id}/sys/properties/report?request_id={request_id}。若不指定，平台会自动生成request_id，用于标识此次请求。

请求示例 设备消息上报通知示例： 设备消息上报通知 { "resource" : "device.message", "event" : "report", "event_time" : "20151212T121212Z", "event_time_ms" : "2015-12-12T12:12:12.000Z", "request_id" : "3fe58d5e-8697-4849-a165-7db128f7e776", "notify_data" : { "header" : { "device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "product_id" : "ABC123456789", "app_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "gateway_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "node_id" : "ABC123456789", "tags" : [ { "tag_value" : "testTagValue", "tag_key" : "testTagName" } ] } }, "body" : { "topic" : "topic", "content" : "msg", "properties" : { "response_topic" : "/device/message/response", "content_type" : "text/plain", "user_properties" : [ { "prop_value" : "propValue1", "prop_key" : "propKey1" } ], "correlation_data" : "messageName" } } }

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 resource 是 String 参数说明：订阅的资源名称，取值为device.message。 event 是 String 参数说明：订阅的资源事件，report。 event_time 是 String 参数说明：资源事件生成时间,格式：yyyyMMdd'T'HHmmss'Z' UTC字符串，如：20151212T121212Z。若需要显示本地时区，您需要自己进行时间转换。 event_time_ms 否 String 参数说明：资源事件生成时间,格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z' UTC字符串，如：2015-12-12T12:12:12.000Z。若需要显示本地时区，您需要自己进行时间转换。 request_id 否 String 参数说明：消息ID，由设备侧指定或平台生成，用于跟踪业务流程。 notify_data 是 DeviceMessageReportNotifyData object 参数说明：设备的自定义字段列表。 表2 DeviceMessageReportNotifyData 参数 是否必选 参数类型 描述 header 是 NotifyDataHeader object 参数说明：推送消息header。 body 是 DeviceMessageReport object 参数说明：推送消息body。 表3 NotifyDataHeader 参数 是否必选 参数类型 描述 app_id 否 String 参数说明：应用ID。 最大长度：256 device_id 否 String 参数说明：设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 最大长度：256 node_id 否 String 参数说明：设备标识码，通常使用IMEI、MAC地址或Serial No作为nodeId。 最大长度：256 product_id 否 String 参数说明：产品ID，用于唯一标识一个产品，在注册产品时由物联网平台分配获得。 最大长度：256 gateway_id 否 String 参数说明：网关ID，用于标识一个网关设备。当设备是直连设备时，gatewayId与设备的deviceId一致。当设备是非直连设备时，gatewayId为设备所关联的直连设备（即网关）的deviceId。 最大长度：256 tags 否 Array of TagV5DTO objects 参数说明：要绑定到指定资源的标签列表，标签列表中各项标签键值之间不允许重复，一个资源最多可以绑定10个标签。 表4 TagV5DTO 参数 是否必选 参数类型 描述 tag_key 是 String 参数说明：标签键，在同一资源下标签键唯一。绑定资源时，如果设置的键已存在，则将覆盖之前的标签值。如果设置的键值不存在，则新增标签。 tag_value 否 String 参数说明：标签值。 表5 DeviceMessageReport 参数 是否必选 参数类型 描述 topic 是 String 参数说明：设备上报的mqtt topic。 content 是 Object 参数说明：消息内容。 properties 否 MqttPropertiesDTO object 参数说明：设备携带的属性信息。 表6 MqttPropertiesDTO 参数 是否必选 参数类型 描述 correlation_data 否 String 参数说明：MQTT 5.0版本请求和响应模式中的相关数据，可选。设备可以通过该参数配置MQTT协议请求和响应模式中的相关数据。 最大长度：128 response_topic 否 String 参数说明：MQTT 5.0版本请求和响应模式中的响应主题，可选。设备可以通过该参数配置MQTT协议请求和响应模式中的响应主题。 最大长度：128 content_type 否 String 参数说明：MQTT 5.0版本有效负载的内容类型，可选。设备可以通过该参数配置MQTT协议有效负载的内容类型。 最大长度：128 user_properties 否 Array of UserPropDTO objects 参数说明：用户自定义属性，可选。设备可以通过该参数配置用户自定义属性。 表7 UserPropDTO 参数 是否必选 参数类型 描述 prop_key 否 String 参数说明：用户自定义属性键。 最大长度：128 prop_value 否 String 参数说明：用户自定义属性值。 最大长度：128

请求示例 创建设备代理 POST https://{endpoint}/v5/iot/{project_id}/device-proxies { "proxy_id" : "04ed32dc1b0025b52fe3c01a27c2babc", "proxy_name" : "testAPP01", "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "proxy_devices" : [ "d4922d8a-6c8e-4396-852c-164aefa6638f", "d4922d8a-6c8e-4396-852c-164aefa6638g" ], "effective_time_range" : { "start_time" : "20200812T121212Z", "end_time" : "20210812T121212Z" } }