Retrieve a symlink
Updated at:2025-11-03
API description
The GetSymlink API retrieves the symlink. Read permission for the symlink is required to perform this operation.
Request URI
GET /v1/{bucketName}/{objectKey}?symlink
| Parameter name | Parameter type | Required or not | Description | Example value | Parameter location |
|---|---|---|---|---|---|
| bucketName | String | Yes | Bucket name | "bucketName_example" | Path |
| objectKey | String | Yes | Object name | "objectKey_example" | Path |
Parameters of request body
Description of the data structure of request body fields
Response header parameters
| Parameter name | Parameter type | Description | Example value |
|---|---|---|---|
| x-bce-symlink-target | String | Target file which the symlink points to |
Response body parameters
Description of the data structure of response body fields
Request example
JSON
1GET /v1/bucketName_example/objectKey_example?symlink
2 <Common request headers>
3{ }
Response example
JSON
1HTTP/1.1 200 OK
2 <Common response headers>
3{ }
Error code
Please refer to the general error codes
