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

Object Storage Service:コールバックのアップロード

最終更新日:Feb 26, 2024

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

使用上の注意

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

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

サンプルコード

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

# -*-コーディング: utf-8 -*-
jsonのインポート
インポートbase64
oss2のインポート
oss2.credentialsからEnvironmentVariableCredentialsProviderをインポート

# 環境変数からアクセス資格情報を取得します。 サンプルコードを実行する前に、OSS_ACCESS_KEY_IDおよびOSS_ACCESS_KEY_SECRET環境変数が設定されていることを確認してください。 
auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
# バケットが配置されているリージョンのエンドポイントを指定します。 たとえば、バケットが中国 (杭州) リージョンにある場合、エンドポイントをhttps://oss-cn-hangzhou.aliyuncs.comに設定します。 
# バケットの名前を指定します。 
bucket = oss2.Bucket(auth, 'https:// oss-cn-hangzhou.aliyuncs.com ', 'examplebucket')

# Base64でコールバックパラメーターをエンコードするために使用される関数を指定します。 
def encode_callback(callback_params):
    cb_str = json.dumps(callback_params).strip()
    retur n oss2.com pat.to_string(base64.b64encode(oss2.compat.to_bytes(cb_str)))

# アップロードコールバックパラメータを指定します。 
callback_params = {}
# コールバック要求を受信したコールバックサーバのアドレスを指定します。 例: http://oss-demo.aliyuncs.com:23450。 
callback_params['callbackUrl'] = 'http:// oss-demo.aliyuncs.com:23450'
# (オプション) コールバック要求ヘッダーに含まれるHostフィールドを指定します。 
# callback_params['callbackHost'] = 'yourCallbackHost'
# コールバック要求に含まれるbodyフィールドを指定します。 
callback_params['callbackBody'] = 'bucket =${ bucket}&object =${ object}'
# コールバックリクエストでContent-Typeを指定します。 
callback_params['callbackBodyType'] = 'application/x-www-form-urlencodd'
encoded_callback = encode_callback(callback_params)
# コールバック要求のカスタムパラメーターを設定します。 Each custom parameter consists of a key and a value. The key must start with x:. 
callback_var_params = {'x:my_var1 ': 'my_val1', 'x:my_var2': 'my_val2'}
encoded_callback_var = encode_callback(callback_var_params)

# アップロードコールバックパラメータを指定します。 
params = {'x-oss-callback': encoded_callback, 'x-oss-callback-var': encoded_callback_var}
# オブジェクトのフルパスとアップロードする文字列を指定します。 オブジェクトのフルパスにバケット名を含めないでください。 
result = bucket.put_object('examplefiles/exampleobject.txt ', 'a' * 1024*1024, params) 

参考資料

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

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