查询存储库资源标签 - ShowVaultTag
功能介绍
查询指定实例的标签信息
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v3/{project_id}/vault/{vault_id}/tags
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| tags | Array of Tag objects | 参数解释: 标签列表,Tag对象包含key和value两个字段,key为标签键,value为标签值,tags中key不重复 取值范围: 不涉及 |
| sys_tags | Array of SysTag objects | 仅op_service权限才可以获取此字段: 目前只包含一个resource_tag结构体 key:_sys_enterprise_project_id value:企业项目id。0表示默认企业项目 非op_service场景不能返回此字段。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 标签的键,用于标识和分类资源。 key最大长度为36个字符且不能为空字符串,前后空格会被丢弃。 key不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。 key只能由中文,字母,数字,“-”,“_”组成。 创建时,如果请求体中存在重复key则报错,如果数据库存在就覆盖。 删除时,允许重复key,如果删除的标签不存在,默认处理成功,删除时不对标签字符集范围做校验。 删除时tags结构体不能缺失,key不能为空,或者空字符串。 取值范围: 不涉及 |
| value | String | 参数解释: 标签的值,用于描述存储库资源的具体属性。 添加标签时value必填,删除时选填,最大长度43字符且允许为空,前后空格会自动去除。此外,value不能包含非打印字符及= * < > \ , | /等特殊符号。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 系统标签的键 取值范围: 从白名单中取,不能随意定义。 |
| value | String | 参数解释: 系统标签的值 取值范围: 目前仅会用到企业项目ID,其中默认的企业项目ID为“0”。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 请参见错误码。 |
| error_msg | String | 错误信息 |
请求示例
GET https://{endpoint}/v3/{project_id}/vault/{vault_id}/tags 响应示例
状态码:200
{
"tags" : [ {
"key" : "string",
"value" : ""
} ]
} 状态码:400
{
"error_code" : "BackupService.9900",
"error_msg" : "Invalid vault_id provided."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
错误码
请参见错误码。