Penyiapan OSS SDK untuk upload dan download objek - Object Storage Service

OSS SDK untuk Java, Python, Go, PHP, C#, dan Node.js menghubungkan aplikasi ke bucket serta mendukung operasi upload, download, dan penghapusan objek. Gunakan panduan cepat mulai ini untuk mengonfigurasi SDK dan memverifikasi akses ke OSS.

Prasyarat

OSS telah diaktifkan dan sebuah bucket telah dibuat. Untuk informasi lebih lanjut, lihat Console Quick Start.
Pasangan AccessKey tersedia. Jika Anda belum memiliki pasangan AccessKey, lihat Create an AccessKey pair.

Penting
Untuk mengurangi risiko terpaparnya pasangan AccessKey akun Alibaba Cloud Anda, gunakan pasangan AccessKey dari RAM user. Terapkan prinsip least privilege dan berikan izin oss:PutObject, oss:GetObject, dan oss:DeleteObject pada bucket uji kepada RAM user tersebut.

Konfigurasi kredensial akses

SDK membaca pasangan AccessKey dari variabel lingkungan. Jangan menyematkan pasangan AccessKey secara langsung dalam kode Anda.

macOS atau 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"

Siapkan parameter contoh

Sebelum menjalankan kode, ganti parameter berikut dengan nilai aktual Anda.

Parameter	Nilai contoh	Deskripsi
`region`	`<region-id>`	ID wilayah bucket.
`bucket`	`example-bucket`	Nama bucket yang sudah ada.
`key`	`example.txt`	Nama lengkap objek contoh. Kode ini akan menghapus objek tersebut sebelum keluar.

SDK Java, Python, Go, PHP, dan C# V2 menggunakan titik akhir publik default berdasarkan ID wilayah, sehingga Anda tidak perlu mengonfigurasi titik akhir secara eksplisit dalam contoh ini. Untuk SDK Node.js, tambahkan awalan oss- pada ID wilayah. Untuk menggunakan titik akhir internal, titik akhir percepatan, atau nama domain kustom, lihat Access OSS via Endpoints and Bucket Domains.

Penting

Karena adanya perubahan kebijakan untuk meningkatkan kepatuhan dan keamanan, mulai 20 Maret 2025, pengguna OSS baru harus menggunakan nama domain kustom (CNAME) untuk melakukan operasi API data pada bucket OSS yang berlokasi di wilayah Tiongkok Daratan. Titik akhir publik default dibatasi untuk operasi tersebut. Lihat pengumuman resmi untuk daftar lengkap operasi yang terdampak. Jika Anda mengakses data melalui HTTPS, Anda harus mengikat Sertifikat SSL yang valid ke domain kustom Anda. Hal ini wajib untuk akses Konsol OSS, karena konsol menerapkan HTTPS.

Contoh SDK

Pilih bahasa pemrograman Anda. Setiap tab menyediakan perintah instalasi SDK dan kode lengkap untuk inisialisasi klien, upload, verifikasi download, penghapusan, serta pembersihan resource.

Java SDK V2

Tambahkan dependensi berikut ke file pom.xml proyek Maven Anda. Contoh ini menggunakan versi 0.5.1.

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>alibabacloud-oss-v2</artifactId>
    <version>0.5.1</version>
</dependency>

Kode contoh:

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");
    }
}

Untuk konfigurasi dan contoh lainnya, lihat OSS Java SDK V2.

Python SDK V2

Instal SDK. Contoh ini menggunakan versi 1.3.2.

python3 -m pip install alibabacloud-oss-v2

Kode contoh:

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()

Untuk konfigurasi dan contoh lainnya, lihat OSS Python SDK V2.

Go SDK V2

Instal versi SDK terbaru. Contoh ini menggunakan v1.5.3.

go get github.com/aliyun/alibabacloud-oss-go-sdk-v2@latest

Kode contoh:

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")
}

Untuk konfigurasi dan contoh lainnya, lihat OSS Go SDK V2.

PHP SDK V2

Gunakan Composer untuk menginstal SDK. Contoh ini menggunakan versi 0.4.0.

composer require alibabacloud/oss-v2

Kode contoh:

<?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;

Untuk konfigurasi dan contoh lainnya, lihat OSS PHP SDK V2.

C# SDK V2

Instal SDK. Contoh ini menggunakan versi 0.2.0.

dotnet add package AlibabaCloud.OSS.V2

Kode contoh:

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");

Untuk konfigurasi dan contoh lainnya, lihat OSS C# SDK V2.

Node.js SDK

Instal SDK. Contoh ini menggunakan versi 6.23.0.

npm install ali-oss

Kode contoh:

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;
});

Untuk konfigurasi dan contoh lainnya, lihat OSS Node.js SDK.

Lihat hasilnya

Jalankan yang berhasil akan menghasilkan output berikut. Jika terjadi error setelah upload, contoh ini tetap mencoba menghapus objek yang diupload untuk menghindari penggunaan penyimpanan berkelanjutan.

Object uploaded
Downloaded content: Hello OSS
Object deleted
Quick start completed

Object Storage Service:Panduan Cepat Mulai SDK

Prasyarat

Konfigurasi kredensial akses

macOS atau Linux

Windows PowerShell

Siapkan parameter contoh

Contoh SDK

Java SDK V2

Python SDK V2

Go SDK V2

PHP SDK V2

C# SDK V2

Node.js SDK

Lihat hasilnya

SDK lainnya