Adding a Tag to a File System

Function

This API is used to add a tag to an SFS Turbo file system.

A shared file system can have a maximum of 20 tags.

The keys of multiple tags added to a shared file system must be unique.

This API is idempotent. If the key to be added has already been added to the shared file system, the tag is updated.

URI

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

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Specifies the project ID of the operator.

    share_id

    Yes

    String

    Specifies the ID of the shared file system.

Request

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    tag

    Yes

    Object

    Specifies the tag. For details, see Description of field resource_tag.

  • Description of field resource_tag

    Parameter

    Mandatory

    Type

    Description

    key

    Yes

    String

    Specifies the tag key. The value can contain a maximum of 36 characters. This parameter cannot be left empty. It cannot contain the following characters: ASCII (0-31), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (\), equal signs (=), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).

    value

    Yes

    String

    Specifies the tag value. The value contains a maximum of 43 characters and can be an empty string. It cannot contain ASCII (0-31) or the following characters: =*<>\,|/ It can contain only letters, digits, hyphens (-), and underscores (_).

  • Example request

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

Response

  • Parameter description

    None

  • Example response

    None

Status Codes

  • Normal

    204

  • Abnormal

    Status Code

    Description

    400 Bad Request

    Invalid value.

    401 Unauthorized

    Authentication failed.

    403 Forbidden

    Access to the requested page is forbidden.

    404 Not Found

    The requested resource was not found.

    500 Internal Server Error

    The request is not completed because of a service error.