OSSClientインスタンスは、Object Storage Service (OSS) SDK for Node.jsのクライアントとして機能し、バケットやオブジェクトなどのOSSリソースを管理します。 OSS SDK for Node.js SDKを使用してOSSリクエストを開始する場合、OSSClientインスタンスを初期化し、ビジネス要件に基づいてデフォルト設定を変更する必要があります。
OSSClientインスタンスの作成
V1署名アルゴリズムの使用
OSSエンドポイントを使用したOSSClientインスタンスの作成
次のサンプルコードは、OSSエンドポイントを使用してOSSClientインスタンスを作成する方法の例を示しています。
const OSS = require('ali-OSS ');
const client = new OSS({
// バケットが配置されているリージョンを指定します。 たとえば、バケットが中国 (杭州) リージョンにある場合、リージョンをoss-cn-Hangzhouに設定します。
リージョン: 'yourRegion' 、
// 環境変数からアクセス資格情報を取得します。 サンプルコードを実行する前に、OSS_ACCESS_KEY_IDおよびOSS_ACCESS_KEY_SECRET環境変数が設定されていることを確認してください。
accessKeyId: process.env.OSS_ACCESS_KEY_ID、
accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET、
// バケットの名前を指定します。
bucket: 'yourBucketName' 、});
カスタムドメイン名を使用してOSSClientインスタンスを作成する
次のコードは、カスタムドメイン名を使用してOSSClientインスタンスを作成する方法の例を示しています。 詳細については、「カスタムドメイン名をバケットのデフォルトドメイン名にマップする」をご参照ください。
カスタムドメイン名を使用する場合、client.listBuckets() メソッドは使用できません。
const OSS = require('ali-OSS ')
const client = new OSS({
// バケットにアクセスするには、バケットのエンドポイントとしてカスタムドメイン名を使用します。
エンドポイント: 'http:// img.example.com '、
// 環境変数からアクセス資格情報を取得します。 サンプルコードを実行する前に、OSS_ACCESS_KEY_IDおよびOSS_ACCESS_KEY_SECRET環境変数が設定されていることを確認してください。
accessKeyId: process.env.OSS_ACCESS_KEY_ID、
accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET、
cname: true、
// バケットの名前を指定します。
bucket: 'yourBucketName' 、});
V4署名アルゴリズムの使用 (推奨)
より安全なV4署名アルゴリズムを使用する場合は、初期化中にauthorizationV4をtrueに設定する必要があります。 Node.js 6.20.0以降のOSS SDKは、V4署名をサポートしています。
次のサンプルコードは、V4署名アルゴリズムを使用してOSSエンドポイントを使用してOSSClientインスタンスを作成する方法の例を示しています。 V4署名アルゴリズムを使用して他の方法でOSSClientインスタンスを作成する場合は、次のサンプルコードを参照して変数を変更します。
const OSS = require('ali-OSS ');
const client = new OSS({
// 環境変数からアクセス資格情報を取得します。 サンプルコードを実行する前に、OSS_ACCESS_KEY_IDおよびOSS_ACCESS_KEY_SECRET環境変数が設定されていることを確認してください。
accessKeyId: process.env.OSS_ACCESS_KEY_ID、
accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET、
// バケットが配置されているリージョンを指定します。 たとえば、バケットが中国 (杭州) リージョンにある場合、リージョンをoss-cn-Hangzhouに設定します。
リージョン: 'yourRegion' 、
authorizationV4: true、
// バケットの名前を指定します。
bucket: 'yourBucketName' 、});
OSSClientインスタンスの設定
OSSClientインスタンスを初期化するときに、ビジネス要件に基づいて設定パラメーターを指定できます。 たとえば、timeout
を指定してリクエストタイムアウト期間を指定したり、stsToken
を指定して一時的なアクセス資格情報を指定したりできます。 サポートされている設定パラメーターと設定例の詳細については、「設定パラメーター」をご参照ください。