文档首页/ 数据安全中心 DSC/ API参考/ API/ 资产透视/ 查询Obs桶文件标签信息 - ShowObsMetadata
更新时间：2026-10-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询Obs桶文件标签信息 - ShowObsMetadata

功能介绍

功能介绍：查询Obs桶文件标签信息

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/metadata/detail/obs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可参考获取项目ID获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-32。

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

ins_id

是

String

参数解释：

子网ID

约束限制：

不涉及

取值范围：

1到256个字符

默认取值：

不涉及

bucket_name

否

String

参数解释：

桶名称

约束限制：

不涉及

取值范围：

1到256个字符

默认取值：

不涉及

prefix

否

String

参数解释：

前缀

约束限制：

不涉及

取值范围：

1到256个字符

默认取值：

不涉及

marker

否

String

参数解释：

分页标记

约束限制：

不涉及

取值范围：

1到256个字符

默认取值：

不涉及

object_full_path

否

String

参数解释：

对象完整路径

约束限制：

不涉及

取值范围：

1到256个字符

默认取值：

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释：

总记录数

取值范围：

不涉及

obs_infos

Array of ObsMetadataInfo objects

参数解释：

OBS信息列表

取值范围：

不涉及

marker

String

参数解释：

分页标记

取值范围：

不涉及
表5 ObsMetadataInfo

参数

参数类型

描述

project_id

String

参数解释：

项目ID

取值范围：

不涉及

ins_id

String

参数解释：

实例ID

取值范围：

不涉及

name

String

参数解释：

OBS元数据名称

取值范围：

不涉及

object_full_path

String

参数解释：

对象完整路径

取值范围：

不涉及

description

String

参数解释：

资源描述信息

取值范围：

不涉及

tags

Array of ObsPatchInfo objects

参数解释：

标签

取值范围：

不涉及

classification

Classification object

参数解释：

分类

取值范围：

不涉及

levels

LevelInfo object

参数解释：

等级列表

取值范围：

不涉及

update_time

Long

参数解释：

更新时间

取值范围：

不涉及

is_folder

Boolean

参数解释：

是否文件夹

取值范围：

true-是，false-否

classification_history

String

参数解释：

分类历史

取值范围：

不涉及

level_history

String

参数解释：

等级历史

取值范围：

不涉及

lock

Boolean

参数解释：

锁状态

取值范围：

true-是，false-否

template_id

String

参数解释：

模板ID

取值范围：

不涉及
表6 Classification

参数

参数类型

描述

template_id

String

参数解释：

模板ID

取值范围：

不涉及

children

Array of ObsPatchInfo objects

参数解释：

子分类

取值范围：

不涉及

lock

Boolean

参数解释：

是否锁定

取值范围：

true-是，false-否
表7 ObsPatchInfo

参数

参数类型

描述

id

String

参数解释：

资源ID，唯一标识

取值范围：

不涉及

name

String

参数解释：

OBS补丁名称

取值范围：

不涉及

tag_gen_type

String

参数解释：

标签生成类型

取值范围：

不涉及
表8 LevelInfo

参数

参数类型

描述

id

String

参数解释：

资源ID，唯一标识

取值范围：

不涉及

name

String

参数解释：

级别名称

取值范围：

不涉及

color_number

Integer

参数解释：

颜色编号

取值范围：

不涉及

tag_gen_type

String

参数解释：

标签生成类型

取值范围：

不涉及

lock

Boolean

参数解释：

是否锁定

取值范围：

true-是，false-否

请求示例

查询Obs桶文件标签信息

/v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/metadata/detail/obs

响应示例

状态码：200

{
  "total" : 1,
  "obs_infos" : [ {
    "project_id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70",
    "ins_id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "name" : "asset-resource-01",
    "object_full_path" : "/v1/asset-center/resource",
    "description" : "资产中心数据资源描述",
    "tags" : [ {
      "id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
      "name" : "asset-resource-01",
      "tag_gen_type" : "DATABASE"
    } ],
    "classification" : {
      "template_id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
      "children" : [ {
        "id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
        "name" : "asset-resource-01",
        "tag_gen_type" : "DATABASE"
      } ],
      "lock" : true
    },
    "levels" : {
      "id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70",
      "name" : "asset-resource-01",
      "color_number" : 1,
      "tag_gen_type" : "DATABASE",
      "lock" : true
    },
    "update_time" : 1700000000000,
    "is_folder" : true,
    "classification_history" : "asset-value-01",
    "level_history" : "asset-value-01"
  } ],
  "marker" : "asset-value-01"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 资产透视

相关文档