Updated on 2025-07-22 GMT+08:00

Obtaining Details About a Storage Backend

Function

This API is used to obtain details about 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

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

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.

Response Parameters

Status code: 200

Table 3 Response header parameters

Parameter

Type

Description

X-request-id

String

The request ID.

Table 4 Response body parameters

Parameter

Type

Description

target_id

String

The storage backend ID.

creation_time

String

The time when the storage backend was added.

file_system_path

String

The interworking directory name.

failure_details

FailureDetailsMessage object

The association error information.

lifecycle

String

The association status.

Enumeration values:

  • CREATING

  • AVAILABLE

  • MISCONFIGURED

  • DELETING

  • FAILED

obs

ObsDataRepository object

The OBS storage backend.

Table 5 FailureDetailsMessage

Parameter

Type

Description

message

String

The error message.

Table 6 ObsDataRepository

Parameter

Type

Description

bucket

String

The OBS bucket name.

endpoint

String

The OBS bucket endpoint.

policy

ObsDataRepositoryPolicy object

The auto synchronization policy of the storage backend.

attributes

ObsTargetAttributes object

The attributes of the storage backend. This parameter is not supported for file systems that are created on or before June 30, 2024 and have not been upgraded. Submit a service ticket if you need it.

Table 7 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 8 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.

Table 9 ObsTargetAttributes

Parameter

Type

Description

file_mode

Integer

The permissions on the imported file. Value range: 0 to 777

The first digit indicates the permissions of the file owner, and its value ranges from 0 to 7. The second digit indicates the permissions of the user group to which the file belongs, and its value ranges from 0 to 7. The third digit indicates the permissions of other users, and its value ranges from 0 to 7. The file owner is specified by UID, and the user group to which the file belongs is specified by GID. Users who are not the file owner and not in the user group to which the file belongs are other users.

Values 4, 2, and 1 indicate the read, write, and execute permissions respectively. The total value between 1 and 7 represents the access permissions. For example, the first digit 7 in 750 indicates that the file owner has the read, write, and execute permissions on the file, the second digit 5 indicates that the user group to which the file belongs has the read and execute permissions on the file, and the third digit 0 indicates that other users have no permission on the file.

dir_mode

Integer

The permissions on the imported directory. Value range: 0 to 777

The first digit indicates the permissions of the directory owner, and its value ranges from 0 to 7. The second digit indicates the permissions of the user group to which the directory belongs, and its value ranges from 0 to 7. The third digit indicates the permissions of other users, and its value ranges from 0 to 7. The directory owner is specified by UID, and the user group to which the directory belongs is specified by GID. Users who are not the directory owner and not in the user group to which the directory belongs are other users.

Values 4, 2, and 1 indicate the read, write, and execute permissions respectively. The total value between 1 and 7 represents the access permissions. For example, the first digit 7 in 750 indicates that the directory owner has the read, write, and execute permissions on the directory, the second digit 5 indicates that the user group to which the directory belongs has the read and execute permissions on the directory, and the third digit 0 indicates that other users have no permission on the directory.

uid

Integer

The ID of the user who owns the imported object. The default value is 0. The value ranges from 0 to 4294967294 (2^32-2).

gid

Integer

The ID of the user group to which the imported object belongs. The default value is 0. The value ranges from 0 to 4294967294 (2^32-2).

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

errCode

String

The error code.

errMsg

String

The error message.

Example Requests

Obtaining details about the storage backend whose ID is 11abef677ac40f46644d1d5cfc2424a4 for the file system whose ID is 77ba6f4b-6365-4895-8dda-bc7142af4dde

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

Example Responses

Status code: 200

Task delivered

{
  "target_id" : "00000334-xxxx-402d-a5d4-bxxxxx87b939",
  "creation_time" : "2023-10-10T12:02:03",
  "file_system_path" : "sfsturboDirName",
  "lifecycle" : "CREATING",
  "obs" : {
    "bucket" : "myBucket",
    "endpoint" : "obs.region.example.com"
  }
}

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

Task delivered

404

Error response

500

Error response

Error Codes

See Error Codes.