绑定标签 - TagDevice
功能介绍
应用服务器可调用此接口为指定资源绑定标签。当前支持标签的资源有Device(设备)。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
iotda:tags:bind
Tagging
-
-
g:EnterpriseProjectId
-
g:RequestTag/<tag-key>
-
g:TagKeys
-
-
-
URI
POST /v5/iot/{project_id}/tags/bind-resource
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见 获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Instance-Id |
否 |
String |
参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考 查看实例详情。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
resource_type |
是 |
String |
参数说明：要绑定标签的资源类型。 取值范围：
|
|
resource_id |
是 |
String |
参数说明：要绑定标签的资源id。例如，资源类型为device，那么对应的资源id就是device_id。 取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
|
tags |
是 |
Array of TagV5DTO objects |
参数说明：要绑定到指定资源的标签列表，标签列表中各项标签键值之间不允许重复，一个资源最多可以绑定10个标签。 |
响应参数
状态码：200
OK
无
请求示例
资源绑定标签，将标签绑定到设备id为d4922d8a的设备上。
POST https://{endpoint}/v5/iot/{project_id}/tags/bind-resource
{
"resource_type" : "device",
"resource_id" : "d4922d8a",
"tags" : [ {
"tag_key" : "testTagName",
"tag_value" : "testTagValue"
} ]
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
