设备接入 IoTDA设备接入 IoTDA

更新时间:2021/09/06 GMT+08:00
分享

绑定标签

接口说明

应用服务器可调用此接口为指定资源绑定标签。当前支持标签的资源有Device(设备)。

调试

您可以在API Explorer中调试该接口。

注意事项

iot_前缀的为系统预留标签,用户不能使用;一个资源最多只能绑定10个标签。

URI

请求方法

POST

URI

/v5/iot/{project_id}/tags/bind-resource

传输协议

HTTPS

请求参数

名称

必选/可选

类型

位置

说明

X-Auth-Token

必选

String

Header

参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

Instance-Id

可选

String

Header

参数说明:实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。

project_id

必选

String

Path

参数说明:项目ID。获取方法请参见 获取项目ID

resource_type

必选

String

Body

参数说明:要绑定标签的资源类型。

取值范围

  • device:设备。

resource_id

必选

String

Body

参数说明:要绑定标签的资源id。例如,资源类型为device,那么对应的资源id就是device_id。

取值范围:长度不超过128,只允许字母、数字、下划线(_)、连接符(-)的组合。

tags

必选

List<TagV5DTO>

Body

参数说明:要绑定到指定资源的标签列表,标签列表中各项标签键值之间不允许重复,一个资源最多可以绑定10个标签。

表1 TagV5DTO

名称

必选/可选

类型

说明

tag_key

必选

String

参数说明:标签键,在同一资源下标签键唯一。绑定资源时,如果设置的键已存在,则将覆盖之前的标签值。如果设置的键值不存在,则新增标签。

取值范围:长度不超过64,只允许中文、字母、数字、以及_.-等字符的组合。

tag_value

可选

String

参数说明:标签值。

取值范围:长度不超过128,只允许中文、字母、数字、以及_.-等字符的组合。

请求示例

POST https://{Endpoint}/v5/iot/{project_id}/tags/bind-resource
Content-Type: application/json
X-Auth-Token: ********
Instance-Id: ********

{
  "resource_type" : "device",
  "resource_id" : "d4922d8a",
  "tags" : [ {
    "tag_value" : "testTagValue",
    "tag_key" : "testTagName"
  } ]
}

响应示例

Status Code: 200 OK

错误码

HTTP状态码

错误码

错误码英文描述

错误码中文描述

处理建议

400

IOTDA.004002

Invalid input. The tag_key %s cannot start with 'iot_'.

标签的tag_key不能以iot_开头

请修改tag_key后进行操作。

IOTDA.004004

Invalid input. The tag_key %s is duplicated in request params.

标签的tag_key重复

请修改tag_key的值后再操作。

403

IOTDA.000021

Operation not allowed. User not found by IAM token or the authorized user has not subscribed IOTDA service.

没有找到IAM Token所对应的用户信息或该用户没有订阅设备接入服务(IOTDA)

请排查IAM Token所在用户是否订阅了设备接入服务(IOTDA)。

IOTDA.000022

Operation not allowed. The user does not have the permission

该用户没有权限

请排查该用户是否有权限访问。

IOTDA.001006

Operation not allowed. Application not found by authorized user or the authorized user has no application.

用户下没有应用或应用与用户不匹配

请排查用户下是否有应用或是否有指定的应用。

IOTDA.004001

Operation not allowed. Total number of existing tags and tags to add exceeds the upper limit 10.

设备绑定的标签数量超过最大限制10

请删除多余的标签再进行绑定,该设备已绑定标签数达到最大限制。

404

IOTDA.004000

The resource does not exist.

资源不存在

请确认请求参数是否正确。如deviceId, resourceId等。

500

IOTDA.000020

Decrypt IAM token failed.

IAM Token解析失败

请联系华为工程师分析解决。

分享:

    相关文档

    相关产品