文档首页/ 设备接入 IoTDA/ API参考/ 应用侧API参考/ API/ 实例管理/ 添加实例标签
更新时间：2024-10-23 GMT+08:00
查看PDF
分享

添加实例标签

功能介绍

添加实例标签。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v5/iot/{project_id}/iotda-instances/{instance_id}/bind-tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

参数说明：实例ID。

取值范围：长度不超过36，由小写字母[a-f]、数字、连接符（-）的组成。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

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

参数

是否必选

参数类型

描述

tags

是

Array of Tag objects

参数说明：实例标签。
表4 Tag

参数

是否必选

参数类型

描述

key

是

String

参数说明：标签键，标签的键可用字母(包含中文)、数字、空格和以下字符：下划线(_)点(.)冒号(:)等号(=)加号(+)中划线(-)以及@，首尾不能有空格字符。

value

否

String

参数说明：标签值，可为空字符串和null，标签的值可用字母(包含中文)、数字、空格和以下字符：下划线(_)点(.)冒号(:)等号(=)加号(+)中划线(-)以及@。

响应参数

无

请求示例

POST https://{endpoint}/v5/iot/{project_id}/iotda-instances/{instance_id}/bind-tags

{
  "tags" : [ {
    "key" : "testTagName",
    "value" : "testTagValue"
  } ]
}

响应示例

无

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

错误码

请参见错误码。

父主题： 实例管理