how to initialize ruby sdk - Object Storage Service - Centre de documentation Alibaba Cloud

OSSClient est le client du SDK Object Storage Service (OSS) pour Ruby. Il permet de gérer les ressources OSS, telles que les buckets et les objets. Avant d'envoyer une requête API avec le SDK OSS pour Ruby, créez une instance OSSClient et adaptez ses paramètres par défaut selon vos besoins.

Création d'une instance OSSClient

Plusieurs méthodes permettent de créer une instance OSSClient :

Création d'une instance OSSClient à l'aide d'un endpoint OSS

L'extrait de code suivant illustre la création d'une instance OSSClient via un endpoint 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']
)

Création d'une instance OSSClient à l'aide de STS

Le code ci-dessous montre comment instancier OSSClient en utilisant 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')

Création d'une instance OSSClient avec un nom de domaine personnalisé

Voici un exemple de création d'instance OSSClient reposant sur un nom de domaine personnalisé.

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
)

Configuration d'une instance OSSClient

Une instance OSSClient accepte les paramètres suivants.

Paramètre	Description
cname	Indique si un CNAME peut servir d'endpoint. true : un CNAME peut être utilisé comme endpoint. false (valeur par défaut) : un nom canonique (CNAME) ne peut pas servir d'endpoint.
download_crc_enable	Active ou désactive la vérification CRC-64 lors du téléchargement des objets. true : active le contrôle de redondance cyclique (CRC) pendant le téléchargement des fichiers. false (par défaut) : désactive le contrôle de redondance cyclique lors du téléchargement des fichiers.
upload_crc_enable	Détermine si la vérification CRC-64 est activée lors de l'envoi des objets. true (par défaut) : active le contrôle de redondance cyclique pour l'envoi de fichiers. false : désactive le contrôle de redondance cyclique pour l'envoi de fichiers.
open_timeout	Délai d'attente pour l'établissement de la connexion, exprimé en secondes. Valeur par défaut : 10.
read_timeout	Délai d'attente maximal pour recevoir une réponse, en secondes. Valeur par défaut : 120.