Help Center/ DataArts Insight/ API Reference/ User Tags/ Obtaining a User Tag Header

Updated on 2025-02-25 GMT+08:00

CLI Examples

View PDF

Obtaining a User Tag Header

This API is used to obtain user tag headers.

GET /v1/{project_id}/tags/head

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	project_id

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
type	Yes	String	Explanation Tag type, which can be user tag or user group tag. Constraints N/A Value range The enumerated values are: user: user tag. userGroup: user group tag. Default value N/A
offset	No	Integer	Start offset of returned items. The default value is 0.
limit	No	Integer	Number of returned records. The default value is 10.

**Table 3** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Obtain a user token by calling IAM's "Obtaining a User Token" API. X-Subject-Token in the response header is the desired user token.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Number of data records.
page_data	Array of UserTagVo objects	Data.

**Table 5** UserTagVo
Parameter	Type	Description
tag_description	String	tagDescription
tag_id	String	tagId
tag_name	String	tagName
tag_type	String	Explanation Tag type, which can be user tag or user group tag. Constraints N/A Value range The enumerated values are: user: user tag. userGroup: user group tag. Default value N/A

Obtain user tag headers.

GET https://{endpoint}/v1/{project_id}/tags?type=user

None

Status Code	Description
200	User tags are successfully listed.

Parent topic: User Tags

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.