On this page

Show all

Help Center/ Scalable File Service/ API Reference/ SFS Turbo APIs/ Tag Management/ Adding a Tag to a File System

Adding a Tag to a File System

Updated on 2025-04-28 GMT+08:00

View PDF

Function

This API is used to add a tag to a file system.

A maximum of 20 tags can be added to a file system.

Tag keys added to the same file system must be unique.

This API is idempotent. If the file system already has the key you want to add, the tag will be updated.

URI

POST /v1/{project_id}/sfs-turbo/{share_id}/tags

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	The project ID.
share_id	Yes	String	The file system ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The account token.
Content-Type	Yes	String	The MIME type.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
tag	Yes	ResourceTag object	The resource_tag field description.

**Table 4** ResourceTag
Parameter	Mandatory	Type	Description
key	Yes	String	The tag key. It can contain a maximum of 128 characters. It cannot be left empty and cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).
value	Yes	String	The tag value. Each tag value can contain a maximum of 255 characters and can be an empty string. It cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).

Response Parameters

Status code: 204

Tag adding request delivered

None

Example Requests

Creating a file system tag, with tag value set to key1 and tag key value1

{
  "tag" : {
    "key" : "key1",
    "value" : "value1"
  }
}

Example Responses

None

Status Codes


Status Code	Description
204	Tag adding request delivered

Error Codes

See Error Codes.

Parent topic: Tag Management

Previous topic: Tag Management

Next topic: Querying All Tags of a File System

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

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.

Chatbot