nav-img
Advanced

Adding a Tag for a File System

Function

This API is used to add a tag to a specified 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

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

Description of the resource_tag field

Table 4 ResourceTag

Parameter

Mandatory

Type

Description

key

Yes

String

Tag key.

The key must be 1 to 128 characters long, cannot start or end with spaces, and cannot be an empty string. It can contain only UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

value

Yes

String

Tag value.

The value must be 0 to 255 characters long and can be an empty string. It can contain only UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

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