軟連結 - Object Storage Service

軟連結功能用於便捷訪問Bucket內的常用Object。設定軟連結後，您可以通過類似於Windows的捷徑，開啟軟連結檔案來訪問Object。

注意事項

對標準儲存或低頻訪問類型的Object設定軟連結後，可通過軟連結檔案訪問Object。
對Archive Storage、冷Archive Storage或者深度冷Archive Storage類型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簡介。

Java

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

<?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;
}

Node.js

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();

Python

# -*- 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)

JavaScript

<!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);
}

Android-Java

// 構建請求。
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)
    }

}

Object C

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;
}];
// 實現同步阻塞等待任務完成。
// [putSymlinkTask waitUntilFinished];

C++

#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中的軟連結僅會刪除連結本身，不會影響源檔案。