Help Center> Scalable File Service> API Reference> SFS Turbo APIs> Tag Management> Adding a Tag for a File System
Updated on 2023-09-27 GMT+08:00
View PDF

Adding a Tag for a File System

Function

This API is used to add a tag to a specified file system. A maximum of 10 tags can be added to one 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 to be added, 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

Project ID

share_id

Yes

String

File system ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Account token

Content-Type

Yes

String

MIME type
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tag

Yes

ResourceTag object

Description of the resource_tag field
Table 4 ResourceTag

Parameter

Mandatory

Type

Description

key

Yes

String

Tag key.

It can contain a maximum of 36 characters.

It cannot be left blank 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 (_).

Minimum: 1

Maximum: 36

value

Yes

String

Tag value.

It can contain a maximum of 43 characters and can be left blank.

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 (_).

Minimum: 0

Maximum: 43

Response Parameters

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