全部產品
Search
文件中心

Object Storage Service:Ruby初始化

更新時間:Feb 28, 2024

Client是OSS的Ruby用戶端,用於管理儲存空間和檔案等OSS資源。使用Ruby SDK發起OSS請求,您需要初始化一個Client執行個體,並根據需要修改Client的預設配置項。

初始化Client

您可以通過以下多種方式建立Client。

使用OSS網域名稱建立Client

以下代碼用於使用OSS網域名稱建立Client。

require 'aliyun/oss'

client = Aliyun::OSS::Client.new(
  # Endpoint以華東1(杭州)為例,其它Region請按實際情況填寫。
  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建立Client

以下代碼用於使用STS建立Client。

require 'aliyun/oss'

client = Aliyun::OSS::Client.new(
  # Endpoint以華東1(杭州)為例,其它Region請按實際情況填寫。
  endpoint: 'https://oss-cn-hangzhou.aliyuncs.com',
  # 從STS服務擷取的臨時存取金鑰(AccessKey ID和AccessKey Secret)。
  access_key_id: 'AccessKeyId',
  access_key_secret: 'AccessKeySecret',
  # 從STS服務擷取的安全性權杖(SecurityToken)。
  sts_token: 'SecurityToken')

使用自訂網域名建立Client

以下代碼用於使用自訂網域名建立Client。

require 'aliyun/oss'

client = Aliyun::OSS::Client.new(
  # 使用自訂網域名作為Endpoint。
  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)
)

配置Client

Client支援配置以下參數。

參數

描述

cname

是否支援CNAME作為Endpoint。

  • true:支援使用CNAME作為Endpoint。

  • false(預設值):不支援CNAME作為Endpoint。

download_crc_enable

下載檔案時是否開啟CRC校正。

  • true:下載檔案時開啟CRC校正。

  • false(預設值):下載檔案時關閉CRC校正。

upload_crc_enable

上傳檔案時是否開啟CRC校正。

  • true(預設值):上傳檔案時開啟CRC校正。

  • false:上傳檔案時關閉CRC校正。

open_timeout

建立串連的時逾時時間,單位為秒,預設值為10秒。

read_timeout

等待響應的逾時時間,單位為秒,預設值為120秒。