Help Center/ Scalable File Service Turbo/ API Reference/ API/ Storage Interworking Management/ Updating the Auto Synchronization Policy of a Storage Backend

Updated on 2024-11-13 GMT+08:00

View PDF

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.

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	Project ID
share_id	Yes	String	File system ID
target_id	Yes	String	Storage backend 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
policy	Yes	ObsDataRepositoryPolicy object	Auto synchronization policy of the storage backend

**Table 4** ObsDataRepositoryPolicy
Parameter	Mandatory	Type	Description
auto_export_policy	No	AutoExportPolicy object	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	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.

Response Parameters

Status code: 200

**Table 6** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID

**Table 7** Response body parameters
Parameter	Type	Description
target_id	String	Storage backend ID
policy	ObsDataRepositoryPolicy object	Auto synchronization policy of the storage backend

**Table 8** ObsDataRepositoryPolicy
Parameter	Type	Description
auto_export_policy	AutoExportPolicy object	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	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.

Status code: 404

**Table 10** Response body parameters
Parameter	Type	Description
errCode	String	Error code
errMsg	String	Error description

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
errCode	String	Error code
errMsg	String	Error description

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

Successful

{
  "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	Successful
404	Error response
500	Error response

Error Codes

See Error Codes.

Parent topic: Storage Interworking Management

Previous topic: Updating the Properties of a Storage Backend

Next topic: Creating an Import or Export Task

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot