オブジェクトストレージのAPI¶
[更新日:2022年3月16日]
API経由でのご利用について¶
オブジェクトストレージでは、利用形態や操作可能な範囲に合わせて「さくらのオブジェクトストレージAPI」と「Amazon S3互換API」の2つの種類のAPIを備えています。
| さくらのオブジェクトストレージAPI | Amazon S3互換API | |
|---|---|---|
| 操作方法 | さくらのクラウドのAPIキー | バケット作成時に発行されるアクセスキー |
| 操作可能な範囲 | バケットの新規作成などを含むさくらの オブジェクトストレージコントロールパネルと同様の操作全般 |
作成済みバケット/オブジェクトの操作 |
| Amazon S3互換クライアントでの使用 | 不可 | 独自のエンドポイント/アクセスキーが設定可能であれば利用可能 |
| API一覧 | さくらのオブジェクトストレージAPI | Amazon S3互換API |
さくらのオブジェクトストレージAPI¶
APIの一覧は さくらのオブジェクトストレージAPI のページを参照ください。
Amazon S3互換API¶
オブジェクトストレージで使用できるAmazon S3互換APIは以下の通りです。
| API名 | 概要 |
| GET Service | バケットのリストを取得する |
| GET Bucket (List Objects) Version 1 | オブジェクトの一覧を取得する |
| GET Bucket (List Objects) Version 2 | オブジェクトの一覧を取得する |
| PUT Bucket Versioning | バケットのバージョニング機能を設定する |
| GET Bucket Versioning | バケットのバージョニング機能の状態を取得する |
| GET Bucket Location | バケットのロケーション(リージョン情報)を取得する |
| GET Bucket Object Versions | オブジェクトの一覧をバージョン情報を含めて取得する |
| HEAD Bucket | バケットの存在とアクセス可能かを確認する |
| PUT Bucket ACL | バケットのACLを設定する |
| GET Bucket ACL | バケットのACLを取得する |
| List Multipart Uploads | Activeな MultipartUploadの一覧を取得する |
| PUT Bucket CORS | CORSの設定をする |
| GET Bucket CORS | CORSの設定状況を取得する |
| DELETE Bucket CORS | CORSの設定を削除する |
| DELETE Object | オブジェクトを削除する |
| DELETE Object Tagging | オブジェクトに設定されたタグを削除する |
| Multi-Object Delete | 複数のオブジェクトをまとめて削除する |
| GET Object | オブジェクトを取得する |
| GET Object Tagging | オブジェクトに設定されたタグを取得する |
| GET Object ACL | オブジェクトに設定されたACLを取得する |
| HEAD Object | オブジェクトの情報を取得する |
| PUT Object | オブジェクトをアップロード(作成)する ※ユーザー定義オブジェクトメタデータ設定可 |
| PUT Object Tagging | オブジェクトにタグを設定する |
| PUT Object ACL | オブジェクトにACLを設定する |
| PUT Object - Copy | 同一バケット内 または 異なるバケットからオブジェクトをコピーする |
| Initiate Multipart Upload | MultipartUploadの初期化をおこなう |
| Upload Part | MultipartUploadの パーツをアップロードする |
| Upload Part - Copy | MultipartUploadを使用して同一バケット内 または 異なるバケットからオブジェクトをコピーする |
| Complete Multipart Upload | MultipartUploadを完了させてオブジェクトを完成させる |
| Abort Multipart Upload | MultipartUploadを中断させてセッション情報の削除、アップロード済みのパーツの削除をおこなう |
| List Parts | MultipartUploadでアップロード済みのパーツの一覧を取得する |
| GET presign | 署名付きURLを作成する |