Help Center/ Scalable File Service Turbo/ API Reference/ API/ Name Management/ Changing the Name of a File System
Updated on 2025-11-14 GMT+08:00
View PDF
Share

Changing the Name of a File System

Function

This API is used to change the name of a file system.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v1/{project_id}/sfs-turbo/shares/{share_id}/action

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

change_name

Yes

ShareName object

The file system to be modified.
Table 4 ShareName

Parameter

Mandatory

Type

Description

name

Yes

String

The name of the file system to be modified.

Response Parameters

Status code: 204

Successful request

None

Example Requests

Changing the name of an SFS Turbo file system to sfs-turbo-test1

{
  "change_name" : {
    "name" : "sfs-turbo-test1"
  }
}

Example Responses

None

Status Codes

Status Code

Description

204

Successful request

400

Incorrect parameter

409

File system name already exists

500

Internal error

Error Codes

See Error Codes.

Parent topic: Name Management