create-symlink (create a symbolic link) - Object Storage Service

Symbolic links can be used to access objects that are commonly used in buckets. The create-symlink command is run to create a symbolic link. After you create a symbolic link for an object, you can use the symbolic link to access the object. Symbolic links work in a similar manner to shortcuts in Windows.

Important

Sample command lines in this topic are based on the 64-bit Linux system. For other systems, replace ./ossutil64 in the commands with the corresponding binary name. For more information, see ossutil.

Command syntax

./ossutil64 create-symlink cloud_url target_object [--encoding-type <value>] [--payer <value>]

The following table describes the parameters that you can configure in this command.

Parameter	Description
cloud_url	The full path of the symbolic link you want to create.
target_object	The full path of the object to which the symbolic link points. A symbolic link and the object to which the symbolic link points must be in the same bucket.
--encoding-type	The method used to encode the object names specified in `cloud_url` and `target_object`. Valid value: url. If you do not specify this parameter, the object names are not encoded.
--payer	The payer of the traffic and request fees incurred when the command is run. If you want that the requester who accesses the resources in the specified path charged for the traffic and request fees incurred when the command is run, set this parameter to requester.

Examples

When you run this command to create a symbolic link, ossutil does not check whether the object to which the symbolic link points to exists. If the object exists, the created symbolic link can access the object. If the object does not exist, the created symbolic link cannot access the object. To determine whether the object to which a symbolic link points exists, run the ls command to query all objects in the bucket.

The following examples show how to create a symbolic link that points to an existing object.

Important

If the name of the symbolic link you want to create is the same as that of an existing symbolic link, the existing symbolic link is overwritten.

Create a symbolic link named test.jpg in the root directory of a bucket named examplebucket and point the symbolic link to an object named exampleobject.jpg in the root directory of examplebucket.
```
./ossutil64 create-symlink  oss://examplebucket/test.jpg  oss://examplebucket/exampleobject.jpg
```
Create a symbolic link named example.jpg in the destfolder directory of a bucket named examplebucket and point the symbolic link to an object named test.jpg in the root directory of examplebucket. Specify that all fees incurred when the command is run are paid by the requester.
```
./ossutil64 create-symlink  oss://examplebucket/destfolder/example.jpg  oss://examplebucket/test.jpg --payer requester
```
If a similar output is displayed, the symbolic link is created.
```
0.106744(s) elapsed
```
After you create a symbolic link, you can run the read-symlink or stat command to query the information about the symbolic link, such as the ETag value and last update time.

Common options

If you use ossutil to switch to a bucket that is located in another region, add the -e option to the command to specify the endpoint of the region in which the specified bucket is located. If you use ossutil to switch to a bucket that belongs to another Alibaba Cloud account, you can add the -i option to the command to specify the AccessKey ID of the specified account, and add the -k option to the command to specify the AccessKey secret of the specified account.

For example, you can run the following command to create a symbolic link named testobject.png that points to an object named exampleobject.png in a bucket named testbucket, which is located in the China (Shanghai) region and owned by another Alibaba Cloud account:

./ossutil64 create-symlink  oss://testbucket/testobject.png  oss://testbucket/exampleobject.png -e oss-cn-shanghai.aliyuncs.com -i LTAI4Fw2NbDUCV8zYUzA****  -k 67DLVBkH7EamOjy2W5RVAHUY9H****

For more information about other common options, see Common options.