软链接功能用于便捷访问Bucket内的常用Object。设置软链接后,您可以通过类似于Windows的快捷方式,打开软链接文件来访问Object。
注意事项
对标准存储或低频访问类型的Object设置软链接后,可通过软链接文件访问Object。
对归档存储、冷归档存储或者深度冷归档存储类型Object设置软链接后,如果需要通过软链接文件访问Object,则Object需要先完成解冻操作。更多信息,请参见解冻文件。
软链接存储的是目标文件的路径名,而非文件内容。因此,软链接占用的存储容量主要由其指向的目标文件路径长度决定,而非目标文件的实际大小。例如,软链接指向的目标文件名称为image.jpg,则软链接的存储容量大小约为0.009KB。
操作步骤
使用OSS控制台
登录OSS管理控制台。
单击Bucket 列表,然后单击目标Bucket名称。
在左侧导航栏,选择文件管理>文件列表。
在目标文件右侧的操作栏下,选择 > 设置软链接。
在设置软链接面板,设置软链接文件目录,然后单击确定。
设置软链接文件目录名称时,请遵循界面提示的命名规范。假设您当前的文件在/test/目录下:
如果选择绝对路径,命名为t1-symlink,则软连接所在路径是
/t1-symlink
。如果选择相对路径,命名为t2-symlink,则软连接所在路径是
/test/t2-symlink
。
重要如果设置的软链接文件名未包含文件扩展名,例如文件myphoto.jpg的软链接文件名为myphoto,通过控制台或URL访问该软链接文件时可正常预览。通过工具或控制台下载该软链接文件时,因文件无文件扩展名,下载后是一个未知文件,无法直接打开。如需打开文件,请添加正确的文件扩展名。
使用图形化管理工具ossbrowser
ossbrowser支持的Object级别的操作与控制台支持的操作类似,请按照ossbrowser界面指引完成设置软链接的操作。关于如何使用ossbrowser,请参见快速使用ossbrowser。
使用阿里云SDK
以下仅列举常见SDK的设置软链接的代码示例。关于其他SDK的设置软链接的代码示例,请参见SDK简介。
import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.model.*;
public class Demo {
public static void main(String[] args) throws Exception {
// Endpoint以华东1(杭州)为例,其它Region请按实际情况填写。
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
// 填写Bucket名称,例如examplebucket。
String bucketName = "examplebucket";
// 指定软链接名称。
String symLink = "yourSymLink";
// 指定软链接指向的目标Object名称。
String destinationObjectName = "yourDestinationObjectName";
// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider);
try {
// 创建上传文件元数据。
ObjectMetadata metadata = new ObjectMetadata();
metadata.setContentType("text/plain");
// 设置自定义元数据property的值为property-value。
metadata.addUserMetadata("property", "property-value");
// 指定创建软链接时是否覆盖同名Object。
// metadata.setHeader("x-oss-forbid-overwrite", "true");
// 指定Object的访问权限。
// metadata.setHeader(OSSHeaders.OSS_OBJECT_ACL, CannedAccessControlList.Default);
// 指定Object的存储类型。
// metadata.setHeader(OSSHeaders.OSS_STORAGE_CLASS, StorageClass.Standard);
// 创建CreateSymlinkRequest。
CreateSymlinkRequest createSymlinkRequest = new CreateSymlinkRequest(bucketName, symLink, destinationObjectName);
// 设置元数据。
createSymlinkRequest.setMetadata(metadata);
// 创建软链接。
ossClient.createSymlink(createSymlinkRequest);
} catch (OSSException oe) {
System.out.println("Caught an OSSException, which means your request made it to OSS, "
+ "but was rejected with an error response for some reason.");
System.out.println("Error Message:" + oe.getErrorMessage());
System.out.println("Error Code:" + oe.getErrorCode());
System.out.println("Request ID:" + oe.getRequestId());
System.out.println("Host ID:" + oe.getHostId());
} catch (ClientException ce) {
System.out.println("Caught an ClientException, which means the client encountered "
+ "a serious internal problem while trying to communicate with OSS, "
+ "such as not being able to access the network.");
System.out.println("Error Message:" + ce.getMessage());
} finally {
if (ossClient != null) {
ossClient.shutdown();
}
}
}
}
<?php
if (is_file(__DIR__ . '/../autoload.php')) {
require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
require_once __DIR__ . '/../vendor/autoload.php';
}
use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
use OSS\CoreOssException;
// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
$provider = new EnvironmentVariableCredentialsProvider();
// Endpoint以华东1(杭州)为例,其他Region请按实际情况填写。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填写Bucket名称,例如examplebucket。
$bucket= "examplebucket";
// 指定软链接指向的目标Object名称,例如exampleobject.txt。
$object = "exampleobject.txt";
// 指定软链接名称,例如examplesymlink.txt。
$symlink = "examplesymlink.txt";
$options[OssClient::OSS_HEADERS] = array(
// 指定创建软链接时是否允许覆盖同名目标Object。此处设置为true,表示禁止覆盖同名目标Object。
'x-oss-forbid-overwrite'=>"true",
// 指定Object的访问权限。此处设置为private,表示私有权限。即只有Object的拥有者和授权用户有该Object的读写权限,其他用户没有权限操作该Object。
'x-oss-object-acl' =>"private",
// 指定Object的存储类型。此处设置为Standard,表示标准存储类型。
'x-oss-storage-class' =>"Standard"
);
try {
$config = array(
"provider" => $provider,
"endpoint" => $endpoint,
);
$ossClient = new OssClient($config);
$ossClient->putSymlink($bucket, $symlink, $object,$options);
} catch (OssException $e) {
printf($e->getMessage() . "\n");
return;
}
const OSS = require('ali-oss')
const client = new OSS({
// yourregion填写Bucket所在地域。以华东1(杭州)为例,Region填写为oss-cn-hangzhou。
region: 'yourRegion',
// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
accessKeyId: process.env.OSS_ACCESS_KEY_ID,
accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
// 填写Bucket名称。
bucket: 'examplebucket',
});
const headers = {
// 指定Object的存储类型。
'x-oss-storage-class':'Standard',
// 指定Object的访问权限。
'x-oss-object-acl':'private',
// 指定创建软链接时是否覆盖同名Object。设置为true,表示禁止覆盖同名Object。
'x-oss-forbid-overwrite': 'true '
};
async function put () {
try {
// 分别指定软链接名称为symlinkobject.txt、软链接指向的目标Object名称为exampleobject.txt。
const result = await client.putSymlink('symlinkobject.txt', 'exampleobject.txt'
// ,{ headers }
);
console.log(result);
} catch (e) {
console.log(e);
}
}
put();
# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
# Endpoint以华东1(杭州)为例,其他Region请按实际情况填写。关于其他Region对应的Endpoint信息,请参见访问域名和数据中心。
# 填写Bucket名称,例如examplebucket。关于Bucket名称命名规范的更多信息,请参见Bucket。
bucket = oss2.Bucket(auth, 'https://oss-cn-hangzhou.aliyuncs.com', 'examplebucket')
# 指定软链接指向的目标Object名称,例如exampleobject.txt。关于Object名称命名规范的更多信息,请参见Object。
object_name = 'exampleobject.txt'
# 指定软链接名称,例如examplesymlick.txt。
symlink = 'examplesymlick.txt';
# headers = dict()
# 指定创建软链接时是否允许覆盖同名目标Object。此处设置为true,表示禁止覆盖同名目标Object。
# headers['x-oss-forbid-overwrite'] = 'true'
# 指定Object的访问权限。此处设置为OBJECT_ACL_PRIVATE,表示私有权限。即只有Object的拥有者和授权用户有该Object的读写权限,其他用户没有权限操作该Object。
# headers[OSS_OBJECT_ACL] = oss2.OBJECT_ACL_PRIVATE
# 指定Object的存储类型。此处设置为BUCKET_STORAGE_CLASS_STANDARD,表示标准存储类型。
# headers['x-oss-storage-class'] = oss2.BUCKET_STORAGE_CLASS_STANDARD
# bucket.put_symlink(object_name, symlink, headers=headers)
# 创建软链接。
bucket.put_symlink(object_name, symlink)
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>Document</title>
</head>
<body>
<button id='upload'>上传</button>
<button id='symlink'>创建软链接</button>
<!--导入SDK文件-->
<script type="text/javascript" src="https://gosspublic.alicdn.com/aliyun-oss-sdk-6.18.0.min.js"></script>
<script type="text/javascript">
const client = new OSS({
// yourRegion填写Bucket所在地域。以华东1(杭州)为例,yourRegion填写为oss-cn-hangzhou。
region: 'yourRegion',
// 从STS服务获取的临时访问密钥(AccessKey ID和AccessKey Secret)。
accessKeyId: 'yourAccessKeyId',
accessKeySecret: 'yourAccessKeySecret',
// 从STS服务获取的安全令牌(SecurityToken)。
stsToken: 'yourSecurityToken',
// 填写Bucket名称,例如examplebucket。
bucket: "examplebucket",
});
const upload = document.getElementById('upload')
const symlink = document.getElementById('symlink')
const getSymlink = document.getElementById("getSymlink")
// 指定待上传的文件内容。
const file = new Blob(['examplecontent'])
// 指定上传至Bucket中的Object名称。
const fileName = 'exampleobject.txt'
// 上传文件。
upload.addEventListener('click', () => {
client.put(fileName, file).then(r => console.log(r))
})
// 创建名为symlink.txt的软链接。
symlink.addEventListener('click', () => {
client.putSymlink('symlink.txt', fileName).then(r => console.log(r))
})
</script>
</body>
</html>
using Aliyun.OSS;
using System.Text;
// yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
var endpoint = "yourEndpoint";
// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
var accessKeyId = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_ID");
var accessKeySecret = Environment.GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET");
// 填写Bucket名称,例如examplebucket。
var bucketName = "examplebucket";
var targetObjectName = "yourTargetObjectName";
var symlinkObjectName = "yourSymlinkObjectName";
var objectContent = "More than just cloud.";
// 创建OssClient实例。
var client = new OssClient(endpoint, accessKeyId, accessKeySecret);
try
{
// 上传目标文件。
byte[] binaryData = Encoding.ASCII.GetBytes(objectContent);
MemoryStream requestContent = new MemoryStream(binaryData);
client.PutObject(bucketName, targetObjectName, requestContent);
// 创建软链接。
client.CreateSymlink(bucketName, symlinkObjectName, targetObjectName);
// 获取软链接指向的目标文件名称。
var ossSymlink = client.GetSymlink(bucketName, symlinkObjectName);
Console.WriteLine("Target object is {0}", ossSymlink.Target);
}
catch (Exception ex)
{
Console.WriteLine("Failed with error info: {0}", ex.Message);
}
// 构建请求。
PutSymlinkRequest putSymlink = new PutSymlinkRequest();
// 填写Bucket名称。
putSymlink.setBucketName("yourBucketName");
// 设置软链接名称。
putSymlink.setObjectKey("yourSymLink");
// 指定软链接指向的目标Object名称。
putSymlink.setTargetObjectName("yourTargetObjectName");
ObjectMetadata metadata = new ObjectMetadata();
// 设置是否禁止覆盖同名Object。此处设置为true,表示禁止覆盖同名Object。
//metadata.setHeader("x-oss-forbid-overwrite", "true");
// 指定Object的访问权限。此处设置为private,表示私有权限。
//metadata.setHeader("x-oss-object-acl", "private");
// 指定Object存储类型。此处设置为Standard,表示标准存储。
//metadata.setHeader("x-oss-storage-class", "Standard");
putSymlink.setMetadata(metadata);
OSSAsyncTask task = oss.asyncPutSymlink(putSymlink, new OSSCompletedCallback<PutSymlinkRequest, PutSymlinkResult>() {
@Override
public void onSuccess(PutSymlinkRequest request, PutSymlinkResult result) {
Log.d("PutSymlink", "PutSymlink success");
}
@Override
public void onFailure(PutSymlinkRequest request, ClientException clientException,
ServiceException serviceException) {
// 请求异常。
if (clientException != null) {
// 客户端异常,例如网络异常等。
clientException.printStackTrace();
}
if (serviceException != null) {
// 服务端异常。
Log.e("ErrorCode", serviceException.getErrorCode());
Log.e("RequestId", serviceException.getRequestId());
Log.e("HostId", serviceException.getHostId());
Log.e("RawMessage", serviceException.getRawMessage());
}
}
});
task.waitUntilFinished();
package main
import (
"fmt"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
"os"
)
func main() {
// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
// 创建OSSClient实例。
// yourEndpoint填写Bucket对应的Endpoint,以华东1(杭州)为例,填写为https://oss-cn-hangzhou.aliyuncs.com。其它Region请按实际情况填写。
client, err := oss.New("yourEndpoint", "", "", oss.SetCredentialsProvider(&provider))
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
// 填写Bucket名称,例如examplebucket。
bucketName := "examplebucket"
// 指定软链接名称,例如examplesymlink。
symObjectKey := "examplesymlink.txt"
// 指定软链接指向的目标Object名称,例如exampleobject.txt。
objectName := "exampleobject.txt"
bucket, err := client.Bucket(bucketName)
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
// 创建软链接。
option := [] oss.Option{
// 指定创建软链接时是否覆盖同名Object。true表示覆盖,false表示不覆盖。
oss.ForbidOverWrite(true),
// 指定Object的访问权限。此处指定为Private,表示私有访问权限。
oss.ObjectACL(oss.ACLPrivate),
// 指定Object的存储类型。此处指定为Standard,表示标准存储类型。
oss.StorageClass(oss.StorageStandard),
}
err = bucket.PutSymlink(symObjectKey,objectName ,option...)
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
}
OSSPutSymlinkRequest *request = [OSSPutSymlinkRequest new];
// 填写Bucket名称,例如examplebucket。
request.bucketName = @"examplebucket";
// 填写软链接名称。
request.objectKey = @"examplesymlink";
// 填写软链接指定的Object完整路径,Object完整路径中不能包含Bucket名称。
request.targetObjectName = @"exampleobject.txt";
OSSTask *putSymlinkTask = [client putSymlink:request];
[putSymlinkTask continueWithBlock:^id _Nullable(OSSTask * _Nonnull task) {
if (!task.error) {
NSLog(@"put symlink success");
} else {
NSLog(@"put symlink failed, error: %@", task.error);
}
return nil;
}];
#include <alibabacloud/oss/OssClient.h>
using namespace AlibabaCloud::OSS;
int main(void)
{
/* yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。*/
std::string Endpoint = "yourEndpoint";
/* 填写Bucket名称,例如examplebucket。*/
std::string BucketName = "examplebucket";
/* 填写Object完整路径,例如exampledir/exampleobject.txt。Object完整路径中不能包含Bucket名称。*/
std::string ObjectName = "exampledir/exampleobject.txt";
/* 填写软链接完整路径,例如shortcut/myobject.txt。*/
std::string LinkName = "shortcut/myobject.txt";
/* 初始化网络等资源。*/
InitializeSdk();
ClientConfiguration conf;
/* 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。*/
auto credentialsProvider = std::make_shared<EnvironmentVariableCredentialsProvider>();
OssClient client(Endpoint, credentialsProvider, conf);
/* 设置HTTP header。*/
auto meta = ObjectMetaData();
meta.setContentType("text/plain");
/* 设置自定义文件元数据。*/
meta.UserMetaData()["meta"] = "meta-value";
/* 创建软链接。*/
CreateSymlinkRequest request(BucketName, ObjectName, meta);
request.SetSymlinkTarget(LinkName);
auto outcome = client.CreateSymlink(request);
if (!outcome.isSuccess()) {
/* 异常处理。*/
std::cout << "CreateSymlink fail" <<
",code:" << outcome.error().Code() <<
",message:" << outcome.error().Message() <<
",requestId:" << outcome.error().RequestId() << std::endl;
return -1;
}
/* 释放网络等资源。*/
ShutdownSdk();
return 0;
}
#include "oss_api.h"
#include "aos_http_io.h"
/* yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。*/
const char *endpoint = "yourEndpoint";
/* 填写Bucket名称,例如examplebucket。*/
const char *bucket_name = "examplebucket";
/* 填写Object完整路径,完整路径中不能包含Bucket名称,例如exampledir/exampleobject.txt。*/
const char *object_name = "exampledir/exampleobject.txt";
/* 填写软链接完整路径。*/
const char *link_object_name = "yourLinkObjectName";
void init_options(oss_request_options_t *options)
{
options->config = oss_config_create(options->pool);
/* 用char*类型的字符串初始化aos_string_t类型。*/
aos_str_set(&options->config->endpoint, endpoint);
/* 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。*/
aos_str_set(&options->config->access_key_id, getenv("OSS_ACCESS_KEY_ID"));
aos_str_set(&options->config->access_key_secret, getenv("OSS_ACCESS_KEY_SECRET"));
/* 是否使用了CNAME。0表示不使用。*/
options->config->is_cname = 0;
/* 用于设置网络相关参数,比如超时时间等。*/
options->ctl = aos_http_controller_create(options->pool, 0);
}
int main(int argc, char *argv[])
{
/* 在程序入口调用aos_http_io_initialize方法来初始化网络、内存等全局资源。*/
if (aos_http_io_initialize(NULL, 0) != AOSE_OK) {
exit(1);
}
/* 用于创建内存管理的内存池(pool),等价于apr_pool_t。其实现代码在apr库中。*/
aos_pool_t *pool;
/* 重新创建一个内存池,第二个参数是NULL,表示没有继承其它内存池。*/
aos_pool_create(&pool, NULL);
/* 创建并初始化options,该参数包括endpoint、access_key_id、access_key_secret、is_cname、curl等全局配置信息。*/
oss_request_options_t *oss_client_options;
/* 在内存池中分配内存给options。*/
oss_client_options = oss_request_options_create(pool);
/* 初始化Client的选项oss_client_options。*/
init_options(oss_client_options);
/* 初始化参数。*/
aos_string_t bucket;
aos_string_t object;
aos_string_t sym_object;
aos_table_t *resp_headers = NULL;
aos_status_t *resp_status = NULL;
aos_str_set(&bucket, bucket_name);
aos_str_set(&object, object_name);
aos_str_set(&sym_object, link_object_name);
resp_status = oss_put_symlink(oss_client_options, &bucket, &sym_object, &object, &resp_headers);
if (aos_status_is_ok(resp_status)) {
printf("put symlink succeeded\n");
} else {
printf("put symlink failed\n");
}
/* 释放内存池,相当于释放了请求过程中各资源分配的内存。*/
aos_pool_destroy(pool);
/* 释放之前分配的全局资源。*/
aos_http_io_deinitialize();
return 0;
}
使用命令行工具ossutil
关于使用ossutil创建软链接的具体操作,请参见create-symlink(创建软链接)。
使用REST API
如果您的程序自定义要求较高,您可以直接发起REST API请求。直接发起REST API请求需要手动编写代码计算签名。更多信息,请参见PutSymlink。
常见问题
私有文件可以设置软链接么?
可以。设置软链接与Object读写权限无关,读写权限为继承Bucket、私有、公共读、公共读写的Object均可以设置软链接。
如何判断objectkey是不是软链接?
您可以调用HeadObject或GetObject接口查看响应信息。
如果Object类型为软链接,则返回目标Object的内容。响应头中Content-Length
、ETag
、Content-Md5
为目标Object的元数据。
删除OSS中的软链接是否会删除源文件?
不会,删除OSS中的软链接仅会删除链接本身,不会影响源文件。