このトピックでは、Object Storage Service (OSS) API の概要を説明します。OSS のコアコンセプトとリソースモデルを理解し、必要な API をすばやく見つけるのに役立ちます。カスタム開発では、本番環境でソフトウェア開発キット (SDK) を使用します。SDK は、署名、再試行、同時実行などの複雑なロジックをカプセル化します。このトピックは、SDK の基盤となる実装のリファレンスとして機能し、高度なカスタマイズや通信メカニズムの理解に役立ちます。
開始する前に、次の点に注意してください。
クイックスタート: 最初の API の呼び出し
このセクションでは、バケットの作成 (PutBucket) を例として、API 呼び出しを行う完全なプロセスについて説明します。
1. 準備
開始する前に、次の情報を取得してください。
AccessKey: セキュリティのため、匿名アクセスリクエストを除くすべての OSS API リクエストは、認証のために署名される必要があります。OSS は、AccessKey ID と AccessKey シークレットで構成される AccessKey ペアに基づく署名メカニズムを使用してリクエストを検証します。署名情報は、HTTP リクエストヘッダーの
Authorizationフィールドに含める必要があります。署名の計算方法の詳細については、「署名 V4 (推奨)」をご参照ください。エンドポイント: API リクエストは、ターゲットバケットが配置されているリージョンのエンドポイントに送信する必要があります。エンドポイントは、OSS サービスのアクセスアドレスです。さまざまなリージョンのエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。
2. リクエストの作成と送信
PUT / HTTP/1.1
Host: oss-example.oss-cn-hangzhou.aliyuncs.com
Date: Thu, 17 Apr 2025 03:15:40 GMT
x-oss-acl: private
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
<?xml version="1.0" encoding="UTF-8"?>
<CreateBucketConfiguration>
<StorageClass>Standard</StorageClass>
<DataRedundancyType>LRS</DataRedundancyType>
</CreateBucketConfiguration>3. 応答の理解
成功応答: リクエストが成功した場合、サーバーは
2xxステータスコードを返します。コンテンツを返す操作の場合、応答本文は XML 形式です。HTTP/1.1 200 OK x-oss-request-id: 534B371674E88A4D8906**** Date: Fri, 24 Feb 2017 03:15:40 GMT Content-Length: 0 Connection: keep-alive Server: AliyunOSS Location: /oss-exampleエラー処理: リクエストが失敗した場合、サーバーは
4xxまたは5xxステータスコードを返します。応答本文も XML 形式であり、特定のエラーコード (Code) とエラーメッセージ (Message) が含まれています。詳細については、「エラーコード」をご参照ください。問題をトラブルシューティングします。
API リスト
サービス操作
API | 説明 |
リクエスタが所有するすべてのバケットを返します。 | |
リクエスタのすべてのデータ冗長性移行タスクを一覧表示します。 |
リージョン操作
API | 説明 |
サポートされているすべてのリージョンまたは指定されたリージョンのエンドポイントを照会します。 |
バケット操作
分類 | API | 説明 |
基本操作 | バケットを作成します。 | |
バケットを削除します。 | ||
バケット内のすべてのオブジェクトに関する情報を一覧表示します。 | ||
バケット情報を照会します。 | ||
バケットの場所を照会します。 | ||
バケット内のストレージ使用量とオブジェクト数を照会します。 | ||
保持ポリシー | 保持ポリシーを作成します。 | |
ロックされていない保持ポリシーを削除します。 | ||
保持ポリシーをロックします。 | ||
保持ポリシーがロックされているバケット内のオブジェクトの保持期間を延長します。 | ||
バケットの保持ポリシーを照会します。 | ||
アクセス制御 | バケットのアクセス権限を設定します。 | |
バケットのアクセス権限を照会します。 | ||
ライフサイクル | バケット内のオブジェクトのライフサイクルルールを設定します。 | |
バケット内のオブジェクトのライフサイクルルールを照会します。 | ||
バケット内のオブジェクトのライフサイクルルールを削除します。 | ||
転送アクセラレーション | バケットの転送アクセラレーションを設定します。 | |
バケットの転送アクセラレーション設定を照会します。 | ||
バージョン管理 | バケットのバージョン管理状態を設定します。 | |
バケットのバージョン管理状態を照会します。 | ||
バケット内のすべてのオブジェクトのバージョンを一覧表示します。 | ||
クロスリージョンレプリケーション | バケットのデータレプリケーションルールを設定します。 | |
既存のクロスリージョンレプリケーションルールに対してレプリケーション時間制御 (RTC) を有効または無効にします。 | ||
バケットに設定されているデータレプリケーションルールを照会します。 | ||
データをレプリケーションできるターゲットリージョンを照会します。 | ||
バケットのデータレプリケーションの進行状況を照会します。 | ||
データレプリケーションタスクを停止し、バケットのレプリケーション設定を削除します。 | ||
承認ポリシー | バケットポリシーを設定します。 | |
バケットポリシーを照会します。 | ||
現在のバケットポリシーがパブリックアクセスを許可しているかどうかを確認します。 | ||
バケットポリシーを削除します。 | ||
在庫 | バケットのインベントリ ルールを設定します。 | |
バケット内の指定されたインベントリタスクを照会します。 | ||
バケット内のすべてのインベントリタスクを照会します。 | ||
バケットから指定されたインベントリタスクを削除します。 | ||
ログ管理 | バケットのアクセスログ記録機能を有効にします。 | |
バケットのアクセスログ設定を照会します。 | ||
バケットのアクセスログ記録機能を無効にします。 | ||
バケットのリアルタイムログの | ||
バケットのリアルタイムログの | ||
バケットのリアルタイムログの | ||
静的 Web サイト | バケットを静的 Web サイトホスティングモードに設定します。 | |
バケットの静的 Web サイトホスティングステータスを照会します。 | ||
バケットの静的 Web サイトホスティングモードを無効にします。 | ||
ホットリンク保護 | バケットのホットリンク保護ルールを設定します。 | |
バケットのホットリンク保護ルールを照会します。 | ||
タグ | バケットタグを追加または変更します。 | |
バケットタグを照会します。 | ||
バケットタグを削除します。 | ||
暗号化 | バケットの暗号化ルールを設定します。 | |
バケットの暗号化ルールを照会します。 | ||
バケットの暗号化ルールを削除します。 | ||
リクエスト元による支払い | バケットをリクエスト元支払いモードに設定します。 | |
バケットのリクエスト元支払いモードの設定を照会します。 | ||
オリジン間リソース共有 | 指定されたバケットのオリジン間リソース共有 (CORS) ルールを設定します。 | |
指定されたバケットの現在の CORS ルールを照会します。 | ||
CORS 機能を無効にし、指定されたバケットのすべての CORS ルールをクリアします。 | ||
ブラウザがクロスオリジンリクエストを送信する前に、ソースオリジン、HTTP メソッド、ヘッダーなどの情報を含むプリフライトリクエスト (OPTIONS) を OSS に送信し、実際のリクエストを送信するかどうかを決定します。 | ||
アクセス追跡 | バケットのアクセストラッキング状態を設定します。 | |
バケットのアクセストラッキング状態を照会します。 | ||
データインデックス作成 | バケットのメタデータ管理機能を有効にします。 | |
指定されたバケットのメタデータインデックスライブラリを照会します。 | ||
指定された条件を満たすオブジェクトを照会し、指定されたフィールドとソート方法に基づいてオブジェクト情報を一覧表示します。 | ||
バケットのメタデータ管理機能を無効にします。 | ||
DDoS 保護 | Anti-DDoS for OSS インスタンスを作成します。 | |
Anti-DDoS for OSS インスタンスのステータスを変更します。 | ||
指定されたアカウントに属する Anti-DDoS for OSS インスタンスに関する情報を照会します。 | ||
バケットの保護を初期化します。 | ||
バケットの保護ステータスを更新します。 | ||
バケットの保護情報のリストを照会します。 | ||
リソースグループ | バケットのリソースグループを設定します。 | |
バケットが属するリソースグループの ID を照会します。 | ||
カスタムドメイン名 | ドメイン名の所有権を検証するために必要な CNAME トークンを作成します。 | |
作成された CNAME トークンを照会します。 | ||
CNAME レコードをバケットにバインドします。 | ||
バケットにバインドされているすべての CNAME レコードのリストを照会します。 | ||
バインドされた CNAME レコードを削除します。 | ||
イメージスタイル | イメージスタイルを追加します。 | |
バケット内の指定されたイメージスタイルに関する情報を照会します。 | ||
バケットで作成されたすべてのイメージスタイルを照会します。 | ||
バケットから指定されたイメージスタイルを削除します。 | ||
トランスポート層セキュリティ | バケットの TLS バージョン設定を有効または無効にします。 | |
バケットの TLS バージョン設定を照会します。 | ||
冗長性移行 | データ冗長性移行タスクを作成します。 | |
データ冗長性移行タスクを照会します。 | ||
データ冗長性移行タスクを削除します。 | ||
リクエスタのすべてのデータ冗長性移行タスクを一覧表示します。 | ||
バケット内のすべてのデータ冗長性移行タスクを一覧表示します。 | ||
アクセスポイント | アクセスポイントを作成します。 | |
アクセスポイントに関する情報を照会します。 | ||
アクセスポイントを削除します。 | ||
ユーザーレベルまたはバケットレベルのアクセスポイントに関する情報を照会します。 | ||
アクセスポイントポリシーを設定します。 | ||
アクセスポイントポリシーの設定を照会します。 | ||
アクセスポイントポリシーを削除します。 | ||
Object FC アクセスポイント | Object FC アクセスポイントを作成します。 | |
Object FC アクセスポイントの基本情報を照会します。 | ||
Object FC アクセスポイントを削除します。 | ||
ユーザーレベルの Object FC アクセスポイントに関する情報を照会します。 | ||
Object FC アクセスポイントの設定を変更します。 | ||
Object FC アクセスポイントの設定を照会します。 | ||
Object FC アクセスポイントのアクセスポリシーを設定します。 | ||
Object FC アクセスポイントのアクセスポリシー設定を照会します。 | ||
Object FC アクセスポイントのアクセスポリシーを削除します。 | ||
返されるデータと応答ヘッダーをカスタマイズします。 | ||
パブリックアクセスのブロック | OSS のパブリックアクセスブロックをグローバルに有効にします。 | |
OSS のグローバルなパブリックアクセスブロック設定を照会します。 | ||
OSS のグローバルなパブリックアクセスブロック設定を削除します。 | ||
バケットのパブリックアクセスブロックを有効にします。 | ||
指定されたバケットのパブリックアクセスブロック設定を照会します。 | ||
指定されたバケットのパブリックアクセスブロック設定を削除します。 | ||
アクセスポイントのパブリックアクセスブロックを有効にします。 | ||
指定されたアクセスポイントのパブリックアクセスブロック設定を照会します。 | ||
指定されたアクセスポイントのパブリックアクセスブロック設定を削除します。 | ||
アーカイブオブジェクトのリアルタイムアクセス | アーカイブオブジェクトのリアルタイムアクセスを有効または無効にします。 | |
アーカイブオブジェクトのリアルタイムアクセスが有効になっているかどうかを照会します。 | ||
OSS アクセラレータ | OSS アクセラレータを作成するか、その設定を変更します。 | |
OSS アクセラレータに関する情報を照会します。 | ||
OSS アクセラレータを削除します。 |
オブジェクト操作
分類 | API | 説明 |
基本操作 | オブジェクトをアップロードします。 | |
オブジェクトを照会します。 | ||
オブジェクトをコピーします。 | ||
追加アップロードを使用してオブジェクトをアップロードします。 | ||
Appendable オブジェクトへのデータの追加を防ぎます。 | ||
単一のオブジェクトを削除します。 | ||
複数のオブジェクトを削除します。 | ||
オブジェクトのメタデータのみを返し、オブジェクトのコンテンツは返しません。 | ||
オブジェクトの ETag、サイズ、最終変更時刻などのオブジェクトの基本メタデータを返しますが、オブジェクトのコンテンツは返しません。 | ||
HTML フォームを使用してオブジェクトをアップロードします。 | ||
OSS に送信するリクエストにコールバックパラメーターを含めることで、コールバックを実装できます。 | ||
アーカイブストレージ、コールドアーカイブ、またはディープコールドアーカイブオブジェクトを復元します。 | ||
オブジェクトの解凍状態を事前に終了します。 | ||
オブジェクトファイルに対して SQL ステートメントを実行し、実行結果を返します。 | ||
オブジェクトファイルの合計行数、合計列数 (CSV ファイルの場合)、および分割数を照会します。 | ||
フォルダー管理 | フォルダを作成します。 | |
フォルダまたはオブジェクトの名前を変更します。 | ||
フォルダを削除します。 | ||
マルチパートアップロード | マルチパートアップロードイベントを開始します。 | |
指定されたオブジェクト名とアップロード ID に基づいてデータをパーツでアップロードします。 | ||
UploadPartCopy 操作を呼び出して、既存のオブジェクトからデータをコピーし、UploadPart リクエストに x-oss-copy-source リクエストヘッダーを追加してパーツをアップロードします。 | ||
ファイルのすべてのパーツがアップロードされた後、CompleteMultipartUpload 操作を呼び出して、ファイルのマルチパートアップロードを完了する必要があります。 | ||
マルチパートアップロードイベントをキャンセルし、アップロードされたパーツを削除します。 | ||
進行中のすべてのマルチパートアップロードイベントを一覧表示します。進行中のマルチパートアップロードイベントは、開始されたが完了または中止されていないマルチパートアップロードイベントです。 | ||
指定されたアップロード ID に属する正常にアップロードされたすべてのパーツを一覧表示します。 | ||
アクセス制御 | オブジェクトのアクセス権限を変更します。 | |
オブジェクトのアクセス権限を照会します。 | ||
シンボリックリンク | シンボリックリンクを作成します。 | |
シンボリックリンクを照会します。 | ||
タグ付け | オブジェクトタグを設定または更新します。 | |
オブジェクトタグを照会します。 | ||
指定されたオブジェクトタグを削除します。 |
ベクターバケット操作
分類 | API | 説明 |
ベクターバケット | ベクターバケットを作成します。 | |
ベクターバケットの詳細を照会します。 | ||
現在のアカウントに属するすべてのベクターバケットを一覧表示します。 | ||
ベクターバケットを削除します。 | ||
インデックス | ベクターバケットにベクターインデックスを作成します。 | |
ベクターインデックスの詳細を照会します。 | ||
ベクターバケット内のすべてのベクターインデックスを一覧表示します。 | ||
すべてのデータパーツをアップロードした後、CompleteMultipartUpload API を呼び出してマルチパートアップロードを完了する必要があります。 | ||
ベクター | ベクターデータをインデックスに書き込みます。 | |
指定されたベクターデータを照会します。 | ||
ベクターインデックス内のすべてのベクターデータを一覧表示します。 | ||
ベクターインデックスから指定されたベクターデータを削除します。 | ||
ベクター類似検索を実行します。 |
リソースグループ QoS 操作
API | 説明 |
リソースプール内のバケットの速度制限を設定します。 | |
リソースプール内のバケットの速度制限設定を照会します。 | |
リソースプール内の指定されたバケットの速度制限設定を削除します。 | |
リクエスタのバケットレベルの速度制限を設定します。 | |
指定されたリクエスタのバケットレベルの速度制限設定を照会します。 | |
すべてのリクエスタのバケットレベルの速度制限設定を照会します。 | |
バケットのリクエスタの速度制限設定を削除します。 | |
現在のアカウントに属するすべてのリソースプールに関する情報を照会します。 | |
指定されたリソースプールの速度制限設定を照会します。 | |
指定されたリソースプールに含まれるバケットのリストを照会します。 | |
リソースプールのリクエスタの速度制限を設定します。 | |
リソースプールの指定されたリクエスタの速度制限設定を照会します。 | |
リソースプールのすべてのリクエスタの速度制限設定を照会します。 | |
リソースプールの指定されたリクエスタの速度制限設定を削除します。 | |
リソースプール内のバケットをバケットグループに追加します。 | |
指定されたリソースプール内のバケットグループを一覧表示します。 | |
リソースプール内のバケットグループの速度制限設定を構成または変更します。 | |
リソースプール内のバケットグループの速度制限設定を照会します。 | |
リソースプール内のバケットグループの速度制限設定を一覧表示します。 | |
リソースプール内のバケットグループの速度制限設定を削除します。 |
LiveChannel 操作
API | 説明 |
LiveChannel のステータスを切り替えます。 | |
LiveChannel を作成します。 | |
再生リストを照会します。 | |
再生リストを生成します。 | |
LiveChannel のアップストリーミングステータスを照会します。 | |
LiveChannel の設定を照会します。 | |
LiveChannel のアップストリーミングレコードを照会します。 | |
LiveChannel を一覧表示します。 | |
LiveChannel を削除します。 |