Help Center/ Scalable File Service Turbo/ API Reference/ API/ Storage Interworking Management/ Updating the Auto Synchronization Policy of a Storage Backend
Updated on 2025-07-22 GMT+08:00
View PDF
Share

Updating the Auto Synchronization Policy of a Storage Backend

Function

This API is used to update the auto synchronization policy of a storage backend.

Constraints

  • 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.

URI

PUT /v1/{project_id}/sfs-turbo/shares/{share_id}/targets/{target_id}/policy

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

share_id

Yes

String

The file system ID.

target_id

Yes

String

The storage backend 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

policy

Yes

ObsDataRepositoryPolicy object

The auto synchronization policy of the storage backend.
Table 4 ObsDataRepositoryPolicy

Parameter

Mandatory

Type

Description

auto_export_policy

No

AutoExportPolicy object

The auto export policy of the storage backend. If enabled, all updates made on the file system will be automatically exported to the OBS bucket.
Table 5 AutoExportPolicy

Parameter

Mandatory

Type

Description

events

No

Array of strings

The type of data automatically exported to the OBS bucket.

  • NEW: Files created and then modified in the SFS Turbo interworking directory. Any data or metadata modifications made will be automatically synchronized to the OBS bucket.

  • CHANGED: Files previously imported from the OBS bucket and then modified in the SFS Turbo interworking directory. Any data or metadata modifications made will be automatically synchronized to the OBS bucket.

  • DELETED: Files deleted from the SFS Turbo interworking directory. Deletions will be automatically synchronized to the OBS bucket, and only such files that were previously exported to the bucket will be deleted.

Enumeration values:

  • NEW

  • CHANGED

  • DELETED

prefix

No

String

The prefix to be matched in the storage backend.

suffix

No

String

The suffix to be matched in the storage backend.

Response Parameters

Status code: 200

Table 6 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 7 Response body parameters

Parameter

Type

Description

target_id

String

The storage backend ID.

policy

ObsDataRepositoryPolicy object

The auto synchronization policy of the storage backend.
Table 8 ObsDataRepositoryPolicy

Parameter

Type

Description

auto_export_policy

AutoExportPolicy object

The auto export policy of the storage backend. If enabled, all updates made on the file system will be automatically exported to the OBS bucket.
Table 9 AutoExportPolicy

Parameter

Type

Description

events

Array of strings

The type of data automatically exported to the OBS bucket.

  • NEW: Files created and then modified in the SFS Turbo interworking directory. Any data or metadata modifications made will be automatically synchronized to the OBS bucket.

  • CHANGED: Files previously imported from the OBS bucket and then modified in the SFS Turbo interworking directory. Any data or metadata modifications made will be automatically synchronized to the OBS bucket.

  • DELETED: Files deleted from the SFS Turbo interworking directory. Deletions will be automatically synchronized to the OBS bucket, and only such files that were previously exported to the bucket will be deleted.

Enumeration values:

  • NEW

  • CHANGED

  • DELETED

prefix

String

The prefix to be matched in the storage backend.

suffix

String

The suffix to be matched in the storage backend.

Status code: 404

Table 10 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 11 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Status code: 500

Table 12 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.
Table 13 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Example Requests

Updating the auto synchronization policy of the storage backend whose ID is 11abef677ac40f46644d1d5cfc2424a4 for the file system whose ID is 77ba6f4b-6365-4895-8dda-bc7142af4dde

PUT HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde/targets/11abef677ac40f46644d1d5cfc2424a4/policy

{
  "policy" : {
    "auto_export_policy" : {
      "events" : [ "NEW", "CHANGED", "DELETED" ]
    }
  }
}

Example Responses

Status code: 200

Success

{
  "target_id" : "xxxxxx-xxx-xxxx-xxxxxxx",
  "policy" : {
    "auto_export_policy" : {
      "events" : [ "NEW", "CHANGED", "DELETED" ]
    }
  }
}

Status code: 404

Error response

{
  "errCode" : "SFS.TURBO.0126",
  "errMsg" : "target not found, not bound yet"
}

Status code: 500

Error response

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

Status Codes

Status Code

Description

200

Success

404

Error response

500

Error response

Error Codes

See Error Codes.