文档

Ruby初始化

更新时间:

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秒。

  • 本页导读 (1)