Todos os produtos
Search
Central de documentação

Object Storage Service:Inicialização (SDK para Ruby)

Última atualização: Jul 03, 2026

O OSSClient é o cliente do SDK do Object Storage Service (OSS) para Ruby e gerencia recursos do OSS, como buckets e objetos. Antes de usar o SDK do OSS para Ruby para iniciar uma solicitação de API, crie uma instância do OSSClient e modifique as configurações padrão conforme necessário.

Criar uma instância do OSSClient

Use um dos métodos a seguir para criar uma instância do OSSClient:

Criar uma instância do OSSClient usando um endpoint do OSS

O código a seguir mostra como criar uma instância do OSSClient com um endpoint do OSS:

require 'aliyun/oss'

client = Aliyun::OSS::Client.new(
  # The endpoint is set to China (Hangzhou) in this example. Specify the actual endpoint for your region.
  endpoint: 'https://oss-cn-hangzhou.aliyuncs.com',
  # Obtain access credentials from environment variables. Before you run this code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are set.
  access_key_id: ENV['OSS_ACCESS_KEY_ID'],
  access_key_secret: ENV['OSS_ACCESS_KEY_SECRET']
)

Criar uma instância do OSSClient usando STS

O exemplo a seguir mostra como criar uma instância do OSSClient com o Security Token Service (STS):

require 'aliyun/oss'

client = Aliyun::OSS::Client.new(
  # The endpoint is set to China (Hangzhou) in this example. Specify the actual endpoint for your region.
  endpoint: 'https://oss-cn-hangzhou.aliyuncs.com',
  # The temporary AccessKey ID and AccessKey secret obtained from STS.
  access_key_id: 'AccessKeyId',
  access_key_secret: 'AccessKeySecret',
  # The security token obtained from STS.
  sts_token: 'SecurityToken')

Criar uma instância do OSSClient usando um nome de domínio personalizado

O código a seguir mostra como criar uma instância do OSSClient com um nome de domínio personalizado:

require 'aliyun/oss'

client = Aliyun::OSS::Client.new(
  # Use a custom domain name as the endpoint.
  endpoint: 'http://example.com',
  # Obtain access credentials from environment variables. Before you run this code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are set.
  access_key_id: ENV['OSS_ACCESS_KEY_ID'],
  access_key_secret: ENV['OSS_ACCESS_KEY_SECRET'],
  cname: true
)

Configurar uma instância do OSSClient

Uma instância do OSSClient aceita os seguintes parâmetros:

Parâmetro

Descrição

cname

Defina se um CNAME pode ser usado como endpoint.

  • true: permite o uso de CNAME como endpoint.

  • false (valor padrão): não permite o uso de canonical name (CNAME) como endpoint.

download_crc_enable

Defina se a verificação CRC-64 deve ser ativada durante o download de objetos.

  • true: ativa a verificação de redundância cíclica (CRC) no download de arquivos.

  • false (valor padrão): desativa a verificação de redundância cíclica no download de arquivos.

upload_crc_enable

Defina se a verificação CRC-64 deve ser ativada durante o upload de objetos.

  • true (valor padrão): ativa a verificação de redundância cíclica no upload de arquivos.

  • false: desativa a verificação de redundância cíclica no upload de arquivos.

open_timeout

Tempo limite para estabelecer uma conexão. Unidade: segundos. Valor padrão: 10.

read_timeout

Tempo limite de espera por uma resposta. Unidade: segundos. Valor padrão: 120.