Obtaining Tag Information About Files in an OBS Bucket

This API is used to obtain tag information of files in an OBS bucket. You can specify the project ID, instance ID, or other optional parameters.

For details, see Calling APIs.

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
bucket_name	No	String	OBS bucket name.
ins_id	Yes	String	Instance ID.
marker	No	String	Pagination flag, which is used to obtain the next page of results.
object_full_path	No	String	Complete path of the object.
prefix	No	String	Filtering prefix, which is used to filter results.
limit	No	Integer	Maximum number of results on each page.

None

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
marker	String	Label, which is a string used for pagination or identification.
obs_infos	Array of ObsMetadataInfo objects	OBS metadata information list.
total	Integer	Total number of OBS metadata records.

**Table 4** ObsMetadataInfo
Parameter	Type	Description
classification	Classification object	Category information, including asset category details.
description	String	Asset description.
ins_id	String	Instance ID, which uniquely identifies an instance.
is_folder	Boolean	Whether the asset is a folder.
levels	LevelInfo object	Asset level information.
name	String	Asset name.
object_full_path	String	Complete path of an asset.
project_id	String	Project ID, which uniquely identifies a project.
tags	Array of ObsPatchInfo objects	Tag information list, which contains information about multiple tags.
update_time	Long	Timestamp when an asset is last updated.

**Table 5** Classification
Parameter	Type	Description
children	Array of ObsPatchInfo objects	Subcategory information list.
lock	Boolean	Lock status, indicating whether the category is locked.
template_id	String	Template ID, which uniquely identifies a template.

**Table 6** LevelInfo
Parameter	Type	Description
color_number	Integer	Color code, which indicates the color of the level.
id	String	ID, which uniquely identifies a level.
lock	Boolean	Lock status, indicating whether the level is locked.
name	String	Level name.
tag_gen_type	String	Tag generation type.

Obtain tag information about files in an OBS bucket.

GET /v1/{project_id}/metadata/detail/obs?ins_id=XXXX&bucket_name=XXX

None

Status Code	Description
200	OK
401	Unauthorized. Authentication required.
403	Unauthorized access.
404	Resource not found.

Parent topic: Asset Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.