Files
doc-exports/docs/sfs/api-ref/ChangeShareName.html
lizaoxu 3bac3b88e8 sfs_api_251009
Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Co-authored-by: lizaoxu <lizaoxu@huawei.com>
Co-committed-by: lizaoxu <lizaoxu@huawei.com>
2025-12-03 13:51:09 +00:00

8.1 KiB

Changing the Name of a File System

Function

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

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.