すべてのプロダクト
Search
ドキュメントセンター

Object Storage Service:OSS SDK for Goを使用したアップロードコールバックの設定例

最終更新日:Nov 04, 2024

Object Storage Service (OSS) は、単純なアップロード (PutObjectおよびPutObjectFromFile) およびマルチパートアップロード (UploadFile) タスクが完了すると、アプリケーションサーバーにコールバックを送信できます。 アップロードコールバックを設定するには、必要なコールバックパラメーターをOSSに送信されるアップロードリクエストに追加するだけです。

使用上の注意

  • このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。 OSSと同じリージョンにある他のAlibaba CloudサービスからOSSにアクセスする場合は、内部エンドポイントを使用します。 OSSリージョンとエンドポイントの詳細については、「リージョン、エンドポイント、オープンポート」をご参照ください。

  • このトピックでは、アクセス資格情報は環境変数から取得します。 アクセス資格情報の設定方法の詳細については、「アクセス資格情報の設定」をご参照ください。

  • このトピックでは、OSSエンドポイントを使用してOSSClientインスタンスを作成します。 カスタムドメイン名またはSTS (Security Token Service) を使用してOSSClientインスタンスを作成する場合は、「初期化」をご参照ください。

次のサンプルコードは、examplebucketのexamplefilesディレクトリにあるexampleobject.txtオブジェクトに文字列をアップロードするときにアップロードコールバックを設定する方法の例を示しています。

package main

import (
	"encoding/base64"
	"encoding/json"
	"fmt"
	"os"
	"strings"

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

func main() {
	// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
	provider, err := oss.NewEnvironmentVariableCredentialsProvider()
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}

	// Create an OSSClient instance. 
	// Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com. Specify your actual endpoint. 
	// Specify the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the region to cn-hangzhou. Specify the actual region.
	clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
	clientOptions = append(clientOptions, oss.Region("yourRegion"))
	// Specify the version of the signature algorithm.
	clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
	client, err := oss.New("yourEndpoint", "", "", clientOptions...)
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}

        // Specify the name of the bucket. Example: examplebucket. 
	bucket, err := client.Bucket("examplebucket")
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}

	// Specify custom callback parameters. 
	callbackUrl := "http://your.callback.server.address" // Specify the URL of the callback server. 
	callbackMap := map[string]string{
		"callbackUrl": callbackUrl, // Specify the URL of the callback server. 
		"callbackBody": "bucket=${bucket}&object=${object}", // Specify the callback request body. 
		"callbackBodyType": "application/x-www-form-urlencoded", // Specify the type of the callback request body. 
	}

	// Convert the configurations of the callback parameters to a JSON string and encode the string in Base64. 
	callbackStr, err := json.Marshal(callbackMap)
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}
	callbackBase64 := base64.StdEncoding.EncodeToString(callbackStr)

	// Specify the upload callback parameters. 
	options := []oss.Option{
		oss.Callback(callbackBase64),
	}

	// Construct a string that consists of 1024 x 1024 "a" character. 
	content := strings.Repeat("a", 1024*1024)

	// Upload the string. Do not include the bucket name in the object path. 
	objectPath := "examplefiles/exampleobject.txt"
	err = bucket.PutObject(objectPath, strings.NewReader(content), options...)
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}

	// A message which indicates the object is uploaded is returned. 
	fmt.Println("Object uploaded with callback successfully.")
}

関連ドキュメント

  • アップロードコールバックの設定に使用される完全なサンプルコードについては、GitHubをご覧ください。

  • アップロードコールバックを設定するために呼び出すことができるAPI操作の詳細については、「コールバック」をご参照ください。