Help Center/ Scalable File Service Turbo/ API Reference/ API/ Storage Interworking Management/ Updating the Cold Data Eviction Duration of a File System
Updated on 2025-12-19 GMT+08:00
View PDF

Updating the Cold Data Eviction Duration of a File System

Function

This API is used to update the cold data eviction duration of a file system.

Constraints

  • This API is only supported for file systems that have storage backends added. This API is only supported for SFS Turbo 1,000 MB/s/TiB, 500 MB/s/TiB, 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, and 20 MB/s/TiB file systems.

  • This API is only supported for NFS file systems.

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

PUT /v1/{project_id}/sfs-turbo/shares/{share_id}

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

action

Yes

String

The operation type. Only config_gc_time is supported currently.

gc_time

Yes

Integer

The cold data eviction duration. The unit is hour. The value ranges from 1 to 100000000. The default value is 60 hours.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 5 Response body parameters

Parameter

Type

Description

gc_time

Integer

The cold data eviction duration of the file system.

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Example Requests

Updating the cold data eviction duration of a file system

{
  "action" : "config_gc_time",
  "gc_time" : 5
}

Example Responses

Status code: 200

Task delivered

{
  "gc_time" : 10
}

Status code: 404

Error response

{
  "errCode" : "SFS.TURBO.0002",
  "errMsg" : "share not exist"
}

Status code: 500

Error response

{
  "errCode" : "SFS.TURBO.0005",
  "errMsg" : "Internal server error"
}

Status Codes

Status Code

Description

200

Task delivered

404

Error response

500

Error response

Error Codes

See Error Codes.