Ruby SDK の初期化方法 - Object Storage Service - Alibaba Cloud ドキュメントセンター

OSSClient は、Object Storage Service (OSS) の Ruby SDK のクライアントであり、バケットやオブジェクトなどの OSS リソースを管理します。Ruby SDK を使用して API リクエストを開始する前に、OSSClient インスタンスを作成し、必要に応じて OSSClient のデフォルト設定を変更する必要があります。

OSSClient インスタンスの作成

次のいずれかの方法で OSSClient インスタンスを作成できます。

OSS エンドポイントを使用した OSSClient インスタンスの作成

次のコードは、OSS エンドポイントを使用して OSSClient インスタンスを作成する方法の例です。

require 'aliyun/oss'

client = Aliyun::OSS::Client.new(
  # この例では、エンドポイントは中国 (杭州) に設定されています。ご利用のリージョンの実際のエンドポイントを指定してください。
  endpoint: '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 インスタンスを作成する方法の例です。

require 'aliyun/oss'

client = Aliyun::OSS::Client.new(
  # この例では、エンドポイントは中国 (杭州) に設定されています。ご利用のリージョンの実際のエンドポイントを指定してください。
  endpoint: 'https://oss-cn-hangzhou.aliyuncs.com',
  # STS から取得した一時的な AccessKey ID と AccessKey Secret。
  access_key_id: 'AccessKeyId',
  access_key_secret: 'AccessKeySecret',
  # STS から取得したセキュリティトークン。
  sts_token: 'SecurityToken')

カスタムドメイン名を使用した OSSClient インスタンスの作成

次のコードは、カスタムドメイン名を使用して OSSClient インスタンスを作成する方法の例です。

require 'aliyun/oss'

client = Aliyun::OSS::Client.new(
  # カスタムドメイン名をエンドポイントとして使用します。
  endpoint: '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 ドメイン名をエンドポイントとして使用できるかどうかを指定します。 true：CNAME ドメイン名をエンドポイントとして使用できます。 false (デフォルト値)：CNAME ドメイン名をエンドポイントとして使用できません。
download_crc_enable	オブジェクトをダウンロードするときに CRC-64 を有効にするかどうかを指定します。 true：ファイルのダウンロード中に巡回冗長検査 (CRC) を有効にします。 false (デフォルト)：ファイルのダウンロード中に巡回冗長検査を無効にします。
upload_crc_enable	オブジェクトをアップロードするときに CRC-64 を有効にするかどうかを指定します。 true (デフォルト)：ファイルのアップロード中に巡回冗長検査を有効にします。 false：ファイルのアップロード中に巡回冗長検査を無効にします。
open_timeout	接続を確立するためのタイムアウト期間。単位：秒。デフォルト値：10。
read_timeout	応答を待機するためのタイムアウト期間。単位：秒。デフォルト値：120。