文档首页/ 云备份 CBR/ API参考/ API/ 标签/ 查询存储库资源标签
更新时间：2024-12-12 GMT+08:00
编辑
查看PDF
分享

查询存储库资源标签

功能介绍

查询指定实例的标签信息

标签管理服务需要使用该接口查询指定实例的全部标签数据

URI

GET /v3/{project_id}/vault/{vault_id}/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id

vault_id

是

String

资源id

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

tags

Array of Tag objects

标签列表

tags中key不重复

sys_tags

Array of SysTag objects

仅op_service权限才可以获取此字段：

目前只包含一个resource_tag结构体

key：_sys_enterprise_project_id

value：企业项目id。0表示默认企业项目

非op_service场景不能返回此字段。
表3 Tag

参数

参数类型

描述

key

String

键。

key最大长度为36个字符。

key不能为空字符串。

key前后空格会被丢弃。

key不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

key只能由中文，字母，数字，“-”，“_”组成。

value

String

值。

添加标签时value值必选，删除标签时value值可选。

value最大长度为43个字符。

value可以为空字符串。

value前后的空格会被丢弃。

value不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value只能由中文，字母，数字，“-”，“_”，“.”组成。
表4 SysTag

参数

参数类型

描述

key

String

键。

系统标签的key，从白名单中取，不能随意定义。

目前仅支持 _sys_enterprise_project_id字段，对应 的value为企业项目ID。

value

String

值。

目前仅会用到企业项目ID，其中默认的企业项目ID为“0”。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

请参见错误码。

error_msg

String

错误信息

请求示例

GET  https://{endpoint}/v3/{project_id}/vault/{vault_id}/tags

响应示例

状态码： 200

OK

{
  "tags" : [ {
    "key" : "string",
    "value" : ""
  } ]
}

状态码： 400

Bad Request

{
  "error_code" : "BackupService.9900",
  "error_msg" : "Invalid vault_id provided."
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题： 标签

相关文档