使用檔案URL上傳檔案 - Object Storage Service

簽名URL允許第三方使用者在沒有安全憑證或者授權的情況下進行上傳操作。第三方使用者使用簽名URL上傳檔案後，OSS將在指定的Bucket產生該檔案。

注意事項

產生簽名URL過程中，SDK利用本機存放區的密鑰資訊，根據特定演算法計算出簽名（signature），然後將其附加到URL上，以確保URL的有效性和安全性。這一系列計算和構造URL的操作都是在用戶端完成，不涉及網路請求到服務端。因此，產生簽名URL時不需要授予調用者特定許可權。但是，為避免第三方使用者無法對簽名URL授權的資源執行相關操作，需要確保調用產生簽名URL介面的身份主體被授予對應的許可權。
例如，通過簽名URL上傳檔案時，需要授予oss:PutObject許可權。
產生私人檔案URL時涉及設定URL的有效時間長度。超出簽名URL設定的有效時間長度後，通過簽名URL上傳檔案時會提示簽名URL已到期，導致無法正常上傳檔案。如果您希望繼續使用簽名URL上傳檔案，需要重新擷取簽名URL。

操作步驟

產生簽名URL。

以下僅列舉常見SDK的產生簽名URL的程式碼範例。關於其他SDK的產生簽名URL程式碼範例，請參見SDK簡介。

Java

import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.internal.OSSHeaders;
import com.aliyun.oss.model.GeneratePresignedUrlRequest;
import com.aliyun.oss.model.StorageClass;
import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPut;
import org.apache.http.entity.FileEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.*;
import java.net.URL;
import java.util.*;
import java.util.Date;

public class Demo {
    public static void main(String[] args) throws Throwable {
        // 以華東1（杭州）的外網Endpoint為例，其它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";
        // 填寫Object完整路徑，例如exampleobject.txt。Object完整路徑中不能包含Bucket名稱。
        String objectName = "exampleobject.txt";

        // 建立OSSClient執行個體
        OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider);

        // 佈建要求頭。
        Map<String, String> headers = new HashMap<String, String>();
        /*// 指定Object的儲存類型。
        headers.put(OSSHeaders.STORAGE_CLASS, StorageClass.Standard.toString());
        // 指定ContentType。
        headers.put(OSSHeaders.CONTENT_TYPE, "text/txt");*/

        // 設定使用者自訂中繼資料。
        Map<String, String> userMetadata = new HashMap<String, String>();
        /*userMetadata.put("key1","value1");
        userMetadata.put("key2","value2");*/

        URL signedUrl = null;
        try {
            // 指定產生的簽名URL到期時間，單位為毫秒。本樣本以設定到期時間為1小時為例。
            Date expiration = new Date(new Date().getTime() + 3600 * 1000L);

            // 產生簽名URL。
            GeneratePresignedUrlRequest request = new GeneratePresignedUrlRequest(bucketName, objectName, HttpMethod.PUT);
            // 設定到期時間。
            request.setExpiration(expiration);

            // 將要求標頭加入到request中。
            request.setHeaders(headers);
            // 添加使用者自訂中繼資料。
            request.setUserMetadata(userMetadata);

            // 通過HTTP PUT請求產生簽名URL。
            signedUrl = ossClient.generatePresignedUrl(request);
            // 列印簽名URL。
            System.out.println("signed url for putObject: " + signedUrl);

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

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\Core\OssException;
use OSS\Http\RequestCore;
use OSS\Http\ResponseCore;

// 運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
$provider = new EnvironmentVariableCredentialsProvider();
// yourEndpoint填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
$endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Bucket名稱。
$bucket= "examplebucket";
// 填寫不包含Bucket名稱在內的Object完整路徑。
$object = "exampleobject.txt";
// 設定簽名URL的有效時間長度為3600秒。
$timeout = 3600;
try {
    $config = array(
        "provider" => $provider,
        "endpoint" => $endpoint,        
    );
    $ossClient = new OssClient($config);

    // 產生簽名URL。
    $signedUrl = $ossClient->signUrl($bucket, $object, $timeout, "PUT");
} catch (OssException $e) {
    printf(__FUNCTION__ . ": FAILED\n");
    printf($e->getMessage() . "\n");
    return;
}
print(__FUNCTION__ . ": signedUrl: " . $signedUrl . "\n");

Node.js

const OSS = require("ali-oss");
const { default: axios } = require("axios");
const fs = require("fs");

const client = new OSS({
  // yourregion填寫Bucket所在地區。以華東1（杭州）為例，Region填寫為oss-cn-hangzhou。
  region: "oss-cn-hangzhou",
  // 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數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",
});

// 組建檔案的簽名URL。
const url = client.signatureUrl("exampleobject.txt", {
  method: "PUT",
  "Content-Type": "application/x-www-form-urlencoded",
});
console.log(url);

Python

# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
import requests

# 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())

# yourEndpoint填寫Bucket所在地區對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
# 填寫Bucket名稱，例如examplebucket。
bucket = oss2.Bucket(auth, 'https://oss-cn-hangzhou.aliyuncs.com', 'examplebucket')
# 填寫Object完整路徑，Object完整路徑中不能包含Bucket名稱。
object_name = 'exampleobject.txt'

# 指定Header。
headers = dict()
# 指定Content-Type。
headers['Content-Type'] = 'text/txt'
# 指定儲存類型。
headers["x-oss-storage-class"] = "Standard"

# 產生上傳檔案的簽名URL，有效時間為60秒。
# 產生簽名URL時，OSS預設會對Object完整路徑中的正斜線（/）進行轉義，從而導致產生的簽名URL無法直接使用。
# 設定slash_safe為True，OSS不會對Object完整路徑中的正斜線（/）進行轉義，此時產生的簽名URL可以直接使用。
url = bucket.sign_url('PUT', object_name, 60, slash_safe=True, headers=headers)
print('簽名URL的地址為：', url)

Browser.js

Android

// 填寫Bucket名稱，例如examplebucket。
String bucketName = "examplebucket";
// 填寫不包含Bucket名稱在內源Object的完整路徑，例如exampleobject.txt。
String objectKey = "exampleobject.txt";
// 設定content-type。
String contentType = "application/octet-stream";
String url = null;
try {
    // 產生用於上傳檔案的簽名URL。
    GeneratePresignedUrlRequest request = new GeneratePresignedUrlRequest(bucketName, objectKey);
    // 設定簽名URL的到期時間為30分鐘。
    request.setExpiration(30*60);
    request.setContentType(contentType);    
    request.setMethod(HttpMethod.PUT);
    url = oss.presignConstrainedObjectURL(request);
    Log.d("url", url);
} catch (ClientException e) {
    e.printStackTrace();
}

Go

package main

import (
    "fmt"
    "os"
    "github.com/aliyun/aliyun-oss-go-sdk/oss"
)

func HandleError(err error) {
    fmt.Println("Error:", err)
    os.Exit(-1)
}

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"
    // 填寫檔案完整路徑，例如exampledir/exampleobject.txt。檔案完整路徑中不能包含Bucket名稱。
    objectName := "exampledir/exampleobject.txt"
    bucket, err := client.Bucket(bucketName)
    if err != nil {
        HandleError(err)
    }
    // 產生用於上傳的簽名URL，並指定簽名URL的有效時間為60秒。
    signedURL, err := bucket.SignURL(objectName, oss.HTTPPut, 60)
    if err != nil {
        HandleError(err)
    }

    // 如果要在前端使用帶選擇性參數的簽名URL，請確保在服務端產生該簽名URL時設定的ContentType與在前端使用時設定的ContentType一致。
    options := []oss.Option{
        oss.Meta("myprop", "mypropval"),
        oss.ContentType("text/plain"),
    }
    
    signedURL, err = bucket.SignURL(objectName, oss.HTTPPut, 60, options...)
    if err != nil {
        HandleError(err)
    }
    fmt.Printf("Sign Url:%s\n", signedURL)
}

iOS

// 填寫Bucket名稱。
NSString *bucketName = @"examplebucket";
// 填寫Object名稱。
NSString *objectKey = @"exampleobject.txt";
NSURL *file = [NSURL fileURLWithPath:@"<filePath>"];
NSString *contentType = [OSSUtil detemineMimeTypeForFilePath:file.absoluteString uploadName:objectKey];
__block NSString *urlString;
// 產生用於上傳的簽名URL，並指定簽名URL到期時間為30分鐘。
OSSTask *task = [client presignConstrainURLWithBucketName:bucketName
                                            withObjectKey:objectKey
                                               httpMethod:@"PUT"
                                   withExpirationInterval:30 * 60
                                           withParameters:@{}
                                              contentType:contentType
                                               contentMd5:nil];
[task continueWithBlock:^id _Nullable(OSSTask * _Nonnull task) {
    if (task.error) {
        NSLog(@"presign error: %@", task.error);
    } else {
        urlString = task.result;
        NSLog(@"url: %@", urlString);
    }
    return nil;
}];

使用簽名URL上傳檔案。

以下僅列舉常見SDK使用簽名URL簡單上傳的程式碼範例。關於其他SDK使用簽名URL簡單上傳的程式碼範例，請參見SDK簡介。

Java

import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPut;
import org.apache.http.entity.FileEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.*;
import java.util.*;

public class Demo {
    public static void main(String[] args) throws Throwable {
    
        // 填寫本地檔案的完整路徑。如果未指定本地路徑，則預設從樣本程式所屬專案對應本地路徑中上傳檔案。
        String pathName = "D:\\examplefile.txt";
        // 填寫步驟1產生的簽名URL。
        String signedUrl = "yourSignedUrl";        

        Map<String, String> headers = new HashMap<String, String>();
        Map<String, String> userMetadata = new HashMap<String, String>();


        // 通過簽名URL臨時授權簡單上傳檔案，以HttpClients為例說明。
        putObjectWithHttp(signedUrl, pathName, headers, userMetadata);
    }


    public static void putObjectWithHttp(String signedUrl, String pathName, Map<String, String> headers, Map<String, String> userMetadata) throws IOException {
        CloseableHttpClient httpClient = null;
        CloseableHttpResponse response = null;
        try {
            HttpPut put = new HttpPut(signedUrl);
            HttpEntity entity = new FileEntity(new File(pathName));
            put.setEntity(entity);
            // 如果產生簽名URL時設定了header參數，例如使用者中繼資料，儲存類型等，則呼叫簽章URL上傳檔案時，也需要將這些參數發送至服務端。如果簽名和發送至服務端的不一致，會報簽名錯誤。
            for(Map.Entry header: headers.entrySet()){
                put.addHeader(header.getKey().toString(),header.getValue().toString());
            }
            for(Map.Entry meta: userMetadata.entrySet()){
                // 如果使用userMeta，sdk內部會為userMeta拼接"x-oss-meta-"首碼。當您使用其他方式產生簽名URL進行上傳時，userMeta也需要拼接"x-oss-meta-"首碼。
                put.addHeader("x-oss-meta-"+meta.getKey().toString(), meta.getValue().toString());
            }

            httpClient = HttpClients.createDefault();

            response = httpClient.execute(put);

            System.out.println("返回上傳狀態代碼："+response.getStatusLine().getStatusCode());
            if(response.getStatusLine().getStatusCode() == 200){
                System.out.println("使用網路程式庫上傳成功");
            }
            System.out.println(response.toString());
        } catch (Exception e){
            e.printStackTrace();
        } finally {
            response.close();
            httpClient.close();
        }
    }
}

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\Http\RequestCore;
use OSS\Http\ResponseCore;

// 填寫步驟1產生的簽名URL。
$signedUrl = 'yourSignedUrl';
$content = "Hello OSS";
$request = new RequestCore($signedUrl);
// 使用簽名URL上傳檔案。
$request->set_method('PUT');
$request->add_header('Content-Type', '');
$request->add_header('Content-Length', strlen($content));
$request->set_body($content);
$request->send_request();
$res = new ResponseCore($request->get_response_header(),
    $request->get_response_body(), $request->get_response_code());
if ($res->isOK()) {
    print(__FUNCTION__ . ": OK" . "\n");
} else {
    print(__FUNCTION__ . ": FAILED" . "\n");
};

Node.js

const OSS = require("ali-oss");
const { default: axios } = require("axios");
const fs = require("fs");

// 填寫步驟1產生的簽名URL。
const url = "yourSignedUrl";

// 指定本地檔案的完整路徑。
const file = fs.readFileSync("D:\\examplefile.txt");

// 使用簽名URL上傳檔案。
axios({
  url,
  method: "PUT",
  data: file,
})
  .then((r) => console.log(r))
  .catch((e) => console.log(e));

Python

# -*- coding: utf-8 -*-
import oss2
import requests
# 填寫步驟1產生的簽名URL。
url = 'yourSignedUrl'

# 指定Header。
headers = dict()
# 指定Content-Type。
headers['Content-Type'] = 'text/txt'
# 指定儲存類型。
headers["x-oss-storage-class"] = "Standard"

# 通過簽名URL上傳檔案。
# 填寫本地檔案路徑，例如D:\\examplefile.txt。
requests.put(url, data=open('D:\\examplefile.txt', 'rb').read(), headers=headers)

Browser.js

Android

// 填寫產生的簽名URL。
String url = "";
// 指定本地檔案的完整路徑。
String localFile = "/storage/emulated/0/oss/examplefile";
// 設定content-type。
String contentType = "application/octet-stream";
// 通過簽名URL上傳檔案。
OkHttpClient client = new OkHttpClient();
Request putRequest = new Request.Builder()
        .url(url)
        .put(RequestBody.create(MediaType.parse(contentType), new File(localFile)))
        .build();
client.newCall(putRequest).enqueue(new Callback() {
    @Override
    public void onFailure(Call call, IOException e) {
        e.printStackTrace();
    }

    @Override
    public void onResponse(Call call, Response response) throws IOException {
        Log.d("response", response.body().string());
    }
});

Go

package main

import (
	"fmt"
	"os"
	"strings"

	"github.com/aliyun/aliyun-oss-go-sdk/oss"
)

func main() {
	client, err := oss.New("oss-cn-hangzhou.aliyuncs.com", "", "")
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}
	// 填寫Bucket名稱，例如examplebucket。
	bucketName := "examplebucket"


	bucket, err := client.Bucket(bucketName)
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}
    // 填寫步驟1擷取的簽名URL。
	signedURL := "yourSignedUrl"

	var val = "上雲就上阿里雲"
	err = bucket.PutObjectWithURL(signedURL, strings.NewReader(val))
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}
}

iOS

// 通過簽名URL上傳檔案。
NSURL * url = [NSURL URLWithString:urlString];
NSMutableURLRequest * request = [NSMutableURLRequest requestWithURL:url];
request.HTTPMethod = @"PUT";
request.allHTTPHeaderFields = @{OSSHttpHeaderContentType: contentType};
NSURLSession * session = [NSURLSession sharedSession];
NSURLSessionTask * sessionTask = [session uploadTaskWithRequest:request
                                                       fromFile:file
                                              completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
    if (error) {
        NSLog(@"upload error: %@", error);
        return;
    } else if (((NSHTTPURLResponse*)response).statusCode == 203 ||
               ((NSHTTPURLResponse*)response).statusCode >= 300) {
        NSString *body = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"upload error: %@", body);
        return;
    }
    NSLog(@"upload success");
}];
[sessionTask resume];

Object Storage Service：使用檔案URL上傳檔案

注意事項

操作步驟

Java

PHP

Node.js

Python

Browser.js

Android

Go

iOS

Java

PHP

Node.js

Python

Browser.js

Android

Go

iOS

相關文檔