文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 标签管理/ 添加实例标签
更新时间：2025-08-11 GMT+08:00
查看PDF
分享

添加实例标签

功能介绍

对指定实例添加用户标签信息。

URI

POST /v3/{project_id}/instances/{instance_id}/tags

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是用户创建实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为36个字符。

默认取值：

不涉及。

请求参数

表2 参数说明

名称

是否必选

参数类型

说明

tags

是

Array of objects

参数解释：

需要添加的用户标签列表。

详情请参见表3。
表3 tags参数说明

名称

是否必选

参数类型

说明

key

是

String

参数解释：

标签键。

约束限制：

不涉及。

取值范围：

允许包含任意语种字母、数字、空格和_ . : = + - @特殊字符，但首尾不能含有空格，不能以_sys_开头，限制长度最长128。

默认取值：

不涉及。

value

是

String

参数解释：

标签值。

约束限制：

不涉及。

取值范围：

允许包含任意语种字母、数字、空格和_ . : / = + - @特殊字符，限制长度最长255。

默认取值：

不涉及。

响应参数

表4 参数说明

参数

参数类型

描述

instance_id

String

参数解释：

实例ID。

取值范围：

不涉及。

instance_name

String

参数解释：

实例名称。

取值范围：

不涉及。

请求示例

创建一个用户标签，key为1，value为2。 
POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/tags
{
	"tags": [{
		"key":"1",
                "value":"2"
	}]
}

响应示例

{
    "instance_id": "dsfae23fsfdsae3435in01",
    "instance_name": "Gauss-a87h"
}

状态码

错误码

请参见错误码。

父主题： 标签管理