OSSClientは、RubyがバケットやオブジェクトなどのOSSリソースを管理するためのObject Storage Service (OSS) SDKのクライアントとして機能します。 OSS SDK for Rubyを使用してAPIリクエストを開始する前に、OSSClientインスタンスを作成し、ビジネス要件に基づいてOSSClientのデフォルト設定を変更する必要があります。
OSSClientインスタンスの作成
次のいずれかの方法を使用して、OSSClientインスタンスを作成できます。
OSSエンドポイントを使用したOSSClientインスタンスの作成
次のコードは、OSSエンドポイントを使用してOSSClientインスタンスを作成する方法の例を示しています。
'aliyun/oss 'が必要です
client = Aliyun::OSS::Client.new (
# この例では、中国 (杭州) リージョンのエンドポイントが使用されます。 実際のエンドポイントを指定します。
エンドポイント: 'https:// oss-cn-hangzhou.aliyuncs.com '、
# 環境変数からアクセス資格情報を取得します。 サンプルコードを実行する前に、OSS_ACCESS_KEY_IDおよびOSS_ACCESS_KEY_SECRET環境変数が設定されていることを確認してください。
access_key_id: ENV['OSS_ACCESS_KEY_ID '] 、
access_key_secret: ENV['OSS_ACCESS_KEY_SECRET ']
) STSを使用したOSSClientインスタンスの作成
次のコードは、Security Token Service (STS) を使用してOSSClientインスタンスを作成する方法の例を示しています。
'aliyun/oss 'が必要です
client = Aliyun::OSS::Client.new (
# この例では、中国 (杭州) リージョンのエンドポイントが使用されます。 実際のエンドポイントを指定します。
エンドポイント: 'https:// oss-cn-hangzhou.aliyuncs.com '、
# STSから取得した一時的なAccessKeyペアを指定します。 AccessKeyペアは、AccessKey IDとAccessKeyシークレットで構成されます。
access_key_id: 'AccessKeyId' 、
access_key_secret: 'AccessKeySecret' 、
# STSから取得したセキュリティトークンを指定します。
sts_token: 'SecurityToken') カスタムドメイン名を使用してOSSClientインスタンスを作成する
次のコードは、カスタムドメイン名を使用してOSSClientインスタンスを作成する方法の例を示しています。
'aliyun/oss 'が必要です
client = Aliyun::OSS::Client.new (
# バケットにマッピングするカスタムドメイン名を指定します。
エンドポイント: 'http:// example.com '、
# 環境変数からアクセス資格情報を取得します。 サンプルコードを実行する前に、OSS_ACCESS_KEY_IDおよびOSS_ACCESS_KEY_SECRET環境変数が設定されていることを確認してください。
access_key_id: ENV['OSS_ACCESS_KEY_ID '] 、
access_key_secret: ENV['OSS_ACCESS_KEY_SECRET ']
cname: true)
) OSSClient インスタンスの設定
OSSClientインスタンスは、次のパラメーターをサポートしています。
パラメーター | 説明 |
cname | CNAME をエンドポイントとして使用できるかどうかを指定します。
|
download_crc_enable | オブジェクトのダウンロード時にCRC-64を有効にするかどうかを指定します。
|
upload_crc_enable | オブジェクトのアップロード時にCRC-64を有効にするかどうかを指定します。
|
open_timeout | 接続を確立するためのタイムアウト期間。 単位は秒です。 デフォルト値は 10 です。 |
read_timeout | 応答待ちのタイムアウト時間。 単位は秒です。 デフォルト値: 120 |