Obtaining a Symbolic Link (SDK for Java)
Function
This API obtains a symbolic link.
If you have any questions during development, post them on the Issues page of GitHub.
Restrictions
- To obtain a symbolic link, you must be the bucket owner or have the required permission (obs:object:GetObject in IAM or GetObject in a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Configuring an Object Policy.
- The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.
- Objects in the Archive storage class can be downloaded only when they are restored.
Method
GetSymlinkResult getSymlink(GetSymlinkRequest request)
Request Parameters
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| request | Yes | Explanation: Request parameters for downloading an object. For details, see Table 2. |
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| bucketName | String | Yes | Explanation: Bucket name. Restrictions:
Default value: None |
| objectKey | String | Yes | Explanation: Symbolic link name. An object is uniquely identified by an object name in a bucket. An object name is a complete path of the object that does not contain the bucket name. For example, if the address for accessing the object is examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt, the object name is folder/test.txt. Value range: The value must contain 1 to 1,024 characters. Default value: None |
| versionId | String | No | Explanation: Version number of the symbolic link. Value range: The value must contain 32 characters. Default value: None |
Responses
| Method | Return Value Type | Description |
|---|---|---|
| getSymlink(GetSymlinkRequest request) | Results returned for the request to obtain a symbolic link. |
| Parameter | Type | Description |
|---|---|---|
| statusCode | int | Explanation: HTTP status code. Value range: A status code is a group of digits indicating the status of a response. It ranges from 2xx (indicating successes) to 4xx or 5xx (indicating errors). For more information, see Status Code. Default value: None |
| symlinkTarget | String | Explanation: Name of the target object that the symbolic link points to. Default value: None |
| responseHeaders | Map<String, Object> | Explanation: HTTP response header list, composed of tuples. In a tuple, the String key indicates the name of the header, and the Object value indicates the value of the header. Default value: None |
Code Example
This example obtains the symbolic link symlinkobject in bucket examplebucket using a stream.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 | import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.ObsObject; import java.io.ByteArrayOutputStream; import java.io.InputStream; public class GetObject001 { public static void main(String[] args) { // Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage. // Obtain an AK/SK pair on the management console. String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // (Optional) If you are using a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding, which may result in information leakage. // Obtain an AK/SK pair and a security token using environment variables or import them in other ways. // String securityToken = System.getenv("SECURITY_TOKEN"); // Enter the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use. To view the endpoint of a bucket, see https://support.huaweicloud.com/intl/en-us/usermanual-obs/obs_03_0312.html. String endPoint = "https://obs.ap-southeast-1.myhuaweicloud.com"; // Obtain an endpoint using environment variables or import it in other ways. //String endPoint = System.getenv("ENDPOINT"); // Create an ObsClient instance. // Use a permanent AK/SK pair to initialize the client. ObsClient obsClient = new ObsClient(ak, sk, endPoint); // Use a temporary AK/SK pair and security token to initialize the client. // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint); try { // Obtain the symbolic link (a non-versioned object). GetSymlinkRequest request = new GetSymlinkRequest("examplebucket", "symlinkobject", null); GetSymlinkResult getSymlinkResult = obsClient.getSymlink(request); System.out.println("getSymlink successfully"); // Obtain the name of the object that the symbolic link points to. System.out.println("SymlinkTarget:" + getSymlinkResult.getSymlinkTarget()); // Obtain the object type. System.out.println("ObjectType:" + getSymlinkResult.getResponseHeaders().get("object-type")); // Obtain all original response headers. System.out.println("OriginalHeaders:" + getSymlinkResult.getOriginalHeaders()); } catch (ObsException e) { System.out.println("getSymlink failed"); // Request failed. Print the HTTP status code. System.out.println("HTTP Code:" + e.getResponseCode()); // Request failed. Print the server-side error code. System.out.println("Error Code:" + e.getErrorCode()); // Request failed. Print the error details. System.out.println("Error Message:" + e.getErrorMessage()); // Request failed. Print the request ID. System.out.println("Request ID:" + e.getErrorRequestId()); System.out.println("Host ID:" + e.getErrorHostId()); e.printStackTrace(); } catch (Exception e) { System.out.println("getSymlink failed"); // Print other error information. e.printStackTrace(); } } } |
What is your overall rating for this page?
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.
For any further questions, feel free to contact us through the chatbot.
Chatbot