Updated on 2024-03-05 GMT+08:00

Adding a Tag to a Shared File System

Function

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

A shared file system can have a maximum of 10 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 /v2/{project_id}/sfs/{share_id}/tags
  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Specifies the project ID of the operator. For details about how to obtain the project ID, see Obtaining a Project ID.

    share_id

    Yes

    String

    Specifies the ID of the shared file system.

Request Header

The operation message header is the same as that of a common request. For details, see Table 3.

Request

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    tag

    Yes

    Resource_tag

    Specifies the 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. The key cannot be left blank and cannot contain non-printable ASCII characters (0-31) or the following characters: =*<>\,|/

    value

    Yes

    String

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

  • Example request
    Adding a tag (key1, value1) to a shared file system
    {
      "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.