Updated on 2023-09-27 GMT+08:00

Changing the Name of a File System

Function

This API is used to change the name of an SFS Turbo 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

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

change_name

Yes

ShareName object

SFS Turbo file system to be modified

Table 4 ShareName

Parameter

Mandatory

Type

Description

name

Yes

String

Name of the SFS Turbo file system to be modified

Response Parameters

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

Request successful

400

Invalid parameter

500

Internal error

409

The file system name already exists.

Error Codes

See Error Codes.