Java、Python、Go、PHP、C#、Node.js 用の Object Storage Service (OSS) SDK は、アプリケーションをバケットに接続し、オブジェクトのアップロード、ダウンロード、削除をサポートします。このクイックスタートでは、SDK を設定し、OSS へのアクセスを検証する方法について説明します。
前提条件
-
OSS が有効化されており、バケットが作成されていること。詳細については、「コンソールクイックスタート」をご参照ください。
-
AccessKey ペアが利用できること。AccessKey ペアがない場合は、「AccessKeyペアを作成する」をご参照ください。
重要Alibaba Cloud アカウントの AccessKey ペアが漏えいするリスクを低減するため、RAM ユーザーの AccessKey ペアを使用してください。最小権限の原則に従い、RAM ユーザーに対してテスト用バケットの
oss:PutObject、oss:GetObject、oss:DeleteObject権限を付与してください。
アクセス認証情報の設定
SDK は環境変数から AccessKey ペアを読み取ります。コード内に AccessKey ペアをハードコードしないでください。
macOSまたはLinux
export OSS_ACCESS_KEY_ID="yourAccessKeyId"
export OSS_ACCESS_KEY_SECRET="yourAccessKeySecret"
Windows PowerShell
$env:OSS_ACCESS_KEY_ID="yourAccessKeyId"
$env:OSS_ACCESS_KEY_SECRET="yourAccessKeySecret"
サンプルパラメーターの準備
コードを実行する前に、次のパラメーターを実際の値に置き換えてください。
|
パラメーター |
例 |
説明 |
region |
<region-id> |
バケットのリージョン ID。 |
bucket |
example-bucket |
既存のバケット名。 |
key |
example.txt |
サンプルオブジェクトの完全な名前。コードは終了前にこのオブジェクトを削除します。 |
Java、Python、Go、PHP、C# の V2 SDK は、リージョン ID に基づくデフォルトのパブリックエンドポイントを使用します。そのため、この例ではエンドポイントを明示的に設定する必要はありません。Node.js SDK の場合は、リージョン ID の先頭に oss- を付与してください。内部エンドポイント、アクセラレーションエンドポイント、またはカスタムドメイン名を使用する場合は、「エンドポイントおよびバケットドメインを介したOSSへのアクセス」をご参照ください。
コンプライアンスとセキュリティを向上させるためのポリシー変更により、2025 年 3 月 20 日以降、新規 OSS ユーザーは、中国本土リージョンにある OSS バケットでデータ API オペレーションを実行するために、カスタムドメイン名 (CNAME) を使用する必要があります。これらの操作では、デフォルトのパブリックエンドポイントの使用が制限されます。影響を受ける操作の完全なリストについては、公式発表をご参照ください。HTTPS 経由でデータにアクセスする場合は、有効な SSL 証明書をカスタムドメインにバインドする必要があります。コンソールでは HTTPS が強制されるため、これはOSS コンソールへのアクセスに必須です。
SDKの例
プログラミング言語を選択してください。各タブには、SDK のインストールコマンドと、クライアントの初期化、アップロード、ダウンロードの検証、削除、リソースのクリーンアップに関する完全なコードが含まれます。
Java SDK V2
Maven プロジェクトの pom.xml ファイルに次の依存関係を追加してください。この例ではバージョン 0.5.1 を使用します。
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>alibabacloud-oss-v2</artifactId>
<version>0.5.1</version>
</dependency>
サンプルコード:
package com.example.oss;
import com.aliyun.sdk.service.oss2.OSSClient;
import com.aliyun.sdk.service.oss2.credentials.EnvironmentVariableCredentialsProvider;
import com.aliyun.sdk.service.oss2.models.DeleteObjectRequest;
import com.aliyun.sdk.service.oss2.models.GetObjectRequest;
import com.aliyun.sdk.service.oss2.models.GetObjectResult;
import com.aliyun.sdk.service.oss2.models.PutObjectRequest;
import com.aliyun.sdk.service.oss2.transport.BinaryData;
import com.aliyun.sdk.service.oss2.utils.IOUtils;
import java.nio.charset.StandardCharsets;
public class QuickStart {
public static void main(String[] args) throws Exception {
String region = "<region-id>";
String bucket = "example-bucket";
String key = "example.txt";
String content = "Hello OSS";
try (OSSClient client = OSSClient.newBuilder()
.credentialsProvider(new EnvironmentVariableCredentialsProvider())
.region(region)
.build()) {
boolean uploaded = false;
try {
client.putObject(PutObjectRequest.newBuilder()
.bucket(bucket)
.key(key)
.body(BinaryData.fromString(content))
.build());
uploaded = true;
System.out.println("Object uploaded");
String downloaded;
try (GetObjectResult result = client.getObject(GetObjectRequest.newBuilder()
.bucket(bucket)
.key(key)
.build())) {
downloaded = new String(IOUtils.toByteArray(result.body()), StandardCharsets.UTF_8);
}
if (!content.equals(downloaded)) {
throw new IllegalStateException("Downloaded content does not match uploaded content");
}
System.out.println("Downloaded content: " + downloaded);
} finally {
if (uploaded) {
client.deleteObject(DeleteObjectRequest.newBuilder()
.bucket(bucket)
.key(key)
.build());
System.out.println("Object deleted");
}
}
}
System.out.println("Quick start completed");
}
}
その他の設定や例については、「OSS Java SDK V2」をご参照ください。
Python SDK V2
SDK をインストールしてください。この例ではバージョン 1.3.2 を使用します。
python3 -m pip install alibabacloud-oss-v2
サンプルコード:
import alibabacloud_oss_v2 as oss
def main():
region = "<region-id>"
bucket = "example-bucket"
key = "example.txt"
content = "Hello OSS"
config = oss.config.load_default()
config.credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()
config.region = region
client = oss.Client(config)
uploaded = False
try:
client.put_object(oss.PutObjectRequest(
bucket=bucket,
key=key,
body=content.encode("utf-8"),
))
uploaded = True
print("Object uploaded")
result = client.get_object(oss.GetObjectRequest(bucket=bucket, key=key))
with result.body as body_stream:
downloaded = body_stream.read().decode("utf-8")
if downloaded != content:
raise RuntimeError("Downloaded content does not match uploaded content")
print(f"Downloaded content: {downloaded}")
finally:
if uploaded:
client.delete_object(oss.DeleteObjectRequest(bucket=bucket, key=key))
print("Object deleted")
print("Quick start completed")
if __name__ == "__main__":
main()
その他の設定や例については、「OSS Python SDK V2」をご参照ください。
Go SDK V2
最新の SDK バージョンをインストールしてください。この例では v1.5.3 を使用します。
go get github.com/aliyun/alibabacloud-oss-go-sdk-v2@latest
サンプルコード:
package main
import (
"context"
"fmt"
"io"
"log"
"strings"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)
func run() (err error) {
region := "<region-id>"
bucket := "example-bucket"
key := "example.txt"
content := "Hello OSS"
ctx := context.Background()
config := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
client := oss.NewClient(config)
uploaded := false
defer func() {
if !uploaded {
return
}
_, deleteErr := client.DeleteObject(ctx, &oss.DeleteObjectRequest{
Bucket: oss.Ptr(bucket),
Key: oss.Ptr(key),
})
if deleteErr != nil {
if err == nil {
err = fmt.Errorf("delete object: %w", deleteErr)
}
return
}
fmt.Println("Object deleted")
}()
_, err = client.PutObject(ctx, &oss.PutObjectRequest{
Bucket: oss.Ptr(bucket),
Key: oss.Ptr(key),
Body: strings.NewReader(content),
})
if err != nil {
return fmt.Errorf("upload object: %w", err)
}
uploaded = true
fmt.Println("Object uploaded")
result, err := client.GetObject(ctx, &oss.GetObjectRequest{
Bucket: oss.Ptr(bucket),
Key: oss.Ptr(key),
})
if err != nil {
return fmt.Errorf("download object: %w", err)
}
defer result.Body.Close()
data, err := io.ReadAll(result.Body)
if err != nil {
return fmt.Errorf("read downloaded object: %w", err)
}
downloaded := string(data)
if downloaded != content {
return fmt.Errorf("downloaded content does not match uploaded content")
}
fmt.Printf("Downloaded content: %s\n", downloaded)
return nil
}
func main() {
if err := run(); err != nil {
log.Fatal(err)
}
fmt.Println("Quick start completed")
}
その他の設定や例については、「OSS Go SDK V2」をご参照ください。
PHP SDK V2
Composer を使用して SDK をインストールしてください。この例ではバージョン 0.4.0 を使用します。
composer require alibabacloud/oss-v2
サンプルコード:
<?php
require_once __DIR__ . '/vendor/autoload.php';
use AlibabaCloud\Oss\V2 as Oss;
$region = '<region-id>';
$bucket = 'example-bucket';
$key = 'example.txt';
$content = 'Hello OSS';
$config = Oss\Config::loadDefault();
$config->setCredentialsProvider(new Oss\Credentials\EnvironmentVariableCredentialsProvider());
$config->setRegion($region);
$client = new Oss\Client($config);
$uploaded = false;
try {
$putRequest = new Oss\Models\PutObjectRequest($bucket, $key);
$putRequest->body = Oss\Utils::streamFor($content);
$client->putObject($putRequest);
$uploaded = true;
echo 'Object uploaded' . PHP_EOL;
$result = $client->getObject(new Oss\Models\GetObjectRequest($bucket, $key));
$downloaded = $result->body->getContents();
if ($downloaded !== $content) {
throw new RuntimeException('Downloaded content does not match uploaded content');
}
echo 'Downloaded content: ' . $downloaded . PHP_EOL;
} finally {
if ($uploaded) {
$client->deleteObject(new Oss\Models\DeleteObjectRequest($bucket, $key));
echo 'Object deleted' . PHP_EOL;
}
}
echo 'Quick start completed' . PHP_EOL;
その他の設定や例については、「OSS PHP SDK V2」をご参照ください。
C# SDK V2
SDK をインストールしてください。この例ではバージョン 0.2.0 を使用します。
dotnet add package AlibabaCloud.OSS.V2
サンプルコード:
using System.Text;
using OSS = AlibabaCloud.OSS.V2;
var region = "<region-id>";
var bucket = "example-bucket";
var key = "example.txt";
var content = "Hello OSS";
var config = OSS.Configuration.LoadDefault();
config.CredentialsProvider = new OSS.Credentials.EnvironmentVariableCredentialsProvider();
config.Region = region;
using var client = new OSS.Client(config);
var uploaded = false;
try
{
await client.PutObjectAsync(new OSS.Models.PutObjectRequest
{
Bucket = bucket,
Key = key,
Body = new MemoryStream(Encoding.UTF8.GetBytes(content))
});
uploaded = true;
Console.WriteLine("Object uploaded");
var result = await client.GetObjectAsync(new OSS.Models.GetObjectRequest
{
Bucket = bucket,
Key = key
});
using var body = result.Body ?? throw new InvalidOperationException("The response body is empty");
using var reader = new StreamReader(body, Encoding.UTF8);
var downloaded = await reader.ReadToEndAsync();
if (downloaded != content)
{
throw new InvalidOperationException("Downloaded content does not match uploaded content");
}
Console.WriteLine($"Downloaded content: {downloaded}");
}
finally
{
if (uploaded)
{
await client.DeleteObjectAsync(new OSS.Models.DeleteObjectRequest
{
Bucket = bucket,
Key = key
});
Console.WriteLine("Object deleted");
}
}
Console.WriteLine("Quick start completed");
その他の設定や例については、「OSS C# SDK V2」をご参照ください。
Node.js SDK
SDK をインストールしてください。この例ではバージョン 6.23.0 を使用します。
npm install ali-oss
サンプルコード:
const OSS = require('ali-oss');
const region = 'oss-<region-id>';
const bucket = 'example-bucket';
const key = 'example.txt';
const content = 'Hello OSS';
const client = new OSS({
region,
bucket,
accessKeyId: process.env.OSS_ACCESS_KEY_ID,
accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
authorizationV4: true,
});
async function main() {
let uploaded = false;
try {
await client.put(key, Buffer.from(content, 'utf8'));
uploaded = true;
console.log('Object uploaded');
const result = await client.get(key);
const downloaded = result.content.toString('utf8');
if (downloaded !== content) {
throw new Error('Downloaded content does not match uploaded content');
}
console.log(`Downloaded content: ${downloaded}`);
} finally {
if (uploaded) {
await client.delete(key);
console.log('Object deleted');
}
}
console.log('Quick start completed');
}
main().catch((error) => {
console.error(error);
process.exitCode = 1;
});
その他の設定や例については、「OSS Node.js SDK」をご参照ください。
結果の確認
正常に実行されると、次の出力が返されます。アップロード後にエラーが発生した場合でも、ストレージが継続して使用されるのを防ぐため、サンプルはアップロードされたオブジェクトの削除を試行します。
Object uploaded
Downloaded content: Hello OSS
Object deleted
Quick start completed